Sales Offices
For a current list of our domestic and international sales offices, go to the Lantronix
web site at
www.lantronix.com/support
www.lantronix.com/about/contact
xPico User Guide2
Date
Rev.
Comments
April 2012
A
Initial release for firmware version 6.8.0.0.
January 2013
B
Updated for firmware version 6.8.0.3.
Disclaimer
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.
Note:This product has been designed to comply with the limits for a Class B digital
device pursuant to Part 15 of FCC Rules. These limits are designed to provide
reasonable protection against harmful interference in a residential installation. This
equipment generates, uses, and can radiate radio frequency energy, and if not
installed and used in accordance with this guide, may cause harmful interference to
radio communications.
Changes or modifications to this device not explicitly approved by Lantronix will void
the user's authority to operate this device.
Note: With the purchase of xPico, the OEM agrees to an OEM firmware license
agreement that grants the OEM a non-exclusive, royalty-free firmware license to use
and distribute the binary firmware image provided, only to the extent necessary to
use the xPico hardware. For further details, please see the xPico OEM firmware
license agreement.
Revision History
For the latest revision of this product document, please check our online
documentation at
www.lantronix.com/support/documentation.
xPico User Guide3
Table of Contents
Copyright and Trademark ............................................................................................. 2
Describes the main features of the xPico and the protocols
it supports.
3: Using DeviceInstaller
Provides information for getting your unit up and running,
4: Configuration Using Web
Manager
Details using the Web-Manager to set parameters such as
port and server properties.
5: Configuration via Telnet or
Provides instructions for accessing Setup Mode (command
through the serial port.
6: Setup Mode: Server
Configuration
Details the network (server) settings
7: Setup Mode: Channel
Configuration
Details the serial port settings.
8: Setup Mode: Advanced
Settings
Details expert and security settings and explains how to
reset the unit to factory default values.
9: GPIO Interface
Provides instructions for configuring the eight General
10: Firmware Upgrades
Provides instructions for obtaining the latest firmware and
updating the xPico.
11: Monitor Mode
Provides instructions for accessing and using the
diagnosing problems.
12: Troubleshooting
Describes common problems and error messages and how
to contact Lantronix Technical Support.
A: Binary to Hexadecimal
Conversions
Provides instructions for conve rt ing binary numb ers to
hexadecimals.
B: Compliance
Provides compliance informat i on.
1. Using This Guide
Purpose and Audience
This guide covers xPico Device Ser ver Module. It provides the information needed to
configure, use, and update the xPico firmware and is intended for OEMs and system
integrators who are embedding the xPico in their end product designs.
Chapter Summary
The remaining chapters in this guide include:
Serial Port (Setup Mode)
using DeviceInstaller to assign an IP address.
line interface) using a Telnet connection through the
network or a terminal or terminal emulation program
Purpose I/O pins (CP1-8).
command line interface for monitoring the network and
xPico User Guide9
Additional Docume ntation
Document
Description
xPico Quick Start
Provides the steps for getting the xPico evaluation board up
and running.
xPico Integration Guide
Provides information about the xPico hardware, testing the
into your product.
xPico Development Kit
Quick Start
Instructions for using the xPico on the xPico evaluation board.
Com Port Redirector
User Guide
Provides information on using the Window s-ba sed uti lity to
create a virtual com port.
DeviceInstaller Online
Help
Provides information on using DeviceIn staller to configure IP
addresses and locate Lantronix devices on the network.
Visit the Lantronix Web site at www.lantronix.com/support/documentation for the
latest documentation and the foll o wing add it ion al doc umentation.
1: Using This Guide
xPico using the evaluation board, and integrating the xPico
xPico User Guide10
2. Introduction
This chapter summarizes the xPico device server’s features and the basic
information needed to get started.
Capabilities
The xPico 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 xPico also supports UDP datagrams.
Contains a web [HTTP] server allowing presentation of custom content and easy
configuration through a browser.
Has eight programmable I/O pins used to monitor or control attached devices.
Applications
The xPico 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
xPico User Guide 11
Protocol Support
The xPico 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.
TCP/IP, UDP/IP, 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.
Configuration Me thods
2: Introduction
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 xPico config ur ation 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 xPico and its settings using
the xPico’s Web-Manager. ( See 4Configuration 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) )
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 identify the unit as a Lantronix
product. The fourth, fifth, and sixth bytes are unique numbers assigned to each unit.
Example: 00-80-A3-14-01-18
Note:Make note of the MAC address. It is needed to locate the xPico using
DeviceInstaller.
xPico User Guide 12
IP Address
Date Code
Product Model
Country of Origin
Revision
Every device connected to an IP network must have a unique IP address . T his
address is used to reference the specific unit. The xPico is automatically assign ed 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 T ab le 7-4. Reserved Port Numbers on page 42.
Product Informa ti on Label
The product information label on the unit contains the following information about the
specific unit:
2: Introduction
Part Number
Revision
Manufacturing Date Code
Product Model
Country of Origin
Lantronix Datamatrix Barcode
MAC Address
Figure 2-1. Product Label
Part Number
Manufacturing
MAC Address
Lantronix
Datamatrix
Barcode
xPico User Guide13
3. Using DeviceInstaller
This chapter covers the steps for getting the xPico device server online and viewing
its current configuration.
Note:DeviceInstaller is a free utility program provided by Lantronix that
discovers, configures, upgrades, and manages Lantronix Device Servers. It
can be downloaded from the Lantronix website at
www.lantronix.com/support/downloads.
For instructions on using DeviceInstaller to configure the IP address and
related settings or for more advanced features, see the
Online Help.
DeviceInstaller
Installing DeviceInstaller
To install DeviceInstaller:
1. Download the latest version of DeviceInstaller from
http://www.lantronix.com/downloads.
2. Run the executable to start the installation process.
3. Respond to the installation wizard prompts. (If prompted to select an installation
type, select Typical).
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.
Note: To use a serial connection instead of an Ethernet connection to configure the
device, see 5 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 StartPrograms LantronixDeviceInstallerDeviceInstaller. 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.
xPico User Guide 14
3: Using DeviceInstaller
Name
Configurable field. A name that identif ies the xPico.
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 ad d re ss. 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 result s displa y 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 xPico folder. The list of available Lantronix xPico modules display.
3. Expand the list of xPicos by clicking the + symbol next to the xPico icon. Select
the xPico 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 xPico.
2. In the right pane, click the Device Details tab. The current xPico configuration
displays:
xPico User Guide15
Double-click the field, type in the value, and press Enter to
complete. This name is not visible on other PCs or laptops
3: Using DeviceInstaller
DHCP Device Name
Non-configurable field. Displays the name associated with
or Configuration via Telnet or Serial Port (Setup Mode).
Group
Configurable field. A group name to categorize the xPico.
laptops using DeviceInstaller.
Comments
Configurable field. Information about the xPico.
PCs or laptops using DeviceInstaller.
Device Family
Non-configurable field. Displays the xPico’s device family as
xPico.
Type
Non-configurable field. Displays the device type as xPico.
ID
Non-configurable field. Displays the xPico’s ID embedded
within the unit.
Hardware Address
Non-configurable field. Displays the xPico’s hardware (or MAC)
address.
Firmware Version
Non-configurable field. Displays the firmware currently installed
on the xPico.
Extended Firmware
Version
Non-configurable field. Displays the full version nomenclature of
the firmware.
Online Status
Non-configurable field. Displays the xPico’s status as online,
(the xPico is currently performing a task).
IP Address
Non-configurable field. Displays the xPico’s current IP address.
page 14.
IP Address was Obtained
Displays “Dynamically” if the xPico automatically received an
Obtain via Auto IP with value of True or False
Subnet Mask
Non-configurable field. Displays the xPico’s current subnet
Address on page 14.
Gateway
Non-configurable field. Displays the xPico’s current gateway.
14.
Number of COB partitions
supported
Non-configurable field. Displays the number of COB partitions
supported.
Number of Ports
Non-configurable field. Displays the number of ports on the
xPico.
TCP Keepalive
Non-configurable field. Displays 1-65s, the xPico’s TCP
keepalive value. The default setting is 45.
xPico’s current IP address, if the IP address was obtained
dynamically.
To change the DHCP device name, see Configuration Using
Web Manager
Double-click the field, type in the value, and press Enter to
complete. This group name is not visible on other PCs or
Double-click the field, type in the value, and press Enter to
complete. This description or comment is not visible on other
offline, unreachable (the xPico is on a different subnet), or busy
To change the IP address, see Assigning an IP Address on
IP address (e.g., from DHCP). Displays “Statically” if the IP
address was configured manually. If the IP address was
assigned dynamically, the following fields appear:
Obtain via DHCP with value of True or False.
Ob tain via BOOTP with value of True or False.
Obtain via RARP with value of True or False
mask. To change the subnet mask, see Assign ing an IP
To change the gateway, see Assigning an IP Address on page
xPico User Guide 16
3: Using DeviceInstaller
Telnet Supported
Non-configurable field. Indicates if Telnet sessions are
permitted.
Telnet Port
Non-configurable field. Displays the xPico’s port for Telnet
sessions.
Web Port
Non-configurable field. Displays the xPico’s port for WebManager configuration.
Maximum Baud Rate
Non-configurable field. Displays the xPico’s maximum baud
Note: the xPico may not currently be running at this rate.
Firmware Upgradeable
Non-configurable field. Displays True, indicating the xPico’s
firmware is upgradeable as newer version become available.
Supports Configurable
Pins
Non-configurable field. Displays True, indicating configurable
pins are available on the xPico.
Supports Email Triggers
Non-configurable field. Displays False, indic ating email triggers
are not supported on xPico.
Non-configurable field. Displays True. xPico supports the RS485 protocol.
Supports 921K Baud Rate
Non-configurable field. Displays True. xPico supports baud
rates up to 921600 bits per second (bps).
Supports HTTP Server
Non-configurable field. Displays True.
Supports HTTP Setup
Non-configurable field. Displays True.
Supports 230K Baud Rate
Non-configurable field. Displays True.
Supports GPIO
Non-configurable field. Displays True, indicating the xPico
supports General Purpose Input Output (GPIO).
Supported
rate.
xPico User Guide17
4. Configuration Using Web Man ager
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 wil l respo nd to seria l and net wor k
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 xPico 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 Web-Manager Using DeviceInstaller
Note: For more information on DeviceInstaller, see 3 Using DeviceInstaller.
1. Run DeviceInstaller and search for the list of available Lantronix device servers.
2. Click on the xPico folder. The list of available xPicos displays.
3. Expand the list of xPicos by clicking the + symbol next to the xPico icon.
4. Select the xPico unit by clicking its hardware address.
5. In the right pane, click the WebConfiguration tab.
6. To view the xPico’s Web-Manager in the current DeviceInstaller window, click the
Go button. To open the Web-Manager in a web browser, click the External
Browser button.
Note: Alternatively, to open Web-Manager, open your web browser and
enter the IP address of the xPico.
A dialog box appears to prompt for a User Name and Password.
xPico User Guide 18
4: Configuration Using Web Manager
Figure 4-1. Web-Manager Login Window
7. 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.
Network Configuration
The unit’s network values display when you select Network from the main menu. The
following sections describe the conf ig urab le par ameters on the Network Settings
page.
xPico User Guide 19
4: Configuration Using Web Manager
Network Mode
WiredOnly is the only choice. It enables the Ethernet network
connectivity.
BOOTP
Select Enable to permit the Bootstrap Protocol (BOOTP).
automatically. Enable is the default.
DHCP
Select Enable to permit the Dynamic Host Configuration
Figure 4-3. Network Settings
Network Mode
1. Click Network from the main menu.
2. Note the following:
Automatic IP Address Configuration
An IP address can be assig ned 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):
server to assign the IP address from a pool of addresses
xPico User Guide 20
4: Configuration Using Web Manager
Protocol (DHCP) to assign a leased IP address to the xPico
unit automatically. Enable is the default.
AutoIP
Select Enable to permit the xPico to generate an IP in the
the default.
DHCP Host Name
Enter the desired host name for the xPico.
IP Address
If DHCP is not used to assign IP addresses, enter it manually
unique value in the network.
Subnet Mask
A subnet mask defines the number of bits taken from the IP
address that are assigned for the host part.
Default Gateway
The gateway address, or router, allows communication to
network.
DNS Server
The DNS server allows the name of a remote machine to be
mode.
169.254.x.x address range with a Class B subnet. Enable is
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):
in decimal-dot notation. The IP address must be set to a
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
resolved automatically. Enter the IP address of the DNS
server. If the device is DHCP enabled, the DHCP server
provides the DNS server IP address, which will override this
configured value.
Note: This setting is applicable only in Manual Connection
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):
xPico User Guide21
Auto Negotiate
With this option, the Ethernet port auto-negotiates the speed
default is Full.
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 conf ig urab le par ameters on the Server Settings page.
4: Configuration Using Web Manager
and duplex with the hardware endpoint to which it is
connected. This is the default.
If this option is n ot selecte d, the complete the fields that
become available:
Speed: The speed of data transmission. The default
is 100 Mbps.
Duplex: The direction of data transmis si on. The
Figure 4-4. Server Settings
To configure the xPico’s device server settings:
1. On the main menu, click Server.
2. Configure or modify the following fields:
xPico User Guide22
Server Configuration
Advanced Password
Select whether to enable advanced password:
passwords up to 4 bytes in length.
Telnet/Web
Manager Password
Enter the password required for Telnet conf iguratio n and Web
Manager access.
Retype Password
Re-enter the password required for Telnet confi gurat ion and
Web Manager access.
ARP Cache Timeout
When the unit communicates with another device on the
refreshes this table.
TCP Keepalive
TCP Keepalive time defines how many seconds the unit waits
keepalive. The default setting is 45.
Monitor Mode @ Bootup
Select Disable to disable entry into the monitor mode using
initialization at startup.
CPU Performance Mode
Select the xPico’s performance mode. Higher performance
Mhz. The default is Regular.
HTTP Server Port
This option allows the configuration of the web server port
number. The valid range is 1-65535. The default port is 80.
Config Server Port
Not applicable for this product.
MTU Size
The Maximum Transmission Unit (MTU) is the largest physical
between 512 and 1400 bytes. The default is 1400 bytes.
TCP Re-transmission
The desired TCP re-transmission timeout value. If the ACK is
msec.
Advanced
4: Configuration Using Web Manager
Enable: selecting this option enables advanced
password creation, allowing you to create passwords up
to 16 bytes in length.
Disable: selecting this option disables advanced
password creation, allowing you to create basic
network, it adds an entry into its ARP table. ARP Cache
timeout defines the number of seconds (1-600) before it
during an inactive connection before ch ec king its statu s. If the
unit does not receive a response, it drops that connection.
Enter a value between 0 and 60 seconds. 0 disables
timeout (ms)
3. When you are finished, click the OK button.
4. On the main menu, click Apply Settings.
Host List Configuration
the 'yyy' or 'xx1' key sequence at startup. This field prevents
the unit from entering monitor mode by interpreting the str e a m
of characters that are received during the device server's
settings require more energy. Regular is 48 Mhz; High is 88
packet size a network can transmit for TCP and UDP. Enter
not received for a packet sent from the xPico device, then the
unit will retransmit the data. The valid range is 500-4000
The xPico 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.
xPico User Guide 23
4: Configuration Using Web Manager
Retry Counter
Enter the value for the number of times the xPico should
attempt to retry connecting to the host list.
Retry Timeout
Enter the duration (in milliseconds) the xPico should abandon
attempting a connection to the host list.
Host Address
Enter or modify the host’s IP address.
Port
Enter the target port number.
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 xPico’s host list:
1. On the main menu, click Hostlist.
Figure 4-5. Hostlist Settings
2. Enter or modify the following fields:
Retry Settings
Host Information
3. When you are finished, click the OK button.
4. On the main menu, click Apply Settings.
Channel 1 and 2 Configuration
The Channel 1 and Channel 2 configuration define how the serial ports respond to
network and serial communication.
xPico User Guide 24
Loading...
+ 55 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.