Lantronix Device Server UDS 10 User Manual

UDS-10
User Guide
Revision D 07/15/02
Part Number 900-207
Copyright and Trademark
© 2000, Lantronix. All rights reserved. No part of the contents of this book may be transmitted or reproduced in any form or by any means without the written permission of Lantronix. Printed in the United States of America.
Ethernet is a trademark of XEROX Corporation. UNIX is a registered trademark of The Open Group. Windows 95, Windows 98, Windows 2000, and Windows NT are trademarks of Microsoft Corp. Netscape is a trademark of Netscape Communications Corporation.
Lantronix
15353 Barranca Parkway Irvine, CA 92618, USA Phone: 949-453-3990
Technical Support
Phone: 800-422-7044 or 9949-453-7198 Fax: 949-450-7226 On-line: www.lantronix.com/support
Disclaimer and Revisions
Operation of this equipment in a residential area is likely to cause interference in which case the user, at his or her own expense, will be required to take whatever measures may be required to correct the interference.
Attention: This product has been designed to comply with the limits for a Class A digital device pursuant to Part 15 of FCC Rules. These limits are designed to provide reasonable protection against such interference when operating in a commercial environment. This equipment generates, uses, and can radiate radio frequency energy, and if not installed and used in accordance with this guide, may cause harmful interference to radio communications.
Changes or modifications to this device not explicitly approved by Lantronix will void the user's authority to operate this device.
The information in this guide may change without notice. The manufacturer assumes no responsibility for any errors which may appear in this guide.
Date Rev. Author Comments
05/11/00 B 06/01/01 C DS Current release. 07/15/02 D GR Revised for Device Installer, new format. Includes all
UDS-10 devices.
Declaration of Conformity
(according to ISO/IEC Guide 22 and BS 7514)
Manufacturer’s Name & Address:
Lantronix, 15353 Barranca Parkway, Irvine, CA 92618 USA
Declares that the following product:
Product Name Model: UDS-10 Universal Device Server
Conforms to the following standards or other normative documents:
Safety: EN60950:1992+A1, A2, A3, A4,A11 Electromagnetic Emissions:
FCC Part 15, Subpart B, Class A EN55022: 1998 (CISPR 22, Class A: 1993, A1: 1995, A2: 1996) IEC 1000-3-2/A14: 2000 IEC 1000-3-3: 1994
Electromagnetic Immunity:
EN55024: 1998 Information Technology Equipment-Immunity Characteristics IEC61000-4-2: 1995 Electro-Static Discharge Test IEC61000-4-3: 1996 Radiated Immunity Field Test IEC61000-4-4: 1995 Electrical Fast Transient Test IEC61000-4-5: 1995 Power Supply Surge Test IEC61000-4-6: 1996 Conducted Immunity Test IEC61000-4-8: 1993 Magnetic Field Test IEC61000-4-11: 1994 Voltage Dips & Interrupts Test (L.V.D. Directive 73/23/EEC)
Supplementary Information:
This Class A digital apparatus has been verified as being compliant within the Class A limits of the FCC Radio Frequency Device Rules (FCC Title 47, Part 15, Subpart B CLASS A), measured to CISPR 22: 1993 limits and methods of measurement of Radio Disturbance Characteristics of Information Technology Equipment. The product complies with the requirements of the Low Voltage Directive 72/23/EEC and the EMC Directive 89/336/EEC.
Manufacturer’s Contact:
Director of Quality Assurance, Lantronix 15353 Barranca Parkway, Irvine, CA 92618 USA Tel: 949-453-3990 Fax: 949-453-3995
Warranty
Lantronix warrants each Lantronix product to be free from defects in material and workmanship for a period of FIVE YEARS (or for the period specified on the product warranty registration card) after the date of shipment. During this period, if a customer is unable to resolve a product problem with Lantronix Technical Support, a Return Material Authorization (RMA) will be issued. Following receipt of a RMA number, the customer shall return the product to Lantronix, freight prepaid. Upon verification of warranty, Lantronix will
-- at its option -- repair or replace the product and return it to the customer freight prepaid. No services are handled at the customer's site under this warranty. This warranty is voided if the customer uses the product in an unauthorized or improper way, or in an environment for which it was not designed.
Lantronix warrants the media containing its software product to be free from defects and warrants that the software will operate substantially according to Lantronix specifications for a period of 60 DAYS after the date of shipment. The customer will ship defective media to Lantronix. Lantronix will ship the replacement media to the customer.
In no event will Lantronix be responsible to the user in contract, in tort (including negligence), strict liability or otherwise for any special, indirect, incidental or consequential damage or loss of equipment, plant or power system, cost of capital, loss of profits or revenues, cost of replacement power, additional expenses in the use of existing software, hardware, equipment or facilities, or claims against the user by its employees or customers resulting from the use of the information, recommendations, descriptions and safety notations supplied by Lantronix. Lantronix liability is limited (at its election) to:
1) refund of buyer's purchase price for such affected products (without interest)
2) repair or replacement of such products, provided that the buyer follows the above procedures.
There are no understandings, agreements, representations or warranties, expressed or implied, including warranties of merchantability or fitness for a particular purpose, other than those specifically set out above or by any existing contract between the parties. Any such contract states the entire obligation of Lantronix. The contents of this document shall not become part of or modify any prior or existing agreement, commitment or relationship.
Sales Offices
The Americas 15353 Barranca Parkway Irvine, CA 92618, USA Phone: (949) 450-7227 Fax: (949) 450-7231
sales@lantronix.com
France 2 Rue Hélène Boucher 78280 Guyancourt France Tel: +33 1 39 30 41 74 Fax: +33 1 39 30 41 73 europesud@lantronix.com
Germany Karlstrasse 49 78054 VS-Schwenningen Germany Tel: +49 (0)77 20 30 1620 Fax: +49 (0)77 20 30 1688
ursula.koch@lantronix.com
Asia Pacific 16th Floor Cheung Kong Center 2 Queen's Road Central Hong Kong Tel: +852 2297 2287 Fax: +852 2297 2357
asiapacsales@lantronix.com
EMEA Sales (Europe, Mid East, Africa)
eu_sales@lantronix.com eu_order@lantronix.com
EMEA Technical Support +49 (0) 7720 3016 20/57
eu_techsupp@lantronix.com
Contents
Table of Contents
1. Introduction ......................................................................................................................1-1
1.1 UDS-10 ...............................................................................................................1-2
1.2 UDS-10B.............................................................................................................1-3
1.3 UDS-10-IAP Device Server ................................................................................1-4
1.3.1 Industrial Automation Protocols .........................................................1-5
1.4 Network Protocols............................................................................................... 1-6
1.4.1 Packing Algorithm .............................................................................. 1-6
1.4.2 IP Address ........................................................................................... 1-6
1.4.3 Port Number ........................................................................................ 1-6
1.5 Serial Interface .................................................................................................... 1-7
1.6 RJ-45 Ethernet Interface...................................................................................... 1-7
1.7 Ethernet Cable..................................................................................................... 1-8
1.8 Serial Interface Connection................................................................................. 1-9
1.9 LEDs .................................................................................................................1-10
1.10 Dimensions...................................................................................................... 1-11
1.11 Product Information Label .............................................................................. 1-11
1.12 Software Support............................................................................................. 1-11
1.13 Power Requirements .......................................................................................1-12
1.14 Reset Switch.................................................................................................... 1-12
1.15 Technical Specifications .................................................................................1-13
2. Getting Started .................................................................................................................2-1
2.1 Addresses and Port Number................................................................................ 2-1
2.1.1 Ethernet (MAC) Address ....................................................................2-1
2.1.2 Internet Protocol (IP) Address.............................................................2-1
2.1.3 Port Number ........................................................................................ 2-2
2.2 Physically Connecting the Unit........................................................................... 2-2
2.3 Methods of Assigning the IP Address................................................................. 2-3
2.3.1 DHCP .................................................................................................. 2-4
2.3.2 AutoIP ................................................................................................. 2-4
2.4 DeviceInstaller ....................................................................................................2-5
2.4.1 Install DeviceInstaller Software ..........................................................2-5
2.4.2 Assign IP Address and Network Class................................................ 2-6
2.4.3 Test the IP Address .............................................................................2-7
UDS-10 User Guide i
Contents
2.4.4 Add the Unit to the Manage List ........................................................ 2-8
2.4.5 Opening a Configuration Window.................................................... 2-10
2.5 ARP and Telnet................................................................................................. 2-11
2.6 Serial Port Login............................................................................................... 2-12
3. Configuring the Unit........................................................................................................ 3-1
3.1 Configuring via Web Browser............................................................................ 3-1
3.2 Using DeviceInstaller ......................................................................................... 3-2
3.3 Web Manager Page............................................................................................. 3-4
3.3.1 Unit Configuration.............................................................................. 3-5
3.3.2 Server Properties................................................................................. 3-6
3.3.3 Port Properties .................................................................................... 3-7
3.3.4 Technical Support............................................................................... 3-9
3.3.5 Update Settings................................................................................... 3-9
3.4 Configuring via the Setup Mode Window........................................................ 3-10
3.4.1 Using a Telnet Connection ............................................................... 3-10
3.4.2 Using the Serial Port......................................................................... 3-12
3.5 Server Configuration (Network Configuration)................................................ 3-12
3.5.1 IP Address......................................................................................... 3-12
3.5.2 Set Gateway IP Address ................................................................... 3-12
3.5.3 Netmask: Number of Bits for Host Part............................................ 3-13
3.5.4 Change Telnet configuration password ............................................ 3-14
3.5.5 DHCP Naming.................................................................................. 3-14
3.6 Channel 1 Configuration (Serial Port Parameters) ........................................... 3-15
3.6.1 Baudrate............................................................................................ 3-15
3.6.2 I/F (Interface) Mode ......................................................................... 3-15
3.6.3 Flow .................................................................................................. 3-17
3.6.4 Port Number...................................................................................... 3-17
3.6.5 Connect Mode................................................................................... 3-18
3.6.6 Remote IP Address ........................................................................... 3-21
3.6.7 Remote Port ...................................................................................... 3-21
3.6.8 DisConnMode................................................................................... 3-21
3.6.9 Flush Mode (Buffer Flushing) .......................................................... 3-22
3.6.10 Pack Control ................................................................................... 3-23
3.6.11 DisConnTime (Inactivity Timeout) ................................................ 3-24
3.6.12 Send Characters .............................................................................. 3-24
3.6.13 Telnet Terminal Type ..................................................................... 3-24
3.6.14 Channel (Port) Password ................................................................ 3-24
3.7 Expert Settings.................................................................................................. 3-25
3.7.1 TCP Keepalive time in s ................................................................... 3-25
3.8 Security Settings ............................................................................................... 3-25
3.8.1 Disable SNMP .................................................................................. 3-25
ii
UDS-10 User Guide
Contents
3.8.2 SNMP Community Name .................................................................3-25
3.8.3 Disable Telnet Setup .........................................................................3-26
3.8.4 Disable TFTP Firmware Upgrade .....................................................3-26
3.8.5 Disable Port 77FE (Hex)................................................................... 3-26
3.8.6 Disable Web Server........................................................................... 3-26
3.8.7 Enable Enhanced Password............................................................... 3-26
3.9 Factory Defaults ................................................................................................3-26
3.10 Exit Configuration Mode ................................................................................3-27
3.11 Get Configuration............................................................................................ 3-27
3.12 Set Configuration ............................................................................................ 3-28
4. Updating Protocol (Firmware)........................................................................................ 4-1
4.1 Protocol Firmware............................................................................................... 4-1
4.2 Reloading Protocol Firmware .............................................................................4-1
4.2.1 Via DeviceInstaller.............................................................................. 4-2
4.2.2 Via TFTP............................................................................................. 4-4
4.2.3 Via Another Unit................................................................................. 4-5
4.2.4 Via the Serial Port ............................................................................... 4-6
5. DeviceComm Manager ....................................................................................................5-1
5.1 Installing DeviceComm Manager .......................................................................5-2
5.1.1 Install DeviceComm Manager ............................................................5-2
5.1.2 Setup.................................................................................................... 5-3
6. Troubleshooting................................................................................................................6-1
6.1 Technical Support ...............................................................................................6-1
6.1.1 Technical Support ...............................................................................6-1
7. Monitor Mode...................................................................................................................7-1
7.1 Monitor Mode .....................................................................................................7-1
7.1.1 Entering Monitor Mode Via the Serial Port ........................................7-1
7.1.2 Entering Monitor Mode Via the Network Port ...................................7-1
7.1.3 Monitor Mode Commands .................................................................. 7-1
8. Network Configuration using UDP.................................................................................8-1
8.1 UDP Datagrams...................................................................................................8-1
8.2 Configuring Multiple Devices............................................................................. 8-3
8.2.1 Acquiring a Valid Setup Record .........................................................8-3
8.2.2 Sending a Setup Record ......................................................................8-4
8.2.3 The Intel Hex Format .......................................................................... 8-5
8.2.4 Calculating the Checksum................................................................... 8-6
8.2.5 Calculating the Two’s Complement.................................................... 8-6
8.3 Setup Records...................................................................................................... 8-7
8.3.1 Channel Parameters............................................................................. 8-8
UDS-10 User Guide iii
Contents
8.3.2 Interface Mode.................................................................................... 8-9
8.3.3 Baud Rate ......................................................................................... 8-10
8.3.4 Flow Control..................................................................................... 8-10
8.3.5 Connect Mode................................................................................... 8-11
8.3.6 Disconnect Mode .............................................................................. 8-12
8.3.7 Flush Mode (Buffer Flushing) JKE Check the modifications to 3.6.98-13
8.3.8 Pack Control ..................................................................................... 8-13
8.4 IP Addresses ..................................................................................................... 8-14
8.4.1 Network Portion................................................................................ 8-14
8.4.2 Subnet Portion .................................................................................. 8-14
8.4.3 Host Portion...................................................................................... 8-15
8.4.4 Network Address .............................................................................. 8-15
8.4.5 Broadcast Address ............................................................................ 8-15
8.4.6 Private IP Networks and the Internet................................................ 8-16
8.4.7 Network RFCs .................................................................................. 8-16
9. Binary to Hex Conversion............................................................................................... 9-1
9.1 Connect Mode Options ....................................................................................... 9-2
9.2 Disconnect Mode Options .................................................................................. 9-5
9.3 Flush Mode (Buffer Flushing) Options .............................................................. 9-7
9.4 Interface Mode Options .................................................................................... 9-13
9.5 Pack Control Options........................................................................................ 9-14
10. IP Addresses ................................................................................................................. 10-1
10.1 Class A Network............................................................................................. 10-1
10.2 Class B Network ............................................................................................. 10-1
10.3 Class C Network ............................................................................................. 10-1
10.4 Network Address ............................................................................................ 10-2
10.5 Broadcast Address .......................................................................................... 10-2
10.6 IP Netmask...................................................................................................... 10-2
10.7 Private IP Networks and the Internet.............................................................. 10-3
10.8 Network RFCs ................................................................................................ 10-3
11. Glossary of Terms........................................................................................................ 11-1
iv
UDS-10 User Guide
Contents
List of Figures
Figure 1 – UDS-10-IAP .........................................................................................................1-4
Figure 2 - RJ-45 Connector.................................................................................................... 1-8
Figure 3 – UDS-10 Connected to Serial Device and Network............................................... 2-2
Figure 4 – CD Main Window................................................................................................. 2-5
Figure 5 - DeviceInstaller Window........................................................................................ 2-6
Figure 6 - Assign IP Address Window................................................................................... 2-6
Figure 7 - Ping Device Window............................................................................................. 2-7
Figure 8 - Search Network Window.......................................................................................2-8
Figure 9 - Devices in a Group ................................................................................................ 2-9
Figure 10 - Device Management Window ........................................................................... 2-10
Figure 11 - Lantronix Web-Manager .....................................................................................3-4
Figure 12 - Server Properties Configuration on the Web Browser ........................................ 3-6
Figure 13 - Setup Mode Window......................................................................................... 3-11
Figure 14 - Device Installer....................................................................................................4-2
Figure 15 - Search Network Window.....................................................................................4-3
Figure 16 - Devices in a Group .............................................................................................. 4-3
Figure 17 - Upgrade Firmware............................................................................................... 4-4
Figure 18 - TFTP Dialog Box ................................................................................................ 4-4
Figure 19 – UDS/CoBox Main Window................................................................................ 5-2
Figure 20 - Sample Setup Record in Intel Hex Format.......................................................... 8-3
UDS-10 User Guide v
Contents
List of Tables
Table 1 - Ethernet Interface Signals....................................................................................... 1-8
Table 2 - UDS-10 LED Functions ...................................................................................... 1-10
Table 3 - Technical Specs.................................................................................................... 1-13
Table 4 - Standard IP Network Netmasks............................................................................ 3-13
Table 5 - Netmask Examples ............................................................................................... 3-13
Table 6 - Interface Mode Options........................................................................................ 3-15
Table 7 - Common Interface Mode Settings........................................................................ 3-16
Table 8 - Flow Control Options........................................................................................... 3-17
Table 9 - Connect Mode Options......................................................................................... 3-18
Table 10 - Manual Connection Address Example ............................................................... 3-19
Table 11 - Modem Mode Commands .................................................................................. 3-20
Table 12 - Disconnect Mode Options .................................................................................. 3-21
Table 13 - Flush Mode Options ........................................................................................... 3-22
Table 14 - Pack Control Options ......................................................................................... 3-23
Table 15 - Protocol Firmware................................................................................................ 4-1
Table 16 - Problems and Error Messages .............................................................................. 6-3
Table 17 - Monitor Mode Commands ................................................................................... 7-2
Table 18 -Command Response Codes ................................................................................... 7-2
Table 19 - UDP Configuration............................................................................................... 8-1
Table 20 - Block Types..........................................................................................................8-5
Table 21 - Setup Record Construction................................................................................... 8-7
Table 22 - Channel Parameters.............................................................................................. 8-8
Table 23 - Interface Mode Options........................................................................................ 8-9
Table 24 - Common Interface Mode Settings........................................................................ 8-9
Table 25 - Baud Rate Settings ............................................................................................. 8-10
Table 26 - Flow Control Options......................................................................................... 8-10
Table 27 - Connect Mode Options....................................................................................... 8-11
Table 28 - Disconnect Mode Options .................................................................................. 8-12
Table 29 - Flush Mode Options ........................................................................................... 8-13
Table 30 - Pack Control Options ......................................................................................... 8-13
Table 31 - Network Portion of IP Address .......................................................................... 8-14
Table 32 - Available IP Addresses....................................................................................... 8-14
Table 33 - Standard IP Network Netmasks.......................................................................... 8-15
Table 34 - Netmask Examples ............................................................................................. 8-16
Table 35 - Binary to Hexadecimal Conversion Table............................................................ 9-1
Table 36 - Connect Mode Options......................................................................................... 9-2
Table 37 - Connect Mode Options for Modem Emulation .................................................... 9-4
vi
UDS-10 User Guide
Contents
Table 38 - Disconnect Mode Options.....................................................................................9-5
Table 39 - Flush Mode Options.............................................................................................. 9-7
Table 40 - Interface Mode Options ...................................................................................... 9-13
Table 41 - Pack Control Options..........................................................................................9-14
UDS-10 User Guide vii
Introduction
1. Introduction
This manual describes the family of Universal Device Servers (UDS), including the UDS-10 Device Server and the UDS-10-IAP Device Server with Industrial Automation Protocols. The UDS-10B Embedded Device Server is shown here for reference only. It is part of the UDS-10 family but is described in the Embedded Integration Kit (EIK) User Manual. For all practical purposes, it is the same as the UDS-10 but has no external metal case.
Most of the material in this manual applies to all of the UDS-10 products. However, in some cases there will be some features that apply to only one product. In those cases, a note will explain the variation.
Note: In most cases UDS-10 refers to UDS-10, UDS-10-IAP and UDS-10B.
UDS-10 User Guide 1-1
Introduction
1.1 UDS-10
The UDS-10 Device Server connects serial devices to Ethernet networks using the IP protocol family (TCP for connection-oriented stream applications and UDP for datagram applications). A few of the different types of serial devices supported are listed below:
Time/Attendance Clocks and Terminals
ATM Machines
CNC Controllers
Data Collection Devices
Universal Power Supply (UPS) Management Units
Telecommunications Equipment
Data Display Devices
Security Alarms and Access Control Devices
Handheld Instruments
Modems
The UDS-10 connects these devices through a TCP data channel or through a Telnet connection to computers or another Device Server. Datagrams can be sent by UDP.
The UDS-10 supports RS-232, RS-422/485 via its DB-25F serial port. It supports 10Mb/s Ethernet through the RJ-45 connector. It can be configured via HTTP, SNMP, DHCP or Telnet. It contains a Flash ROM for easy software upgrades.
1-2
UDS-10 User Guide
Introduction
1.2 UDS-10B
Note: This section is for the UDS-10B only.
The UDS-10B is the embedded version of the UDS-10, and is designed to be easily and quickly integrated into products. The UDS-10B operates the same as the UDS-10, except the UDS-10B has no external metal case. Serial interface is accomplished via a female DB25 (DCE) connector which provides the necessary signals for both RS232 and RS422/RS485 interfaces.
In addition, an RJ45 (10BASE-T) connector is available for Ethernet access. It will support network speeds of 10Mbps.
The UDS-10B board comes with various power supply options:
a power jack for 9-30 VDC or 9-24 VAC with maximum 140mA.
power via the DB25 inputs at either the regulated +5 VDC with maximum 200mA or
the unregulated 9-30 VDC.
The UDS-10B’s well-developed IP firmware supports protocols such as ARP, UDP, TCP, Telnet, ICMP, SNMP, BOOTP,DHCP, TFTP, AutoIP, HTTP, and custom protocols.
Note: Please see the EIK, Embedded Integration Kit user manual, 900-226, for information on using the UDS-10B Embedded Device Server.
UDS-10 User Guide 1-3
Introduction
1.3 UDS-10-IAP Device Server
Note: This section is for the UDS-10-IAP only.
The Lantronix Industrial Automation Platform (IAP) family of Device Servers allows a single network and protocol to connect multiple serial devices from many vendors. IAP provides the automation industry with a network-enabling solution using TCP/IP and standard Ethernet networks that is vendor-independent.
By encapsulating serial data and transporting it over Ethernet, the Device Server allows virtual serial links to be established over Ethernet and IP (TCP/IP, UDP/IP) networks. As a result, limited distance, point-to-point, direct serial connections can be extended within the plant, throughout the facility, or across the global enterprise. The following picture is one of the Device Servers in the IAP family.
Figure 1 – UDS-10-IAP
Lantronix provides IAP Device Servers specifically designed for different industrial environments.
CoBox-DR1-IAP, with a DIN rail interface for harsh environments or alongside
controls instruments in electrical panels.
CoBox-FL-IAP, with fiber connectivity for long cable runs or electrically hazardous
environments.
UDS-10-IAP, a compact Device Server for use in less demanding environments.
1-4
UDS-10 User Guide
Introduction
A few examples of attached devices are:
PLCs
AC/DC drives
CNC systems
Operator panels and message displays
Process Controls
Instrumentation
Power monitoring equipment
Scales and weighing systems
Barcode scanners
Label printers
Most factory floor serial devices
1.3.1 Industrial Automation Protocols
IAP Device Servers, adapted to multiple factory environments, can unite any mixture of equipment from industrial automation vendors into a single reliable pipeline. This new and open infrastructure opens the way for data to flow in real time from all your plant devices up to your IT layer.
IAP Device Servers are delivered with IAP Standard Tunneling protocol and can be loaded with industrial communication protocols. The suite of protocols include DF1 (Rockwell Automation) and Modbus (Schneider Electric). Where the IAP Standard Tunneling protocol is limited to exclusive, standard ASCII device-to-device connections, the industrial protocols offer connections to other devices that require special formatting or features simultaneously.
For information about using any of the industrial communication protocols, see the user manuals on the software CD or our web site. Protocol firmware files are also contained on the CD and new versions are available from the Lantronix web site.
You can set up the unit using the serial port, or remotely over Ethernet using Telnet or a web browser. The CD that comes with your Device Server includes DeviceInstaller, a Windows based configuration software that simplifies the process of installing protocols and configuring them for use with attached devices. IAP Device Servers use Flash memory for maintenance-free, non-volatile storage which allows for fast system upgrades.
UDS-10 User Guide 1-5
Introduction
1.4 Network Protocols
Note: UDS-10 refers to UDS-10, UDS-10-IAP and UDS-10B except where noted.
The UDS-10 uses TCP/IP protocols for network communication. The supported standards are: ARP, UDP, TCP, ICMP, Telnet, TFTP, DHCP, AutoIP, and SNMP. For transparent connections, TCP/IP (binary stream) or Telnet protocols are used. Firmware upgrades can be made with the TFTP protocol.
The IP (Internet Protocol) protocol defines addressing, routing, and data-block handling over the network. The TCP (transmission control protocol) assures that no data is lost or duplicated, and that everything sent into the connection on one side arrives at the target exactly as it was sent.
For typical datagram applications where devices interact with others without maintaining a point-to-point connection, UDP datagram is used.
1.4.1 Packing Algorithm
The two available packet algorithms (which define how and when packets are sent to the network) are software selectable. The standard algorithm is optimized for applications where UDS-10 is used in a local environment, allowing for very small delays for single characters while trying to keep the packet count low. The alternate packing algorithm minimizes the packet count on the network and is especially useful for applications in routed Wide Area Networks. Various parameters can be set in this mode to economize the serial data stream.
1.4.2 IP Address
Every active device connected to the TCP/IP network must have a unique IP address. This IP address is used to reference a specific device, for example, to build a connection to UDS-10’s serial port. See IP Addresses on page 10-1 for a complete description of IP Addressing.
1.4.3 Port Number
A destination IP address and a port number define every TCP connection and every UDP datagram. A port number is necessary to address an application or a channel on a network host. The port number can be compared to an extension on a PBX system.
A Telnet application (login to a host with an ASCII terminal) is commonly assigned TCP port number 23. More than one Telnet connection can be established to one host using the Telnet port; however, the other peer IP address/port number combinations must be different.
In the UDS-10, a port number can be configured on the channel (port). The UDS-10 uses this port number for outgoing messages and incoming connections, or UDP datagrams, which are addressed to its port number. Port 9999 (decimal) is used for remote configuration.
1-6
UDS-10 User Guide
Introduction
1.5 Serial Interface
UDS-10 has a female DCE DB-25 serial port that supports RS232 and RS485/422 serial standards (firmware selectable) up to 115.2 Kbps.
LEDs
1
14
DB-25 Se rial Po rt
TX (input) RX (output) RTS (input)
CTS (output) DSR (output)
GND
DCD (output)
Reg. +5VDC
(Note 1)
Reg. +9-30VDC
(Note 1)
13
TX+ (out) TX- (out)
DTR (input) RX+ (in) RX- (in)
25
Note 1: The Device Server can alternately be powered up via the serial port using one of these pins.
Note 2: The minus sign (-) is sometimes shown as A (TXA), and the plus sign is sometimes shown as B (TXB)
(Note 2)
RS-232/485 DB-25F
(Note 2)
1.6 RJ-45 Ethernet Interface
The UDS-10’s back panel contains a 9-30VDC power plug, a reset switch, and an RJ-45 (10Base-T) Ethernet port that supports up to 10 Mbps.
LEDs
Reset Switch
RJ-45 Ethernet Port
UDS-10 User Guide 1-7
Power Socket
Introduction
1.7 Ethernet Cable
The next drawing shows a typical RJ-45 connector. The color is not standard but very typical of an Ethernet Patch cable. Pin 1 is located at the top of the connector (Orange + White). The view is from the end of the connector.
Orange + Whit e
Orange
Green + White
Blue
Blue + White
Green
Brown + White
Brown
View from Connector End
Ethernet
(RJ45)
Figure 2 - RJ-45 Connector
Table 1 - Ethernet Interface Signals
Signal Name DIR PIN Primary Function
TX+ Out 1 Transmit Data + TX- Out 2 Transmit Data ­RX+ In 3 Differential Ethernet Receive Data + RX- In 6 Differential Ethernet Receive Data -
1 8
1 - TX+ 2 - TX­3 - RX+ 6 - RX-
1-8
UDS-10 User Guide
Introduction
13
1.8 Serial Interface Connection
The UDS-10 can be connected to a serial or Ethernet device for setup and configuration. The serial device can be RS-232 or RS-485/422. The following diagram shows a typical interface cable for the RS-232 Serial interface. The UDS-M-SBC is an optional male DB-25 to RS-485 screw block connector.
25
GND
5
DTR
CTS
RTS
DSR
4
9
3
8
7 6
TXD
2
RXD
1
DTE, 9-Pin, FEMALE
RX(in)
TX(in)
5
4
3
2
DCE, 25-Pin, MALE
20
6
14
1
UDS-10 User Guide 1-9
Introduction
1.9 LEDs
The device contains the following LEDs:
link net Tx/Rx collision
diagnostic status
Table 2 - UDS-10 LED Functions
LED Meaning
L (Green) Lights solid green to indicate network port is
Net Tx/Rx (Yellow) Blinks yellow to indicate network packets are
Collision (Red) Lights solid red to indicate network collisions. Diagnostic (Red)
Status (Green)
connected to the network.
transmitting and receiving.
Blinks or glows red in combination with the green Status LED to indicate error detection. Red solid, green (Status LED) blinking: 1x: EPROM checksum error 2x: RAM error 3x: Token Ring error 4x: EEPROM checksum error 5x: Duplicated IP address on the network Red blinking, green (Status LED) blinking: 4x: Faulty network connection 5x: No DHCP response received
Lights solid green to indicate that the physical serial port does not have a connection to or from the network. Blinks green to indicate that the physical serial port does have a connection to or from the network.
1-10
UDS-10 User Guide
Introduction
1.10 Dimensions
The UDS-10 dimensions are shown in the following drawing.
Note: For UDS-10 and UDS-10-IAP.
6.4cm (2.5 in)
9 cm (3.5 in)
2.3 cm (0.9 in)
1.11 Product Information Label
The product information label contains important information about your specific unit.
UDS-10B 00-20-4A-24-BB-42 Rev. D12 Made in USA
S/N:2447938
Serial Number Part Number MAC ID Revision
1.12 Software Support
DeviceInstaller is a powerful software utility for configuring device servers from a network connection. For more information, see Using DeviceInstaller on page 3-2.
Lantronix DeviceComm Manager is a Windows based COM port redirector software utility. Its function is to redirect customer application data destined for a local serial (COM) port to the PC’s network port. Rather than going out the local port, the data is transmitted across the Ethernet network port using the TCP/IP protocol. For more information, see DeviceComm Manager on page 5-1.
UDS-10 User Guide 1-11
Introduction
1.13 Power Requirements
The UDS-10 is shipped with a 12VDC, 1A power supply, but any DC power supply between 9VDC and 30VDC can be used. You can order the UDS-10 with a 110VAC (UDS-10-01) or 230VAC (UDS-10-02) power supply.
Note: The input voltage for all UDS-10 products has been changed from 6-9VDC to 9­30VDC. The new power supply shipped with the product supplies voltage within the new 9­30VDC range. Please note that this new power supply should only be used with the 9-30VDC UDS-10 products. The correct input voltage is marked on a label above the power socket and on the back of the unit.
Power Socket
1.14 Reset Switch
The unit has a reset switch located next to the RJ-45 connector. This reset switch will reboot the UDS when pressed.
Reset Switch
1-12
UDS-10 User Guide
Introduction
1.15 Technical Specifications
Table 3 - Technical Specs
Category Description
CPU, Memory AMD 188ES CPU, 25MHz clock, 128kByte RAM
Flash, EPROM 512kByte Flash PROM Installable Serial Protocols
Serial Interface Female DB-25 connector (DCE pinout)
Reset Front panel recessed push button Power Supply External adapter for 9-30 VDC, 3 Watts Max Dimensions 2.3 cm (0.9 in) H, 6.4 cm (2.5 in) W, 9.0 cm (3.5 in) D Weight 204.12g (7.2oz) Temperature Operating range: 5° to +50° C (41to122° F)
Humidity 10% to 90% RH, non-condensing, 40% to 60% recommended Case Metal case with mounting flanges. (Not UDS-10B) Protocols Supported Auto IP, ARP, UDP/IP, TCP/IP, Telnet, ICMP, SNMP, DHCP,
Network Interface RJ-45 10Base-T Ethernet Data Rates 300 bps to 115,200 bps Serial Line Formats Characters: 7 or 8 data bits
Modem Control DTR, DCD, CTS, RTS, DSR Flow Control CTS/RTS (hardware)
Management Internal web server (Standard Tunneling only)
System Software Windows® 95/98/ME/NT/2000 based configuration software LEDs Link (green), Network transmit/receive (yellow), Collision (red),
Compatibility Ethernet: Version 2.0/IEEE 802.3 Isolation Ethernet: 1500 Vrms, Serial: 2000 Vrms Agency Approvals C/UL, TUV, FCC-B, CE
Standard Tunnel (UDS-10, and UDS-10-IAP), Modbus (UDS-10­IAP), DF1 (UDS-10-IAP)
Baud Rate selectable from 300 to 115kBaud Software selectable RS-232C or RS-422/485
Max temperature change per hour: 20° C (36° F) Storage range: -40° to +66° C (-40 to 151° F)
BOOTP, TFTP, and HTTP
Stop bits: 1,2 Parity: odd, even, none
XON/XOFF (software)
SNMP (read only) Serial login Telnet login
Diagnostic (red), Status (green)
UDS-10 User Guide 1-13
Getting Started
2. Getting Started
This section describes all the procedures for configuring your unit. For a short version, see the Quick Start Guide. Go to the Lantronix web site for the latest firmware and release notes.
UDS-10 comes with Standard Tunnel Protocol and the UDS-10-IAP comes with the IAP Standard Tunnel Protocol. Both versions are similar but cannot be interchanged. Standard Tunneling is a serial communications protocol used by most Lantronix Device Servers. It can be configured to Ethernet-enable most serial devices such as barcode scanners, weigh scales, operator panels, data access devices, alpha numeric displays, and thousands of intelligent serial devices. For UDS-10-IAP users, see Industrial Automation Protocols on page 1-5
Loading industrial protocols to a UDS-10-IAP, such as IAP Modbus Bridge, may remove the web pages and change the configure dialogs. See the user manuals on individual protocols for protocol specific settings and configuration dialogs. Protocol manuals are found on the software CD. This section describes the setup and configuration dialogs for the Standard Tunnel Protocol.
Note: The following information is based on the condition that a UDS-10 is loaded with Standard Tunnel Protocol. The UDS-10-IAP with IAP Standard Tunnel Protocol may have different options available.
2.1 Addresses and Port Number
2.1.1 Ethernet (MAC) Address
The Ethernet address is also referred to as the hardware address or the MAC address. The first three bytes of the Ethernet Address are fixed and read 00-20-4A, identifying the unit as a Lantronix product. The fourth, fifth, and sixth bytes are unique numbers assigned to each unit.
00-20-4A-21-18-17 or 00:20:4A:21:18:17
2.1.2 Internet Protocol (IP) Address
Every device connected to an IP network must have a unique IP address. This address is used to reference the specific unit.
UDS-10 User Guide 2-1
Getting Started
2.1.3 Port Number
Every TCP connection and every UDP datagram is defined by a destination IP address and a port number. For example, a Telnet application commonly uses port number 23. A port number is similar to an extension on a PBX system.
The unit 's serial channel (port) can be associated with a specific TCP/UDP port number. Port number 9999 is reserved for access to the unit's Setup (configuration) Mode window.
2.2 Physically Connecting the Unit
The following diagram shows a typical hardware configuration for the UDS-10. Use one of the cables described in Serial Interface Connection on page 1-9 to connect a PC COM port to the UDS-10.
Ethernet
RS-232
Ethernet
9-30VDC
Figure 3 – UDS-10 Connected to Serial Device and Network
1. Connect a serial device to your unit. See Serial Interface Connection on page 1-9 for more information about cable and connector specifications.
2. Connect an Ethernet cable to the Ethernet port.
3. Supply power to your unit using a 9-30VDC source.
Note: The required input voltage is 9-30VDC (3 W maximum).
4. Supply power to the serial device.
Note: Connecting a device to an active Ethernet network can disrupt communications on the network. Make sure the device is configured for your application before connecting to an active network.
2-2
UDS-10 User Guide
Getting Started
2.3 Methods of Assigning the IP Address
The unit's IP address must be configured before a network connection is available. You have the following options for assigning an IP to your unit:
Method Description
DHCP A DHCP server automatically assigns the IP address and network
settings. See DeviceInstaller (Recommended)
ARP and Telnet You manually assign the IP address and other network settings at a
AutoIP This automatic method is appropriate when you have a small group of
Serial Port Login You initially configure the unit through a serial connection. See Serial
You manually assign the IP address using a graphical user interface
(GUI) on a PC attached to a network. See DeviceInstaller on page 2-5.
command prompt using a UNIX or Windows-based system. Only one
person at a time can be logged into the configuration port (port 9999).
This eliminates the possibility of several people simultaneously
attempting to configure the unit. See
hosts rather than a large network. This method allows the hosts to
negotiate with each other and assign addresses, in effect creating a
small network. See
Port Login on page 2-12.
DHCP on page 2-4.
ARP and Telnet on page 2-11.
AutoIP on page 2-4.
These methods are described in the remaining sections of this chapter.
Note: In most installations, a fixed IP address is desirable. The systems administrator generally provides the IP address. Obtain the following information before starting to set up your unit: IP Address: ___ ___ ___ ___ Subnet Mask: ___ ___ ___ ___ Gateway: ___ ___ ___ ___
UDS-10 User Guide 2-3
Getting Started
2.3.1 DHCP
The unit ships with a default IP address of 0.0.0.0, which automatically enables DHCP.
Provided a DHCP server exists on the network, it will assign the unit an IP address, gateway address, and subnet mask when the unit boots up. The DR1 has acquired an IP address if the red LED stops flashing and the green Status LED is on continuously. (If no DHCP server exists, the unit responds with a diagnostic error: the red Diagnostic LED blinks continuously, and the green Status LED blinks five times. This blinking only continues for about 15 seconds.)
You can use the DeviceInstaller software to search the network for the IP your unit has been assigned by the DHCP server and add it to the managed list. See Add the Unit to the Manage
List later in this chapter.
Note: This DHCP address will not appear in the unit’s standard configuration screens. You can determine your unit’s DHCP-assigned IP address from the DHCP server, or in Monitor Mode. When you enter Monitor Mode from the serial port with network connection enabled and issue the NC (Network Communication) command, you will see the unit’s IP configuration.
2.3.2 AutoIP
The unit ships with a default IP address of 0.0.0.0, which automatically enables Auto IP within the unit. AutoIP is an alternative to DHCP that allows hosts to automatically obtain an IP address in smaller networks that may not have a DHCP server. A range of IP addresses (from 169.254.0.1 to 169.254.255.254) has been explicitly reserved for AutoIP-enabled devices. The range of Auto IP addresses is not to be used over the Internet.
If your unit cannot find a DHCP server, and you have not manually assigned an IP address to it, the unit automatically selects an address from the AutoIP reserved range. Then, your unit sends out a (ARP) request to other nodes on the same network to see whether the selected address is being used.
If the selected address is not in use, then the unit uses it for local subnet communication. 
If another device is using the selected IP address, the unit selects another address from the
AutoIP range and reboots itself. After reboot, the unit sends out another ARP request to see if the selected address is in use, and so on.
AutoIP is not intended to replace DHCP. The unit will continue to look for a DHCP server on the network. If a DHCP server is found, the unit will switch to the DHCP server-provided address and reboot.
Note: If a DHCP server is found, but it denies the request for an IP address, the unit does not attach to the network, but waits and retries.
2-4
UDS-10 User Guide
Getting Started
AutoIP can be disabled by setting the unit’s IP address to 0.0.1.0. This setting enables DHCP but disables AutoIP.
2.4 DeviceInstaller
You can manually assign the IP address using DeviceInstaller software, which is found on the product CD. If you want to use a serial connection instead of an Ethernet connection to configure the device, go to Serial Port Login on page 2-12.
2.4.1 Install DeviceInstaller Software
1. Insert the product CD into your CD-ROM drive. The CD will automatically start and display the main window.
If the CD does not launch automatically:
a) Click the Start button on the Task Bar and select Run.
b) Enter your CD drive letter, colon, backslash, deviceinstaller.exe (e.g., E:\deviceinstaller.exe).
Figure 4 – CD Main Window
2. Click the Device Installer button. The installation wizard window displays.
3. Respond to the installation wizard prompts. (When prompted to select an installation type, select Typical.)
UDS-10 User Guide 2-5
Getting Started
2.4.2 Assign IP Address and Network Class
Click the Start button on the Task Bar and select Programs \Device Installer \Device Installer. The Device Installer window displays.
Figure 5 - DeviceInstaller Window
1. Click the IP icon
. The Assign IP Address window displays.
Figure 6 - Assign IP Address Window
2. In the Enter the Hardware or Ethernet Address field, enter the Ethernet address (MAC address), which is listed on the label on the side of the unit.
2-6
UDS-10 User Guide
Getting Started
3. In the Enter IP Address to assign field, enter the unit’s IP address in
XXX.XXX.XXX.XXX format.
4. In the PC Network Class section, select the class (subnet mask). (Most users select Class
C).
5. Click the Set IP Address button. (IP is assigned, pinged, and tested)
6. Confirm that the “Assign IP successful” message displays and click OK.
7. Click the Back button to return to the DeviceInstaller window.
2.4.3 Test the IP Address
1. Click the Ping icon . The Ping Device window displays.
Figure 7 - Ping Device Window
2. Confirm that “Reply received” messages display in the window, indicating that the IP
address has been entered successfully.
Note: If you do not receive “Reply received” messages, make sure the unit is properly attached to the network and that the IP address assigned is valid for the particular network segment you are working with. If you are not sure, check with your systems administrator.
3. Click the Back button to return to the Device Installer window.
UDS-10 User Guide 2-7
Getting Started
2.4.4 Add the Unit to the Manage List
Now add the unit to the list of similar Lantronix devices on the network so that you can manage and configure it.
1. Click the Search the network for devices
icon. The Search Network window
displays.
Figure 8 - Search Network Window
2. Select the PC Network Class. Class C is the default.
3. Click the Start Search button. A list of all active units displays.
4. Click the Save button. A confirmation message displays.
5. Click OK.
2-8
UDS-10 User Guide
Getting Started
6. Click the Back button to return to the DeviceInstaller window. The DeviceInstaller
window now lists all of the devices in the group, including the unit you are setting up. The hardware address and firmware release number for the unit display.
Figure 9 - Devices in a Group
Now you can manage (configure) the unit so that it works with the serial device on the network.
UDS-10 User Guide 2-9
Getting Started
2.4.5 Opening a Configuration Window
1. Click the Manage icon . The Device Management window displays.
Figure 10 - Device Management Window
2. Do one of the following:
Note: To assign Expert settings and Security settings, you must use the Setup Mode window in a Telnet session.
To configure the unit via a Web browser, click the Web Configuration icon
The Lantronix Web-Manager window displays in your browser. For Web Configuration, see Web Manager Page on page 3-4.
To configure the unit via a Telnet session, click the Telnet to Device icon
. The Setup Mode window displays. For Telnet Configuration, see Using a Telnet Connection on page 3-10
3. Continue with the appropriate configuration procedure described in the next chapter.
Note: The Get Configuration icon on the Device Management window allows you to save a configuration locally on your computer as a file. The Set Configuration icon sends a saved file to the unit.
To Get Configuration information see Get Configuration on page 3-27. To Set Configuration of a specific device see Set Configuration on page 3-28.
2-10
UDS-10 User Guide
.
Getting Started
2.5 ARP and Telnet
The unit’s IP address must be configured before a network connection is available. You are able to ARP an address into a CoBox/UDS device even if there is already an address in the unit. If the unit has no IP address, you can use Address Resolution Protocol (ARP) method from UNIX and Windows-based systems to assign a temporary IP address. If you want to initially configure the unit through the network, follow these steps:
1. On a UNIX or Windows-based host, create an entry in the host's ARP table using the intended IP address and the hardware address of the unit, which is found on the product label on the bottom of the unit. Some UNIX hosts use colons “:” between hardware octets, and some use dashes “-“. All Windows hosts use dashes.
arp -s 191.12.3.77 00:20:4a:xx:xx:xx
Note: For the ARP command to work on Windows 95, the ARP table on the PC must have at least one IP address defined other than its own.
2. If you are using Windows 95, type ARP -A at the DOS command prompt to verify that there is at least one entry in the ARP table. If the local machine is the only entry, ping another IP address on your network to build a new entry in the ARP table; the IP address must be a host other than the machine on which you are working. Once there is at least one additional entry in the ARP table, use the following command to ARP an IP address to the unit:
arp -s 191.12.3.77 00-20-4a-xx-xx-xx
3. Open a Telnet connection to port 1. The connection will fail quickly, but the unit will temporarily change its IP address to the one designated in this step.
telnet 191.12.3.77 1
4. Finally, open a Telnet connection to port 9999, and press Enter within three seconds to go into Setup Mode. If you wait longer than three seconds, the unit will reboot and you will need to perform step 3 again.
telnet 191.12.3.77 9999
5. Set all required parameters
Note: The IP address you just set is temporary and will revert to the default value when the unit 's power is reset unless you log into the unit and store the changes permanently. Refer to the chapter on configuration for instructions on permanently configuring the IP address.
UDS-10 User Guide 2-11
Getting Started
2.6 Serial Port Login
If you want to initially configure the unit through a serial connection, follow these steps:
1. Connect a console terminal or PC running a terminal emulation program to your unit's serial port. The default serial port settings are 9600 baud, 8 bits, no parity, 1 stop bit, no flow control.
2. To enter Setup Mode, cycle the unit's power (power off and back on). After power-up, the self-test begins and the red Diagnostic LED starts blinking. You have one second to enter three lowercase x characters.
Note: The easiest way to enter Setup Mode is to hold down the x key at the terminal (or emulation) while powering up the unit.
3. At this point, the screen display is the same as when you use a Telnet connection. To continue with a serial port login, go to Using a Telnet Connection on page 3-10.
2-12
UDS-10 User Guide
Configure
3. Configuring the Unit
You must configure the unit so that it can communicate on a network with your serial device. For example, you must set the way the unit will respond to serial and network traffic, how it will handle serial packets, and when to start or close a connection. You can configure your unit locally or remotely using the following procedures:
Use a standard Web browser to access the unit’s internal Web pages and configure
the unit over the network. This is the easiest and preferred method.
Use a Telnet connection to configure the unit over the network.
Use a terminal or terminal emulation program to access the serial port locally.
The unit’s configuration is stored in nonvolatile memory (NVRam) and is retained without power. You can change the configuration at any time. The unit performs a reset after the configuration has been changed and stored.
Note: The configuration menus in this section show a typical device and all of the possible configuration options. Your device may have different configuration options.
3.1 Configuring via Web Browser
Open your JAVA enabled web browser and enter the IP address. The Lantronix Web Manager page will display. Go to Web Manager Page for a summary of the menu selections.
Note: The UDS-10-IAP may not have a web page or may use a different format web page.
UDS-10 User Guide 3-1
Configure
3.2 Using DeviceInstaller
DeviceInstaller is a powerful software utility for configuring device servers from a network connection. This section uses the utility to demonstrate the various methods of configuring a device. The Device Management window is a common page for gaining access to different menus.
1. Start DeviceInstaller. Click the Search for network for devices icon
. The Search
Network window displays.
2. Click the Start Search button. A list of all active units displays.
3. Click the Save button. Click OK for the confirmation message. Click the Back button.
4. Click the Manage device configuration icon
to open the Device Management
window.
5. For Web configuration, click the Web Configuration icon to start your browser. (A small Web Configuration window appears, showing the IP address.)
Go to Web Manager Page on page 3-4 for a summary of the menu selections.
Note: If your unit already has an IP address (see Methods of Assigning the IP Address), you can log into it using a standard Web browser that is Java enabled. Type the unit's IP address into the Web browser's URL (Address/Location) field.
3-2
UDS-10 User Guide
Configure
6. For Telnet configuration, click the Telnet to Device icon. A small Telnet to Device
window appears, showing the IP Address and the Port address. The main Lantronix Universal Device Server window opens.
Go to Using a Telnet Connection on page 3-10 for a summary of the menu selections.
7. To Get device configuration information see Get Configuration on page 3-27.
Configuration information can be read from a device and saved in a file.
8. To Set the configuration of a specific device see Set Configuration on page 3-28
A device can be configured by reading a configuration file and sending the information to the device.
UDS-10 User Guide 3-3
Configure
3.3 Web Manager Page
Note: The UDS-10-IAP may not have a web page or may use a different format web page.
You can start a web browser for configuration by opening your JAVA enabled web browser and entering the IP address or by clicking the Web Configuration button on the Device Management window. The Lantronix Web Manager page will display.
Figure 11 - Lantronix Web-Manager
Web Manager 3.0 has the following buttons:
Unit Configuration
Server Properties
Port Properties
Factory Settings1 (also Factory Settings2 for devices with two serial channels)
Update Settings
Channel 1 (also Channel 2 for devices with two serial channels)
Tech Support
FTP – Site
Back to Web-Manager
Contact Us
1. Use the menu (pushbuttons) to navigate to sub pages where you can configure server settings. See explanations of the configuration parameters later in this chapter.
2. When you are finished, click the Update Settings button to save your settings.
3-4
UDS-10 User Guide
Configure
3.3.1 Unit Configuration
Click the Unit Configuration button to display the following dialog box. This page contains the Server Configuration and the Port Configuration settings. These are static settings read from the device.
Note: The following screen shots represent the web page shown when the device is loaded with cbxw300.cob firmware.
UDS-10 User Guide 3-5
Configure
3.3.2 Server Properties
You can change the server properties by editing any of the fields. Lingering over one of the fields will display operator messages. Changing the IP address will require you to enter the new IP address in the browser to reload the page.
Figure 12 - Server Properties Configuration on the Web Browser
Telnet Password
In the Telnet Password field, enter a password to prevent unauthorized access to the Setup Mode via a Telnet connection to port 9999. The password is limited to 4 characters. (An enhanced password setting of 16 characters is available under Security Settings on the Telnet Setup Mode window.)
Note: No password is required to access the Setup Mode window via a serial connection.
3-6
UDS-10 User Guide
3.3.3 Port Properties
Serial Protocol: RS232, RS422/485 4-wire, RS485 2-wire Speed: 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200 Character Size: 8, 7 Parity: None, Even, Odd Stop Bit: 1,2 Flow Control: None, XON/XOFF, XON/XOFF Pass Characters to Host, CTS/RTS (Hardware)
Configure
UDP Datagram Mode: Enable, Disable UDP Datagram Type: (User selectable) Incoming Connection: Accept unconditional, Accept Incoming/DTR (Inactive), Never accept incoming Response: Nothing (quiet), Character response Startup: No active startup, with any character, with active DTR (Inactive), with CR (0x0D) only, Manual Connection, Autostart, Modem Mode
Remote IP Address: (user selectable) Remote Port: (user selectable) Local Port: 10001 (default 10001, user selectable)
UDS-10 User Guide 3-7
Configure
On Active Connection: Enable, Disable On Passive Connection: Enable, Disable At Time of Disconnect: Enable, Disable
Packing Algorithm: Enable, Disable Idle Time: Force transmit 12 ms, Force transmit 52 ms, Force Transmit 250 ms, Force Transmit 5000 ms Trailing Characters: None, One, Two Send Immediate After Sendchars: Enable, Disable Send Define2-Byte Sequence: Enable, Disable Send Character 01: (User Selectable) Send Character 02: (User Selectable)
3-8
UDS-10 User Guide
Configure
Disconnect Mode: with DTR Drop, Ignore DTR Check for CTRL-D to Disconnect: Enable, Disable Port Password: Enable, Disable Telnet Mode: Enable, Disable Inactivity Timeout: Enable, Disable Inactivity Timer: (User Selectable) Port Password: (User Selectable. Port Password must be enabled)
3.3.4 Technical Support
Several buttons provide direct links to Technical Support functions. You can use the Tech Support button to link directly to the Lantronix Tech Support web page, the FTP-Site button
will link you to the web page for downloading new firmware, manuals, and other files. The Contact Us button will link you to the Contact Information page.
3.3.5 Update Settings
Click the Update Settings button to send all changed settings to the device.
UDS-10 User Guide 3-9
Configure
3.4 Configuring via the Setup Mode Window
3.4.1 Using a Telnet Connection
To configure the unit over the network, establish a Telnet connection to port 9999.
Note: If you use the Telnet to Device icon on the Device Installer Device Management window OR a serial port login to establish the connection, skip steps 1and 2.
1. From the Windows Start menu, click Run and type the following command, where x.x.x.x is the IP address and 9999 is the unit’s fixed network configuration port number.
telnet x.x.x.x 9999
Note: Be sure to include a space between the IP address and 9999.
2. Click OK.
3. The Lantronix Universal Device Server window displays.
*** Lantronix Universal Device Server *** Serial Number 7218033 MAC address 00:20:4A:72:46:71 Software version 04.5 (011025)
Press Enter to go into Setup Mode
4. To enter the Setup Mode, you must press Enter within 5 seconds. The configuration settings will appear. See Figure 13 - Setup Mode Window.
Note: The following line appears only with IAP Standard Tunnel Protocol Firmware.
Model: Device Server Plus+! (Firmware Code: AQ)
5. Select an option on the menu by entering the number of the option in the Your choice ? field and pressing Enter.
6. To enter a value for a parameter, type the value and press Enter, or to confirm a current value, just press Enter.
7. When you are finished, save the new configurations (option 9). The unit will reboot.
3-10
UDS-10 User Guide
*** basic parameters Hardware: Ethernet Autodetect IP addr – 0.0.0.0/DHCP/BOOTP/AutoIP, no gateway set DHCP device name : not set
***************** Security ***************** SNMP is enabled (not IAP firmware) SNMP Community Name: (not IAP firmware) Telnet Setup is enabled TFPT Download is enabled Port 77Feh is enabled Web Server is enabled Enhanced password is disabled
***************** Channel 1 ***************** Baudrate 9600, I/F Mode 4C, Flow 00 Port 10001 Remote IP Adr: --- none ---, Port 00000 Connect Mode : C0 Disconn Mode: 00 Flush Mode : 00
****************** Expert ******************* TCP Keepalive : 0s (not IAP firmware)
Change Setup :0 Server configuration
1 Channel 1 configuration 5 Expert settings (not IAP firmware) 6 Security 7 Factory defaults 8 Exit without save 9 Save and exit Your choice ?
Configure
Figure 13 - Setup Mode Window
UDS-10 User Guide 3-11
Configure
3.4.2 Using the Serial Port
If you want to initially configure the unit through a serial connection, follow these steps:
8. Connect a console terminal or PC running a terminal emulation program to your unit's serial port. The default serial port settings are 9600 baud, 8 bits, no parity, 1 stop bit, no flow control.
9. To enter Setup Mode, cycle the unit's power (power off and back on). After power-up, the self-test begins and the red Diagnostic LED starts blinking. You have one second to enter three lowercase x characters (xxx).
Note: The easiest way to enter Setup Mode is to hold down the x key at the terminal (or emulation) while powering up the unit.
10. At this point, the screen display is the same as when you use a Telnet connection. To continue with a serial port login, go to Using a Telnet Connection on page 3-10.
3.5 Server Configuration (Network Configuration)
These are the unit’s basic network parameters. The following parameters are displayed when you select Server configuration.
IP Address : (000) .(000) .(000) .(000) Set Gateway IP Address (N) Netmask: Number of Bits for Host Part (0=default) (00) Change telnet config password (N)
3.5.1 IP Address
The IP address must be set to a unique value in your network. See Methods of Assigning the IP Address on page 2-3 for more information about IP addressing.
3.5.2 Set Gateway IP Address
The gateway address, or router, allows communication to other LAN segments. The gateway address should be the IP address of the router connected to the same LAN segment as the unit. The gateway address must be within the local network.
3-12
UDS-10 User Guide
Configure
3.5.3 Netmask: Number of Bits for Host Part
A netmask defines the number of bits taken from the IP address that are assigned for the host section.
Note: Class A: 24 bits; Class B: 16 bits; Class C: 8 bits.
The unit prompts for the number of host bits to be entered, then calculates the netmask, which is displayed in standard decimal-dot notation when the saved parameters are displayed (for example, 255.255.255.0).
Table 4 - Standard IP Network Netmasks
Network Class Host Bits Netmask
A 24 255.0.0.0
B 16 255.255.0.0
C 8 255.255.255.0
Table 5 - Netmask Examples
Netmask Host Bits
255.255.255.252 2
255.255.255.248 3
255.255.255.240 4
255.255.255.224 5
255.255.255.192 6
255.255.255.128 7
255.255.255.0 8
255.255.254.0 9
255.255.252.0 10
255.255.248.0 11
... ...
255.128.0.0 23
255.0.0.0 24
UDS-10 User Guide 3-13
Configure
3.5.4 Change Telnet configuration password
Setting the Telnet configuration password prevents unauthorized access of the setup menu via a Telnet connection to port 9999 or via Web pages. The password is limited to 4 characters. An enhanced password setting of 16 characters is available under Security Settings for Telnet access only.
Note: No password is required to access the Setup Mode window via a serial connection.
3.5.5 DHCP Naming
There are 3 methods for assigning DHCP names to these products.
1) Default DHCP name. If you do not change the DHCP name, and you are using an IP of
0.0.0.0, then the DHCP name will default to CXXXXXX (XXXXXX is the last 6 digits of the
MAC address shown on the label on the bottom/side of the unit). For example, if the MAC address is 00-20-4A-12-34-56, then the default DHCP name is C123456.
2) Custom DHCP name. You can create your own DHCP name on these products. If you are
using an IP address of 0.0.0.0, then the last option in "Server configuration" will be "Change DHCP device name". The "Change DHCP device name" option will allow you to change the DHCP name to an alpha numeric name.
Change DHCP device name (not set) ? (N) Y Enter new DHCP device name : LTX
3) Numeric DHCP name. You are able to change the DHCP name by specifying the last
octet of the IP address. When you use this method, the DHCP name will be LTXYY where YY is what you chose for the last octet of the IP address. If the IP address you specify is
0.0.0.12, then the DHCP name will be LTX12. This method will only work with 2 digit
numbers (0-99).
3-14
UDS-10 User Guide
Configure
3.6 Channel 1 Configuration (Serial Port Parameters)
Using this option, define how the serial port will respond to network and serial communications.
Baudrate (9600) I/F Mode (4C) Flow (00) Port No (10001) ConnectMode (C0) Remote IP Address : (000).(000).(000).(000) Remote Port (00000) DisConnMode (00) FlushMode (00) DisConnTime (00:00) : SendChar 1 (00) SendChar 2 (00)
3.6.1 Baudrate
The unit and attached serial device, such as a modem, must agree on a speed or baud rate to use for the serial connection. Valid baud rates are 300, 600, 1200, 2400, 4800, 9600 (default), 19200, 38400, 57600, and 115200 bits per second.
3.6.2 I/F (Interface) Mode
The Interface (I/F) Mode is a bit-coded byte that you enter in hexadecimal notation.
Note: See Table 35 - Binary to Hexadecimal Conversion Table.
Table 6 - Interface Mode Options
I/F Mode Option 7 6 5 4 3 2 1 0
RS-232C RS-422/485 RS-485 2-wire 7 Bit 1 0 8 Bit 1 1 No Parity 0 0 Even Parity 1 1 Odd Parity 0 1 1 Stop bit 0 1 2 Stop bit 1 1
(1) The UDS-10 requires you to choose the correct setting in the IF mode.
UDS-10 User Guide 3-15
(1)
0 0
(1)
0 1
(1)
1 1
Configure
The following table demonstrates how to build some common Interface Mode settings:
Table 7 - Common Interface Mode Settings
Common I/F Mode Setting Binary Hex
RS-232C, 8-bit, No Parity, 1 stop bit RS-232C, 7-bit, Even Parity, 1 stop bit RS-485 2-Wire, 8-bit, No Parity, 1 stop bit RS-422, 8-bit, Odd Parity, 1 stop bit
(1)
0100 1100 4C
(1)
0111 1000 78
(1)
(1)
0100 1111 4F
0101 1101 5D
(1) The UDS-10 requires you to choose the correct setting in the IF mode.
3-16
UDS-10 User Guide
Configure
3.6.3 Flow
Flow control sets the local handshake method for stopping serial input/output.
Table 8 - Flow Control Options
Flow Control Option Hex
No flow control 00 XON/XOFF flow control 01 Hardware handshake with RTS/CTS lines 02 XON/XOFF pass characters to host 05
3.6.4 Port Number
The setting represents the source port number in TCP connections, and is the number used to identify the channel for remote initiating connections. Default setting for Port 1 is 10001. Range: 0-65535 except for the following reserved port numbers:
Port Numbers Reserved for
1 – 1024 Reserved (well known ports) 9999 Telnet setup 14000-14009 Reserved 30718 Reserved (77FEh)
10000-10999
Recommended ports, should be used for DeviceComm Manager (COM1-COM256) or direct socket connections
The port number functions as the TCP/UDP source port number for outgoing packets. Packets sent to the unit with this port number are received to this channel. The port number selected is the Incoming TCP/UDP port and Outgoing TCP/UDP source port. Port 0 is used when you want the outgoing source port to change with each connection.
UDS-10 User Guide 3-17
Configure
3.6.5 Connect Mode
Connect Mode defines how the unit makes a connection, and how it reacts to incoming connections over the network. Enter Connect Mode options in hexadecimal notation.
Note: See Table 35 - Binary to Hexadecimal Conversion Table.
Table 9 - Connect Mode Options
Connect Mode Option 7 6 5 4 3 2 1 0
Incoming Connection
Never accept incoming 0 0 0 Accept incoming with DTR 0 1 0 Accept unconditional 1 1 0
Response Nothing (quiet) 0
Character response (C=connect, D=disconnect, N=unreachable)
Startup No active startup 0 0 0 0 With any character 0 0 0 1 With active DTR With CR (0x0D) only 0 0 1 1 Manual connection 0 1 0 0 Autostart 0 1 0 1
Datagram Type Directed UDP 1 1 0 0
Modem Mode
Full Verbose 1 0 1 1 0 Without Echo 0 0 1 1 0 1-character Response 1 0 1 1 1
(1)
0 0 1 0
1
Manual Connection: When you use manual connection, you are not required to enter the entire IP address if the IP is already configured as the remote IP address in the unit. For example, if the remote IP address already configured in the unit is 129.1.2.3, then an example command string would be C3/7. (This would connect to 129.1.2.3 and port 7.) You may also use a different ending for the connection string. For example, C50.1/23 would connect you to
129.1.50.1 and port 23.
3-18
UDS-10 User Guide
Configure
Table 10 - Manual Connection Address Example
Command String Result if remote IP is 129.1.2.3 and remote port is 1234
C121.2.4.5/1 Complete override; connection is started with host 121.2.4.5, port 1 C5 Connect to 129.1.2.5, port 1234 C28.10/12 Connect to 129.1.28.10, port 12
Autostart (Automatic Connection): If autostart is enabled, the unit automatically connects to the remote IP address and remote port specified.
Datagram Type: When selecting this option, you will be prompted for the Datagram type. Enter 01 for directed or broadcast UDP.
Modem (Emulation) Mode: In Modem Mode, the unit presents a modem interface to the attached serial device. It accepts AT-style modem commands, and handles the modem signals correctly.
Normally there is a modem connected to a local PC and a modem connected to a remote machine. A user must dial from the local PC to the remote machine, accumulating phone charges for each connection. Modem Mode allows you to replace modems with device servers, and to use an Ethernet connection instead of a phone call, without having to change communications applications and make potentially expensive phone calls.
To select Modem Mode, set the Connect Mode to C6 (no echo), D6 (echo with full verbose), or D7 (echo with 1-character response).
Note: If the unit is in Modem Mode and the serial port is idle, the unit can still accept network TCP connections to the serial port if Connect Mode is set to C6 (no echo), D6 (echo with full verbose), or D7 (echo with 1-character response).
In Modem Mode, echo refers to the echo of all of the characters entered in command mode; it does not mean to echo data that is transferred. Quiet Mode (no echo) refers to the modem not sending an answer to the commands received (or displaying what was typed).
To disconnect a connection using Modem Mode commands:
There must be 1-second guardtime (no data traffic) before sending +++. 
There must not be a break longer that 1 second between +s.
There must be another 1-second guardtime after the last + is sent.
The unit acknowledges with an OK to indicate that it is in command mode.
Enter ATH and press Enter. It is echoed if echo is enabled. ATH is acknowledged
by another OK.
UDS-10 User Guide 3-19
Configure
Table 11 - Modem Mode Commands
Modem Mode
Function
Command
ATDTx.x.x.x,pppp or ATDTx.x.x.x/pppp
ATDTx.x.x.x
ATD0.0.0.0
ATD
ATDx.x.x.x
ATH Hangs up the connection (Entered as +++ATH ).
ATS0=n
ATEn
ATVn
Makes a connection to an IP address (x.x.x.x) and a remote port number (pppp).
Makes a connection to an IP address (x.x.x.x) and the remote port number defined within the unit.
Forces the unit into monitor mode if a remote IP address and port number are defined within the unit.
Forces the unit into monitor mode if a remote IP address and port number are not defined within the unit.
Makes a connection to an IP address (x.x.x.x) and the remote port number defined within the unit.
Enables or disables connections from the network going to the serial port. n=0 disables the ability to make a connection from the network to the serial port. n=1-9 enables the ability to make a connection from the network to the serial port. n>1-9 is invalid.
Enables or disables character echo and responses. n=0 disables character echo and responses. n=1 enables character echo and responses.
Enables 1-character response or full verbose. n=0 enables 1-character response. n=1 enables full verbose.
Note: These AT commands are only recognized as single commands like ATE0 or ATV1; compound commands such as ATE0V1 are not recognized. All other AT commands with Modem Mode set to full verbose acknowledge with an OK, but no action is taken.
3-20
UDS-10 User Guide
Configure
3.6.6 Remote IP Address
This is the destination IP address used with an outgoing connection.
3.6.7 Remote Port
The remote TCP port number must be set for the unit to make outgoing connections. This parameter defines the port number on the target host to which a connection is attempted.
Note: To connect an ASCII terminal to a host using the unit for login purposes, use the remote port number 23 (Internet standard port number for Telnet services).
3.6.8 DisConnMode
Note: See Table 35 - Binary to Hexadecimal Conversion Table.
Table 12 - Disconnect Mode Options
Disconnect Mode Option 7 6 5 4 3 2 1 0
Disconnect with DTR drop Ignore DTR 0
Telnet mode and terminal type setup
(1)
Channel (port) password
Hard disconnect
(3)
0
Disable hard disconnect 1 State LED off with connection
(4)
Disconnect with EOT (^D)
1. The CoBox will send the "Terminal Type" upon an outgoing connection.
2. A password is required for a connection to the serial port from the network.
3. The TCP connection will close even if the remote site does not acknowledge the disconnection.
4. When there is a network connection to or from the serial port, the state LED will turn off instead of blink.
5. When Ctrl D or Hex 04 are detected, the connection is dropped. Both Telnet mode and Disconnect with EOT must be enabled
for Disconnect with EOT to function properly. Ctrl D will only be detected going from the serial port to the network.
6. When DTR on the CoBox/UDS product transitions from a high state to a low state, then the network connection to or from
the serial port will drop.
(6)
1
1
(2)
1
1
(5)
1
UDS-10 User Guide 3-21
Configure
3.6.9 Flush Mode (Buffer Flushing)
Using this parameter, you can control line handling and network buffers with connection startup and disconnect. You can also select between two different packing algorithms.
Note: See Table 35 - Binary to Hexadecimal Conversion Table.
Table 13 - Flush Mode Options
Function 7 6 5 4 3 2 1 0
Input Buffer (Serial to Network)
Clear with a connection that is initiated from the UDS to the network Clear with a connection initiated from the network to the UDS Clear when the network connection to or from the UDS is disconnected Output Buffer (Network to Serial) Clear with a connection that is initiated from the UDS to the network Clear with a connection initiated from the network to the UDS Clear when the network connection to or from the UDS is disconnected Alternate Packing Algorithm (Pack Control) Enable 1
1
1
1
1
1
1
3-22
UDS-10 User Guide
Configure
3.6.10 Pack Control
Two firmware-selectable packing algorithms define how and when packets are sent to the network. The standard algorithm is optimized for applications in which the unit is used in a local environment, allowing for very small delays for single characters while keeping the packet count low. The alternate packing algorithm minimizes the packet count on the network and is especially useful in applications in a routed Wide Area Network (WAN). Adjusting parameters in this mode can economize the network data stream.
Pack control settings are enabled in Flush Mode. Set this value to 00 if specific functions are not needed.
Note: See Table 35 - Binary to Hexadecimal Conversion Table.
Table 14 - Pack Control Options
Option 7 6 5 4 3 2 1 0
Idle Time
Force transmit: 12ms 0 0 Force transmit: 52ms 0 1 Force transmit: 250ms 1 0 Force transmit: 5sec 1 1 Trailing Characters None 0 0 One 0 1 Two 1 0 Send Characters 2-Byte Send Character
Sequence Send Immediately After Send chars
1
1
Idle Time: Idle time to "Force transmit" defines how long the unit should wait before sending accumulated characters. This wait period is between characters. If there is an idle period between characters equal to the force transmit set, then the unit will package up the serial data currently in the buffer and send it to the network.
Trailing Characters: In some applications, CRC, Checksum, or other trailing characters follow the end-of-sequence character; this option helps to adapt frame transmission to the frame boundary.
UDS-10 User Guide 3-23
Configure
Send Characters: If 2-Byte Send Character Sequence is enabled, the unit interprets the sendchars as a 2-byte sequence; if not set, they are interpreted independently.
If Send Immediately After Characters is not set, any characters already in the serial buffer are included in the transmission after a "transmit" condition is found. If set, the unit sends immediately after recognizing the transmit condition (sendchar or timeout).
Note: A transmission might occur if status information needs to be exchanged or an acknowledgment needs to be sent.
3.6.11 DisConnTime (Inactivity Timeout)
Use this parameter to set an inactivity timeout. The connection is dropped if there is no activity on the serial line before the set time expires. Enter time in the following format: mm:ss, where m is the number of minutes and s is the number of seconds. To disable the inactivity timeout, enter 00:00.
3.6.12 Send Characters
You can enter up to two characters in hexadecimal representation in the parameters "sendchar." If a character received on the serial line matches one of these characters, it is sent immediately, along with any awaiting characters, to the TCP connection. This minimizes the response time for specific protocol characters on the serial line (for example, ETX, EOT, etc.). Setting the first sendchar to 00 disables the recognition of the characters. Alternatively, the two characters can be interpreted as a sequence (see Pack Control on page 3-23).
3.6.13 Telnet Terminal Type
This parameter appears only if the terminal type option is enabled in Disconnect Mode (see DisConnMode on page 3-21 above). If this option is enabled, you can use the terminal name for the Telnet terminal type. Enter only one name.
If the terminal type option is enabled, the unit also reacts to the EOR (end of record) and binary options, which can be used for applications like terminal emulation to IBM hosts.
3.6.14 Channel (Port) Password
This parameter appears only if the channel (port) password option is enabled in Disconnect Mode (see DisConnMode on page 3-21). If set, you can set a password on the serial port.
3-24
UDS-10 User Guide
Configure
3.7 Expert Settings
Note: You can change these settings via Telnet or serial connections only, not on the Web­Manager.
Note: The Expert Settings option does not appear with UDS-10-IAP.
These parameters should only be changed if you are an expert and definitely know the consequences the changes might have.
TCP Keepalive time in s (1s – 65s; 0s=disable): (0)
3.7.1 TCP Keepalive time in s
This option allows you to change how many seconds the unit will wait during a silent connection before attempting to see if the currently connected network device is still on the network. If the unit then gets no response, it will drop that connection.
3.8 Security Settings
Note: You can change these settings via Telnet or serial connections only, not on the Web­Manager. We recommend that you set security over the dedicated network or over the serial setup. If you set parameters over the network (Telnet 9999), someone else could capture these settings.
Disable SNMP (N) (Not with IAP) SNMP Community Name (public): (Not with IAP) Disable Telnet Setup (N) Disable TFTP Firmware Update (N) Disable Port 77FEh (N) Disable Web Server (N) Enable Enhanced Password (N)
3.8.1 Disable SNMP
Note: This option does not appear with UDS-10-IAP.
This setting allows you to disable the SNMP protocol on the unit for security reasons.
3.8.2 SNMP Community Name
Note: This option does not appear with UDS-10-IAP.
This option allows you to change the SNMP Community Name on the unit. This allows for ease of management, and possibly some security. If someone tries to violate security but doesn’t know what community to connect to, that person will be unable to get the SNMP community information from the unit.
UDS-10 User Guide 3-25
Configure
3.8.3 Disable Telnet Setup
This setting defaults to the N (No) option. The Y (Yes) option disables access to this Configuration Menu by Telnet (port 9999). It only allows access via the Web pages and the serial port of the unit.
3.8.4 Disable TFTP Firmware Upgrade
This setting defaults to the N (No) option. The Y (Yes) option disables the use of TFTP to perform network firmware upgrades. With this option, firmware upgrades can be performed only by using a *.hex file over the serial port of the unit.
3.8.5 Disable Port 77FE (Hex)
Port 77FE is a setting that allows DeviceInstaller, Web Pages, and custom programs to configure the unit remotely. You may wish to disable this capability for security purposes. For more information about remote configuration, see the Lantronix Embedded Integration Kit user guide on the Lantronix Web site www.lantronix.com.
The default setting is the N (No) option, which enables remote configuration. You can configure the unit by using DeviceInstaller, Web pages, Telnet, or serial configuration. The Y (Yes) option disables remote configuration and Web pages.
Note: The Yes option disables many of the GUI tools for configuring the Device Server, including the embedded Web Page Configuration tool.
3.8.6 Disable Web Server
This setting defaults to the N (option). The Y (Yes) option disables the use of the Web Page Configuration tool that is built into the unit.
3.8.7 Enable Enhanced Password
This setting defaults to the N (option), which allows you to set a 4-character password that protects the Configuration Menu via Telnet and Web pages. The Y (Yes) option allows you to set an extended security password of 16-characters for protecting Telnet access.
3.9 Factory Defaults
Select 7 to reset the unit’s Channel 1 and Enhanced Security to the factory default settings. The server configurations (IP address information) remain unchanged.
3-26
UDS-10 User Guide
Configure
3.10 Exit Configuration Mode
Select 8 to exit the configuration mode without saving any changes or rebooting. Select 9 to save all changes and reboot the device. All values are stored in nonvolatile memory.
3.11 Get Configuration
The device configuration information is stored in flash memory and can be read and saved in a configuration file (filename.cfg). To get the configuration information, click the Get Configuration icon button on the Device Management window. The following dialog appears.
The Device IP Address is shown in the first field. This is the device selected in the DeviceInstaller main window. In the Configuration File field, click the Open File button to select a filename for the configuration file. Click the Get button and the file information is read from the device and saved in the selected file.
UDS-10 User Guide 3-27
Configure
3.12 Set Configuration
Device configuration information can be saved in a file and later used to set the configuration of one or several devices. To set the configuration of a device from a saved file, click the Set Configuration button on the Device Management window. The following dialog appears.
The Device IP Address is shown in the first field. This is the device selected in the DeviceInstaller main window. In the Configuration File field, click the Open File button to select a configuration file. Click the Set button and the file information is read and stored in the device.
3-28
UDS-10 User Guide
Firmware
4. Updating Protocol (Firmware)
4.1 Protocol Firmware
You can update the unit's internal operational code to a newer revision, or change the code to operate with a specific vendor.
The UDS-10-IAP was designed to allow loading of vendor specific protocol firmware. This firmware takes the place of the IAP Standard Tunnel Protocol. Vendor specific protocols and the software tools needed to load them can be found on the software CD.
You can obtain the most up-to-date protocol firmware and release notes for the unit from the Lantronix Web site (www.lantronix.com
Once you load a vendor specific protocol, you must reference the user manual associated with that protocol, since many of the setup and configuration dialogs will be changed. Some features, such as web pages, may not be available with certain vendor protocols.
Note: If you change the protocol to a vendor specific protocol, you MUST reference the associated protocol manual for setup and configuration information. The menu options shown in this manual are for Standard Tunnel Protocol.
) or by using anonymous FTP (ftp.lantronix.com).
4.2 Reloading Protocol Firmware
There are several ways to update the unit's internal operational code (*.ROM): via DeviceInstaller (the preferred way), via TFTP, via another unit, or via the serial port. You can also update the unit's internal Web interface (*.COB) via TFTP or DeviceInstaller.
The firmware files are located on the software CD in the firmware folder. Here is a list of typical names for those files. Check the Lantronix web site for the latest versions and release notes.
Table 15 - Protocol Firmware
Folder Name ROM File COB
AD - DF1 MultiMaster
AM - Modbus Bridge
AQ - Standard
UDS10 ltx45.rom cbxw300.cob
UDS-10 User Guide 4-1
DF1 Multi-master ad0100.rom (IAP only)
AM0144.rom (IAP only)
Standard Tunnel aq0100.rom (IAP only)
NA
NA
(Standard Tunnel_aq0100wb6.cob) (or cbxw300.cob)
Firmware
4.2.1 Via DeviceInstaller
After downloading the firmware to your computer, or locating the file on your software CD, you can use DeviceInstaller to install it.
1. Download the updated firmware files from www.lantronix.com or ftp.lantronix.com and store them in a subfolder on your computer.
2. Click the Start button on the Task Bar and select Programs\DeviceInstaller\Device Installer. The Device Installer window displays.
Figure 14 - Device Installer
4-2
UDS-10 User Guide
Firmware
3. Click the Search the network for devices icon . The Search Network window
displays.
Figure 15 - Search Network Window
4. Click the Start Search button. A list of all active units on the local network displays.
5. Click the Save button. A confirmation message displays.
6. Click OK.
7. Click the Back button to return to the Device Installer window. The Device Installer
window now lists all of the devices in the group, including the unit you are updating.
Figure 16 - Devices in a Group
UDS-10 User Guide 4-3
Firmware
8. Select the desired unit and click the Upgrade Firmware file (.ROM) icon
. The
Upgrade Firmware window displays.
Figure 17 - Upgrade Firmware
9. In the Existing Firmware list box, select the firmware type that is currently in the unit. This selection must match the Firmware file type currently installed or an error message will be displayed.
10. In the Source FW File field, locate the firmware file from the software CD or the file you downloaded from the Lantronix web site.
11. Click the Update FW File button. Upgrade status process messages display in the lower part of the window. When the process is complete, the “File upgrade successful” message displays.
12. Click OK.
Note: You can update the unit’s Web pages by clicking the Upgrade Web files (.COB) icon. Though it would be rare to need to update both the firmware and Web pages at the same time, you can do so by clicking the Update the firmware files and Webpages in one step icon.
4.2.2 Via TFTP
To download new firmware from a computer:
1. Use a TFTP client to send a binary file to the unit (*.ROM to upgrade the unit 's internal operational code and *.COB to upgrade its internal Web interface).
Note: TFTP requires the .ROM (binary) version of the unit's internal operational code.
2. Make sure the Put and Binary options at the top of the window are selected.
3. Enter the full path of the firmware file in the Source File field.
4-4
UDS-10 User Guide
Firmware
4. In the Destination File field, enter the current internal operational code or WEB5 for
the internal Web interface. (For UDS-10-IAP, AQ = Standard Tunnel, AM = Modbus, AD = DF1. For UDS-10, 3Q = Standard Tunnel)
5. In the Remote Host field, enter the IP address of the unit being upgraded.
6. Click the Put button to transfer the file to the unit.
Figure 18 - TFTP Dialog Box
The unit performs a power reset after the firmware has been loaded and stored.
4.2.3 Via Another Unit
To distribute firmware to another unit over the network:
1. Enter the host unit's Monitor Mode (see Monitor Mode on page 7-1).
2. Send the firmware to the receiving unit using the SF command, where x.x.x.x is the
receiving unit's IP address.
SF x.x.x.x
The receiving unit performs a power reset after the firmware has been loaded and stored.
Note: You can only update your unit 's internal Web interface using TFTP or Device Installer.
UDS-10 User Guide 4-5
Firmware
4.2.4 Via the Serial Port
The following procedure is for using the HyperTerminal software application. In some cases, the HEX format file is available on the software CD and on the Web site.
Before you can load firmware through the serial port you need to convert the ROM code to HEX format. There is a DOS application, R2H.EXE that can be used to convert the ROM file to HEX format. The R2H.EXE application is available at ftp://ftp.lantronix.com/pub.
Put R2H.EXE and the *.ROM file into the same directory on a PC then open a DOS Window to that directory and type:
C:\ R2H filename
This will create a filename.hex file that you can load via the serial port.
Note: Do not switch off the power supply during the update. A loss of power while reprogramming will result in a corrupt program image and a nonfunctional unit.
To download firmware from a computer via the unit’s serial port:
1. Enter Monitor Mode via the serial port. (see Monitor Mode on page 7-1).
2. Download the firmware to the unit using the DL command.
3. Select Send Text File and select the *.HEX file to be downloaded. The downloaded file must be the .HEX (ASCII) version.
4. After the final record is received, the unit checks the integrity of the firmware image before programming the new firmware in the flash ROM. The following message displays when the firmware upgrade is complete.
*** NodeSet 2.0 *** 0>DL 02049 lines loaded.
Note: You can only update your unit 's internal Web interface using TFTP or Device Installer.
4-6
UDS-10 User Guide
Firmware
L
l
5. DeviceComm Manager
Lantronix DeviceComm Manager is a Windows based COM port redirector software utility. Its function is to redirect customer application data destined for a local serial (COM) port to the PC’s network port. Rather than going out the local serial port, the data is transmitted across the Ethernet network port using the TCP/IP protocol.
A Device Server attached to the network receives the data and presents it on its serial port. Conversely, data into the serial port of the Device Server is sent back over the network to the DeviceComm Manager. The DeviceComm Manager then presents the data to the customer application as if it were from a local serial COM port.
Customer Application
Serial Data
Device Comm
Manager
PC
This powerful 32-bit Windows utility allows any commercially available or application­specific software to communicate with networked devices as if they were directly attached to the PC's COM ports. To the user, this means that when they network-enable a serial device with a Lantronix Device Server, they can retain their existing PC-based applications software without having to undertake the additional time and expense of developing new software.
oca Serial (COM) Port
Ethernet Network
Device Server
Remote Serial Data to/from Attached Device
Using simple on-screen menus, users can map up to 255 COM ports directly to IP addresses assigned to Lantronix Device Servers. Once COM ports are mapped, any networked PC with DeviceComm Manager software installed can access devices on the network via Lantronix’ Device Servers. Both the software application and the serial device operate normally as if they were still directly connected - Lantronix Device Server and the DeviceComm Manager utility do all the work in between to keep data flowing smoothly.
The DeviceComm Manager utility consists of a Control Panel applet, a device driver, and a Windows service.
Eliminates the need for the users to develop or modify their existing application software
No understanding of how to develop networking software is required
Everything is totally transparent to the serial device, the application software, and the user
Redirects up to 255 COM ports simultaneously over TCP/IP protocol
Provides raw mode data only, which means it will not change or modify the data being sent
Supports Windows 2000, Windows NT4.0, and Windows XP
Easy to install and even easier to configure
UDS-10 User Guide 5-1
Firmware
5.1 Installing DeviceComm Manager
The DeviceComm Manager software is included on the product CD or it can be downloaded from the Lantronix web site.
5.1.1 Install DeviceComm Manager
1. Insert the product CD into your CD-ROM drive. The CD will automatically start and display the main window.
If the CD does not launch automatically:
a) Click the Start button on the Task Bar and select Run.
b) Enter your CD drive letter, colon, backslash, devicecomm.exe (e.g., D:\devicecomm.exe).
Figure 19 – UDS/CoBox Main Window
2. Click the DeviceComm Manager button. The installation wizard window displays.
Respond to the installation wizard prompts.
Note: DeviceComm Manager is installed in the Control Panel.
5-2
UDS-10 User Guide
5.1.2 Setup
1. Open Control Panel.
Firmware
2. Double click on the “DeviceComm Manager” Icon
.
Status Meaning
DISABLED Unused port on your system N/A Port being used by other hardware / software on your system IDLE An IP address and port number have been associated with the COM port CONNECTED An active TCP/IP connection exists between the COM port and the device server
3. Select one of the DISABLED ports by clicking on it, and then press the Edit button.
4. Select the Enabled check box.
5. Type in the IP address of the target device server in the “Host:” section.
UDS-10 User Guide 5-3
Firmware
6. Enter the Port number of the target device server in the “Port:” section. Click OK when done.
****Please Note:**** Because this is a raw mode redirector: a. On UDS and CoBox products, you cannot use ports 14000 through 14009. b. On MSS, ETS, LRS, and SCS products DO use the 3001, 3002, 3003, etc. ports.
Note: You will be required to reboot your system when enabling COM ports. You may want to set them all up at one time and then reboot.
7. Click the Settings button for advanced configuration. Some serial applications do not work well when redirected because they are not expecting the latency (delay) that an Ethernet network may cause. Increasing the “Read Network Timeout” and the “Write Network Timeout” values may help the situation. Network latency varies depending on a number of factors. You can get a rough idea of the delay at a given time by “pinging” the device server from the PC and looking at the “time” column. You may also find the PC command “tracert” helpful. See your Windows OS documentation for more details on these commands. Both “ping” and “tracert” are DOS prompt commands.
8. Click Ok to close the Settings dialog box.
9. Select the "Enable Connection Status” checkbox at the bottom of the DeviceComm Manager screen if you wish to be notified via screen pop-up when the connection to the remote port is established. If your application is very time sensitive regarding the initial connection, or you do not wish to have a screen pop-up, leave this box unchecked.
10. Click OK to complete the setup.
No other setup is required. In the above example, all data sent to COM4 will be sent across the network to the device server at “172.20.197.50”, port “10001”.
5-4
UDS-10 User Guide
Troubleshooting
6. Troubleshooting
6.1 Technical Support
This chapter discusses how you can diagnose and fix errors quickly without having to contact a dealer or Lantronix.
It helps to connect a terminal to the serial port while diagnosing an error to view summary messages that may be displayed. When troubleshooting, always ensure that the physical connections (power cable, network cable, and serial cable) are secure.
Note: Some unexplained errors might be caused by duplicate IP addresses on the network. Make sure that your unit's IP address is unique.
6.1.1 Technical Support
If you are experiencing an error that is not described in this chapter, or if you are unable to fix the error, you may:
Check our online knowledge base at www.lantronix.com/support
E-mail us at E-mail: support@lantronix.com
Call us at:
(800) 422-7044 Domestic (949) 453-7198 International (949) 450-7226 Fax
Our phone lines are open from 6:00AM - 5:30 PM Pacific Time Monday through Friday excluding holidays.
Firmware downloads, FAQs, and the most up-to-date documentation are available at:
www.lantronix.com/support
Technical Support Europe, Middle East, and Africa +49 (0) 7720 3016 20/57
eu_techsupp@lantronix.com
UDS-10 User Guide 6-1
Troubleshooting
When you report a problem, please provide the following information:
Your name, and your company name, address, and phone number
Lantronix model number
Lantronix serial number
Software version (on the first screen shown when you Telnet to port
9999)
Description of the problem
Debug report (stack dump), if applicable
Status of the unit when the problem occurred (please try to include information on
user and network activity at the time of the problem)
When troubleshooting the following problems, make sure that the DR1 is powered up and the Link (L) LED is lit solid green. If the Link LED is not lit, then the physical network connection is bad. Confirm that you are using a good network connection.
6-2
UDS-10 User Guide
Table 16 - Problems and Error Messages
Problem/Message Reason Solution
When you issue the ARP –S command in Windows, “The ARP entry addition failed: 5" message displays. When you attempted to assign an IP address to the
UDS/CoBox via the ARP
method, the “Press Enter to go into Setup Mode” error (described below) displayed. Now when you Telnet to the UDS/CoBox, the connection fails. When you Telnet to port 9999, the message “Press Enter to go into Setup Mode” displays. However, nothing happens when you press Enter, or your connection is closed. When you Telnet to port 1 to assign an IP address to the
UDS/CoBox, the Telnet window
does not respond for a long time.
When you try to assign an IP with Device Installer, you get the following message:
“No response from device! Verify the IP, Hardware address and Network Class. Please try again.”
Your currently logged-in user does not have the correct rights to use this command on this PC.
When you Telnet into port 1 on the UDS/CoBox, you are only assigning a temporary IP address. When you Telnet into port 9999 and do not press Enter quickly, the UDS/CoBox will reboot, causing it to lose the IP address.
You did not press Enter quickly enough. You only have 5 seconds to press Enter before the connection is closed.
You may have entered the Ethernet address incorrectly with the ARP command.
The IP address you are trying to assign is not on your logical subnet.
The UDS/CoBox may not be plugged into the network properly.
The cause is most likely one of the following: The Hardware address you specified is incorrect. The IP address you are trying to assign is not a valid IP for your logical subnet. You did not choose the correct subnet mask.
Have someone from your IT department log you in with sufficient rights.
Telnet back into Port 1. Wait for it to fail, then Telnet to port 9999 again. Make sure you press Enter quickly.
Telnet to port 9999 again, but press Enter as soon as you see the message “Press Enter to go into Setup Mode.”
Confirm that the Ethernet address that you entered with the ARP command is correct. The Ethernet address may only include numbers 0-9 and letters A-F. In Windows and usually in Unix, the segments of the Ethernet address are separated by dashes. In some forms of Unix, the Ethernet address is segmented with colons. Confirm that your PC has an IP address and that it is in the same logical subnet that you are trying to assign to the UDS/CoBox. Make sure that the Link LED is lit. If the Link LED is not lit, then the UDS/CoBox is not properly plugged into the network. Double-check the parameters that you specified. Tip: You cannot assign an IP address to a
UDS/CoBox through a router.
Troubleshooting
UDS-10 User Guide 6-3
Troubleshooting
Problem/Message Reason Solution
No LEDs are lit. The unit or its power supply is
damaged. The UDS/CoBox will not power up properly, and the LEDs are flashing.
The UDS/CoBox is not communicating with the serial device it is attached to.
When you try to enter the setup mode on the UDS/CoBox via the serial port, you get no response. You can ping the UDS/CoBox, but not Telnet to the UDS/CoBox on port 9999.
With Device Installer you get the “Wrong Password” error when you try to upgrade the firmware.
Various Consult the LEDs section in the
The most likely reason is the
wrong serial settings were
chosen.
The issue will most likely be
something covered in the
previous problem, or possibly
you have Caps Lock on.
There may be an IP address
conflict on your network
You are not Telneting to port
9999.
The Telnet configuration port
(9999) is disabled within the
UDS/CoBox security settings.
You have chosen the incorrect
setting for the Existing
Firmware field.
Change power supplies.
Introduction chapter or the Quick Start for the LED flashing sequence patterns. Call Lantronix Technical Support if the blinking pattern indicates a critical error. The serial settings for the serial device and the UDS/CoBox must match. The default serial settings for the UDS/CoBox are RS232, 9600 Baud, 8 Character Bits, No Parity, 1 Stop Bit, No Flow Control. Double-check everything in the problem above. Confirm that Caps Lock is not on.
Turn the UDS/CoBox off and then issue the following commands at the DOS prompt of your computer: ARP -D X.X.X.X (X.X.X.X is the IP of the UDS/CoBox) PING X.X.X.X (X.X.X.X is the IP of the UDS/CoBox).
If you get a response, then there is a duplicate IP address on the network (the LEDs on the UDS/CoBox should flash a sequence that tells you this). If you do not get a response, use the serial port to verify that Telnet is not disabled. Try upgrading the firmware again, but make sure to use the correct setting in the field of Existing Firmware field.
6-4
UDS-10 User Guide
Problem/Message Reason Solution
The UDS/CoBox appears to be set up correctly, but you are not communicating with your device attached to the UDS/CoBox across the network.
When connecting to the Web­Manager within the
UDS/CoBox, the message “No
Connection With CoBox” displays.
If you are sure that the serial port setting is correct, then you may not be connecting to the correct socket of the UDS/CoBox.
Another possibility is that the UDS/CoBox is not set up correctly to make a good socket connection to the network.
Your computer is not able to connect to port 30718 (77FEh) on the UDS/CoBox.
You can check to see whether there is a socket connection to or from the UDS/CoBox by looking at the Status LED.
If the Status LED is blinking consistently then there is a good socket connection.
If the Status LED is solid green, then the socket connection does not exist. Use the Connect Mode option C0 for making a connection to the UDS/CoBox from the network. Use Connect Mode option C1 or C5 for a connection to the network from the UDS/CoBox. See the full list of Connect Mode Options in the Binary to Hexadecimal chapter. Make sure that port 30718 (77FEh) is not blocked with any router that you are using on the network. Also make sure that port 77FEh is not disabled within the Security settings of the
UDS/CoBox.
Troubleshooting
UDS-10 User Guide 6-5
Monitor Mode
7. Monitor Mode
7.1 Monitor Mode
Monitor Mode is a command-line interface used for diagnostic purposes (see Table 17 ­Monitor Mode Commands). There are two ways to enter Monitor Mode: locally via the serial
port or remotely via the network.
7.1.1 Entering Monitor Mode Via the Serial Port
To enter Monitor Mode locally:
1. Follow the same principles used in setting the serial configuration parameters (see Configuring via the Setup Mode Window on page 3-10.
2. Instead of typing three “x” keys, however, type zzz (or xxl) to enter Monitor Mode with network connections.
Type yyy (or yyy) to enter Monitor Mode without network connections.
3. A 0> prompt indicates that you have successfully entered Monitor Mode.
7.1.2 Entering Monitor Mode Via the Network Port
To enter Monitor Mode using a Telnet connection:
4. First establish a Telnet session to the configuration port (9999). The following message appears:
Serial Number 1400280 MAC address 00:20:4A:14:01:18 Software Version 4.3 (xxxxxx) Press Enter to go into Setup Mode
5. Type M (upper case).
A 0> prompt indicates that you have successfully entered Monitor Mode.
7.1.3 Monitor Mode Commands
The following commands are available in Monitor Mode. Many commands have an IP address as an optional parameter (xxx.xxx.xxx.xxx). If the IP address is given, the command is applied to another Device Server with that IP address. If no IP address is given, the command is executed locally.
Note: All commands must be given in capital letters.
UDS-10 User Guide 7-1
Monitor Mode
Table 17 - Monitor Mode Commands
Command Command Name Function
DL Download Download firmware to the Device Server via the
serial port in hex format
SF x.x.x.x Send Firmware Send firmware to Device Server with IP address
x.x.x.x
VS x.x.x.x Version Query software header record (16 bytes) of
Device Server with IP address x.x.x.x
GC x.x.x.x Get Configuration Get configuration of Device Server with IP
address x.x.x.x as hex records (120 bytes)
SC x.x.x.x Send Configuration Set configuration of Device Server with IP address
x.x.x.x from hex records
PI x.x.x.x Ping Ping Device Server with IP address x.x.x.x to
check device status AT ARP Table Show the Device Server’s ARP table entries TT TCP Connection
Table NC Network Connection Shows the Device Server’s IP configuration RS Reset Resets the Device Server’s power SI xxx.xxx.xxx.xxx: yyy.yyy.yyy.yyy
QU Quit Exit diagnostics mode
G0, G1, ....,Ge,
Gf S0, S1,...,Se, Sf Set configuration to
Send/Set IP
Address
Get configuration
from memory page
memory page
Shows all incoming and outgoing TCP connections
Remotely assign an IP address to a Device Server, where xxx.xxx.xxx.xxx is the IP address, and yyyy.yyy.yyyy.yyy is the two-part identification number at the bottom of the label, converted to decimal, and written twice.
Gets a memory page of configuration information from the device. Sets a memory page of configuration information on the device.
Responses to some of the commands are given in Intel Hex format (see The Intel Hex Format on page 8-5).
Note: Entering any of the commands listed above will generate one of the following command response codes:
Table 18 -Command Response Codes
Response Meaning
0> OK; no error 1> No answer from remote device 2> Cannot reach remote device or no
answer 8> Wrong parameter(s) 9> Invalid command
7-2
UDS-10 User Guide
UDP
8. Network Configuration using UDP
8.1 UDP Datagrams
The Device Server can also be configured or queried over the network using UDP datagrams. The Device Server has a UDP listener set for port 30718 (77FE Hex). Responses from the Device Server are returned to the source port of the UDP packet.
The first three bytes of the UDP data block should be set to zero. The fourth byte selects the function as described in the following table:
Table 19 - UDP Configuration
Byte Command Parameters Notes
03 Node Reset 2 bytes, software
type
F6 Query for
Firmware Version
F7 Firmware
Information
F8 Query for
Setup Record
F9 Configuration
Readback
FA Set
Configuration
FB Configuration
Change Acknowledge
FC Set IP Address First 8 bytes must This block can be sent as a broadcast,
None The Device Server responds with the F7
First 16 bytes of the firmware image, and 4 bytes device information and serial number. None The Device Server responds with the F9
120 byte setup record (see Setup Records on page E-
7) 120 byte setup record (see Setup Records on page E-
7) None This block is sent back to the host
These 2 bytes are used to prevent accidental reset of the Device Server. (Value for standard CoBox firmware: 33 51 [Hex], 3Q)
block below.
The first 16 bytes of the firmware image contain the software type (offset 4,5) and checksum (offset 14,15). The last two bytes of the device information contain the serial number.
block below. n/a
The IP address (byte 0-3) will not be overridden using FA. See FD for this functionality.
requesting a configuration change (FB). After sending out this block, the Device Server resets and uses the new configuration sent with the FA command.
UDS-10 User Guide 8-1
UDP
Byte Command Parameters Notes
because the serial number is unique. It provides one method to set the IP address of the Device Server if is on the local network and the serial number is known. Remember, broadcasts are only ‘heard’ on the subnet on which they are generated. No reply is sent by the Device Server, which restarts using the new IP address after the block is received.
Example (all in Hex): 49 50 2D 63 45 54 55 50 00 00 2A 12 81 00 01 02 IP address of the node with serial number 42-18 set to 129.0.1.2
n/a
FD Set
Configuration and IP Address
be set to the string IP-SETUP (Hex 49 50 2D 53 45 54 55
50).
Next 2 bytes have to be set to 00.
Next 2 bytes must contain the serial number.
Next 4 bytes have to be the new IP address.
Same as FA, but changes IP address as well (bytes 0-3).
8-2
UDS-10 User Guide
UDP
8.2 Configuring Multiple Devices
When configuring a number of Device Servers identically, it is useful to create a template setup record. The setup record can then be sent to the “target” Device Servers from a “master” Device Server via “cut and paste” or UDP (see Network Configuration using UDP on page 8-1).
Device Servers use a 120-byte setup record in Intel Hex format. This format facilitates the transfer of binary data using ASCII characters. See Setup Records on page 8-7 and The Intel Hex Format on page 8-5 for information about setup records and converting them to Intel Hex format.
:20000010AC10C81D0000100000000000AC10010B4C0200001127000000000000C000 000011 :20002010000000000000000000000000000000000000000000000000000000000000 0000B0 :200040104C0200001227000000000000C00000000000000000000000000000000000 000049 :1800601000000000000000000000000000000000000000000000000078 :00000001FF
Figure 20 - Sample Setup Record in Intel Hex Format
8.2.1 Acquiring a Valid Setup Record
There are a number of ways to acquire a valid setup record:
Copy the setup record of a properly configured Device Server via Monitor Mode
(easiest method).
Request the setup record of a properly configured Device Server via another Device
Server on the network.
Build the setup record in software.
From a host PC, request the setup record of a properly configured Device Server via
UDP.
To copy the setup record of a properly configured Device Server:
1. Configure a “master” Device Server with the desired parameters.
2. Enter Monitor Mode on the master Device Server (see Monitor Mode on page 7-1).
3. At the prompt, enter GC followed by a carriage return. The Device Server will respond with its setup record in Intel Hex format.
4. Copy the setup record into a text file and save it for future use.
UDS-10 User Guide 8-3
UDP
To request the setup record of a properly configured Device Server via another Device Server on the network:
5. Make sure that both units are plugged onto the network properly.
6. Enter Monitor Mode (with network support enabled) on the unit that is not properly configured. (see Monitor Mode on page 7-1)
7. Issue the command GC x.x.x.x followed by a carriage return, where x.x.x.x is the IP address of the properly configured device. The properly configured device will respond by sending its setup record to the unit you are currently on. This configuration will be displayed in Intel HEX format.
8. Copy that HEX string, and then issue the command SC. Now paste the copied string.
The unit will not reboot on its own. You must reboot the unit before the settings take effect.
To build the setup record in software:
1. Create a 120-byte setup record.
2. Convert it to an Intel Hex record (see The Intel Hex Format on page 8-5).
3. Copy the setup record into a text file and save it for future use.
To request the setup record of a properly configured Device Server via UDP:
1. Configure a Device Server with the desired parameters and place it on the network.
2. From a host PC, send the F8 datagram to the Device Server (see Network Configuration using UDP on page 8-1). The Device Server responds with the F9 datagram, which includes its setup record.
3. Send a previously saved setup record from a host PC via UDP.
8.2.2 Sending a Setup Record
There are also a number of ways to send a setup record to a Device Server:
Send a previously saved setup record via Monitor Mode (easiest method).
Send the setup record of a properly configured Device Server to another Device
Server on the network.
Send a previously saved setup record from a host PC via UDP.
8-4
UDS-10 User Guide
UDP
To send a setup record via Monitor Mode:
1. Configure a “master” Device Server with the desired parameters and place it on the
network.
2. Place another Device Server (the “target”) on the network.
3. Enter Monitor Mode (with network support enabled) on the master Device Server (see
Monitor Mode on page 7-1)
4. At the prompt, enter SC, the IP address of the target, and a carriage return.
5. Send the setup record to the target Device Server.
Note: For example, using Hyperterminal, copy the setup record and select “Paste to Host” to send it to the Device Server. The Device Server reboots with the new configuration.
To send a previously saved setup record to a Device Server via UDP, from a host PC, send the FA (or FD) datagram to the “target” Device Server (see Network Configuration using
UDP on page 8-1).
Note: The Device Server responds with the FB datagram. Refer to the table.
8.2.3 The Intel Hex Format
With this format, 8-bit binary data can be sent and received as ASCII text. The transmission is blocked in records, and every record has its own checksum.
The record begins with a colon (:) and consists of a block length (2-character Hex), a 16-bit address (4-character Hex), and a block type (2-character Hex). It is built by adding all binary 8-bit values and taking the complement, so adding all byte values (including length, address, and type) should yield zero.
Example:
00000001FF
End record, type 01, length 00, address 00 00, checksum FF.
01002000805F
Data record consisting of one byte (value 80 Hex) for address 0020 (32 decimal).
For communication with the node, the following block types are defined:
Table 20 - Block Types
Option Hex
Data block program memory (firmware) 00 End record 01 Data block configuration memory 10
UDS-10 User Guide 8-5
UDP
To get and set the node configuration, 120 bytes should be exchanged at once in 32-Byte records. The IP address in the record (bytes 0 to 3) will be ignored (unless the UDP FD command is being used).
8.2.4 Calculating the Checksum
As mentioned in Table 20 - Block Types above, the last two characters of an Intel Hex setup record represent a checksum of the data in the line. Since the checksum is a two-digit hexadecimal value, it can represent a value from 0 to 255.
The checksum is calculated by summing the value of the data on the line and taking the two’s complement of the sum.
Note: Do not include the leading colon or the checksum byte in the sum.
Example:
0300300002337A1E
Record length: 03 (3 bytes of data) Address: 0030 (the 3 bytes will be stored at 0030, 0031, and 0032) Record Type: 00 (normal data) Data: 02, 33, 7A Checksum: 1E
03 + 00 + 30 + 00+ 02 + 33 + 7A = E2
The two’s complement of E2 is 1E. See Calculating the Two’s Complement below.
8.2.5 Calculating the Two’s Complement
The two’s complement of a number is the value that must be added to the number to reach a Hexadecimal value of 100 (256 in decimal). In the example above, E2 + 1E = 100.
You can also calculate the two’s complement by subtracting the sum from 100. Using the example above again, 100 - E2 = 1E. It may help to use a scientific calculator.
8-6
UDS-10 User Guide
UDP
8.3 Setup Records
A setup record consists of 120 bytes. They are transmitted at once from and to the node. Unused bytes should be initialized as 00. Table 21 - Setup Record Construction defines the structure of a setup record:
Table 21 - Setup Record Construction
Byte(s) Function
00-03 IP address of the unit (x.x.x.x) 04 Reserved (0) 05 Flag BYTE
Bit 7: Reserved (0) Bit 6: Set 1 for AUI, 0 for 10BASE-T (CoBox-Micro only) Bits 5-0: Reserved (0)
06 Number of host bits for subnetting; if 0, matching standard netmask for Class A,
B, C is used. 07 Reserved (0) 08-11 Telnet configuration password (0 if not used) 12-15 Gateway IP address (0,0,0,0 if not used) 16-63 48-byte Channel 1 parameters; parameter setup Channel 1 (see Table E-4:
Channel Parameters) 64-111 48-byte Channel 2 parameters; parameter setup Channel 2 (see Table E-4:
Channel Parameters)) 112-119 Reserved (0)
UDS-10 User Guide 8-7
UDP
8.3.1 Channel Parameters
Use the following table to select setup record parameters for Channels 1:
Table 22 - Channel Parameters
Byte(s) (Channel 1)
16 17 Line Speed
18 19 Reserved
20-21 Own TCP port low-byte, high-byte (Intel) 22-23 Remote TCP port low byte, high-byte (Intel) 24-27 Remote IP address (low/high low/high) 28
29 30 Disconnect w/ inactivity time-out, minutes (00 if unused)
31 Disconnect w/ inactivity time-out, seconds (00 if unused) 32-33 Characters to trigger send immediately (sendchar) 34
35 36-47 Reserved (0)
48-63 a) Terminal name for Telnet terminal type option (15 characters max),
Function
Interface Mode (see
Bits 7-5: Reserved
Bits 4-0: Baud Rate (see
Flow Control (see
Connect Mode (see
Disconnect Mode (see
Flush mode (see
Pack Control (see
0-terminated. If set and Bit 6 in Disconnect Mode is set, Telnet
connection will be assumed.
Table 23 - Interface Mode Options)
Table 25 - Baud Rate Settings)
Table 26 - Flow Control Options)
Table 27 - Connect Mode Options)
Table 28 - Disconnect Mode Options)
Table 29 - Flush Mode Options)
Table 30 - Pack Control Options)
b) Password for Passworded Socket Connection (Bit 4 in Disconnect
Mode Set).
8-8
UDS-10 User Guide
8.3.2 Interface Mode
The Interface (I/F) Mode is a bit-coded byte entered in hexadecimal notation. Use the following table to select Interface Mode settings:
Table 23 - Interface Mode Options
UDP
I/F Mode Option 7 6 5 4 3 2 1 0
RS-232C RS-422/485 RS-485 2-wire
(1)
(1)
(1)
7 Bit 1 0 8 Bit 1 1 No Parity 0 0 Even Parity 1 1 Odd Parity 0 1 1 Stop bit 0 1 2 Stop bits 1 1
0 0 0 1 1 1
(1) The UDS-10 requires you to choose the correct setting in the IF mode.
The following table demonstrates how to build some common Interface Mode settings:
Table 24 - Common Interface Mode Settings
Option Binary Hex
RS-232C, 8-bit, No Parity, 1 stop bit RS-232C, 7-bit, Even Parity, 1 stop bit
(1)
(1)
RS-485 2-Wire, 8-bit, No Parity, 1 stop bit RS-422, 8-bit, Odd Parity, 2 stop bits
(1)
0100 1100 4C 0111 1000 78
(1)
0100 1111 4F 1101 1101 DD
(1) The UDS-10 requires you to choose the correct setting in the IF mode.
Note: See Table 35 - Binary to Hexadecimal Conversion Table.
UDS-10 User Guide 8-9
UDP
8.3.3 Baud Rate
The Device Server and attached serial device must agree on a speed or baud rate to use for the serial connection. Use the following table to select Baud Rate settings:
Table 25 - Baud Rate Settings
Speed
Hex
(bps)
38400 00 19200 01 9600 02 4800 03 2400 04 1200 05 600 06 300 07 115200 08 57600 09
8.3.4 Flow Control
Flow control sets the local handshaking method for stopping serial input/output. Generally, flow control is not required if the connection is used to pass a blocked protocol with block sizes less than 1k (ACK/NAK) and/or speeds of 19200 or less. Use the following table to select Flow Control options:
Table 26 - Flow Control Options
Option Hex
No flow control 00 XON/XOFF flow control 01 Hardware handshake with RTS/CTS lines 02 XON/XOFF pass characters to host 05
8-10
UDS-10 User Guide
UDP
8.3.5 Connect Mode
Connect Mode defines how the Device Server makes a connection, and how it reacts to incoming connections over the network. Use the following table to select Connect Mode options:
Table 27 - Connect Mode Options
Connect Mode Option 7 6 5 4 3 2 1 0
Incoming Connection
Never accept incoming 0 0 0 Accept incoming with DTR 0 1 0 Accept unconditional 1 1 0
Response Nothing (quiet) 0
Character response (C=conn, D=disconn, N=unreachable)
Startup No active startup 0 0 0 0 With any character 0 0 0 1 With active DTR With CR (0x0D) only 0 0 1 1 Manual connection 0 1 0 0 Autostart 0 1 0 1
Datagram Type Directed UDP 1 1 0 0
Modem Mode
Full Verbose 1 0 1 1 0 Without Echo 0 0 1 1 0 1-character Response 1 0 1 1 1
(1)
0 0 1 0
1
Note: See Table 35 - Binary to Hexadecimal Conversion Table.
UDS-10 User Guide 8-11
UDP
8.3.6 Disconnect Mode
In Disconnect Mode, DTR drop either drops the connection or is ignored. Use the following table to select Disconnect Mode Options:
Table 28 - Disconnect Mode Options
Disconnect Mode Option 7 6 5 4 3 2 1 0
Disconnect with DTR drop Ignore DTR 0
Telnet mode and terminal type setup
(1)
Channel (port) password
Hard disconnect
(3)
0
Disable hard disconnect 1 State LED off with connection
(4)
Disconnect with EOT (^D)
1. The CoBox will send the "Terminal Type" upon an outgoing connection.
2. A password is required for a connection to the serial port from the network.
3. The TCP connection will close even if the remote site does not acknowledge the disconnection.
4. When there is a network connection to or from the serial port, the state LED will turn off instead of blink.
5. When Ctrl D or Hex 04 are detected, the connection is dropped. Both Telnet mode and Disconnect with EOT must be enabled for Disconnect with EOT to function properly. Ctrl D will only be detected going from the serial port to the network.
6. When DTR on the CoBox/UDS product transitions from a high state to a low state, then the network connection to or from the serial port will drop.
Note: See Table 35 - Binary to Hexadecimal Conversion Table.
(6)
1
1
(2)
1
1
(5)
1
8-12
UDS-10 User Guide
UDP
8.3.7 Flush Mode (Buffer Flushing)
Using this parameter, you can control line handling and network buffers with connection startup and disconnect. You can also select between two different packing algorithms. Use the following table to select Flush Mode options:
Table 29 - Flush Mode Options
Function 7 6 5 4 3 2 1 0
Input Buffer (Serial to Network)
Clear with a connection that is initiated from the UDS to the network Clear with a connection initiated from the network to the UDS Clear when the network connection to or from the UDS is disconnected
Output Buffer (Network to Serial)
Clear with a connection that is initiated from the UDS to the network Clear with a connection initiated from the network to the UDS Clear when the network connection to or from the UDS is disconnected
Alternate Packing Algorithm (Pack Control)
Enable 1
Note: See Table 35 - Binary to Hexadecimal Conversion Table.
1
1
1
1
1
1
8.3.8 Pack Control
Alternate packing algorithm settings are enabled in Flush Mode. Use the following table to select Pack Control options:
Table 30 - Pack Control Options
Option 7 6 5 4 3 2 1 0
Idle Time Force transmit: 12ms 0 0 Force transmit: 52ms 0 1 Force transmit: 250ms 1 0 Force transmit: 5sec 1 1 Trailing Characters None 0 0 One 0 1 Two 1 0 Send Characters Sendchars Define 2-Byte Sequence 1 Send Immediately After Sendchars 1
UDS-10 User Guide 8-13
UDP
8.4 IP Addresses
Each TCP/IP node on a network host has a unique IP address. This address provides the information needed to forward packets on the local network and across multiple networks if necessary.
IP addresses are specified as x.x.x.x, where each x is a number from 1 to 254; for example,
192.0.1.99. The Device Server must be assigned a unique IP address to use TCP/IP network
functionality.
IP addresses contain three pieces of information: the network, the subnet, and the host.
8.4.1 Network Portion
The network portion of the IP address is determined by the network type: Class A, B, or C.
Table 31 - Network Portion of IP Address
Network Class Network Portion of Address
Class A First byte (2nd, 3rd, and 4th bytes are the host) Class B First 2 bytes (3rd and 4th bytes are the host) Class C First 3 bytes (4th byte is the host)
In most network examples, the host portion of the address is set to zero.
Table 32 - Available IP Addresses
Class Reserved Available
A 0.0.0.0
127.0.0.0
B 128.0.0.0
191.255.0.0
C 192.0.0.0
223.255.255.0
D, E 224.0.0.0 to 255.255.255.254
255.255.255.255
1.0.0.0 to 126.0.0.0
128.1.0.0 to 191.254.0.0
192.0.1.0 to 223.255.254.0
None (Check this)
Consider the IP address 36.1.3.4. This address is a Class A address; therefore, the network portion of the address is 36.0.0.0 and the host portion is 1.3.4.
8.4.2 Subnet Portion
The subnet portion of the IP address represents which sub-network the address is from. Sub­networks are formed when an IP network is broken down into smaller networks using a subnet mask.
8-14
UDS-10 User Guide
Loading...