Perle IOAN DS1 User manual

IOLAN DS Family
DS1/TS2 User’s Guide
Version 1.8
Part #5500162-18
November 2006

Copyright Statement
This document must not be reproduced in any way whatsoever, either printed or electronically, without the consent of:
Perle Systems Limited,
60 Renfrew Drive
Markham, ON
Canada
L3R 0E1
Perle reserves the right to make changes without further notice, to any products to improve reliability, function, or
design.
Perle, the Perle logo, and IOLAN are trademarks of Perle Systems Limited.
Microsoft, Windows 98, Windows NT, Windows 2000, Windows Server 2003, Windows XP, and Internet Explorer are
trademarks of Microsoft Corporation.
Netscape is a trademark of Netscape Communications Corporation.
Mozilla Firefox is a trademark of the Mozilla Foundation.
Solaris is a registered trademark of Sun Microsystems, Inc. in the USA and other countries.
Perle Systems Limited, 2004-2006.
FCC Note The IOLAN Device Server has been found to comply with the limits for a Class A digital
device, pursuant to Part 15 of the FCC rules. These limits are designed to provide
reasonable protection against harmful interference when the equipment is operated in a
commercial environment. This equipment generates, uses, and can radiate radio frequency
energy and, if not installed and used in accordance with the instructions in this Guide, may
cause harmful interference to radio communications. Operation of this equipment in a
residential area is likely to cause harmful interference, in which case the user will be
required to correct the interference at his/her own expense.
EN 55022: 1998, Class A, Note
WARNING ThisisaClassAproduct.Inadomesticenvironmentthisproductmaycauseradiointerferenceinwhichcase
the user may be required to take adequate measures.
Caution: The IOLAN Device Server is approved for commercial use only.

IOLAN Device Server User’s Guide, Version 1.8 3
Preface ...............................................................................19
About This Book ........................................................................ 19
Intended Audience..................................................................... 19
Documentation........................................................................... 19
Typeface Conventions............................................................... 20
Online Help................................................................................. 20
Contacting Technical Support.................................................. 21
Making a Technical Support Query ...................................................... 21
Who To Contact................................................................................. 21
Have Your Product Information Ready .............................................. 21
Making a support query via the Perle web page................................ 21
Repair Procedure.................................................................................... 22
Feedback on this Manual....................................................................... 22
Chapter 1 Introduction......................................................23
About the IOLAN Device Server ............................................... 23
IOLAN Device Server Models.................................................... 23
Device Server Features............................................................. 24
Hardware................................................................................................. 24
Software .................................................................................................. 24
Security ................................................................................................... 25
Supported Products/Versions .................................................. 25
Web Browsers......................................................................................... 25
Table of Contents

Table of Contents
4 IOLAN Device Server User’s Guide, Version 1.8
Typical Applications Summary .................................................25
Managing the Device Server..................................................................25
Managing/Accessing devices attached to the Device Server.............25
Network Security.....................................................................................26
Chapter 2 Installation........................................................27
Introduction.................................................................................27
IOLAN Device Server Components...........................................27
What’s Included ......................................................................................27
What You Need to Supply......................................................................27
Available Accessories............................................................................27
Getting to Know Your Device Server........................................28
DS1...........................................................................................................28
TS2 ...........................................................................................................28
LED Guide................................................................................................29
Console Mode vs. Serial Mode..............................................................29
Powering Up the Device Server ................................................29
Power Supply Requirements.................................................................29
Serial Only Models ............................................................................. 29
I/O Models.......................................................................................... 30
Serial Only Models..................................................................................30
I/O Models................................................................................................30
Setting Jumpers .........................................................................31
1-Port Device Server...............................................................................31
Device Server DB25 Male/Female..................................................... 31
Device Server RJ45............................................................................ 31
Device Server DB9............................................................................. 32
2-Port Device Server...............................................................................32
Digital I/O Module....................................................................................33
Analog Input Module ..............................................................................34

5
Table of Contents
Wiring I/O Diagrams................................................................... 34
Digital I/O................................................................................................. 34
Digital Input Wet Contact ................................................................... 34
Digital Input Dry Contact.................................................................... 35
Digital Output Sink ............................................................................. 35
Digital Output Source......................................................................... 35
Analog Input............................................................................................ 36
Current............................................................................................... 36
Voltage............................................................................................... 36
Temperature Input.................................................................................. 36
Thermocouple.................................................................................... 36
RTD 2-Wire........................................................................................ 37
RTD 3-Wire........................................................................................ 37
RTD 4-Wire........................................................................................ 37
Relay Output........................................................................................... 37
Normally Open Contact...................................................................... 37
Normally Closed Contact ................................................................... 38
Setting an Initial IP Address ..................................................... 38
Using DeviceManager............................................................................ 39
Using a Direct Connection..................................................................... 40
Using DHCP/BOOTP............................................................................... 40
Using ARP-Ping...................................................................................... 41
IPv6 Network........................................................................................... 41
Pinouts........................................................................................ 42
DB25 Male ............................................................................................... 42
DB25 Female........................................................................................... 43
RJ45......................................................................................................... 44
DB9 Male (Serial Only)........................................................................... 44
DB9 Male I/O............................................................................................ 45
EIA-232 Cabling Diagrams ........................................................ 46
Terminal DB25 Connector ..................................................................... 46
DB25 Male ......................................................................................... 46
DB25 Female..................................................................................... 46
RJ45................................................................................................... 47
DB9 Male ........................................................................................... 47
Modem DB25 Connector........................................................................ 48
DB25 Male ......................................................................................... 48
RJ45................................................................................................... 48
DB9 Male ........................................................................................... 49

Table of Contents
6 IOLAN Device Server User’s Guide, Version 1.8
Chapter 3 Configuration Methods ...................................51
Introduction.................................................................................51
DeviceManager ...........................................................................51
WebManager ...............................................................................52
Using the WebManager..........................................................................52
CLI................................................................................................52
Menu ............................................................................................52
Accessing the Menu...............................................................................52
Menu Conventions..................................................................................53
DHCP/BOOTP..............................................................................53
SNMP ...........................................................................................54
Chapter 4 Configuring the Device Server .......................55
Introduction.................................................................................55
Configuring the Device Server..................................................55
General Device Server Configuration...................................................55
Device Server Services ..........................................................................55
TruePort...................................................................................................56
Hardware Configuration.........................................................................56
Ethernet Connection........................................................................... 56
Serial Connection............................................................................... 56
Other................................................................................................... 56
Modbus Configuration ...............................................................57
Overview..................................................................................................57
Configuring a Master Gateway........................................................... 57
Configuring a Slave Gateway............................................................. 57
Modbus Gateway Settings.....................................................................58
Modbus Master Gateway.................................................................... 58
Modbus Slave Gateway...................................................................... 58
Modbus Line Settings.............................................................................59
Modbus Master Settings..................................................................... 59
Modbus Slave Settings....................................................................... 59
Example Scenario...................................................................................60

7
Table of Contents
Machine To Machine Connections........................................... 62
Users Connecting to Serial Devices ........................................ 62
Users Connecting to the LAN................................................... 62
Connecting To the Device Server......................................................... 63
Connecting Through the Device Server............................................... 63
Setting Up Lines......................................................................... 63
DSLogin................................................................................................... 63
Direct/Silent/Reverse Connections....................................................... 64
Virtual Modems....................................................................................... 64
BIDIR........................................................................................................ 64
TruePort................................................................................................... 64
Signal I/O................................................................................................. 64
UDP.......................................................................................................... 65
Serial Tunnel Settings............................................................................ 66
Setting Up Users........................................................................ 66
User Accounts........................................................................................ 66
User Levels ............................................................................................. 67
Sessions.................................................................................................. 67
Users From LAN to Device Server to Serial Device............................ 67
Easy Port Access Menu..................................................................... 67
Reverse Sessions and Multisessions................................................. 68
Configuring Network Options................................................... 69
Hosts........................................................................................................ 69
Gateways................................................................................................. 69
Syslog...................................................................................................... 69
SNMP....................................................................................................... 69
Configuring Time ....................................................................... 69
Language support...................................................................... 69
Loading a Supplied Language .............................................................. 70
Translation Guidance............................................................................. 70
Software Upgrades and Language Files.............................................. 71

Table of Contents
8 IOLAN Device Server User’s Guide, Version 1.8
Downloading Terminal Definitions ...........................................71
Creating Terminal Definition Files.........................................................71
TFTP Configuration....................................................................73
Resetting Configuration Parameters........................................73
Lost Admin Password................................................................73
DHCP/BOOTP..............................................................................73
DHCP/BOOTP Parameters .....................................................................74
Creating Custom Applications..................................................74
I/O Model Features .....................................................................74
Failsafe Timer..........................................................................................74
Alarms......................................................................................................75
UDP ..........................................................................................................75
UDP Unicast Format........................................................................... 75
UDP Unicast Example........................................................................ 76
I/O Modbus Slave....................................................................................76
Modbus Serial Application Connected to the Serial Port.................... 76
Modbus Serial Application Connected to the Network ....................... 77
Modbus TCP Application.................................................................... 77
Modbus I/O Access.................................................................................77
Function Codes .................................................................................. 77
A4/T4 Registers.................................................................................. 78
A4D2/A4R2 Registers ........................................................................ 78
D4/D2R2 Registers............................................................................. 79
Serial Signals...................................................................................... 79
TruePort...................................................................................................80
TruePort/Modbus Combination........................................................... 80
API Over TruePort Only...................................................................... 80
Digital Channels......................................................................................81
Digital Input......................................................................................... 81
Digital Output...................................................................................... 82
Temperature Channels...........................................................................83
Analog Channels.....................................................................................84
Relay Channels.......................................................................................85
Serial Signals ..........................................................................................85

9
Table of Contents
Calibrating Analog Input........................................................................ 86
Calibrating Voltage............................................................................. 86
Calibrating Current............................................................................. 86
Calibrating Temperature Input.............................................................. 86
Calibrating Thermocouple.................................................................. 86
Calibrating RTD.................................................................................. 86
Chapter 5 Using the DeviceManager...............................87
Introduction................................................................................ 87
Starting a New Session............................................................. 87
Managing a Device Server..................................................................... 88
Populating the Device Server List...................................................... 88
Assigning a Temporary IP Address to a New Device Server............. 89
Adding/Deleting Static Device Servers .............................................. 89
Creating a New Device Server Configuration...................................... 90
Opening an Existing Configuration File............................................... 90
Connecting to a Device Server................................................. 90
Managing a Device Server ........................................................ 91
DeviceManager Work Flow.................................................................... 91
Creating/Editing Configuration Files.................................................... 91
Working With the Device Server Configuration.................................. 91
Working With a Local Configuration File............................................ 91
Configuring the Server.............................................................. 92
Configuring the Main Server Window................................................... 92
Server................................................................................................. 92
Services ............................................................................................. 92
Configuring Advanced Server Settings................................................ 93
Configuring TruePort Baud................................................................... 94
Configuring the Hardware ..................................................................... 94
Custom App............................................................................................ 94

Table of Contents
10 IOLAN Device Server User’s Guide, Version 1.8
Configuring Lines.......................................................................95
Advanced Line Settings.........................................................................97
Service Settings......................................................................................99
DSLogin.............................................................................................. 99
Raw Settings .................................................................................... 100
Telnet Settings.................................................................................. 100
BIDIR Settings.................................................................................. 101
UDP Settings.................................................................................... 102
VModem Settings............................................................................. 103
Server Tunnel Settings..................................................................... 103
Client Tunnel Settings ...................................................................... 104
Modbus Slave Settings..................................................................... 104
Modbus Master Settings................................................................... 105
Remote IP Slave Mappings.............................................................. 106
Custom App Settings........................................................................ 107
TruePort Settings.............................................................................. 108
Packet Forwarding................................................................................109
Configuring Modems............................................................................111
Configuring I/O .........................................................................112
Global Settings......................................................................................112
Temperature Settings....................................................................... 112
Failsafe Timer Settings..................................................................... 112
Modbus Settings............................................................................... 113
TruePort Settings.............................................................................. 113
UDP Settings.................................................................................... 113
Channels................................................................................................115
Digital Output.................................................................................... 115
Digital Input....................................................................................... 116
Relay ................................................................................................ 118
Analog .............................................................................................. 119
Basic Alarm Settings ........................................................................ 120
Advanced Alarm Settings................................................................. 121
Temperature..................................................................................... 122
Configuring Users ....................................................................122
Configuring Line Access......................................................................124
Configuring Sessions...........................................................................124
Configuring the Default User...............................................................125

11
Table of Contents
Configuring the Network......................................................... 125
Configuring Hosts................................................................................ 125
Configuring SNMP................................................................................ 126
Configuring TFTP................................................................................. 127
Configuring Gateways ......................................................................... 127
Configuring Syslog .............................................................................. 128
Configuring Administration Tasks......................................... 129
Configuring Bootup Files .................................................................... 129
Configuring the MOTD File.................................................................. 129
I/O Status/Control .................................................................... 130
Statistics................................................................................... 130
Tools ......................................................................................... 131
Saving a Configuration To File............................................................ 131
Getting a Configuration File................................................................ 131
Configuring Multiple Device Servers.................................................. 131
Downloading Device Server Firmware............................................... 132
Setting the Device Server’s Date and Time........................................ 133
Rebooting the Device Server............................................................... 133
Resetting the Device Server to Factory Defaults .............................. 133
Resetting a Line.................................................................................... 133
Custom Files......................................................................................... 134
Saving Crashes to a Dump File ....................................................... 134
Downloading Terminal Definitions.................................................... 134
Downloading a Language File.......................................................... 134
Downloading a Custom App File...................................................... 134
I/O Channels.......................................................................................... 134
Calibrating Analog Channels............................................................ 134
Resetting Calibration Data............................................................... 135
Setting DeviceManager Options ......................................................... 136

Table of Contents
12 IOLAN Device Server User’s Guide, Version 1.8
Chapter 6 Command Line Interface...............................137
Introduction...............................................................................137
CLI Conventions.......................................................................137
Command Syntax..................................................................................137
Command Shortcuts.............................................................................138
Command Options................................................................................138
Server Commands....................................................................139
Server Commands................................................................................139
Set Custom-App............................................................................... 139
Set Server......................................................................................... 139
Set Service....................................................................................... 141
Show Custom-App............................................................................ 141
Show Modbus................................................................................... 141
Show Server..................................................................................... 141
Hardware Commands...........................................................................142
Set Ethernet...................................................................................... 142
Show Hardware................................................................................ 142
Modbus Commands..............................................................................142
Set Modbus Gateway....................................................................... 142
Show Modbus................................................................................... 143
TruePort Baud Commands ..................................................................144
Set TruePort Remap-Baud............................................................... 144
Show TruePort.................................................................................. 144
User Commands.......................................................................144
Logged Into the Device Server Commands........................................144
Admin ............................................................................................... 144
Help.................................................................................................. 144
Kill Line............................................................................................. 144
Kill Session....................................................................................... 144
Logout............................................................................................... 145
Menu................................................................................................. 145
Ping .................................................................................................. 145
Resume............................................................................................ 145
Screen.............................................................................................. 145
Set Termtype.................................................................................... 146
Set User............................................................................................ 146
Set User Session.............................................................................. 147
Show Line Users .............................................................................. 147
Syslog Console................................................................................. 147
Show Sessions................................................................................. 147

13
Table of Contents
Show Termtype................................................................................ 147
Start.................................................................................................. 148
Telnet............................................................................................... 148
Version............................................................................................. 149
Configuring Users................................................................................ 149
Add User.......................................................................................... 149
Delete User...................................................................................... 149
Set Default User............................................................................... 150
Set User........................................................................................... 152
Set User Session ............................................................................. 154
Show Default User........................................................................... 154
Show User........................................................................................ 154
Line Commands....................................................................... 155
Line Commands.................................................................................... 155
Set Line............................................................................................ 155
Set Line Interface............................................................................. 158
Set Line Service............................................................................... 159
Set Modem....................................................................................... 161
Set Termtype.................................................................................... 161
Show Line ........................................................................................ 161
Line Service Commands...................................................................... 162
Set Custom-App............................................................................... 162
Set Telnet-Client .............................................................................. 162
Set UDP........................................................................................... 163
Set Vmodem .................................................................................... 163
Set Modbus-Slave Line.................................................................... 164
Set Modbus-Master Line.................................................................. 165
Show Custom-App........................................................................... 165
Show Interface................................................................................. 166
Show Modbus .................................................................................. 166
Show Telnet-Client........................................................................... 166
Show UDP........................................................................................ 166
Show Vmodem................................................................................. 166
Modem Commands .............................................................................. 166
Add Modem...................................................................................... 166
Delete Modem.................................................................................. 166
Show Modems ................................................................................. 166
Packet Forwarding Commands........................................................... 167
Set Packet-Forwarding Line............................................................. 167
Show Packet-Forwarding Line......................................................... 169

Table of Contents
14 IOLAN Device Server User’s Guide, Version 1.8
Network Commands.................................................................169
SNMP Commands.................................................................................169
Add Community................................................................................ 169
Add Trap........................................................................................... 169
Delete Community............................................................................ 170
Delete Trap....................................................................................... 170
Set SNMP......................................................................................... 170
Show SNMP..................................................................................... 170
TFTP Commands ..................................................................................171
Set Server TFTP............................................................................... 171
Hosts Commands .................................................................................171
Add Host........................................................................................... 171
Delete Host....................................................................................... 171
Set Host............................................................................................ 171
Show Hosts ...................................................................................... 171
Gateway Commands.............................................................................172
Add Gateway.................................................................................... 172
Delete Gateway................................................................................ 172
Set Gateway..................................................................................... 173
Show Gateways................................................................................ 173
Logging Commands.............................................................................174
Set Syslog ........................................................................................ 174
Show Syslog..................................................................................... 174
Time Commands.......................................................................174
Set Time........................................................................................... 174
Show Time........................................................................................ 174
Time/Date Setting Commands.............................................................175
Set Date............................................................................................ 175
Set Time........................................................................................... 175
Show Date........................................................................................ 175
Show Time........................................................................................ 175
Administration Commands......................................................175
Bootup Commands...............................................................................175
Reboot.............................................................................................. 175
Reset................................................................................................ 175
Reset Factory................................................................................... 175
Save ................................................................................................. 175
Set Bootup........................................................................................ 176
Show ARP........................................................................................ 176
Show Bootup.................................................................................... 176

15
Table of Contents
TFTP File Transfer Commands ........................................................... 176
Netload............................................................................................. 176
Netsave............................................................................................ 177
MOTD Commands ................................................................................ 177
Set MOTD........................................................................................ 177
Show MOTD..................................................................................... 178
Statistic Commands ................................................................ 178
Configuration Statistics....................................................................... 178
Show Netstat.................................................................................... 178
Show Modbus Statistics................................................................... 178
Show Netstat Statistics .................................................................... 178
Show Routes.................................................................................... 178
Run-Time Statistics.............................................................................. 179
Delete Arp........................................................................................ 179
Show Arp.......................................................................................... 179
Show Serial...................................................................................... 179
Uptime.............................................................................................. 179
I/O Commands.......................................................................... 179
Global I/O Commands.......................................................................... 179
Set IO UDP ...................................................................................... 179
Set IO Failsafe ................................................................................. 180
Set IO Modbus................................................................................. 180
Set IO Temperature-Scale............................................................... 180
Set Line.................................................................................................. 181
Set Line Service............................................................................... 181
Set IOChannel....................................................................................... 181
Set IOChannel Mode........................................................................ 181
Set IOChannel Digital I/O................................................................. 181
Set IOChannel Digital Input.............................................................. 182
Set IOChannel Digital Input (Serial Pins)......................................... 183
Set IOChannel Digital Output........................................................... 184
Set IOChannel Digital Output (Serial Pins)...................................... 185
Set IOChannel Relay ....................................................................... 186
Set IOChannel Analog (True Analog) .............................................. 187
Set IOChannel Analog (Temperature) ............................................. 189
Kill IOChannel.................................................................................. 191
Show IO ........................................................................................... 191
Show IOChannel.............................................................................. 191

Table of Contents
16 IOLAN Device Server User’s Guide, Version 1.8
I/O Channel Control Commands..........................................................192
Digital Output.................................................................................... 192
Digital Input....................................................................................... 192
Relay ................................................................................................ 192
Analog Input ..................................................................................... 192
Calibrating Analog Input (Analog/Temperature)................................193
Calibrate Analog............................................................................... 193
Reset Calibration.............................................................................. 193
Appendix A Troubleshooting.........................................195
Introduction...............................................................................195
Hardware Problems..................................................................195
Communication Issues ............................................................195
DeviceManager Problems........................................................196
Host Problems ..........................................................................196
Login Problems ........................................................................196
Problems with Terminals.........................................................197
Unknown IP Address................................................................197
DHCP/BOOTP Problems ..........................................................198
Language Problems .................................................................198
Long Reboot Cycle...................................................................198
I/O Digital or Relay....................................................................198

17
Table of Contents
Appendix B Utilities ........................................................199
Introduction.............................................................................. 199
TruePort.................................................................................... 199
API I/O Access Over TruePort ................................................ 200
API Request Format............................................................................. 200
API Response Format.......................................................................... 200
Error Codes...................................................................................... 201
Appendix C Accessories................................................203
Introduction.............................................................................. 203
Starter Kit (Adapters/Cable).................................................... 203
RJ45F to DB25M DTE Crossover Adapter.......................................... 204
RJ45F to DB25M DCE Modem Adapter .............................................. 205
RJ45F to DB25F DTE Crossover Adapter .......................................... 206
RJ45F to DB9M DTE Crossover Adapter............................................ 207
RJ45F to DB9F DTE Crossover Adapter ............................................ 208
Sun/Cisco RJ45M Connector Cable for Rack Mount Models........... 208
Glossary...........................................................................209
Index.................................................................................211

Table of Contents
18 IOLAN Device Server User’s Guide, Version 1.8

IOLAN Device Server User’s Guide, Version 1.3 19
Preface
About This Book
This guide provides the information you need to:
zconfigure the Device Server
zincorporate the Device Server into your production environment
Intended Audience
This guide is for administrators who will be configuring the Device Server.
Some prerequisite knowledge is needed to understand the concepts and examples in this guide:
zIf you are using an external authentication application(s), working knowledge of the
authentication application(s).
zKnowledge of TFTP, the transfer protocol the Device Server uses.
Documentation
The following documentation is included on the Device Server installation CD:
zIOLAN DS1/SDS1 Device Server Quick Start Guide
zIOLAN Device Server User’s Guide
zTruePort User Guide
zTruePort Installation and Configuration Guide for Windows NT
zOnline Help in the DeviceManager (automatically installed with the DeviceManager application)
zLink to knowledge base

Typeface Conventions
20 IOLAN Device Server User’s Guide, Version 1.3
Typeface Conventions
Most text is presented in the typeface used in this paragraph. Other typefaces are used to help you
identify certain types of information. The other typefaces are:
Online Help
Online help is provided in the DeviceManager. You can click on the What’s This button ( or )
and then click on a field to get field-level help. Or, you can press the F1 key to get window-level
help. You can also get the User’s Guide online by selecting Help, Help Topics.
Typeface Example Usage
At the C: prompt, type:
add host
This typeface is used for code examples and
system-generated output. It can represent a line you type
in, or a piece of your code, or an example of output.
Set the value to TRUE.The typeface used for TRUE is also used when referring to
an actual value or identifier that you should use or that is
used in a code example.
subscribe project subject
run yourcode.exec
The italicized portion of these examples shows the
typeface used for variables that are placeholders for
values you specify. This is found in regular text and in
code examples as shown. Instead of entering project,
you enter your own value, such as stock_trader, and
for yourcode, enter the name of your program.
File, Save This typeface and comma indicates a path you should
follow through the menus. In this example, you select
Save from the File menu.
IOLAN DS Family User’s Guide This typeface indicates a book or document title.
See Chapter 1, Introduction on page 23
for more information. This indicates a cross-reference to another chapter or
section that you can click on to jump to that section.