Page 2 - Lantronix Corporate Headquarters
Copyright and Trademark © 2013 Lantronix. All rights reserved. No part of the contents of this book may be transmitted or reproduced in any form or by any means without the written permission of Lantronix. DeviceLinx®, xPico™ and DeviceInstaller™ are trademarks of Lantronix. Ethernet is a trademark ...
Page 3 - Disclaimer
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 ...
Page 4 - Table of Contents; Using This Guide
Table of Contents Copyright and Trademark ............................................................................................. 2 Warranty ....................................................................................................................... 2 Contacts..........................
Page 5 - Configuration via Telnet or Serial Port (Setup Mode)
Table of Contents Server Configuration ................................................................................................... 22 Server Configuration ............................................................................................ 23 Advanced ...................................
Page 6 - Setup Mode: Advanced Settings
Table of Contents c) Active Startup ................................................................................................... 44 d) Datagram Type ................................................................................................ 47 e) Modem Mode .................................
Page 8 - List of Tables
List of Tables and Figures List of Tables Table 6-1. BootP/DHCP/AutoIP Options ____________________________________________ 37 Table 6-2. Standard IP Network Netmasks __________________________________________ 38 Table 7-1. Interface Mode Options ________________________________________________ 41 T...
Page 9 - Using This Guide; Purpose and Audience
1. Using This Guide Purpose and Audience This guide covers xPico Device Server 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 rem...
Page 10 - Additional Documentation
1: Using This Guide Additional Documentation Visit the Lantronix W eb site at www.lantronix.com/support/documentation for the latest documentation and the following additional documentation. Document Description xPico Quick Start Provides the steps for getting the xPico evaluation board up and runni...
Page 12 - Protocol Support; Configuration Methods; Addresses and Port Numbers; Hardware Address
2: Introduction 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. Supported pro...
Page 13 - Product Information Label
2: Introduction 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 xPico is automatically assigned an IP address on DHCP-enabled networks, as it is DHCP-enabled by default. Port Numbers Every TCP connection and e...
Page 14 - Using DeviceInstaller; Installing DeviceInstaller; Assigning an IP Address
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 downloa...
Page 15 - Accessing the xPico Using DeviceInstaller
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 ...
Page 18 - Configuration Using Web Manager; Accessing Web-Manager Using DeviceInstaller
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’...
Page 19 - OK; Network Configuration; Network
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 ...
Page 20 - Automatic IP Address Configuration; To assign an IP address automatically:
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 Wired Only is the only choice. It enables the Ethernet network connectivity. Automatic IP Address Configuration An IP address can be assigned automati...
Page 21 - Static IP Address Configuration; Ethernet Configuration
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 169.254.x.x address range with a Class B subnet. Enable is the default. DHCP Host Name Enter the ...
Page 22 - Server Configuration; Server; To configure the xPico’s device server settings:
4: Configuration Using Web Manager Auto Negotiate 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 da...
Page 23 - Host List Configuration
4: Configuration Using Web Manager Server Configuration Advanced Password Select whether to enable advanced password: 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 pa...
Page 24 - To configure the xPico’s host list:; Retry Settings; Host Information; Channel 1 and 2 Configuration
4: Configuration Using Web Manager 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 opti...
Page 25 - Serial Settings; To configure the channel’s serial settings:; Channel 1; Port Settings
4: Configuration Using Web Manager Note: Directions for configuring Channel 1 serial settings and connection apply for Channel 2 configuration, except where indicated. Serial Settings To configure the channel’s serial settings: 1. On the main menu, click Serial Settings (under Channel 1 ) to display...
Page 26 - Pack Control
4: Configuration Using Web Manager device is prepared to manage it causes lost or retransmitted data. None is the default. Channel 1: None, Xon/Xoff, Xon/Xoff Pass Chars to Host or CTS/RTS (hardware). Channel 2: None, Xon/Xoff or Xon/Xoff Pass Chars to Host Baud Rate The unit and attached serial...
Page 27 - Connection Settings - TCP; To configure a channel’s TCP settings:
4: Configuration Using Web Manager 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 ...
Page 29 - Connect Protocol
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. Required Determines...
Page 30 - Disconnect Mode; Connection Settings - UDP; To configure a channel’s UDP settings:
4: Configuration Using Web Manager 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 This field is available for c...
Page 32 - Configurable Pin Settings; To configure the xPico’s Configurable Pins:; Configurable Pin Functions
4: Configuration Using Web Manager 3. When you are finished, click the OK button. 4. On the main menu, click Apply Settings . Configurable Pin Settings There are eight configurable hardware pins on the xPico unit. For each pin, configure the pin function, communication direction, and activity level....
Page 33 - Apply Settings; Apply Defaults; Yes
4: Configuration Using Web Manager 2-wire and 4-wire mode on OEM hardware design. Serial Channel 1 Status LED Indicates channel 1 status and extended diagnostics. Serial Channel 2 Status LED Indicates channel 2 status and extended diagnostics. 3. When you are finished, click the OK button. 4. On the...
Page 34 - Configuration via Telnet or Serial Port; Setup; Accessing Setup Mode; Telnet Connection
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 Telne...
Page 35 - Serial Port Connection
5: Configuration via Telnet or Serial Port (Setup Mode) To establish a Telnet connection: 1. From the W indows 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: tel...
Page 36 - Exiting Setup Mode; Save and exit; Exit without save
5: Configuration via Telnet or Serial Port (Setup Mode) 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 xPico. At this point, the screen display is the same as when you...
Page 37 - Server configuration; IP Address; Enter; Options
6. Setup Mode: Server Configuration This chapter explains how to configure the network settings. Note: Current values appear 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 A...
Page 38 - Set Gateway IP Address; Netmask: Number of Bits for Host Part; Network Class; Set DNS Server IP Address
6: Setup Mode: Server Configuration 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 d...
Page 39 - DHCP Name; Default DHCP Name; Custom DHCP Name; Change DHCP
6: Setup Mode: Server Configuration An enhanced password setting (for Telnet access only) of 16 characters is available under Security Settings (Option 6) on page 56. 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...
Page 40 - Channel; Baudrate
7. Setup Mode: Channel Configuration This chapter explains how to configure the serial port. Channel 1 (Option 1) or Channel 2 (Option 2) Select Channel 1 (option 1 ) or Channel 2 (option 2 ) from the Change Setup menu to define how the serial port responds to network and serial communications. The ...
Page 41 - Common I/F Mode Setting; Flow
7: Setup Mode: Channel Configuration 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 ...
Page 42 - Port Number; Port Numbers Reserved for; Connect Mode
7: Setup Mode: Channel Configuration Table 7-3. Flow Control Options Flow Control Option Hex No flow control 00 XON/XOFF flow control 01 Hardware handshake with RTS/CTS lines 02 XON/XOFF pass characters to host 05 Port Number The setting represents the source port number in TCP connections. It is th...
Page 43 - Connect Mode Option; a) Incoming Connection
7: Setup Mode: Channel Configuration Table 7-5. Connect Mode Options Connect Mode Option 7 6 5 4 3 2 1 0 a) Incoming Connection 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=unrea...
Page 45 - Command String
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). ...
Page 47 - CF
7: Setup Mode: Channel Configuration d) Datagram Type 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. Wh...
Page 48 - Function
7: Setup Mode: Channel Configuration Message Meaning Numeric Response 0 OK 1 Connected 2 Ring 3 No Carrier 4 Error 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...
Page 49 - Auto Increment Source Port
7: Setup Mode: Channel Configuration Modem Mode Command Function ATD0.0.0.0 Forces the unit into Monitor Mode if a remote IP address and port number are defined within the unit. ATD or ATDT Forces the unit into Monitor Mode if a remote IP address and port number are not defined within the unit. ATDx...
Page 50 - Remote IP Address; Remote Port; DisConnMode; Disconnect Mode Option
7: Setup Mode: Channel Configuration Y (Yes) auto increment the source port. The xPico 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 : (000) (000) (000) (000)_ Note: This option does ...
Page 52 - Option; -Byte Send Character Sequence
7: Setup Mode: Channel Configuration 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. Ta...
Page 53 - Telnet Terminal Type
7: Setup Mode: Channel Configuration DisConnTime (Inactivity Timeout) Use this parameter to set an inactivity timeout. The unit drops the TCP connection to the local port 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 ...
Page 54 - TCP Keepalive time in seconds
8. Setup Mode: Advanced Settings Expert Settings (Option 5) Note: You can change the Enable alternate MAC setting using telnet or serial connections only. It is not available through the Web-Manager. CAUTION: Only an expert should change these parameters. You must definitely know the consequences th...
Page 55 - yyy; HTTP Port Number
8: Setup Mode: Advanced Settings 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 ...
Page 56 - TCP Re-Transmission Timeout
8: Setup Mode: Advanced Settings TCP Re-Transmission Timeout The TCP Re-Transmission Timeout is the interval to wait for acknowledgement of transmitted TCP segments before re-transmitting them. Enter between 500 and 4000 ms. The default is 500 ms . TCP Re-transmission Timeout (500 - 4000) (ms): (500...
Page 57 - public; Disable Telnet Setup
8: Setup Mode: Advanced Settings Disable Port 77F0h (N) ? Disable SNMP This setting allows you to disable the SNMP protocol on the unit for security reasons. Disable SNMP (N) ? _ 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...
Page 58 - Disable TFTP Firmware Upgrade; Disable Web Server
8: Setup Mode: Advanced Settings 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 Firmw...
Page 59 - Enable Encryption; To configure AES encryption on the xPico:
8: Setup Mode: Advanced Settings Enable Encryption Rijndael is the block cipher algorithm chosen by the National Institute of Science and Technology (NIST) as the Advanced Encryption Standard (AES) to be used by the US government. The xPico supports 128-, 192-, and 256-bit encryption key lengths. No...
Page 60 - Enable Enhanced Password; Channel 1 and Channel 2 Configuration Defaults
8: Setup Mode: Advanced Settings Lantronix Secure Com Port Redirector provides an encrypted connection from Windows-based applications to the xPico. Information about SCPR is at www.lantronix.com/device-networking/utilities-tools/scpr A 30-day trial version of SCPR is available. Note: Developers c...
Page 62 - Configurable Pins; Features
9. GPIO Interface Configurable Pins The xPico has eight pins (CP1-8) that you can configure for General Purpose I/O (GPIO). Note: You can also configure the pins for serial port control lines, such as hardware control, modem control (CTS, RTS, DTR, and DCD), and diagnostic outputs to LED, using Devi...
Page 63 - Control Protocol; Guidelines; Get; Commands; Byte 0 Command Types; Set functions
9: GPIO Interface Control Protocol 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 xPico. Response comes from xPico to PC. The protocol allows for control of up to 32 GPIOs. How many are actually a...
Page 65 - Examples
9: GPIO Interface 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...
Page 67 - Firmware Upgrades; Obtaining Firmware; Using TFTP: Graphical User Interface
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/support/downloads ) or by using anonymous FTP ( ftp.lantronix.com/pub ). Reloading Firmware There are several ways to update the unit's ...
Page 68 - Put; Using TFTP: Command Line Interface; To download new firmware from a computer:
10: Firmware Upgrades Figure 10-1. TFTP Window 6. Click the Put button to transfer the file to the unit. The unit performs a power reset after the firmware has been loaded and stored. After the firmware has been loaded and stored, which takes approximately 8 seconds to complete, the unit performs a ...
Page 70 - Entering Monitor Mode Using the Serial Port; To enter Monitor Mode locally:; zzz; Entering Monitor Mode Using the Network Port; To enter Monitor Mode using a Telnet connection:; Monitor Mode Commands
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 ...
Page 73 - Troubleshooting; Problems and Error Messages
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 ...
Page 76 - Technical Support; Technical Support US
12: Troubleshooting 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: Technical Support US Check our online knowledge base or send a question to Technical Support at http://www.lantronix.co...
Page 77 - Binary to Hexadecimal Conversions; Converting Binary to Hexadecimal; Conversion Table; Decimal; Scientific Calculator
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 Followin...
Page 79 - Compliance; RoHS Notice
B: Compliance RoHS Notice All Lantronix products in the following families are China RoHS-compliant and free of the following hazardous substances and elements: • Lead (Pb) • Mercury (Hg) • Polybrominated biphenyls (PBB) • Cadmium (Cd) • Hexavalent Chromium (Cr (VI)) • Polybrominated diphenyl ethers...
