XPort Direct+, 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: 949-453-3990
Fax: 949-453-3995
Technical Support
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 www.lantronix.com/about/contact
XPort Direct+ User Guide2
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.
Date Rev. Firmware Comments
10/07 A Initial release
Contents
XPort Direct+ User Guide 3
Contents
Copyright and Trademark _____________________________________________ 2
This guide covers the Lantronix XPort Direct+. It provides the information needed to
configure, use, and update the XPort Direct+ firmware and is for OEMs and system
integrators who are embedding the XPort Direct+ in their product designs.
Chapter Summary
The remaining chapters in this guide include:
2: Introduction
3: Using DeviceInstaller
4: Configuration Using Web
Manager
5: Configuration via Telnet or
Serial Port (Setup Mode)
6: Setup Mode: Server
Configuration
7: Setup Mode: Channel
Configuration
8: Setup Mode: Advanced
Settings
9: GPIO Interface
10: Firmware Upgrades
11: Monitor Mode
12: Troubleshooting
A: Binary to Hexadecimal
Conversions
Describes the main features of the XPort Direct+ and the
protocols it supports.
Provides information for getting your unit up and running,
using DeviceInstaller to assign an IP address.
Details using the 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 network (server) settings
Details the serial port settings.
Details email, expert, and security settings and explains
how to reset the unit to factory default values.
Provides instructions for configuring the three General
Purpose I/O pins (CP1-3).
Provides instructions for obtaining the latest firmware and
updating the XPort Direct+.
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.
Provides instructions for converting binary numbers to
hexadecimals.
XPort Direct+ User Guide8
Additional Documentation
The following guides are available on the product CD and the Lantronix web site
(www.lantronix.com
).
1: About This Guide
XPort Direct+ Quick Start
XPort Direct+ Integration Guide
DeviceInstaller Online Help
Provides the steps for getting the XPort
Direct+ evaluation board up and running.
Provides information about the XPort Direct+
hardware, testing the XPort Direct+ using the
evaluation board, and integrating the XPort
Direct+ into your product.
Provides information on using DeviceInstaller
to configure IP addresses and locate
Lantronix devices on the network.
XPort Direct+ User Guide 9
2: Introduction
This chapter summarizes the XPort Direct+ device server’s features and the basic
information needed to get started.
Capabilities
The XPort Direct+ 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 Direct+ also
supports UDP datagrams.
Contains a web [HTTP] server allowing presentation of custom content and
easy configuration through a browser.
Has three programmable I/O pins used to monitor or control attached
Applications
The XPort Direct+ 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
Environmental sensors
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 Direct+ User Guide10
Protocol Support
The XPort Direct+ 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.
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 email 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
Note: Make note of the MAC address. It is needed to locate the XPort
Direct+ using DeviceInstaller.
IP Address
Every device connected to an IP network must have a unique IP address. This
address is used to reference the specific unit. The XPort Direct+ is automatically
assigned an IP address on DHCP-enabled networks, as it is DHCP-enabled by
default.
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. Ports 0-1024 are reserved as well. For more information on reserved
port numbers, see to Table 7-5. Reserved Port Numberson page 42.
XPort Direct+ User Guide 11
Configuration 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 to
assign an IP address and configure the unit:
DeviceInstaller: Assign an IP address and view the current XPort Direct+
configuration using a Graphical User Interface (GUI) on a PC attached to a network.
(See 3: Using DeviceInstaller.)
Web-Manager: Through a web interface, configure the XPort Direct+ and its settings
using the XPort Direct+ Web-Manager. (See 4: Configuration Using Web Manager.)
Serial & Telnet Ports: There are two approaches to accessing Serial Mode. Make a
Telnet connection to the network port (9999) or connect a terminal (or a PC running a
terminal emulation program) to the unit’s serial port. (See 5: Configuration via Telnet
or Serial Port (Setup Mode) )
2: Introduction
XPort Direct+ User Guide 12
3: Using DeviceInstaller
This chapter covers the steps for getting the XPort Direct+ device server online and
viewing its current configuration.
Installing DeviceInstaller
To install 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:
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 DeviceInstaller, see the
DeviceInstaller online help.
Assigning 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, see5: Configuration via Telnet or Serial Port (Setup Mode) on page 35.
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 assign an IP address manually:
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.
XPort Direct+ User Guide 13
3: Using DeviceInstaller
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.
2. Click the XPort folder. The list of available Lantronix XPort Direct+ devices
displays.
3. Expand the list of devices by clicking the + symbol next to the XPort Direct+ icon.
Select the XPort Direct+ unit by clicking on its IP address to view its
configuration.
Viewing the Current Configuration
DeviceInstaller provides a view of the unit's configuration.
To view the unit's current settings:
1. Follow the instructions above to locate the XPort Direct+.
2. In the right pane, click the Device Details tab. The current XPort Direct+
configuration displays:
Name
XPort Direct+ User Guide 14
Configurable field. A name that identifies the XPort Direct+.
Double-click the field, type in the value, and press Enter to
complete. This name is not visible on other PCs or laptops
using DeviceInstaller.
3: Using DeviceInstaller
Group
Comments
Device Family
Type Non-configurable field. Displays the device type as XPort
ID
Hardware Address
Firmware Version
Extended Firmware
Version
Online Status
Telnet Enabled
Telnet Port
Web Enabled
Web Port
Maximum Baud Rate
Supported
Firmware Upgradeable Non-configurable field. Displays True, indicating the XPort
IP Address
Number of COB
partitions supported
Supports Dynamic IP
Subnet Mask
Configurable field. A group name to categorize the XPort
Direct+. Double-click the field, type in the value, and press
Enter to complete. This group name is not visible on other
PCs or laptops using DeviceInstaller.
Configurable field. Information about the XPort Direct+.
Double-click the field, type in the value, and press Enter to
complete. This description or comment is not visible on other
PCs or laptops using DeviceInstaller.
Non-configurable field. Displays the device family type as
XPort.
Direct+.
Non-configurable field. Displays the ID embedded within the
XPort Direct+ box.
Non-configurable field. Displays the hardware (or MAC)
address of the XPort Direct+.
Non-configurable field. Displays the firmware currently
installed on the XPort Direct+.
Non-configurable field. Displays the
nomenclature of the firmware.
Non-configurable field. Displays the status of the XPort
Direct+ as online, offline, unreachable (the XPort Direct+ is on
a different subnet), or busy (the XPort Direct+ is currently
performing a task).
Non-configurable field. Permits Telnet sessions.
Non-configurable field. Displays the XPort Direct+ unit’s port
for Telnet sessions.
Non-configurable field. Permits configuration through WebManager.
Non-configurable field. Displays the XPort Direct+’s port for
Web-Manager configuration.
Non-configurable field. Displays the maximum baud rate of the
XPort Direct+. Note: the XPort Direct+ may not currently be running at this rate.
Direct+’s firmware is upgradeable as newer version become
available.
Non-configurable field. Displays the current IP address of the
XPort Direct+. To change the IP address, see Assigning an IP
Address on page 13.
Non-configurable field. Displays the number of COB partitions
supported.
Non-configurable field. Indicates whether the current IP
address on the XPort Direct+ was set manually or assigned by
DHCP.
Non-configurable field. Displays the current subnet mask of
the XPort Direct+. To change the subnet mask, see Assigning
an IP Address on page 13.
full version
XPort Direct+ User Guide 15
3: Using DeviceInstaller
Gateway
Number of Ports
TC P Keepalive Non-configurable field. Displays 1-65s, the TCP keepalive
Supports GPIO Non-configurable field. Displays True, indicating the XPort
Non-configurable field. Displays the current gateway of the
XPort Direct+. To change the gateway, see Assigning an IP
Address on page 13.
Non-configurable field. Displays the number of ports on the
XPort Direct+.
value of the XPort Direct+. The default setting is 45.
Non-configurable field. Displays True, indicating configurable
pins are available on the XPort Direct+.
are available on the XPort Direct+.
Non-configurable field. Displays False.
supports the RS-485 protocol.
Non-configurable field. XPort Direct+ supports baud rates up
to 920 Kbps.
Non-configurable field. Displays True.
Direct+ supports communication via General Purpose Input
Output (GPIO).
XPort Direct+ User Guide 16
4: Configuration Using Web Manager
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 to configure the XPort Direct+ using Web-Manager,
Lantronix’s browser-based configuration tool. (For information on using Setup Mode,
our command line configuration interface, see 5: Configuration via Telnet or Serial
Port (Setup Mode).
Note: The examples in this section show a typical device. Your device may have
different configuration options.
Accessing XPort Direct+ Using DeviceInstaller
Note: Make note of the hardware (MAC) address. You will need it to locate
the XPort Direct+ using DeviceInstaller. For more information on the
hardware address, see Hardware Address on page 11.
Follow the instructions on the product CD to install and run DeviceInstaller.
1. Click StartÆPrograms Æ LantronixÆDeviceInstallerÆDeviceInstaller. If the
PC has more than one network adapter, a message displays requesting the
selection of a network adapter. Select an adapter and click OK.
2. Click the Search icon
pane.
3. Click on the XPort Direct+ folder. The list of available XPort Direct+ units
displays.
4. Expand the list of XPort Direct+ units by clicking the + symbol next to the XPort
Direct+ icon.
5. Select the XPort Direct+ unit by clicking its hardware address.
6. In the right pane, click the Web Configuration tab.
7. To view the XPort Direct+ Web-Manager in the current DeviceInstaller window,
click the Go button. To open the Web-Manager in a web browser, click the
ExternalBrowser button.
. The list of Lantronix device servers displays in the left
XPort Direct+ User Guide17
4: Configuration Using Web Manager
Note: Alternatively, to open Web-Manager, open your web browser and
enter the IP address of the XPort Direct+. (With firmware 1.8 or earlier, your
browser must be JAVA-enabled to use Web-Manager. With firmware 6.1.0.0
and later, your web browser does not need to be JAVA-enabled.)
The XPort Direct+ prompts for a User name and Password.
Figure 4-1. Web-Manager Login Window
8. Perform one of the following:
If no Telnet password has been defined (default), leave both fields blank and
click OK.
If a Telnet password has been defined, leave the username blank, type in the
password, and then click OK.
The Web-Manager displays.
Figure 4-2. Lantronix Web-Manager
The main menu is in the left pane of the Web-Manager window.
XPort Direct+ User Guide 18
Network Configuration
The unit’s network values display when you select Network from the main menu. The
following sections describe the configurable parameters on the Network Settings
page.
4: Configuration Using Web Manager
Figure 4-3. Network Settings
Network Mode
1. Click Network from the main menu.
2. Note the following:
Network Mode
WiredOnly is the only choice. It enables the Ethernet
network connectivity.
Automatic IP Address Configuration
An IP address can be assigned automatically. You then enter related network
settings.
To assign an IP address automatically:
1. On the main menu, click Network.
2. Select Obtain IP address automatically.
3. Enter the following (as necessary):
XPort Direct+ User Guide 19
4: Configuration Using Web Manager
BOOTP Select Enable to permit the Bootstrap Protocol (BOOTP).
server to assign the IP address from a pool of addresses
automatically. Enable is the default.
DHCP Select Enable to permit the Dynamic Host Configuration
Protocol (DHCP) to assign a leased IP address to the XPort
Direct+ unit automatically. Enable is the default.
AutoIP
DHCP Host Name
Select Enable to permit the XPort Direct+ to generate an IP in
the 169.254.x.x address range with a Class B subnet. Enable
is the default.
Enter the name of the host on the network providing the IP
address.
Note: Disabling BOOTP, DHCP, and AutoIP (all three checkboxes) is not
advised as the only available IP assignment method will then be ARP or
serial port.
4. When you are finished, click the OK button.
5. On the main menu, click Apply Settings.
Static IP Address Configuration
You manually assign an IP address to the unit and enter related network settings.
To assign an IP address manually:
1. On the main menu, click Network.
2. Select Use the following IP configuration.
3. Enter the following (as necessary):
IP Address
Subnet Mask
Default Gateway
If DHCP is not used to assign IP addresses, enter it manually
in decimal-dot notation. The IP address must be set to a
unique value in the network.
A subnet mask defines the number of bits taken from the IP
address that are assigned for the host part.
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.
4. When you are finished, click the OK button.
5. On the main menu, click Apply Settings.
Ethernet Configuration
You must specify the speed and direction of data transmission.
To specify how data will be transmitted:
1. On the main menu, click Network.
2. Enter the following (as necessary):
XPort Direct+ User Guide 20
4: Configuration Using Web Manager
Auto Negotiate
3. When you are finished, click the OK button.
4. On the main menu, click Apply Settings.
Server Configuration
The unit’s server values display when you select Server from the main menu. The
following sections describe the configurable parameters on the Server Settings page.
With this option, the Ethernet port auto-negotiates the speed
and duplex with the hardware endpoint to which it is
connected. This is the default.
If this option is not selected, the complete the fields that
become available:
Speed: The speed of data transmission. The default
is 100 Mbps.
Duplex: The direction of data transmission. The
default is Full.
Figure 4-4. Server Settings
To configure the device server settings:
1. On the main menu, click Server.
2. Configure or modify the following fields:
XPort Direct+ User Guide 21
4: Configuration Using Web Manager
Server Configuration
Telnet Password
Retype Password
Enter the password required for Telnet access.
Re-enter the password required for Telnet access.
Advanced
ARP Cache Timeout
TCP Keepalive
Monitor Mode @ Bootup Select Disable to disable entry into the monitor mode using
CPU Performance Mode
HTTP Server Port
MTU Size
When the unit communicates with another device on the
network, it adds an entry into its ARP table. ARP Cache
timeout defines the number of seconds (1-600) before it
refreshes this table.
TCP Keepalive time defines how many seconds the unit waits
during an inactive connection before checking its status. If the
unit does not receive a response, it drops that connection.
Enter a value between 0 and 60 seconds. 0 disables
keepalive. The default setting is 45.
the 'yyy' or 'xx1' key sequence at startup. This field prevents
the unit from entering monitor mode by interpreting the stream
of characters that are received during the device server's
initialization at startup.
Select the XPort Direct+’s performance mode. Higher
performance settings require more energy. Regular is 48
Mhz; High is
88 Mhz. The default is Regular.
This option allows the configuration of the web server port
number. The valid range is 1-65535. The default port is 80.
The Maximum Transmission Unit (MTU) is the largest physical
packet size a network can transmit for TCP and UDP. Enter
between 512 and 1400 bytes. The default is 1400 bytes.
3. When you are finished, click the OK button.
4. On the main menu, click Apply Settings.
Host List Configuration
The XPort Direct+ scrolls through the host list until it connects to a device listed in the
host list table. After a successful connection, the unit stops trying to connect to any
others. If this connection fails, the unit continues to scroll through the table until the
next successful connection.
The host list supports a minimum of 1 and a maximum of 12 entries. Each entry
contains an IP address and a port number.
Note: The host list is disabled for Manual and Modem Mode. The unit does
not accept a data connection from a remote device when the hostlist option is
enabled.
To configure the XPort Direct+’s host list:
1. On the main menu, click Hostlist.
XPort Direct+ User Guide 22
Figure 4-5. Hostlist Settings
2. Enter or modify the following fields:
4: Configuration Using Web Manager
Retry Settings
Retry Counter
Retry Timeout
Host Information
Host Address
Port
3. When you are finished, click the OK button.
4. On the main menu, click Apply Settings.
Channel 1 Configuration
The Channel 1 configuration defines how the serial port responds to network and
serial communication.
Serial Settings
To configure the channel’s serial settings:
1. On the main menu, click Serial Settings (under Channel 1) to display the Serial
Settings window.
Enter the value for the number of times the XPort Direct+
should attempt to retry connecting to the host list.
Enter the duration (in seconds) the XPort Direct+ should
abandon attempting a connection to the host list.
Enter or modify the host’s IP address.
Enter the target port number.
XPort Direct+ User Guide 23
4: Configuration Using Web Manager
Figure 4-6. Channel Serial Settings
2. In the available fields, enter the following information:
Channel 1
Disable Serial Port
When selected, disables communication through the serial
port. The serial port is enabled by default.
Port Settings
Protocol
Flow Control
Baud Rate
Data Bits
Parity Checks for the parity bit. The default is None.
Stop Bits
From the drop-down menu, select the protocol type for the
selected channel.
Flow control manages data flow between devices in a network
to ensure it is processed efficiently. Too much data arriving
before a device is prepared to manage it causes lost or
retransmitted data. None is the default.
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, 115200, 230400, 460800, or
921600.
Indicates the number of bits in a transmitted data package.
The default is 8.
The stop bit follows the data and parity bits in serial
communication. It indicates the end of transmission. The
default is 1.
XPort Direct+ User Guide 24
Loading...
+ 56 hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.