Lantronix xPico User Manual

Lantronix xPico User Manual

Device server
Hide thumbs Also See for xPico:
Table of Contents

Advertisement

Quick Links

xPico
User Guide
Part Number 900-618
Revision B January 2013

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the xPico and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Summary of Contents for Lantronix xPico

  • Page 1 User Guide Part Number 900-618 Revision B January 2013...
  • Page 2: Copyright And Trademark

    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.
  • Page 3: Disclaimer

    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.
  • Page 4: Table Of Contents

    Product Information Label ..................13 3. Using DeviceInstaller Installing DeviceInstaller ..................... 14 Assigning an IP Address .................... 14 Accessing the xPico Using DeviceInstaller ..............15 Viewing the Current Configuration ................15 4. Configuration Using Web Manager Accessing Web-Manager Using DeviceInstaller ............18 Network Configuration ....................
  • Page 5 Channel 1 (Option 1) or Channel 2 (Option 2) ............40 Baudrate ........................40 I/F (Interface) Mode ....................41 Flow ..........................41 Port Number ....................... 42 Connect Mode ......................42 a) Incoming Connection ..................43 b) Response ......................44 xPico User Guide...
  • Page 6 Security Settings (Option 6)..................56 Disable SNMP ...................... 57 SNMP Community Name ..................57 Disable Telnet Setup .................... 57 Disable TFTP Firmware Upgrade ................ 58 Disable Port 77FE (Hex) ..................58 Disable Web Server ..................... 58 Disable Web Setup ....................58 xPico User Guide...
  • Page 7 12. Troubleshooting Problems and Error Messages ................... 73 Technical Support ....................... 76 A: Binary to Hexadecimal Conversions Converting Binary to Hexadecimal ................77 Conversion Table ....................77 Scientific Calculator ..................... 77 B: Compliance RoHS Notice ....................... 79 xPico User Guide...
  • Page 8: List Of Tables

    List of Figures Figure 2-1. Product Label _______________________________________________________ 13 Figure 4-1. Web-Manager Login Window ___________________________________________ 19 Figure 4-2. Lantronix Web-Manager _______________________________________________ 19 Figure 4-3. Network Settings _____________________________________________________ 20 Figure 4-4. Server Settings ______________________________________________________ 22 Figure 4-5. Hostlist Settings _____________________________________________________ 24 Figure 4-6.
  • Page 9: 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.
  • Page 10: Additional Documentation

    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 xPico using the evaluation board, and integrating the xPico into your product.
  • Page 11: Introduction

     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 ...
  • Page 12: Protocol Support

    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.
  • Page 13: Ip Address

    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.
  • Page 14: Using Deviceinstaller

    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...
  • Page 15: Accessing The Xpico Using Deviceinstaller

    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.
  • Page 16 Online Status Non-configurable field. Displays the xPico’s status as online, offline, unreachable (the xPico is on a different subnet), or busy (the xPico is currently performing a task). IP Address Non-configurable field. Displays the xPico’s current IP address.
  • Page 17 Maximum Baud Rate Non-configurable field. Displays the xPico’s maximum baud Supported rate. 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 Non-configurable field.
  • Page 18: Configuration Using Web Manager

    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.
  • Page 19: Network Configuration

    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.
  • Page 20: Network Mode

    3. Enter the following (as necessary): 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 xPico User Guide...
  • Page 21: Static Ip Address Configuration

    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.
  • Page 22: 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. 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:...
  • Page 23: Server Configuration

    4. On the main menu, click Apply Settings. Host List Configuration 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.
  • Page 24: Retry Settings

    2. Enter or modify the following fields: Retry Settings 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.
  • Page 25: Serial Settings

    Channel 1: RS232, RS422/RS485 – 4 wire or RS485 – 2 wire protocols.  Channel 2: RS232 only Flow Control Flow control manages data flow between devices in a network to ensure it is processed efficiently. Too much data arriving before a xPico User Guide...
  • Page 26: Pack Control

    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 xPico. The default is No. Match Bytes Use to indicate the end of a series of data to be sent as one group.
  • Page 27: Connection Settings - Tcp

    3. When you are finished, click the OK button. 4. On the main menu, click Apply Settings. 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. xPico User Guide...
  • Page 28: Figure 4-7. Tcp Connection Settings

    4: Configuration Using Web Manager Figure 4-7. TCP Connection Settings xPico User Guide...
  • Page 29: Connect Protocol

    Remote Port Enter the remote port number. Remote Host Enter the IP address of the remote device. Common Options Telnet Com Port Cntrl This field is available for configuration only when Active xPico User Guide...
  • Page 30: Connection Settings - Udp

    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. 2. In the available fields, enter or modify the following information: xPico User Guide...
  • Page 31: Figure 4-8. Udp Connection Settings

    The table is enabled when Datagram Type is set to FD. Enter 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. xPico User Guide...
  • Page 32: Configurable Pin Settings

    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. For more information, 9 GPIO Interface.
  • Page 33: Apply Settings

    Apply Settings button. Note: Clicking OK on each page does not change the configuration on the device. Clicking the OK button tells the xPico what changes to use; the Apply Settings button makes the changes permanent and reboots the xPico. Apply Defaults 1.
  • Page 34: Configuration Via Telnet Or Serial Port (Setup Mode)

    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. xPico User Guide...
  • Page 35: Serial Port Connection

    Note: The xPico always uses these serial port settings on boot-up. 3. Reset the xPico 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).
  • Page 36: Exiting Setup Mode

    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 use a Telnet connection. To...
  • Page 37: Setup Mode: Server Configuration

    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 xPico to disable AutoIP, DHCP, or BootP. To disable an option, set the appropriate bit.
  • Page 38: Set Gateway Ip Address

    Change Telnet/Web-Manager Password Setting the Telnet/Web-Manager 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/Web-Manager password (N) ? _ xPico User Guide...
  • Page 39: Dhcp Name

    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). xPico User Guide...
  • Page 40: Setup Mode: Channel Configuration

    Valid baud rates are 300, 600, 1200, 2400, 4800, 9600 (default), 19200, 38400, 57600, 115200, and 230400 bits per second. xPico also supports high-performance baud rates of 460800 and 921600 bits per second. (See CPU Performance on page 55).
  • Page 41: I/F (Interface) Mode

    RS-232C, 8-bit, No Parity, 1 stop bit 0100 1100 RS-232C, 7-bit, Even Parity, 1 stop bit 0111 1000 Flow Flow control sets the local handshaking method for stopping serial input/output. Flow (00) ? _ Use the following table to select flow control options: xPico User Guide...
  • Page 42: Port Number

    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. xPico User Guide...
  • Page 43: A) Incoming Connection

    Accepts external connection requests only when the Modem Modem Control In Control In input is asserted. Cannot be used with Modem Mode. Always Accept Accepts any incoming connection when a connection is not already established. Default setting. xPico User Guide...
  • Page 44: B) Response

    Attempts to connect when the Modem Control In input changes Control In from not asserted to asserted. With a Specific Start Attempts to connect when it receives a specific start character Character from the serial port. The default start character is carriage return. xPico User Guide...
  • Page 45: Table 7-6. Manual Connection Address Example

    Connects to 129.1.28.10, port 12 C0.0.0.0/0 Enters Monitor Mode Cwww.lantronix.com/80 Tries to connect to the Lantronix web server if the <hostname:domain> (www.lantronix.com) is configured in the DNS server database. If you enable Autostart, the unit automatically connects to the Autostart (Automatic...
  • Page 46: Figure 7-2. Hostlist Option

    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.
  • Page 47: D) Datagram Type

    Meaning Full Verbose Command was executed without error. CONNECT A network connection has been established. NO CARRIER A network connection has been closed. A remote device, having IP address n.n.n.n, is connecting to this RING n.n.n.n. device. xPico User Guide...
  • Page 48: Table 7-8. Modem Mode Commands

    Function Command ATDTx.x.x.x,pppp, ATDTx.x.x.x/pppp, Makes a connection to an IP address (x.x.x.x) and a remote port number (pppp). ATDTx.x.x.x:pppp Makes a connection to an IP address (x.x.x.x) and the remote port ATDTx.x.x.x number defined within the unit. xPico User Guide...
  • Page 49: Send The Escape Sequence (+++) In Modem Mode

    Send the Escape Sequence (+++) in Modem Mode Send ‘+++’ in Modem Mode (Y) ? _ Disable or enable the xPico’s ability to send the escape sequence. The default is Y (Yes) (send the escape sequence). Show IP addr after 'RING'...
  • Page 50: Remote Ip Address

    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)_...
  • Page 51: Flush Mode (Buffer Flushing)

    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. xPico User Guide...
  • Page 52: Packing Interval

    "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. xPico User Guide...
  • Page 53: Disconntime (Inactivity Timeout)

    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. xPico User Guide...
  • Page 54: Setup Mode: Advanced Settings

    If the unit gets no response, it drops that connection. TCP Keepalive time in s (1s – 65s; 0s=disable): (45)? _ xPico User Guide...
  • Page 55: Arp Cache Timeout In Seconds

    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) ? _ xPico User Guide...
  • Page 56: Tcp Re-Transmission Timeout

    Enable alternate MAC (N) ? _ Ethernet Connection Type The xPico 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 (10 MB/half duplex), 3 (10 MB/full duplex), 4 (100 MB/half duplex), or 5 (100 MB/full duplex).
  • Page 57: Disable Snmp

    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) ? _ xPico User Guide...
  • Page 58: Disable Tftp Firmware Upgrade

    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) ? _ xPico User Guide...
  • Page 59: Enable Encryption

    To configure AES encryption on the xPico: 1. When prompted to enable encryption, select Y. 2. When prompted, enter the encryption key length. The xPico supports 128-, 192-, and 256-bit encryption key lengths. 3. When prompted to change keys, select Y.
  • Page 60: Enable Enhanced Password

    Enable Enhanced Password (Y) ? _ Disable Port 77F0 (Hex) Port 77F0 is a setting that allows a custom application to query or set the eight xPico configurable pins when they are functioning as general purpose I/O (GPIO). You may want to disable this capability for security purposes.
  • Page 61: Expert Settings Defaults

    0 (auto-negotiate) Security Settings Defaults Disable SNMP SNMP community name public Disable Telnet setup Disable TFTP Firmware Update Disable Port 77FEh Disable Web Server Disable Web Setup Disable ECHO ports Enable Encryption Enable Enhanced Password Disable Port 77F0h xPico User Guide...
  • Page 62: Gpio Interface

    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 DeviceInstaller.
  • Page 63: Control Protocol

    There is no Set functions command. Since the pin’s function depends on the hardware in which the xPico 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.
  • Page 64 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. xPico User Guide...
  • Page 65: Examples

    Examples Example 1: PC sends command 10h to find out which configurable pins are available as GPIO. PC -> xPico: 10h, 00h, 00h, 00h, 00h, 00h, 00h, 00h, 00h xPico -> PC: 10h, 03h, 00h, 00h, 00h Command details: xPico User Guide...
  • Page 66 Example 2: PC sends command 1Bh to change the current states of GPIO 0 and 1. PC -> xPico: 1Bh, 01h, 00h, 00h, 00h, 00h, 00h, 00h, 00h xPico -> PC: 1Bh, 05h, 00h, 00h, 00h Command details: 1Bh = command 1Bh 01h, 00h, 00h, 00h = the mask that determines which GPIOs will be changed.
  • Page 67: 10. Firmware Upgrades

    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.
  • Page 68: Using Tftp: Command Line Interface

    –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 xpico_6800 X6 tftp –i 192.168.1.111 put xpico_webm_1900.cob WEB1 xPico User Guide...
  • Page 69: Recovering The Firmware Using The Serial Port And Deviceinstaller

    5. For Firmware File, click the Browse button and go to the location where the firmware file resides. Note: Make sure the xPico on which you are recovering firmware is connected to this selected port on your PC. 6. Click OK to download the file.
  • Page 70: 11. Monitor Mode

    To enter Monitor Mode using a Telnet connection: 1. Establish a Telnet session to the configuration port (9999). The following message appears: MAC address 0080A366000E Software version V6.8.0.0RC4 (120327) XPICO AES library version 1.8.2.1 Press Enter for Setup Mode 2. Type M (upper case).
  • Page 71: Table 11-1. Monitor Mode Commands

    192.168.0.1 = gateway IP address 10001 = port number of the xPico Channel 1 192.168.1.10 = IP address of the DNS Server The xPico stores the setup and performs a reset. It sends an X before the reset if the command was Note:...
  • Page 72: Table 11-2. Command Response Codes

    11: Monitor Mode Table 11-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 xPico User Guide...
  • Page 73: 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.
  • Page 74 Double-check everything in the mode on the device server something covered in the problem above. Confirm that using the serial port, you get no previous problem, or Caps Lock is not on. response. possibly, you have Caps Lock on. xPico User Guide...
  • Page 75 30718 (77FEh) on the router that you are using on the With The Device Server" device server. network. Also, make sure that message displays. port 77FEh is not disabled within the Security settings of the device server. xPico User Guide...
  • Page 76: Technical Support

    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). xPico User Guide...
  • Page 77: A: Binary To Hexadecimal Conversions

    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. 3. Select Bin (Binary), and type the number to convert. xPico User Guide...
  • Page 78 : Binary to Hexadecimal Conversions 4. Click Hex. The hexadecimal value displays. xPico User Guide...
  • Page 79: B: Compliance

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

Table of Contents