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
Pack Control
Enable Packing
Idle Gap Time
Match 2 Byte Sequence
Match Bytes
Send Frame Immediate
Send Trailing Bytes
4: Configuration Using Web Manager
Select to enable packing on the XPort Direct+.
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.
Disabled by default.
Select the maximum time for inactivity. The default time is
12 milliseconds.
Use to indicate the end of a series of data to be sent as one
group. The sequence must occur sequentially to indicate end
of the data collection to the XPort Direct+. The default is No.
Use to indicate the end of a series of data to be sent as one
group. Set this value to 00 if specific functions are not needed.
After the detection of the byte sequence, indicates whether to
send the data frame or the entire buffer. Select Yes to send
only the data frame. The default setting is No.
Select the number of bytes to send after the end-of-sequence
characters. The default is None.
Flush Input Buffer (Serial to Network)
With Active Connect Select Yes to clear the input buffer with a connection that is
initiated from the device to the network. The default is No.
With Passive Connect Select Yes to clear the input buffer with a connection initiated
from the network to the device. The default is No.
At Time of Disconnect Select Yes to clear the input buffer when the network
connection to or from the device is disconnected. The default
is No.
Flush Output Buffer (Network to Serial)
With Active Connect Select Yes to clear the output buffer with a connection that is
initiated from the device to the network. The default is No.
With Passive Connect Select Yes to clear the output buffer with a connection initiated
from the network to the device. The default is No.
At Time of Disconnect Select Yes to clear the output buffer when the network
connection to or from the device is disconnected. The default
is No.
3. When you are finished, click the OK button.
4. On the main menu, click Apply Settings.
XPort Direct+ User Guide 25
4: Configuration Using Web Manager
Connection Settings - TCP
To configure a channel’s TCP settings:
1. On the main menu, click Connection. The Connection Settings window for the
channel displays.
Figure 4-7. TCP Connection Settings
XPort Direct+ User Guide 26
4: Configuration Using Web Manager
2. In the available fields, enter or modify the following information:
Connect Protocol
Protocol From the drop-down menu, select TCP.
Connect Mode: Passive Connection
Accept Incoming Select Yes to accept incoming connections. The default is
Yes.
Password Required
Password If Password Required was set to Yes, enter the password for
Determines whether a password is required for an incoming
passive connection. This field is not available when a
password is set for Telnet mode.
passive connections.
Connect Mode: Active Connection
Active Connect Select None to disable Active Connect. Otherwise, indicate
the connection type from the drop-down list:
With Any Character: Attempts to connect when any
character is received from the serial port.
With Active Mdm Ctrl In: Accepts external connection
requests only when the modem_control_in input is
asserted.
With Start Character: Attempts to connect when it
receives a specific start character from the serial port.
The default start character is carriage return.
Manual Connection: Attempts to connect when directed
by a command string received from the serial port.
Auto Start: Automatically connects to the remote IP
address and port after booting up.
Start Character If Active Connect is set to With Start Character, enter the
start character in this field.
Modem Mode
Show IP Address After
Ring
Indicates the on-screen response type when in Modem Mode
(if Modem Mode is enabled).
Indicates whether to display the remote IP address upon
connection. The default setting is Yes.
Endpoint Configuration
Local Port
Auto increment for
active connect
Remote Port
Remote Host
XPort Direct+ User Guide 27
Enter the local port number.
Select to auto-increment the local port number for new
outgoing connections. The range of auto-incremented port
numbers is 50,000 to 59,999 and loops back to the beginning
when the maximum range is reached.
Enter the remote port number.
Enter the IP address of the remote device.
4: Configuration Using Web Manager
Common Options
Telnet Com Port Cntrl This field is available for configuration only when Active
Connect is set to None. Select Enable to permit Telnet
communication to the unit. The Telnet Com Port Cntrl
feature is used in conjunction with the Com Port Redirector
(CPR) utility. (See the CPR online Help for details.)
Terminal Name
Connect Response
Use Hostlist If this option is set to True, the device server scrolls through
LED Select Blink for the status LEDs to blink upon connection or
This field is available for configuration only when Telnet Mode
is set to Enable.
Use the terminal name for the Telnet terminal type. Enter only
one name. When this option is enabled, the unit also reacts to
the end of record (EOR) and binary options, which can be
used for applications such as terminal emulation to IBM hosts.
A single character is transmitted to the serial port when there
is a change in connection state. Default setting is None.
the host list until it connects to a device listed in the host list
table. Once it connects, the unit stops trying to connect to any
others. If this connection fails, the unit continues to scroll
through the table until it connects to another IP in the host list.
The host list is disabled for Manual Mode and for Modem
Mode. The unit will not accept a data connection from a
remote device when the host list option is enabled.
None for no LED output.
Disconnect Mode
On Mdm_Ctrl_In Drop Set to Yes for the network connection to or from the serial port
to disconnect (drop) when Modem Control In transitions from
an asserted state to not asserted state. The default setting is
No.
Hard Disconnect When set to Yes, the TCP connection closes even if the
remote site does not acknowledge the disconnect request.
Check EOT (Ctrl-D)
Inactivity Timeout
Select Yes to drop the connection when Ctrl-D or Hex 04 is
detected. Both Telnet Com Port Cntrl and Check EOT (Ctrl+ D) must be enabled for Disconnect with EOT to
function properly. Ctrl+D is only detected going from the serial
port to the network. The default setting is No.
Use this parameter to set an inactivity timeout. The unit drops
the connection if there is no activity on the serial line before
the set time expires. Enter time in the 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. When you are finished, click the OK button.
4. On the main menu, click Apply Settings.
Connection Settings - UDP
To configure a channel’s UDP settings:
1. On the main menu, click Connection. The Connection Settings window for the
selected channel displays.
XPort Direct+ User Guide 28
4: Configuration Using Web Manager
2. In the available fields, enter or modify the following information:
Figure 4-8. UDP Connection Settings
Connect Protocol
Protocol Select UDP from the drop-down menu.
Datagram Mode
Datagram Type
Accept Incoming Select Yes to accept incoming UDP datagrams.
Configures the remote IP or network broadcast address and
the remote port. Enter 01 for directed or broadcast UDP. The
default setting is 00.
Endpoint Configuration
Local Port
Remote Port
Remote Host
Use Broadcast
Device Address Table The table is enabled when Datagram Type is set to FD. Enter
Enter the local port number.
Enter the port number of the remote device.
Enter the IP address of the remote device.
Select to broadcast the UDP datagram. The default is not to
broadcast.
Note: Datagrams are sent as subnet-directed broadcasts.
values between 1 and 255 to identify units on the local
network of device servers.
Note: Lantronix Tech Support supports Datagram type 01.
Datagram Type FD is for OEM use.
3. When you are finished, click the OK button.
4. On the main menu, click Apply Settings.
XPort Direct+ User Guide 29
Email Settings
The unit sends an email to multiple recipients when a specific trigger event occurs.
There are three separate triggers, based on any combination of the configurable pins
selected as user I/O functions. Optionally, use a two-byte serial string to initiate a
trigger. Each trigger is independent of the others. Each condition within an individual
trigger must be met before the unit will send the email.
To configure the email settings of the XPort Direct+:
1. On the main menu, select Email. The Email Settings window opens.
4: Configuration Using Web Manager
Figure 4-9. Email Settings
2. Configure the following fields:
Server IP Address
Server Port
Domain Name
Unit Name
Enter the IP address of the mail server.
Enter the port number on the email server.
Enter the email server’s domain name.
Enter the user name used by the XPort Direct+ to send email
messages.
Recipients
Recipient 1: Email
Address
Recipient 2: Email
Address
Enter the email address designated to receive email
notifications.
Enter an additional email address designated to receive email
notifications.
3. When you are finished, click the OK button.
4. On the main menu, click Apply Settings.
Trigger Configuration
A trigger event occurs when the unit receives the specified trigger input resulting from
a specified combination of conditions on the configurable pins.
XPort Direct+ User Guide 30
4: Configuration Using Web Manager
Set the configurable pins to Active, Inactive, or None. The configurable pins are
disabled if they are all set to None. If both the serial sequence and the configurable
pins are disabled, the trigger is disabled.
To configure the email trigger settings of the XPort Direct+:
1. On the main menu, click Trigger 1, Trigger 2, or Trigger 3 to configure the
desired trigger settings. The Email Trigger Settings page opens.
Figure 4-10. Email Trigger Settings
2. Configure or modify the following fields:
Conditions
Configurable Pins
Enable Serial Trigger
Input
Channel
Data Size
Match Data
Select the condition from the drop-down menu for the
configurable pins. Repeat for each Trigger Input field.
Enabling this option causes specified serial communications
to count as a trigger input.
Select the channel prompting the trigger. For the XPort
Direct+, there is only one channel.
Select the data size prompting the trigger.
Enter the data, which, when it appears in the communication
stream, prompts a trigger.
Note: All of the conditions must match for the XPort Direct+ to send an email
notification.
Message Properties
Message
Priority
Notification Interval
The subject line of the trigger event email to the specified
recipient(s).
The priority level for the email.
The minimum time allowed between individual triggers. If a
trigger event occurs within the minimum interval since the last
trigger, it is ignored.
XPort Direct+ User Guide 31
4: Configuration Using Web Manager
Re-notification Interval
3. When you are finished, click the OK button.
4. On the main menu, click Apply Settings.
Configurable Pin Settings
There are threeconfigurable hardware pins on the XPort Direct+ unit. For each pin,
configure the pin function, communication direction, and activity level. For more
information, see 9: GPIO Interface.
To configure the XPort Direct+’s Configurable Pins:
1. On the main menu, click Configurable Pins. The Configurable Pins page opens.
Figure 4-11. Configurable Pins Settings
Indicates the time interval in which a new email message is
sent to the recipient(s) when a single trigger event remains
active.
2. Configure or modify the following fields for each pin:
Function
Direction
Active Level Select the signal active level (Low or High).
From the drop-down menu, select the purpose of the specified
pin. See Configurable Pin Functions (below) for a description
of each available function.
Select whether the pin inputs or outputs.
Configurable Pin Functions
General Purpose I/O
Modem Ctrl In
Monitors input using the 77F0 port or controls output by the
77F0 port.
Allows for control of the connection (and disconnection) of
channel 1.
3. When you are finished, click the OK button.
4. On the main menu, click Apply Settings.
XPort Direct+ User Guide 32
Apply Settings
1. To save and apply the configuration changes to the device server, click the
Apply Settings button.
Note: Clicking OK on each page does not change the configuration on
the device. OK tells the XPort Direct+ what changes to use; Apply
Settings makes the changes permanent and reboots the XPort Direct+.
2. Click Yes to set factory settings or click No to cancel.
Apply Factory Defaults
Click the Apply Factory Defaults button to set the device server back to the default
settings. For details see Default Settings on page 61.
4: Configuration Using Web Manager
XPort Direct+ User Guide 33
5: Configuration via Telnet or Serial Port
(Setup Mode)
You must configure the unit so that it can communicate on a network with your serial
device. As an alternative to using a web browser, as described in the previous
chapter, you can use the following procedures remotely or locally:
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 series of prompts at which you enter configuration settings is called Setup Mode.
Note: Detailed information about other setup methods is available from your
Lantronix Sales Associate.
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.
This chapter tells you how to access Setup Mode and the general procedure for
using it. To complete the configuration, continue with 6: Setup Mode: Server
Configuration, 7:Setup Mode: Channel Configuration, and 8:Setup Mode: Advanced
Settings.
Note: The menus in the configuration chapters show a typical device. Your
device may have different configuration options.
Accessing Setup Mode
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 Configuration tab. Skip
steps 1 and 2.
XPort Direct+ User Guide 34
5: Configuration via Telnet or Serial Port (Setup Mode)
To establish a Telnet connection:
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:
Windows: telnet x.x.x.x 9999
UNIX: telnet x.x.x.x:9999
2. Click OK. The following information displays.
Figure 5-1. MAC Address
3. To enter Setup Mode, press Enter within 5 seconds. The configuration settings
display, followed by the Change Setup menu.
Figure 5-2. Setup Menu Options
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 configuration (option 9). The unit reboots.
Serial Port Connection
To 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. Set the terminal emulator to 9600 baud, 8 bits, no parity, 1-stop bit, no-flow control.
Note:The XPort Direct+ always uses the serial settings above at boot
time.
2. 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.
XPort Direct+ User Guide 35
3. Reset the XPort Direct+ unit by cycling the unit's power (turning the power off
and back on). Immediately upon resetting the device, 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. You must do this within three seconds of resetting the XPort Direct+.
At this point, the screen display is the same as when you use a Telnet connection. To
continue, go to step 4 in Telnet Connection, above.
Exiting Setup Mode
To exit setup mode:
You have two options:
To save all changes and reboot the device, select option 9 Save and exit
from the Change Setup menu. All values are stored in nonvolatile memory.
To exit the configuration mode without saving any changes or rebooting.
select option 8 Exit without save from the Change Setup menu.
5: Configuration via Telnet or Serial Port (Setup Mode)
XPort Direct+ User Guide 36
6: Setup Mode: Server Configuration
This chapter explains how to configure the network settings.
Note: Current values display in parentheses.
Server Configuration (Option 0)
The unit’s basic network parameters display when you select Server configuration
(option 0). The IP Address, Set Gateway IP Address, and Netmask fields display
the current values.
IP Address : (000) .(000) .(000) .(000)
Set Gateway IP Address (N)
Netmask: Number of Bits for Host Part (0=default) (0)
Change telnet config password (N)
IP Address
If DHCP is not used to assign IP addresses, enter the IP address manually. The IP
address must be set to a unique value in the network. Enter each octet and press
Enter between each section. The current value displays in parentheses.
If DHCP is used, the third octet of the IP address sets the BootP/DHCP/AutoIP
options. The following table shows the bits you can manually configure to force the
XPort Direct+ to disable AutoIP, DHCP, or BootP. To disable an option, set the
appropriate bit.
For example, if the third octet is 0.0.5.0, the AutoIP and BootP options are disabled;
only DHCP is enabled. (The value 5 results from adding the binary equivalents of 0
and 2.) This is the most common setting when using DHCP.
IP Address : ( 0) ( 0) ( 0) ( 0) _
Table 6-1. BootP/DHCP/AutoIP options
Options Bit
AutoIP 0
DHCP 1
BootP 2
XPort Direct+ User Guide37
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. The
default is N (No), meaning the gateway address has not been set. To set the gateway
address, type Y and enter the address.
Set Gateway IP Address (N) ? Y
Gateway IP addr ( 0) ( 0) ( 0) ( 0)_
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 part.
Netmask: Number of Bits for Host Part (0=default) (0) _
Note: Class A: 24 bits; Class B: 16 bits; Class C: 8 bits
6: Setup Mode: Server Configuration
The unit prompts for the number of host bits to be entered, then calculates the
netmask, which appears in standard decimal-dot notation (for example,
255.255.255.0) when the saved parameters display.
Table 6-2. 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
Change Telnet Configuration Password
Setting the Telnet configuration password prevents unauthorized access to the setup
menu through a Telnet connection to port 9999 or through web pages. The password
must have 4 characters.
Change telnet config password (N) ? _
An enhanced password setting (for Telnet access only) of 16 characters is available
under Security Settings (Option 6) on page 59.
Note: You do not need a password to access the Setup Mode window by a
serial connection.
DHCP Name
If a DHCP server has automatically assigned the IP address and network settings,
you can discover the unit by using the DeviceInstaller network search feature.
There are three methods for assigning DHCP names to the unit.
XPort Direct+ User Guide 38
6: Setup Mode: Server Configuration
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 defaults 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.
Custom DHCP Name: You can create your own DHCP name. If you are
using an IP address of 0.0.0.0, then the last option in Server configuration is
Change DHCP device name. This option allows you to change the DHCP
name to an alphanumeric name (LTX in our example).
Change DHCP device name (not set) ? (N) Y
Enter new DHCP device name : LTX
Numeric DHCP Name: You can change the DHCP name by specifying the
last octet of the IP address. When you use this method, the DHCP name is
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 is LTX12. This
method only works with 2 digit numbers (01-99).
XPort Direct+ User Guide 39
7: Setup Mode: Channel Configuration
This chapter explains how to configure the serial port.
Notes:
Current values display in parenthesis.
You must enter some values in hexadecimal notation. (See A: Binary to
Hexadecimal Conversions.)
Channel 1 (Option 1)
Select Channel 1 (option 1) from the Change Setup menu to define how the serial
port responds to network and serial communications. The following sections describe
the configurable parameters within the Channel configuration menu.
Figure 7-1. Serial Port Parameters
XPort Direct+ User Guide 40
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, 115200, and 230400 bits per second.
XPort Direct+ and later models also support high-performance baud rates of 460800
and 921600 bits per second (see CPU Performance on page 57).
Baudrate (9600) ? _
I/F (Interface) Mode
The Interface (I/F) Mode is a bit-coded byte entered in hexadecimal notation.
I/F Mode (4C) ? _
The following table displays available I/F Mode options:
Note: All bit positions in the table that are blank represent “don’t care” bits
for that particular option, which can be set to either a 0 or 1 value.
7: Setup Mode: Channel Configuration
Table 7-1. Interface Mode Options
I/F Mode Option 7 6 5 4 3 2 1 0
RS-232C
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) 2 stop bits are implemented by the software. This might influence performance.
(1)
0 0
(1)
1 1
The following table demonstrates how to build some common Interface Mode
settings:
Table 7-2. Common Interface Mode Settings
Common I/F Mode Setting Binary Hex
RS-232C, 8-bit, No Parity, 1 stop bit 0100 1100 4C
RS-232C, 7-bit, Even Parity, 1 stop bit 0111 1000 78
Additional settings for RS-422 4-wire and RS-485 2-wire are available.
Note: All bit positions in the table that are blank represent “don’t care” bits,
for that particular option, which can be set to either a 0 or 1 value.
XPort Direct+ User Guide 41
Flow
7: Setup Mode: Channel Configuration
Table 7-3. Interface Mode Options
I/F Mode Option 7 6 5 4 3 2 1 0
RS-422/485 0 1
RS-485 2-wire 1 1
Flow control sets the local handshaking method for stopping serial input/output.
Flow (0) ? _
Use the following table to select flow control options:
Table 7-4. Flow Control Options
Flow Control Option Hex
No flow control 00
XON/XOFF flow control 01
Hardware handshake with RTS/CTS lines 02
Port Number
The setting represents the source port number in TCP connections. It is the number
that identifies the channel for remote initiating connections.
The default setting for Port 1 is 10001. The range is 1-65535, except for the following
reserved port numbers:
XON/XOFF pass characters to host 05
Port No (10001) ? _
Table 7-5. Reserved Port Numbers
Port Numbers Reserved for
1 – 1024 Reserved (well known ports)
9999 Telnet setup
14000-14009 Reserved for Redirector
30704 Reserved (77F0h)
30718 Reserved (77FEh)
Warning: We recommend that you not use the reserved port numbers
for this setting as incorrect operation may result.
Use Port 0 for the outgoing local port to change with each connection. The port range
is 50,000 to 59,999. Each subsequent connection increments the number by 1 (it
wraps back around to 50,000).
XPort Direct+ User Guide 42
Only use this automatic port increment feature to initiate a connection using TCP. Set
the port to a non-zero value when the unit is in a passive mode or when using UDP
instead of TCP.
Connect Mode
Connect Mode defines how the unit makes a connection, and how it reacts to
incoming connections over the network.
ConnectMode (C0) ? _
Enter Connect Mode options in hexadecimal notation.
Note: All bit positions in the table that are blank represent “don’t care” bits,
for that particular option, which can be set to either a 0 or 1 value.
Connect Mode Option 7 6 5 4 3 2 1 0
a) Incoming Connection
7: Setup Mode: Channel Configuration
Table 7-6. Connect Mode Options
Never accept incoming 0 0 0
Accept with active Modem Control In 0 1 0
Always Accept 1 1 0
b) Response
Nothing (quiet) 0
Character response (C=connect,
D=disconnect, N=unreachable)
c) Active Startup
No active startup 0 0 0 0
With any character 0 0 0 1
With active Modem Control In 0 0 1 0
With a specific start character 0 0 1 1
Manual connection 0 1 0 0
Autostart 0 1 0 1
Hostlist 0 0 1 0
1
d) Datagram Type
Directed UDP 1 1 0 0
e) Modem Mode
No Echo 0 0 1 1
XPort Direct+ User Guide 43
7: Setup Mode: Channel Configuration
Connect Mode Option 7 6 5 4 3 2 1 0
Data Echo & Modem Response
(Numeric)
Data Echo & Modem Response
(Verbose)
Modem Response Only (Numeric) 0 0 1 1 1 1
Modem Response Only (Verbose) 0 0 1 1 1 0
0 1 1 1 1
0 1 1 1 0
a) Incoming Connection
Never Accept Incoming
Accept with active
Modem Control In
Always Accept
Rejects all external connection attempts.
Accepts external connection requests only when the Modem Control In input is asserted. Cannot be used with Modem
Mode.
Accepts any incoming connection when a connection is not
already established. Default setting.
b) Response
Character Response
A single character is transmitted to the serial port when there is a
change in connection state:
C = connected, D = disconnected, N = host unreachable.
The IP address of the host connecting to the CoBos device will
be provided when you use verbose mode.
This option is overridden when the Active Start Modem Mode
or Active Start Host List is in effect. Default setting is Nothing
(quiet).
c) Active Startup
No Active Startup
With Any Character
With active Modem
Control In
With a Specific Start
Character
Does not attempt to initiate a connection under any
circumstance. Default setting.
Attempts to connect when any character is received from the
serial port.
Attempts to connect when the Modem Control In input changes
from not asserted to asserted.
Attempts to connect when it receives a specific start character
from the serial port. The default start character is carriage return.
XPort Direct+ User Guide 44
7: Setup Mode: Channel Configuration
Manual Connection
Attempts to connect when directed by a command string
received from the serial port. The first character of the command
string must be a C (ASCII 0x43), and the last character must be
either a carriage return (ASCII 0x0D) or a line feed (0x0A). No
blanks or space characters may be in the command string.
Between the first and last command string characters must be a
full or partial destination IP address and may be a destination
port number.
The IP address must be in standard decimal-dot notation and
may be a partial address, representing the least significant 1, 2,
or 3 bytes of the remote IP address. The period is required
between each pair of IP address numbers.
If present, the port number must follow the IP address, must be
presented as a decimal number in the range 1-65535, and must
be preceded by a forward slash (ASCII 0x2F). The slash
separates the IP address and the port number. If you omit the
port number from a command string, the internally stored remote
port number starts a connection.
If a partial IP address is presented in a command string, it is
interpreted to be the least significant bytes of the IP address and
uses the internally stored remote IP address to provide the most
significant bytes of the IP address. If the IP address entered is
0.0.0.0/0, the device server enters Monitor Mode.
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.
Figure 7-2. 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
C5 Connects to 129.1.2.5, port 1234
C28.10/12 Connects to 129.1.28.10, port 12
C0.0.0.0/0 Enters Monitor Mode
Autostart (Automatic
Connection)
Hostlist
Complete override; connection is started with host 121.2.4.5,
port 1
If you enable Autostart, the unit automatically connects to the
remote IP address and remote port specified when the firmware
starts.
If you enable this option, the device server scrolls through the
hostlist until it connects to a device listed in the hostlist table.
Once it connects, the unit stops trying to connect to any others. If
this connection fails, the unit continues to scroll through the table
until it is able to connect to another IP in the hostlist.
Hostlist supports a minimum of 1 and a maximum of 12 entries.
Each entry contains the IP address and the port number.
The hostlist is disabled for Manual and Modem Modes. The unit
does not accept a data connection from a remote device when
the hostlist option is enabled.
XPort Direct+ User Guide 45
7: Setup Mode: Channel Configuration
Figure 4-7. Hostlist Option
To enable the hostlist:
1. Enter a Connect Mode of 0x20 (2X), where X is any digit. The menu shows you
a list of current entries already defined in the product.
2. To delete, modify, or add an entry, select Yes. If you enter an IP address of
0.0.0.0, that entry and all others after it are deleted.
3. After completing the hostlist, repeat the previous step if necessary to edit the
hostlist again.
4. For Retrycounter, enter the number of times the Lantronix unit should try to
make a good network connection to a hostlist entry that it has successfully
ARPed. The range is 1-15, with the default set to 3.
5. For Retrytimeout, enter the number of seconds the unit should wait before
failing an attempted connection. The time is stored as units of milliseconds in the
range of 1-65535. The default is 250.
XPort Direct+ User Guide 46
d) Datagram Type
7: Setup Mode: Channel Configuration
Directed UDP
When selecting this option, you are prompted for the Datagram type.
Enter 01 for directed or broadcast UDP. Datagrams of type 01 can be
sent as a broadcast by enabling the Send as Broadcast option. The
default is not to broadcast.
When the UDP option is in effect, the unit never attempts to initiate a
TCP connection because it uses UDP datagrams to send and receive
data.
e) Modem Mode
In Modem (Emulation) 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 XPort Direct+ units, and to use an Ethernet connection instead
of a phone call. By not having to change communications applications, you avoid
potentially expensive phone calls.
To select Modem Mode, set the Connect Mode to C6 (no echo), D6 (echo with full
verbose), D7 (echo with numeric response), CF (modem responses only, numeric
response), or CE (modem responses only, full verbose).
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), D7 (echo with numeric
response, CF (modem responses only, numeric response), or CE (modem
responses only, full verbose).
Without Echo
Data Echo & Modem
Response
Modem Responses
Only
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 (without echo) refers to the modem not
sending an answer to the commands received (or displaying what
was typed).
Full Verbose: The unit echoes modem commands and responds to
a command with a message string shown in the table below.
Numeric Response: The unit echoes modem commands and
responds to a command with a numeric response.
Full Verbose: The unit does not echo modem commands and
responds to a command with a message string shown in the table
below.
Numeric Response: The unit does not echo modem commands
and responds to a command with a numeric response.
XPort Direct+ User Guide 47
7: Setup Mode: Channel Configuration
Table 4-11. Modem Mode Messages
Message Meaning
Full Verbose
OK Command was executed without error.
CONNECT A network connection has been established.
NO CARRIER A network connection has been closed.
RING n.n.n.n.
Numeric Response
0 OK
1 Connected
2 Ring
3 No Carrier
4 Error
A remote device, having IP address n.n.n.n, is connecting to this
device.
Received commands must begin with the two-character sequence AT and be
terminated with a carriage return character.
The unit ignores any character sequence received not starting with AT, and only
recognizes and processes single AT-style commands. The unit treats compound AT
commands as unrecognized commands.
If the Full Verbose option is in effect, the unit responds to an unrecognized
command string that is otherwise formatted correctly (begins with AT and ends with
carriage return) with the "OK" message and takes no further action.
If the Numeric Response option is in effect, the unit responds to an unrecognized
command string that is otherwise formatted correctly with the "OK" message and
takes no further action.
When an active connection is in effect, the unit transfers data and does not process
commands received from the serial interface.
When a connection is terminated or lost, the unit reverts to command mode.
When an active connection is in effect, the unit terminates the connection if it
receives the following sequence from the attached serial device:
No serial data is received for one second.
The character sequence +++ is received, with no more than one second
between each two characters.
No serial data is received for one second after the last + character. At this
time, the unit responds affirmatively per the selected echo/response mode.
The character string ATH is received, terminated with a carriage return. The
unit responds affirmatively according to the selected echo/response mode
and drops the network connection. The serial interface reverts to accepting
command strings.
If this sequence is not followed, the unit remains in data transfer mode.
XPort Direct+ User Guide 48
7: Setup Mode: Channel Configuration
7-7. Modem Mode Commands
Modem Mode
Function
Command
ATDTx.x.x.x,pppp or
ATDTx.x.x.x/pppp
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 numeric response or full verbose.
n=0 enables numeric response.
n=1 enables full verbose.
Note: The unit recognizes these AT commands as single commands such as
ATE0 or ATV1; it does not recognize compound commands such as ATE0V.
Send the Escape Sequence (+++) in Modem Mode
Send ‘+++’ in Modem Mode (Y) ? _
Disable or enable the XPort Direct+’s ability to send the escape sequence. The
default is Y (Yes) (send the escape sequence).
Show IP addr after 'RING'
XPort Direct+ User Guide 49
Disable or enable the XPort Direct+'s ability to show the IP address after RING in
Modem Mode. The default is Y (Yes), to show the IP address.
Auto Increment Source Port
Auto increment source port (N) ? _
Y (Yes) auto increment the source port. The XPort Direct+ increments the port
number used with each new connection.
Remote IP Address
This is the destination IP address used with an outgoing connection.
Remote IP Address : ( 0) ( 0) ( 0) ( 0)_
Note: This option does not display when Hostlist is enabled from the
ConnectMode prompt (see Connect Mode on page 43 for more information).
Remote Port
7: Setup Mode: Channel Configuration
You must set the remote TCP port number for the unit to make outgoing connections.
This parameter defines the port number on the target host to which a connection is
attempted.
Remote Port ( 0) ? _
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).
Note: This option does not display when Hostlist is enabled from the
ConnectMode prompt (see Connect Mode on page 43 for more information).
DisConnMode
This setting determines the conditions under which the unit will cause a network
connection to terminate.
DisConnMode ( 0) ? _
Notes:
In DisConnMode (Disconnect Mode), Modem Control In drop either drops the
connection or is ignored.
All bit positions in the table that are blank represent “don’t care” bits, for that
particular option, which can be set to either a 0 or 1 value.
XPort Direct+ User Guide 50
7: Setup Mode: Channel Configuration
Table 7-8. Disconnect Mode Options
Disconnect Mode Option 7 6 54 3 2 1 0
Disconnect when Modem Control In is not asserted
Ignore Modem Control In 0
Telnet Com Port Cntrl and terminal type setup
Channel (port) password
Hard disconnect
(3)
(2)
1
0
Disable hard disconnect 1
State LED off with connection
Disconnect with EOT (^D)
(1) The Telnet Com Port Control feature is used in conjunction with Com Port Redirector. The unit
sends 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 closes 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 turns off instead of
blinking.
(5) When Ctrl+D or Hex 04 is detected, the connection is dropped. Both Telnet Com Port Cntrl and
Disconnect with EOT must be enabled for Disconnect with EOT to function properly. Ctrl+D is only
detected going from the serial port to the network.
(6) When Modem Control In transitions from a high state to a low state, the network connection to or
from the serial port drops.
(4)
1
(5)
1
(6)
1
(1)
1
Flush Mode (Buffer Flushing)
Using this parameter, you can control line handling and network buffers with
connection startup and disconnect.
FlushMode ( 0) ? _
You can also select between two different packing algorithms.
Note: All bit positions in the table that are blank represent “don’t care” bits,
for that particular option, which can be set to either a 0 or 1 value.
Table 7-9. Flush Mode Options
Function 7 6 5 4 3 2 1 0
Input Buffer (Serial to Network)
Clear with a connection initiated from the device to the network 1
Clear with a connection initiated from the network to the device 1
Clear when the network connection to or from the device is disconnected 1
Output Buffer (Network to Serial)
Clear with a connection initiated from the device to the network 1
Clear with a connection initiated from the network to the device 1
Clear when the network connection to or from the device is disconnected 1
Alternate Packing Algorithm (Pack Control)
Enable 1
XPort Direct+ User Guide 51
Pack Control
The 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 you do not
need specific functions.
Note: All bit positions in the table that are blank represent “don’t care” bits,
for that particular option, which can be set to either a 0 or 1 value.
Option 7 6 5 4 3 2 1 0
Packing Interval
Interval: 12ms 0 0
7: Setup Mode: Channel Configuration
Table 7-10. Pack Control Options
Interval: 52ms 0 1
Interval: 250ms 1 0
Interval: 5sec 1 1
Trailing Characters
None 0 0
One 0 1
Two 1 0
Send Characters
2-Byte Send Character Sequence 1
Send Immediately After Send chars 1
Packing Interval
Packing Interval defines how long the unit should wait before sending accumulated
characters. This wait period is between successive network segments containing
data. For alternate packing, the default interval is 12 ms.
Trailing Characters
In some applications, CRC, Checksum, or other trailing characters follow the end-ofsequence character; this option helps to adapt frame transmission to the frame
boundary.
XPort Direct+ User Guide 52
Send Characters
If 2-Byte Send Character Sequence is enabled, the unit interprets the
sendchars as a 2-byte sequence; if this option is not enabled, the unit
interprets them 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 this option is 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.
DisConnTime (Inactivity Timeout)
Use this parameter to set an inactivity timeout. The unit drops the connection if there
is no activity on the serial line before the set time expires. Enter time in the format
mm:ss, where m is the number of minutes and s is the number of seconds.
DisConnTime (0: 0) ?:
To disable the inactivity timeout, enter 00:00. Range is 0 (disabled) to 5999 seconds
(99 minutes, 59 seconds). Default is 0.
7: Setup Mode: Channel Configuration
Send Characters
Enter up to two characters in hexadecimal representation in sendchar.
SendChar 1 ( 0) ? _
SendChar 2 ( 0) ? _
If the unit receives a character on the serial line that matches one of these
characters, it sends the character immediately, along with any awaiting characters, to
the TCP connection. This action minimizes the response time for specific protocol
characters on the serial line (for example, ETX, EOT). Setting the first sendchar to 00
disables the recognition of the characters. Alternatively, the unit can interpret two
characters as a sequence (see Pack Controlon page 52).
Telnet Terminal Type
This parameter displays only if you enabled the terminal type option in Disconnect
Mode. With this option enabled, you can use the terminal name for the Telnet
terminal type. Enter only one name.
With terminal type option enabled, the unit also reacts to the EOR (end of record) and
binary options, useful for applications like terminal emulation to IBM hosts.
Channel (Port) Password
This parameter appears only if the channel (port) password option is enabled in
Disconnect Mode. With this option enabled, you can set a password on the serial
port.
XPort Direct+ User Guide 53
8: Setup Mode: Advanced Settings
Email Settings (Option 3)
Note: You can change these settings using Telnet, a serial connection, or
Web-Manager. To configure email settings using DeviceInstaller, see Email
Notification in the DeviceInstaller online Help.
The unit sends an email to multiple recipients when a specific trigger event occurs.
There are three separate triggers, based on any combination of the configurable pins
(PIO) when selected as user I/O functions. Optionally, use a two-byte serial string to
initiate a trigger.
To configure email configuration settings, select Email (option 3) from the Change
Setup menu.
Figure 8-1. Email Settings
*** E-mail
Mail server: 0.0.0.0
Unit :
Domain :
Recipient 1:
Recipient 2:
- Trigger 1
Serial trigger input: disabled
Channel: 1
Match: 00
Trigger input1: X
Trigger input2: X
Trigger input3: X
Message :
Priority: L
Min. notification interval: 1 s
Re-notification interval : 0 s
- Trigger 2
Serial trigger input: disabled
Channel: 1
Match: 00
Trigger input1: X
Trigger input2: X
Trigger input3: X
Message :
Priority: L
Min. notification interval: 1 s
Re-notification interval : 0 s
- Trigger 3
Serial trigger input: disabled
Channel: 2
Match: 00
Trigger input1: X
XPort Direct+ User Guide 54
8: Setup Mode: Advanced Settings
Trigger input2: X
Trigger input3: X
Message :
Priority: L
Min. notification interval: 1 s
Re-notification interval : 0 s
Server (0.0.0.0) ? ( 0) _
Mail Server
Enter the IP address of the mail server. Enter each 3-digit section and press Enter
between each section inputted. The current value is displayed in parentheses.
Mail Server (0.0.0.0) ? ( 0) _
Unit Name
Enter the username used by the XPort Direct+ to send email messages. The current
value is displayed in parentheses.
Unit name () ? _
Domain Name
Enter the email server’s domain name. The current value is displayed in parentheses.
Domain name () ? _
Recipient 1
Enter the full email address of the trigger email recipient. The current value is
displayed in parentheses.
Recipient 1 () ? _
Recipient 2
Enter the full email address of the trigger email recipient. The current value is
displayed in parentheses.
Recipient 2 () ? _
Trigger 1
A trigger event occurs when the unit receives the specified trigger input because of a
specified combination of conditions on the configurable pins.
Set the configurable pins to A = Active, I = Inactive, or X = Don’t Care. Active can
mean active low or active high. If the configurable pins are all set to X (Don’t Care),
then they are disabled. If both the serial sequence and the configurable pins are
disabled, the trigger is disabled.
To change the configurable pins’ settings, send setup records to Port 77FE.
Message
Priority The priority level for the trigger even email. Enter L for normal
Minimum notification
interval
Re-notification interval
The subject line of the trigger event email to the specified
recipient(s).
priority or H for high priority.
The minimum time allowed between individual triggers. If a
trigger event occurs within the minimum interval since the last
trigger, it is ignored.
Indicates the time interval at which a new email message is sent
to the recipient(s) when a single trigger event remains active.
Trigger 2
Refer to Trigger 1 for details on completing these fields.
Note: Each trigger is independent of the others. Each condition within an
individual trigger must be met before the unit sends the email.
Trigger 3
Refer to Trigger 1 for details on completing these fields.
Note: Each trigger is independent of the others. Each condition within an
individual trigger must be met before the unit sends the email.
Expert Settings (Option 5)
Note: You can change these settings using Telnet or serial connections only,
not on the Web-Manager.
Caution: Only an expert should change these parameters. You must
definitely know the consequences the changes might have.
XPort Direct+ User Guide 56
Figure 8-2. Expert Settings
The default settings are listed below:
8: Setup Mode: Advanced Settings
TCP Keepalive time in s
45
(1s – 65s; 0s=disable)
ARP Cache timeout in s
600
(1s – 600s)
CPU Performance
Monitor Mode @ bootup
HTTP Port Number
Regular
Enabled
80
(1-65535)
SMTP Port Number
25
(1-65535)
MTU Size (512 – 1400)
Enable alternate MAC
Ethernet connection type
0 (resulting in an operational value of 1400)
No (OEM use only)
0 (resulting in auto-negotiation)
TCP Keepalive time in seconds
This option allows you to change how many seconds the unit waits during a silent
connection before attempting to see if the currently connected network device is still
on the network. If the unit gets no response, it drops that connection.
TCP Keepalive time in s (1s – 65s; 0s=disable): (45)? _
ARP Cache timeout in seconds
Whenever the unit communicates with another device on the network, it adds an
entry into its ARP table. The ARP Cache timeout option allows you to define how
many seconds (1-600) the unit will wait before timing out this table.
ARP Cache timeout in s (1s – 65s; 0s=disable): (600)? _
CPU Performance
XPort Direct+ User Guide 57
8: Setup Mode: Advanced Settings
This option applies to XPort Direct+ and later units only. It allows you to increase the
CPU performance required to use the higher baud rates on the serial interface (460
Kbps and 920 Kbps). The standard CPU performance mode supports up to 230400
Kbps.
Notes:
If a baud rate of 460 Kbps or 920 Kbps is set and the high performance mode is
disabled, the operation of the serial channel would be out of the specified error
tolerance, thereby leading to inconsistent speed settings on the two ends of the
serial channel.
Increasing CPU clock speed consumes more power and generates more heat.
This reduces the maximum operating temperature specification. See the
appropriate product brief for details.
Disable Monitor Mode at bootup
This option allows you to disable all entries into Monitor Mode during startup, except
for the ‘xxx’ sequence. This prevents entry using yyy, zzz, xx1, and yy1 key
sequences (only during the bootup sequence). The default for Monitor Mode at
bootup is N (No). (See 11:Monitor Mode.)
Disable Monitor Mode @ bootup (N) ? _
HTTP Port Number
This option allows the configuration of the web server port number. The valid range is
1-65535. The default HTTP port number is 80.
HTTP Port Number : (80) ? _
SMTP Port Number
This option allows the configuration of the email port number. The valid range is
1-65535. The default SMTP port number is 25.
SMTP Port Number : (25) ? _
Note: When configuring the HTTP or SMTP port number, take note of the ‘reserved’
port numbers on page 42.
MTU Size
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.
MTU Size: (1400) ? _
Enable alternate MAC
XPort Direct+ User Guide 58
If necessary, enable the alternate MAC address (if specified in the OEM setup
record).
Enable alternate MAC (N) ? _
Ethernet Connection Type
The XPort Direct+ allows for the Ethernet speed and duplex to be manually
configured. Enter 0 for auto-negotiation (default). To select the speed and duplex,
enter one of the following: 2 (10Mbit/half duplex), 3 (10Mbit/full duplex), 4
(100Mbit/half duplex), or 5 (100Mbit/full duplex).
Ethernet connection type: (0) ? _
Security Settings (Option 6)
You can change security settings by means of 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 to prevent eavesdropping.
8: Setup Mode: Advanced Settings
Caution: Disabling both Telnet Setup and Port 77FE will prevent users from
accessing the setup menu from the network. Disabling Port 77FE also
disables the Web from configuring the device.
Select 7 to configure security settings.
Figure 8-3. Security Settings
Disable SNMP
This setting allows you to disable the SNMP protocol on the unit for security reasons.
Disable SNMP (N) ? _
XPort Direct+ User Guide 59
8: Setup Mode: Advanced Settings
SNMP Community Name
The SNMP Community Name is a required field for NMS to read or write to a device.
Enter a string of 1 to 13 characters.
SNMP Community Name (public): _
The default entry is public. The current value is displayed in parentheses.
Disable Telnet Setup
Note: If you choose to disable this option, keep in mind that disabling both
Telnet Setup and Port 77FE will prevent users from accessing the setup
menu from the network.
This setting defaults to the N (No) option. The Y (Yes) option disables access to
Setup Mode by Telnet (port 9999). It only allows access locally using the web pages
and the serial port of the unit.
Disable Telnet Setup (N) ? _
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, you can download
firmware upgrades over the serial port using DeviceInstaller’s Recover Firmware
procedure. (See 10: Firmware Upgrades.)
Disable TFTP Firmware Update (N) : _
Disable Port 77FE (Hex)
Note: If you choose to disable this option, keep in mind that disabling both
Telnet Setup and Port 77FE will prevent users from accessing the setup
menu from the network.
Port 77FE is a setting that allows DeviceInstaller, Web-Manager, and custom
programs to configure the unit remotely. You may wish to disable this capability for
security purposes.
Disable Port 77FEh (N) ? _
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 sites.
Note: The Y (Yes) option disables many of the GUI tools for configuring the
unit, including the embedded Web-Manager tool.
Disable Web Server
This setting defaults to the N (option). The Y (Yes) option disables the web server.
XPort Direct+ User Guide 60
8: Setup Mode: Advanced Settings
Disable Web Server (N) ? _
Disable Web Setup
The Y (Yes) option disables configuration using the Web-Manager. This setting
defaults to the N (option).
Disable Web Setup (N) ? _
Disable ECHO Ports
This setting controls whether port 7 echoes characters it receives.
Disable ECHO ports (Y) ? _
Enable Enhanced Password
This setting defaults to the N (No) option, which allows you to set a 4-character
password that protects Setup Mode by means of Telnet and web pages. The Y (Yes)
option allows you to set an extended security password of 16-characters for
protecting Telnet and Web Page access.
Enable Enhanced Password (Y) ? _
Disable Port 77F0 (Hex)
Port 77F0 is a setting that allows a custom application to query or set the three XPort
Direct+ configurable pins when they are functioning as general purpose I/O (GPIO).
You may want to disable this capability for security purposes. The default setting is
the N (No) option, which enables GPIO control. The Y (Yes) option disables the
GPIO control interface.
Disable Port 77F0h ? _
Default Settings (Option 7)
Select 7 to reset the unit’s Channel 1 configuration, email settings, and expert
settings to the default settings. The server configuration settings for IP address,
gateway IP address, and netmask remain unchanged. The configurable pins’ settings
also remain unchanged. The specific settings that this option changes are listed
below:
Channel 1 Configuration Defaults
Baudrate
I/F Mode
Flow
Port number
9600
4C (1 stop bit, no parity, 8 bit, RS-232C)
00
10001
XPort Direct+ User Guide 61
8: Setup Mode: Advanced Settings
Connect Mode
Send '+++' in Modem Mode
Show IP addr after 'RING'
Auto increment source port
Hostlist retry counter
Hostlist retry timeout
Start character for serial channel 1
All other parameters
Expert Settings Defaults
TCP Keepalive time in s
ARP Cache timeout in s
CPU Performance
Disable Monitor Mode @ bootup
HTTP Port Number
(1-65535)
SMTP Port Number
(1-65535)
MTU Size (512 – 1400)
Alternate MAC
Ethernet Connection Type
C0 (always accept incoming connection; no active
connection startup)
Enabled
Enabled
Disable
3
250 (msec)
0x0D (CR)
0
45
600
0 (Regular)
No
80
25
0 (resulting in an operational value of 1400)
Disabled ( for OEM use only)
0 (auto-negotiate)
Security Settings Defaults
Disable SNMP
SNMP community name
Disable Telnet setup
Disable TFTP Firmware Update
Disable Port 77FEh
Disable Web Server
Disable Web Setup
Disable ECHO ports
Enable Enhanced Password
Disable Port 77F0h
No
public
No
No
No
No
No
Yes
No
No
XPort Direct+ User Guide 62
Email Settings
8: Setup Mode: Advanced Settings
Priority
Min. notification interval
All other parameters
L
1 (second)
0 (e.g., email notification and triggers are disabled)
XPort Direct+ User Guide 63
9: GPIO Interface
Configurable Pins
The XPort Direct+ has three pins (CP0-2) that you can configure for General Purpose
I/O (GPIO).
Note: You can also configure any one of the pins for modem control input
signal (serial port control line) using DeviceInstaller.
You can use these GPIO pins to control devices such as relays, servers, lights,
monitor switches, sensors, and even processes such as data transfer.
You can set the functions for the three pins independently and in any combination.
The initial directions (input/output) and active levels (active low or high) at boot up
can also be configured through 77FE, for example, by using DeviceInstaller.
This chapter describes how the directions, active levels, and states can be
dynamically controlled and probed through special port 77F0.
The configurable pins default configuration is:
Function: General Purpose Input
Active Level: Active Low
Features
TCP and UDP can be used.
Function configuration can be retrieved.
Input or output selection can be retrieved and controlled.
Active low or high selection can be retrieved and controlled.
Active or inactive selection can be retrieved and controlled.
77F0 can be disabled.
Every change of state (active/inactive) requires a command over TCP or UDP, and
thus is not very fast. If you use this port for data transfer, the throughput is low,
usually up to 1 Kbps.
XPort Direct+ User Guide64
9: GPIO Interface
Control Protocol
COPIED FROM XPORT DIRECT.
The GPIO control protocol is a simple, proprietary protocol.
Guidelines
The GPIO control protocol is described from the PC side. Send means from PC to
XPort Direct+. Response comes from XPort Direct+ to PC.
The protocol allows for control of up to 32 GPIOs. How many are actually available
depends on the product. XPort Direct+ has only two.
The parameters are four bytes long and represent GPIOs 0-31, with GPIO0 in bit 0 of
the first byte (Little Endian). Parameter bits for configurable pins not configured as
GPIOs are undefined for Get commands and ignored on Set commands.
Every command consists of nine bytes: one command type of one byte and two
parameters of four bytes each.
Command Parameter 1 Parameter 2
0 1 2 3 4 5 6 7 8
On some commands, one or all parameters are ignored.
For UDP, command type and parameters need to be in the same datagram.
Responses to valid commands are always five bytes long, consisting of the returned
command byte and as parameters in the current or updated values. In case of an
invalid command, only one byte with value 0FFh is returned.
Command Parameter 1
0 1 2 3 4
When sending a command (TCP and UDP), wait for the response before sending the
next command.
Commands
Byte 0 Command Types
10h Get functions
11h Get directions (input or output)
12h Get active levels (high active or low active)
13h Get current states (active or not active)
19h Set directions
1Ah Set active levels
1Bh Set current states
There is no Set functions command. Since the pin’s function depends on the
hardware in which the XPort Direct+ is embedded, that configuration is only allowed
using 77FE. Settings changed by any of the Set commands are not stored and are
lost when the unit is powered down or rebooted.
XPort Direct+ User Guide 65
9: GPIO Interface
Command 10h, Get Functions
Send:
No parameters
Response:
1 parameter
Bytes 1-4: Functions
Bit X 1 means general purpose I/O available to the user.
0 means dedicated function (e.g., serial flow control, diagnostics) for
configurable pin X.
Command 11h, Get Directions
Send:
No parameters
Response:
1 parameter
Bytes 1-4: Directions
Bit X 1 means GPIO X is an output.
0 means it is an input.
Command 12h, Get Active Levels
Send:
No parameters
Response:
1 parameter
Bytes 1-4: Active levels
Bit X 1 means GPIO X is active low (0V when active, 3.3V when inactive).
0 means it is active high (3.3V when active, 0V when inactive).
Command 13h, Get Current States
Send:
No parameters
Response:
1 parameter
Bytes 1-4: States
Bit X 1 means GPIO X is active
0 means it is inactive.
Command 19h, Set Directions
Send:
2 parameters
Bytes 1-4: Mask
Bit X 1 means the direction for GPIO X will be updated with the value in the
second parameter.
0 means the direction for that GPIO will not change.
Bytes 5-8: New Directions
Bit X 1 means GPIO X will become an output.
0 means it will become an input.
Response:
1 parameter
Bytes 1-4: The updated directions
XPort Direct+ User Guide 66
9: GPIO Interface
Command 1Ah, Set Active Levels
Send:
2 parameters
Bytes 1-4: Mask
Bit X 1 means the direction for GPIO X will be updated with the value in the
second parameter.
0 means the active type for that GPIO will not change.
Bytes 5-8: New Active Levels
Bit X 1 means GPIO X will become active low.
0 means it will become active high.
Response:
1 parameter
Bytes 1-4: Updated active levels
Command 1Bh, Set States
Send:
2 parameters
Bytes 1-4: Mask
Bit X 1 means the state for GPIO X will be updated with the value in the
second parameter.
0 means the state for that GPIO will not change.
Bytes 5-8: New States
Bit X 1 means GPIO X will become active.
0 means it will become inactive.
Response:
1 parameter
Bytes 1-4: Updated states
Examples
Example 1: PC sends command 10h to find out which configurable pins are
available as GPIO.
bit 0 is 1 → GPIO0 = 1
bit 1 is 0 → GPIO1 = 0
bit 2 is 1 → GPIO2 = 1
The other bits are ignored because there are only two configurable pins on
the XPort Direct+.
Command details:
1Bh = command 1Bh
01h, 00h, 00h, 00h = the mask that determines which GPIOs will be changed.
bit 0 is 1 → GPIO0 will be changed.
bit 1 is 0 → GPIO1 will remain the same.
00h, 00h, 00h, 00h = the new states
bit 0 is 0 → GPIO0 will become 0.
bit 1 is ignored since it is masked out.
bit 0 is 1 → GPIO0 = 1
bit 1 is 0 → GPIO1 = 0
bit 2 is 1 → GPIO2 = 1
The other bits are ignored because there are only three configurable pins on
the XPort Direct+.
XPort Direct+ User Guide 68
10: Firmware Upgrades
Obtaining Firmware
You can obtain the most up-to-date firmware and release notes for the unit from the
Lantronix web site (www.lantronix.com
(ftp.lantronix.com).
Reloading Firmware
) or by using anonymous FTP
There are several ways to update the unit's internal operational code (*.ROM): using
DeviceInstaller (the preferred way), using TFTP, or using the serial port. You can also
update the unit's internal Web interface (*.COB) using TFTP or DeviceInstaller.
Here are typical names for those files. Check the Lantronix web site for the latest
versions and release notes.
Table 10-1. Firmware Files
ROM File COB
xptdp_6508.rom gen_xptdp_webm_1605.cob
Please refer to the DeviceInstaller online Help for information about reloading
firmware using DeviceInstaller. The other methods are discussed below.
Using TFTP: Graphical User Interface
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. In the TFTP server field, enter the IP address of the unit being upgraded.
3. Select Upload operation and Binary format.
4. Enter the full path of the firmware file in the Local file name field.
5. In the Remote file name field, enter the current internal operational code or WEB1 for the internal Web interface.
The TFTP destination file for XPort Direct+ is X8.
XPort Direct+ User Guide69
6. Click the Upload Now button to transfer the file to the unit.
Figure 10-1. TFTP Window
10: Firmware Upgrades
After the firmware has been loaded and stored, which takes approximately 8 seconds
to complete, the unit performs a power reset.
Using TFTP: Command Line Interface
To download new firmware from a computer:
1. Enter the following from a TFTP command line interface:
tftp –i <ip address> put <local filename> <destination file name>
The following examples demonstrate the TFTP command sequence to download
the .rom file and the .cob file:
tftp –i 192.168.1.111 put XPTDP_6508.rom X8
tftp –i 192.168.1.111 put gen_XPTDP_webm_1300.cob WEB1
2. In the Remote file name field, enter the current internal operational code or
WEB1 for the internal Web interface.
The TFTP destination files for XPort Direct+ is X8.
XPort Direct+ User Guide 70
10: Firmware Upgrades
Recovering the Firmware Using the Serial Port and DeviceInstaller
If for some reason the firmware is damaged, you can recover the firmware file by
using DeviceInstaller to download the *.ROM file over the serial port.
To recover firmware:
1. Start DeviceInstaller. If your PC has more than one network adapter, a message
displays. Select an adapter and click OK.
2. From the Tools menu, select Advanced/Recover Firmware. The Serial Port
Firmware Upgrade window displays.
3. For Port on PC, enter the COM port on the PC that is connected to the serial
port of the Lantronix unit.
4. For Device Model, be sure the appropriate XPort Direct+ device is shown.
5. For Firmware File, click the Browse button and go to the location where the
firmware file resides.
Note: Make sure the XPort Direct+ on which you are recovering firmware is
connected to this selected port on your PC.
6. Click OK to download the file.
7. When prompted, reset the device. Status messages and a progress bar at the
bottom of the screen show the progress of the file transfer. When the file transfer
completes, the message “Successful, Click OK to Close” appears.
8. Click the OK button to complete this procedure.
Note For more information, see Recovering Firmware in the DeviceInstaller
online Help.
XPort Direct+ User Guide 71
11: Monitor Mode
Monitor Mode is a command-line interface used for diagnostic purposes.
There are two ways to enter Monitor Mode: locally using the serial port or remotely
using the network.
Entering Monitor Mode Using the Serial Port
To enter Monitor Mode locally:
1. Follow the same steps used for setting the serial configuration parameters
(see Serial Port on page 35).
2. Instead of typing three x keys, however:
a) Type zzz (or xx1) to enter Monitor Mode with network connections.
b) Type yyy (or yy1) to enter Monitor Mode without network connections.
A 0> prompt indicates that you have successfully entered Monitor Mode.
Entering Monitor Mode Using the Network Port
To enter Monitor Mode using a Telnet connection:
1. Establish a Telnet session to the configuration port (9999). The following
message appears:
2. Type M (upper case).
A 0> prompt indicates that you have successfully entered Monitor Mode.
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 you enter the IP address, the
command is applied to another unit with that IP address. If you do not enter the IP
address, the command is executed locally.
Note: All commands must be in capital letters.
XPort Direct+ User Guide 72
11-1. Monitor Mode Commands
Command Command Name Function
VS x.x.x.x
GC x.x.x.x
SC x.x.x.x
PI x.x.x.x
AT
TT
NC
RS
QU
G0, G1, ....,Ge, Gf
S0, S1,...,Se, Sf
GM
SS
SA
NS
Version Queries software header record (16 bytes) of unit
with IP address x.x.x.x.
Get Configuration Gets configuration of unit with IP address x.x.x.x as
hex records (120 bytes).
Send Configuration Sets configuration of unit with IP address x.x.x.x
from hex records.
Ping Pings unit with IP address x.x.x.x to check device
status.
ARP Table Shows the unit’s ARP table entries.
TCP Connection
Table
Network Connection Shows the unit’s IP configuration.
Reset Resets the unit’s power.
Quit Exits diagnostics mode.
Get configuration
from memory page
Set configuration to
memory page
Get MAC address Shows the unit's 6-byte MAC address.
Set Security record Sets the Security record without the encryption key
Scan Initiates a wireless scan if the wireless interface is
Network Status Reports the network interfaces’ statuses. Includes
Shows all incoming and outgoing TCP connections.
Gets a memory page of configuration information
from the device.
Sets a memory page of configuration information
on the device.
and length parameters. The entire record must still
be written, but the encryption-specific bytes do not
need to be provided (they can be null since they
are not overwritten).
enabled. Reports any stations found, including
BSSID, SSID, and RSSI. If SA is followed by a
string, the string is used to filter SSIDs before
reporting. If the BSS does not broadcast its SSID,
only the BSSID and RSSI are returned.
potentially negotiated parameters like speed/duplex
for Ethernet or BSSID, encryption, authentication
for wireless interfaces.
11: Monitor Mode
Responses to some of the commands are in Intel Hex format.
XPort Direct+ User Guide 73
11: Monitor Mode
Note: Entering any of the commands listed above generates one of the
following command response codes:
Table 7-2. 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
XPort Direct+ User Guide 74
12: Troubleshooting
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 display. 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.
When troubleshooting the following problems, make sure that the XPort Direct+ is
powered up. Confirm that you are using a good network connection.
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 attempt to assign an
IP address to the unit by the
ARP method, the "Press Enter to
go into Setup Mode" error
"(described below) message
displays. Now when you Telnet
to the device server, the
connection fails.
When you Telnet to port 9999,
the "Press Enter to go into Setup
Mode" message displays.
However, nothing happens when
you press Enter, or your
connection is closed.
Your currently logged-in
user does not have the
correct rights to use this
command on this PC.
When you Telnet to port
1 on the device server,
you are only assigning a
temporary IP address.
When you Telnet into
port 9999 and do not
press Enter quickly, the
device server reboots,
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.
Have someone from your IT
department log you in with
sufficient rights.
Telnet back to 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 "Press Enter to go into
Setup Mode" message.
XPort Direct+ User Guide75
Problem/Message Reason Solution
When you Telnet to port 1 to
assign an IP address to the
device server, the Telnet window
does not respond for a long time.
When you try to assign an IP
with DeviceInstaller, you get the
following :
"No response from device!
Verify the IP, Hardware
Address and Network Class.
Please try again."
The device server is not
communicating with the serial
device to which it is attached.
When you try to enter the setup
mode on the device server using
the serial port, you get no
response.
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 device server 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.
The most likely reason is
the wrong serial settings
were chosen.
The issue is most likely
something covered in
the previous problem, or
possibly, you have Caps Lock on.
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
device server.
Make sure that the Link LED is
lit. If the Link LED is not lit,
then the device server is not
properly plugged into the
network.
Double-check the parameters
that you specified.
Note: You cannot assign an
IP address to a device server
through a router.
The serial settings for the
serial device and the device
server must match. The
default serial settings for the
device server are RS-232,
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.
Troubleshooting
XPort Direct+ User Guide 76
Problem/Message Reason Solution
You can ping the device server,
but not Telnet to the device
server on port 9999.
The device server appears to be
set up correctly, but you are not
communicating with your device
attached to the device server
across the network.
When connecting to the WebManager within the device
server, the "No Connection With
The Device Server" message
displays.
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 device server
security settings.
If you are sure that the
serial port setting is
correct, then you may
not be connecting to the
correct socket of the
device server.
Another possibility is that
the device server 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
device server.
Turn the device server 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 device server).
PING X.X.X.X (X.X.X.X is the
IP of the device server).
If you get a response, then
there is a duplicate IP address
on the network. If you do not
get a response, use the serial
port to verify that Telnet is not
disabled.
You can check to see whether
there is a socket connection to
or from the device server by
checking the state of CP1, if it
has been configured for LED1
functionality.
If the state of CP1 is blinking
consistently, or is completely
off, then there is a good
socket connection.
If the state of CP1 is low, use
the Connect Mode option C0
for making a connection to the
device server from the
network. Use Connect Mode
option C1 or C5 for a
connection to the network
from the device server. See
the full list of Connect Mode
options in Connect Mode on
page 43.
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 device server.
Troubleshooting
XPort Direct+ User Guide 77
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 have the following options:
To check our online knowledge base or send a question to Technical Support, go to
Firmware downloads, FAQs, and the most up-to-date documentation are available at:
www.lantronix.com/support
When you report a problem, please provide the following information:
Your name, and your company name, address, and phone number
Lantronix model number
Lantronix MAC number
Troubleshooting
.
or eu_support@lantronix.com
Software version (on the first screen shown when you Telnet to port 9999)
Description of the problem
Status of the unit when the problem occurred (please try to include
information on user and network activity at the time of the problem).
XPort Direct+ User Guide 78
A: Binary to Hexadecimal
Conversions
Many of the unit’s configuration procedures require assembling a series of options
(represented as bits) into a complete command (represented as a byte). Convert the
resulting binary value to a hexadecimal representation.
Converting Binary to Hexadecimal
Following are two simple ways to convert binary numbers to hexadecimals.
Conversion Table
Hexadecimal digits have values ranging from 0 to F, which are represented as 0-9, A
(for 10), B (for 11), etc. To convert a binary value (for example, 0100 1100) to a
hexadecimal representation, the upper and lower four bits are treated separately,
resulting in a two-digit hexadecimal number (in this case, 4C). Use the following table
to convert values from binary to hexadecimal.
9 1001 9
10 1010 A
11 1011 B
12 1100 C
13 1101 D
14 1110 E
15 1111 F
Scientific Calculator
Another simple way to convert binary to hexadecimals is to use a scientific calculator,
such as the one available on Windows’ operating systems. For example:
1. On the Windows’ Start menu, click ProgramsÆAccessoriesÆCalculator.
2. On the View menu, select Scientific. The scientific calculator displays.
XPort Direct+ User Guide79
Binary to Hexadecimal Conversions
3. Select Bin (Binary), and type the number to convert.
4. Click Hex. The hexadecimal value displays.
XPort Direct+ User Guide 80
Loading...
+ 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.