Lantronix XPort User Manual

XPort™ User Guide

Part Number 900-270

Revision C 11/03

Copyright and Trademark

© 2003, 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.

XPort, with its patent-pending technology, is a trademark of Lantronix.

Ethernet is a trademark of XEROX Corporation. UNIX is a registered trademark of
The Open Group. Windows 95, Windows 98, Windows 2000, Windows NT, and
Windows XP are trademarks of Microsoft Corp. Netscape is a trademark of Netscape
Communications Corporation.

Contacts

Lantronix Corporate Headquarters

15353 Barranca Parkway
Irvine, CA 92618, USA
Phone: [phone]
Fax: [phone]

Technical Support

Phone: [phone] or 949-453-7198
Fax: [phone]
Online:
E-mail

Sales Offices

For a current list of our domestic and international sales offices, go to the Lantronix
web site at

www.lantronix.com/support
[e-mail]

http://www.lantronix.com/about/contact/index.html

XPort™ User Guide i

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.

Changes or modifications to this device not explicitly approved by Lantronix will void
the user's authority to operate this device.

Attention: With the purchase of XPort™, the OEM agrees to an OEM

firmware license agreement that grants the OEM a non-exclusive, royalty­free firmware license to use and distribute the binary firmware image
provided, only to the extent necessary to use the XPort™ hardware. For
further details, please see the XPort OEM firmware license agreement.

Date Rev. Comments

11/03 C Revised for v.1.5 of the firmware. We consolidated software documentation in

this user guide; hardware information is now in the XPort Integration Guide.

If you use a previous version of the firmware, go to the Lantronix FTP site at

ftp://ftp.lantronix.com/pub to find the earlier documentation.

ii XPort™ User Guide

Contents

Copyright and Trademark _________________________________________________ i
Contacts ______________________________________________________________ i
Disclaimer and Revisions _________________________________________________ii

1: Using This Guide 1-1

Purpose and Audience _________________________________________________ 1-1
Chapter Summary _____________________________________________________ 1-1
Additional Documentation _______________________________________________ 1-2

2: Introduction 2-1

Capabilities __________________________________________________________ 2-1
Applications __________________________________________________________ 2-1
Protocol Support ______________________________________________________ 2-2
Addresses and Port Numbers ____________________________________________ 2-2

Logon Methods _______________________________________________________ 2-3

Hardware Address _________________________________________________________ 2-2
IP Address________________________________________________________________ 2-2
Port Numbers _____________________________________________________________ 2-2

3: Getting Started 3-1

Required Information ___________________________________________________ 3-1

Hardware Address _________________________________________________________ 3-1
IP Address________________________________________________________________ 3-1

Using DeviceInstaller to Assign an IP Address _______________________________ 3-2

Installing DeviceInstaller _____________________________________________________ 3-2
Assigning an IP Address_____________________________________________________ 3-2

Using Web-Manager to Configure the Unit __________________________________ 3-3
Unit Configuration Settings ______________________________________________ 3-4
Server Properties______________________________________________________ 3-6
Port Properties________________________________________________________ 3-6

Serial Port Settings _________________________________________________________ 3-6
Connect Mode Settings______________________________________________________ 3-7
Dedicated Connection_______________________________________________________ 3-7
Flush Mode Input Buffer _____________________________________________________ 3-7
Packing Algorithm __________________________________________________________ 3-8
Additional Settings _________________________________________________________ 3-8

Factory Settings_______________________________________________________ 3-9
Update Settings _______________________________________________________ 3-9

4: Using Setup Mode for Configuration 4-1

Accessing Setup Mode _________________________________________________ 4-1

Using a Telnet Connection ___________________________________________________ 4-1
Using the Serial Port ________________________________________________________ 4-2

Server Configuration (Network Configuration)________________________________ 4-4

XPort™ User Guide iii

Contents

IP Address _______________________________________________________________ 4-4
Set Gateway IP Address ____________________________________________________ 4-4
Netmask: Number of Bits for Host Part _________________________________________ 4-4
Change Telnet Configuration Password ________________________________________ 4-4
DHCP Name______________________________________________________________ 4-5

Channel 1 Configuration (Serial Port Parameters)_____________________________4-5

Baudrate_________________________________________________________________ 4-5
I/F (Interface) Mode ________________________________________________________ 4-6
Flow ____________________________________________________________________ 4-6
Port Number ______________________________________________________________ 4-6
Connect Mode ____________________________________________________________ 4-7
Remote IP Address _______________________________________________________ 4-13
Remote Port _____________________________________________________________ 4-13
DisConnMode____________________________________________________________ 4-14
Flush Mode (Buffer Flushing)________________________________________________ 4-14
Pack Control_____________________________________________________________ 4-15
DisConnTime (Inactivity Timeout) ____________________________________________ 4-16
Send Characters _________________________________________________________ 4-16
Telnet Terminal Type ______________________________________________________ 4-16
Channel (Port) Password ___________________________________________________ 4-17

E-mail Settings_______________________________________________________4-17

E-mail Setup_____________________________________________________________ 4-17
Trigger Setup ____________________________________________________________ 4-18

Expert Settings_______________________________________________________ 4-18

TCP Keepalive time in seconds ______________________________________________ 4-18
ARP Cache timeout in seconds ______________________________________________ 4-18

Security Settings _____________________________________________________ 4-19

Disable SNMP ___________________________________________________________ 4-19
SNMP Community Name ___________________________________________________ 4-19
Disable Telnet Setup ______________________________________________________ 4-19
Disable TFTP Firmware Upgrade ____________________________________________ 4-19
Disable Port 77FE (Hex) ___________________________________________________ 4-20
Disable Web Server _______________________________________________________ 4-20
Disable ECHO Ports_______________________________________________________ 4-20
Enable Encryption ________________________________________________________ 4-20
Enable Enhanced Password ________________________________________________ 4-21
Disable Port 77F0 (Hex)____________________________________________________ 4-21

Factory Defaults______________________________________________________ 4-21

Channel 1 Configuration ___________________________________________________ 4-21
Expert Settings ___________________________________________________________ 4-21
Security Settings _________________________________________________________ 4-23
E-mail Settings ___________________________________________________________ 4-23

Exit Configuration Mode________________________________________________ 4-23

5: GPIO Interface 5-1

Configurable Pins______________________________________________________5-1

Features: ________________________________________________________________ 5-1

Control Protocol _______________________________________________________ 5-2

iv XPort™ User Guide

Contents

Guidelines ________________________________________________________________ 5-2
Commands _______________________________________________________________ 5-2

Examples____________________________________________________________ 5-5

6: Updating Firmware 6-1

Obtaining Firmware ____________________________________________________ 6-1
Reloading Firmware ___________________________________________________ 6-1

Using TFTP_______________________________________________________________ 6-1
Recovering the Firmware using the Serial Port ___________________________________ 6-2

7: Monitoring the Network 7-1

Entering Monitor Mode via the Serial Port _______________________________________ 7-1
Entering Monitor Mode via the Network Port _____________________________________ 7-1
Monitor Mode Commands____________________________________________________ 7-2

8: Troubleshooting 8-1

Problems and Error Messages ___________________________________________ 8-1
Technical Support _____________________________________________________ 8-4

9: IP Addresses 9-1

Components of the IP Address ___________________________________________ 9-1

Network Portion____________________________________________________________ 9-1
Subnet Portion ____________________________________________________________ 9-2
Host Portion ______________________________________________________________ 9-2

Network Address ______________________________________________________ 9-2
Broadcast Address ____________________________________________________ 9-2
IP Subnet Mask _______________________________________________________ 9-2
Private IP Networks and the Internet_______________________________________ 9-3
Network RFCs ________________________________________________________ 9-3
Alternative Ways to Assign an IP Address __________________________________ 9-4

DHCP ___________________________________________________________________ 9-4
AutoIP ___________________________________________________________________ 9-4
ARP and Telnet____________________________________________________________ 9-5

A: Binary to Hex Conversions A-2

Connect Mode Options _________________________________________________ A-3
Disconnect Mode Options _______________________________________________A-5
Flush Mode (Buffer Flushing) Options______________________________________ A-7
Interface Mode Options ________________________________________________ A-12
Pack Control Options__________________________________________________ A-12

B: Networking Terms B-1

XPort™ User Guide v

11:: UUssiinngg TThhiiss GGuuiiddee

Purpose and Audience

This guide provides the information needed to configure, use and update the XPort™
and is intended for software developers and system integrators who are embedding
the XPort™ in their designs. The information in this guide is relevant to XPort with
firmware version 1.5 and higher.

Chapter Summary

The remaining chapters in this guide include:

2:Introduction Describes the main features of the XPort and the protocols it

3:Getting Started

4:Using Setup Mode Provides instructions for accessing Setup Mode (command line

5:GPIO Interface Provides instructions for configuring the three General Purpose I/O

6:Updating Firmware Provides instructions for obtaining the latest firmware and updating

7:Monitoring the Network Provides instructions for accessing and using the command line

8:Troubleshooting Describes common problems and error messages and how to

9:IP Addresses Provides detailed information about IP addressing and the

A: Binary to Hex Conversion Provides tables for converting from binary numbers to the

supports.

Provides information for getting your unit up and running, using
DeviceInstaller to assign an IP address, and Web-Manager to set
parameters such as port and server properties.

interface) using a Telnet connection through the network or a
terminal or terminal emulation program through the serial port.
Details the parameters that you must configure.

pins (CP1-3).

the XPort.

interface for monitoring the network and diagnosing problems.

contact Lantronix Technical Support.

components of an IP address.

hexadecimal notation needed when setting some parameters.

B: Networking Terms Defines common networking terms.

XPort™ User Guide 1-1

Using This Guide

Additional Documentation

The following guides are available on the product CD and the Lantronix web site
(

www.lantronix.com)

XPort Quick Start

XPort Integration Guide

DeviceInstaller User Guide

Com Port Redirector User Guide

Creating Custom Web Pages

Provides the steps for getting the XPort
evaluation board up and running.

Provides information about the XPort
hardware, testing the XPort using the
evaluation board, and integrating the XPort into
your product.

Provides instructions for using the Windows-

based utility to configure the XPort and other

Lantronix device servers.

Provides information on using the Windows­based utility to create a virtual com port.

Explains the detailed requirements for adding
web services to your XPort and to other
Lantronix device servers.

1-2 XPort™ User Guide

22:: IInnttrroodduuccttiioonn

This chapter familiarizes you with what the XPort device server can do and some
basic information you need to know before you get started.

Topic Page

Capabilities 2-1

Applications 2-1

Protocol Support 2-2

Addresses and Port Numbers 2-2

Logon Methods 2-3

Capabilities

The XPort device server has the following capabilities:

 Connects devices through a TCP data channel or through a Telnet

connection to computers or to another device server. The XPort can also
send UDP datagrams.

 Contains a web [HTTP] server that allows presentation of custom content

and easy configuration through the browser.

 Has three programmable IO pins that can be used to monitor or control

attached devices.

Applications

The XPort device server connects serial devices such as those listed below to
Ethernet networks using the IP protocol family.

 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
 Time/attendance clocks and terminals

XPort™ User Guide 2-1

Introduction

Protocol Support

The XPort device server uses the Internet Protocol (IP) for network communications.
It uses the Transmission Control Protocol (TCP) to assure that no data is lost or
duplicated, and that everything sent to the connection arrives correctly at the target.

Other supported protocols include:

 ARP, UDP, TCP, ICMP, Telnet, TFTP, AutoIP, DHCP, HTTP, and SNMP for

network communications and management.

 TCP, UDP, and Telnet for connections to the serial port.
 TFTP for firmware and web page updates.
 IP for addressing, routing, and data block handling over the network.
 User Datagram Protocol (UDP) for typical datagram applications in which

devices interact with other devices without maintaining a point-to-point
connection.

 SMTP for e-mail transmission.

Addresses and Port Numbers

Hardware Address

The hardware address is also referred to as the Ethernet 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.

Example: 00-20-4A-14-01-18

IP Address

Every device connected to an IP network must have a unique IP address. This
address is used to reference the specific unit. (See 9:IP Addresses for further
explanation of IP addresses.)

Port Numbers

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 phone 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 XPort™ User Guide

Logon Methods

For the unit to operate correctly on a network, it must have a unique IP address on
the network. There are three basic methods for logging into the device server and
assigning the IP address:

DeviceInstaller: You manually assign the IP address using a graphical user interface

(GUI) on a PC attached to a network. (See 3:Getting Started.)

Network Port Login: Make a Telnet connection to the network port (9999). (See

4:Using Setup Mode.)

Serial Port Login: Connect a terminal or a PC running a terminal emulation program
to the unit’s serial port (CH 1). (See 4:Using Setup Mode.)

Introduction

XPort™ User Guide 2-3

33:: GGeettttiinngg SSttaarrtteedd

This chapter covers the steps for getting the XPort device server online and working.
It includes the following topics:

Topic Page

Required Information 3-1

Using DeviceInstaller to Assign an IP Address 3-2

Using Web-Manager to Configure the Unit 3-3

Unit Configuration Settings 3-4

Server Properties 3-6

Port Properties 3-6

Factory Settings 3-9

Update Settings 3-9

Required Information

Hardware Address

You need to know the unit’s hardware address (also known as MAC address), which
is on the product label. It is in the format: 00-20-4a-XX-XX-XX, where the XXs are
unique numbers assigned to the product.

Hardware Address: 00-20-4a-_____-_____-_____

IP Address

Your XPort must have a unique IP address on your network. The systems
administrator generally provides the IP address and corresponding subnet mask and
gateway. The IP address must be within a valid range, unique to your network, and in
the same subnet as your PC.

IP Address: _______ _______ _______ _______

Subnet Mask: _______ _______ _______ _______

Gateway: _______ _______ _______ _______

XPort™ User Guide 3-1

Getting Started

Using DeviceInstaller to Assign an IP Address

The unit’s IP address must be configured before it can work correctly on a network.
You have several options for assigning an IP to your unit. We recommend that you
manually assign the IP address over the network using DeviceInstaller software,
which is on the product CD.

Note: For information about the other methods, see 9:IP Addresses. If you want to

use a serial connection instead of an Ethernet connection to configure the device,
see Using the Serial Port on page 4-2.

Installing DeviceInstaller

1. Open DeviceInstaller on the CD-ROM.

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, Launch.exe (e.g.,

D:\Launch.exe).

2. Respond to the installation wizard prompts.

Note: For more information about DeviceInstaller, see the DeviceInstaller User Guide

on the product CD and the DeviceInstaller help file.

Assigning an IP Address

The unit’s IP address is normally set to 0.0.0.0 at the factory. The hardware address
is on the product label. The unit is DHCP enabled as the default.

To manually assign an IP address:

1.

Click StartPrograms  LantronixDeviceInstallerDeviceInstaller. If your

PC has more than one network adapter, a message displays. Select an adapter

and click OK

Note: If the unit already has an IP address (e.g., DHCP has assigned an

IP address), click the Search icon and select the unit from the list of
Lantronix device servers on the local network.

2. Click the Assign IP icon

3. If prompted, enter the hardware address (on the product label) and click Next.

4. Select Assign a specific IP address and click Next.

5. Enter the IP address. The Subnet mask displays automatically based on the IP

address; if desired, you may change it. On a local network, you can leave the

Default gateway blank (all zeros). Click Next.

.

.

6. Click the Assign pushbutton and wait several seconds until a confirmation
message displays. Click Finish.

3-2 XPort™ User Guide

7. Select the XPort from the main window list and click ToolsPing. The results

display in the Status area. Click the Clear Status button to clear the window so

you can ping the device again.

Note: If you do not receive “Reply” 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.

8. Click the Close pushbutton.

Using Web-Manager to Configure 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.

The unit’s configuration is stored in nonvolatile memory and is retained without
power. You can change the configuration at any time. The unit performs a reset after
you change and store the configuration.

In this chapter, we describe how you can configure the XPort using Web-Manager,
Lantronix’s browser-based configuration tool. (For information on using Setup Mode,
our command line configuration interface, see 4:Using Setup Mode on page 4-1. )

Getting Started

Note: The examples in this section show a typical device. Your device may

have different configuration options.

To configure the unit:

1. Open DeviceInstaller.

2. Click the Search icon

displays.

3. Select the unit and click the Web icon

Device menu.

The Lantronix Web-Manager window displays in your browser.

Note: You can also open your JAVA enabled web browser and enter the

IP address of the XPort to open Web-Manager.

. A list of Lantronix device servers on the network

, or select Web Pages from the

XPort™ User Guide 3-3

Getting Started

Figure 1-1. Lantronix Web-Manager

On the left, Web-Manager has the following menu options (pushbuttons):

 Unit Configuration
 Server Properties
 Port Properties
 Factory Settings1
 Update Settings
 Select Channel

4. Use the Menu to navigate to sub pages where you can configure server settings.

5. When you are finished, click the Update Settings button to save your settings.

Notes:

 The next chapter, 4:Using Setup Mode, explains the configuration settings in

detail.

 You must use Setup Mode to configure e-mail, expert, and security settings.

You must use DeviceInstaller for the configurable pins’ settings.

Unit Configuration Settings

Click the Unit Configuration button to display the following page. This page contains

the Server Configuration and the Port Configuration settings. These are the current
settings read from the device.

Note: The following examples represent typical web pages. See the

Lantronix web site for the latest version.

3-4

The following figure shows the information available on the Unit Configuration web
page.

XPort™ User Guide

Figure 1-3. Unit Configuration Web Page

Getting Started

XPort™ User Guide 3-5

Getting Started

Server Properties

You can change the server properties by editing any of the fields. Holding the cursor
over a field displays a help message for that field. If you change the IP address, you
must enter the new IP address in the browser to reload the page.

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: You do not need a password to access the Setup Mode window via a

serial connection.

Port Properties

Serial Port Settings

Serial Protocol

Speed
Character Size
Parity
Stop Bit
Flow Control

RS232

Note: RS-232 is the only available option for XPort.

300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200, 230400

8, 7

None, Even, Odd

1,2

None, XON/XOFF, XON/XOFF Pass Characters to Host, CTS/RTS
(Hardware)

3-6 XPort™ User Guide

Connect Mode Settings

Getting Started

UDP Datagram Mode
UDP Datagram Type
Incoming Connection

Response
Startup

Enable, Disable

User Selectable

Accept unconditional, Accept incoming/DTR, Never accept
incoming

Nothing (quiet), Character Response

No Active Connection Startup, With Any Character, With a Specific
Start Character, Manual Connection, Autostart, Modem Mode, With
Active DTR

Dedicated Connection

Remote IP Address
Remote Port
Local Port

User selectable

User selectable

User selectable (default 10001)

Flush Mode Input Buffer

On Active Connection
On Passive Connection
At Time To Disconnect

Enable, Disable

Enable, Disable

Enable, Disable

XPort™ User Guide 3-7

Getting Started

Packing Algorithm

Packing Algorithm
Packing Interval

Trailing Characters
Send Immediate After Sendchars
Sendchar Define2-Byte

Sequence
Send Character 01
Send Character 02

Additional Settings

Disconnect Mode
Check for CTRL-D to

Disconnect
Port Password
Telnet Mode
Inactivity Timeout
Inactivity Timer
Port Password

Ignore DTR, With DTR Drop

Enable, Disable

Enable, Disable

Enable, Disable

Enable, Disable

User Selectable

User selectable; Port Password must be enabled

Enable, Disable

Interval 12 ms, Interval 52 ms, Interval 250 ms, Interval
5000 ms

None, One, Two

Enable, Disable

Enable, Disable

User selectable

User selectable

3-8 XPort™ User Guide

Factory Settings

Click the Factory Settings button to set the device server back to the factory default

settings.

Note: Factory Settings resets factory settings for the channel. This option

does not change the IP address, gateway, and subnet mask to the factory
default values.

Update Settings

Click the Update Settings button to send all changed settings to the device.

Getting Started

XPort™ User Guide 3-9

44:: UUssiinngg SSeettuupp MMooddee ffoorr CCoonnffiigguurraattiioonn

You must configure the unit so that it can communicate on a network with your serial
device. You can configure it using a web browser, as described in 3:Getting Started,
or locally or remotely using the following procedures:

 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 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 menus in this section show a typical device. Your device may

have different configuration options.

This chapter includes the following topics:

Topic Page

Accessing Setup Mode 4-1

Server Configuration (Network Configuration) 4-4

Channel 1 Configuration (Serial Port Parameters) 4-5

E-mail Settings 4-17

Expert Settings 4-17

Security Settings 4-19

Factory Defaults 4-21

Exit Configuration Mode 4-23

Accessing Setup Mode

Using a Telnet Connection

To configure the unit over the network, establish a Telnet connection to port 9999.

Note: You can also use DeviceInstaller to access Telnet. Select the device

from the main window list, and click the Telnet icon
Telnet icon on the DeviceInstaller toolbar, skip steps 1 and 2.

XPort™ User Guide 4-1

. If you use the

Using Setup Mode for Configuration

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:

Note: Be sure to include a space between the IP address and 9999.

2. Click OK. The following information displays.

3. To enter the Setup Mode, press Enter within 5 seconds. The configuration

settings display, followed by the setup menu options.

Figure 4-2. Setup Menu Options

Change Setup:
0 Server configuration
1 Channel 1 configuration
3 E-mail settings
5 Expert settings
6 Security
7 Factory defaults
8 Exit without save
9 Save and exit Your choice
?

telnet x.x.x.x 9999

Figure 4-1. MAC Address

4. Select an option on the menu by entering the number of the option in the Your
choice ? field and pressing Enter.

5. To enter a value for a parameter, type the value and press Enter, or to confirm a
current value, just press Enter.

6. When you are finished, save the new configurations (option 9). The unit reboots.

Using the Serial Port

To initially configure the unit through a serial connection:

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, reset the unit, either by pushing the red reset button, or

cycling the unit's power (power off and back on). The self-test will begin. 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 resetting the unit.

3. At this point, the screen display is the same as when you use a Telnet
connection. To continue, go to step 4 in Using a Telnet Connection on page 4-1.

4-2 XPort™ User Guide

Using Setup Mode for Configuration

The figure below shows all of the configuration parameters. The remainder of this
chapter describes each parameter in detail.

Figure 4-4. Setup Mode Configuration Parameters

XPort™ User Guide 4-3