Lantronix XPort User Manual

XPort™ User Guide

Part Number 900-270

Revision E August 2004

Copyright and Trademark

© 2004, 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: www.lantronix.com/support

Sales Offices

For a current list of our domestic and international sales offices, go to the Lantronix
web site at http://www.lantronix.com/about/contact/index.html

XPort™ User Guide 2

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

A Initial release

B Updates.

11/03 C Revised for v.1.6 of the firmware.

4/04 D Information to support XPort-03.

8/04 E Added XPort-485 functionality. Updated common

settings for all models.

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.

XPort™ User Guide 3

Contents

1: Using This Guide 7

Purpose and Audience________________________________________________ 7
Chapter Summary ___________________________________________________ 7
Additional Documentation _____________________________________________ 8

2: Introduction 9

Capabilities ________________________________________________________ 9
Applications ________________________________________________________ 9
Protocol Support ___________________________________________________ 10
Addresses and Port Numbers _________________________________________ 10

Hardware Address ______________________________________________________ 10
IP Address ____________________________________________________________ 10
Port Numbers __________________________________________________________ 10

Assigning an IP Address _____________________________________________ 11

3: Getting Started 12

Required Information ________________________________________________ 12

Hardware Address ______________________________________________________ 12
IP Address ____________________________________________________________ 12

Using DeviceInstaller to Assign an IP Address ____________________________ 12

Installing DeviceInstaller _________________________________________________ 12
Assigning an IP Address _________________________________________________ 13

Using Web-Manager to Configure the Unit _______________________________ 14
Unit Configuration Settings ___________________________________________ 15
Server Properties ___________________________________________________ 16
Port Properties _____________________________________________________ 17

Connect Mode Settings __________________________________________________ 18
Dedicated Connection ___________________________________________________ 18
Flush Mode Input Buffer__________________________________________________ 18
Packing Algorithm ______________________________________________________ 19
Additional Settings ______________________________________________________ 19

Factory Settings ____________________________________________________ 20
Update Settings ____________________________________________________ 20

4: Using Setup Mode for Configuration 21

Accessing Setup Mode ______________________________________________ 21

XPort™ User Guide 4

Contents

Using a Telnet Connection ________________________________________________ 21
Using the Serial Port _____________________________________________________ 22

Server Configuration (Network Configuration)_____________________________ 24

IP Address_____________________________________________________________ 24
Set Gateway IP Address__________________________________________________ 24
Netmask: Number of Bits for Host Part_______________________________________ 24
Change Telnet Configuration Password ______________________________________ 24
DHCP Name ___________________________________________________________ 25

Channel 1 Configuration (Serial Port Parameters) _________________________ 25

Baudrate ______________________________________________________________ 25
I/F (Interface) Mode _____________________________________________________ 26
I/F Mode: XPort-485 only _________________________________________________ 26
Flow__________________________________________________________________ 27
Port Number ___________________________________________________________ 27
Connect Mode__________________________________________________________ 28
Remote IP Address______________________________________________________ 33
Remote Port ___________________________________________________________ 33
DisConnMode __________________________________________________________ 34
Flush Mode (Buffer Flushing) ______________________________________________ 34
Pack Control ___________________________________________________________ 35
DisConnTime (Inactivity Timeout) ___________________________________________ 36
Send Characters ________________________________________________________ 36
Telnet Terminal Type ____________________________________________________ 36
Channel (Port) Password _________________________________________________ 36

E-mail Settings ____________________________________________________ 37

E-mail Setup ___________________________________________________________ 37
Trigger Setup __________________________________________________________ 38

Expert Settings ____________________________________________________ 38

TCP Keepalive time in seconds ____________________________________________ 39
ARP Cache timeout in seconds ____________________________________________ 39
High CPU Performance mode _____________________________________________ 39
Monitor Mode at Bootup __________________________________________________ 39
HTTP Port Number ______________________________________________________ 39
SMTP Port Number______________________________________________________ 39
RS-485 TX Enable Active Level.____________________________________________ 39

Security Settings ___________________________________________________ 40

Disable SNMP__________________________________________________________ 40
SNMP Community Name _________________________________________________ 40
Disable Telnet Setup_____________________________________________________ 40

XPort™ User Guide 5

Contents

Disable TFTP Firmware Upgrade __________________________________________ 41
Disable Port 77FE (Hex) _________________________________________________ 41
Disable Web Server _____________________________________________________ 41
Disable ECHO Ports_____________________________________________________ 41
Enable Encryption ______________________________________________________ 41
Encryption Tutorial ______________________________________________________ 42
Enable Enhanced Password ______________________________________________ 43
Disable Port 77F0 (Hex)__________________________________________________ 43

Factory Defaults____________________________________________________ 43

Channel 1 Configuration Defaults __________________________________________ 43
Expert Settings Defaults__________________________________________________ 44
Security Settings Defaults ________________________________________________ 44
E-mail Settings _________________________________________________________ 44

Exit Configuration Mode______________________________________________ 44

5: GPIO Interface 45

Configurable Pins___________________________________________________ 45

Features: _____________________________________________________________ 45

Control Protocol ____________________________________________________ 45

Guidelines ____________________________________________________________ 46
Commands ____________________________________________________________ 46

Examples _________________________________________________________ 48

6: Updating Firmware 50

Obtaining Firmware _________________________________________________ 50
Reloading Firmware_________________________________________________ 50

Using TFTP ___________________________________________________________ 50
Recovering the Firmware Using the Serial Port and DeviceInstaller ________________ 51

7: Monitoring the Network 52

Entering Monitor Mode via the Serial Port ____________________________________ 52
Entering Monitor Mode via the Network Port __________________________________ 52
Monitor Mode Commands ________________________________________________ 52

8: Troubleshooting 54

Problems and Error Messages ________________________________________ 54
Technical Support __________________________________________________ 57

XPort™ User Guide 6

1: Using This Guide

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.

Note: This document covers XPort™ Device Server versions XP1001000-0 1,

XP1001000-03, and XP1004000-03 (XPort-485).

Chapter Summary

The remaining chapters in this guide include:

2:Introduction

3:Getting Started

4:Using Setup Mode

5:GPIO Interface

6:Updating Firmware

7:Monitoring the Network

8:Troubleshooting

Describes the main features of the XPort and the
protocols it 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.

Provides instructions for accessing Setup Mode
(command line 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.

Provides instructions for configuring the three General
Purpose I/O pins (CP1-3).

Provides instructions for obtaining the latest firmware and
updating the XPort.

Provides instructions for accessing and using the
command line interface for monitoring the network and
diagnosing problems.

Describes common problems and error messages and
how to contact Lantronix Technical Support.

XPort™ User Guide 7

Additional Documentation

The following guides are available on the product CD and the Lantronix web site
(www.lantronix.com

).

1: Using This Guide

XPort Quick Start

XPort Integration Guide

Com Port Redirector User Guide

Web Enabling Your Device
Server

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 information on using the Windows­based utility to create a virtual com port.

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

XPort™ User Guide 8

2: Introduction

This chapter summarizes the XPort device server’s features and basic information
needed before getting started.

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 also
supports UDP datagrams.

 Contains a web [HTTP] server allowing presentation of custom content and

easy configuration through the browser.

 Has three programmable I/O pins used to monitor or control attached

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

devices.

XPort™ User Guide 9

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.

2: Introduction

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.

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.

XPort™ User Guide 10

Assigning an IP Address

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:

DHCP: By default, Dynamic Host Configuration Protocol (DHCP) is enabled on the

device server. DHCP allows a DHCP server to automatically assign an IP address to
the device server. If you use DHCP, the device server is assigned a new IP address
each time it boots.

DeviceInstaller: You can manually assign the IP address using a graphical user
interface (GUI) on a PC attached to a network. (See 3:Getting Started.)

Serial Port Login: With this method, you connect a terminal or a PC running a
terminal emulation program to the unit’s serial port (CH 1). (See 4:Using Setup

Mode.)

2: Introduction

XPort™ User Guide 11

3: Getting Started

This chapter covers the steps for getting the XPort device server online and working.

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

The XPort must have a unique IP address on the 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 the network, and in the same
subnet as the PC.

IP Address: _______ _______ _______ _____ __

Subnet Mask: _______ _______ _______ _______

Gateway: _______ _______ _______ _______

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: To use a serial connection instead of an Ethernet connection to configure the

device, see Using the Serial Port on page 22.

Installing DeviceInstaller

1. Insert the product CD into your CD-ROM drive. The CD automatically starts and
displays the main window.

2. If the CD does not launch automatically:

XPort™ User Guide 12

3: Getting Started

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).

3. Click the DeviceInstaller button. The installation wizard window displays.

4. Respond to the installation wizard prompts.

Note: For more information about Device Installer, see the

DeviceInstaller User Guide on the product CD and the DeviceInstaller
online help.

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 button and wait several seconds until a confirmation message

displays. Click Finish.

7. Select the device from the main window list and select Ping from the Tools

menu. The Ping Device dialog box shows the IP address of the selected unit.

8. From the Tools menu, click the Ping button. The results display in the Status

window. 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. If you are
not sure, check with your systems administrator.

.

9. Click the Close button to close the dialog box and return to the main window.

XPort™ User Guide 13

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 21.)

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

have different configuration options.

To configure the unit:

1. Open DeviceInstaller.

3: Getting Started

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. Web-Manager works
with JAVA v1.3.1x or higher.

Figure 3-1. Lantronix Web-Manager

. A list of Lantronix device servers on the network

, or select Web Pages from the

XPort™ User Guide 14

3: Getting Started

On the left side of the screen, Web-Manager has the following menu options
(buttons):

 Unit Configuration

 Server Properties

 Port Properties

 Factory Settings1

 Update Settings

 Select Channel

4. Use the menu to navigate to subpages for the configuration of server settings.

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

Notes:

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

detail.

 Use Setup Mode to configure e-mail, expert settings, and security settings.

Use DeviceInstaller for the configurable pins’ settings.

Unit Configuration Settings

Click the Unit Configuration button to display the following page:

XPort™ User Guide 15

This page displays the current Server Configuration and the Port Configuration
settings.

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

Lantronix web site for the latest version.

Server Properties

Click the Server Properties button to display the following page:

3: Getting Started

Change the server properties by editing any of the fields. Holding the cursor over a
field displays a Help message for that field. If the IP address is changed, 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

XPort™ User Guide 16

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

Click the Port Properties button to display the following page:

3: Getting Started

Edit the following fields as necessary:

Serial Protocol

Speed

XPort™ User Guide 17

RS232

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

versions XP1001000-01 & XP1001000-03. RS-422/485 is an additional
option for XP1004000-03 (XPort-485).

300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200, and
230400
XPort-03 and greater provide high-performance mode that also supports

the baud rates 460800 and 921600 bps (see High CPU Performance mode

on page 39)

Character Size
Parity
Stop Bit
Flow Control

8, 7

None, Even, Odd

1,2

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

Connect Mode Settings

3: 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 carriage
return (C0x0D) 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

XPort™ User Guide 18