Lantronix xPico xPico - User Guide

Lantronix xPico Manual

Lantronix xPico manual content summary:

  • Lantronix xPico | xPico - User Guide - Page 1
    xPico User Guide Part Number 900-618 Revision B January 2013
  • Lantronix xPico | xPico - User Guide - Page 2
    CA 92618, USA Toll Free: 800-526-8766 Phone: 949-453-3995 Fax: 949-450-7249 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 xPico User Guide 2
  • Lantronix xPico | xPico - User Guide - Page 3
    History Date April 2012 January 2013 Rev. Comments A Initial release for firmware version 6.8.0.0. B Updated for firmware version 6.8.0.3. For the latest revision of this product document, please check our online documentation at www.lantronix.com/support/documentation. xPico User Guide 3
  • Lantronix xPico | xPico - User Guide - Page 4
    History...3 List of Tables ...8 List of Figures ...8 1. Using This Guide 9 Purpose and Audience 9 Chapter Summary ...9 Additional Documentation 10 2. Introduction 11 Capabilities ...11 Applications ...11 Protocol Support ...12 Configuration Methods 12 Addresses and Port Numbers 12
  • Lantronix xPico | xPico - User Guide - Page 5
    40 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 5
  • Lantronix xPico | xPico - User Guide - Page 6
    Enable alternate MAC 56 Ethernet Connection Type 56 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
  • Lantronix xPico | xPico - User Guide - Page 7
    70 Monitor Mode Commands 70 12. Troubleshooting 73 Problems and Error Messages 73 Technical Support...76 A: Binary to Hexadecimal Conversions 77 Converting Binary to Hexadecimal 77 Conversion Table 77 Scientific Calculator 77 B: Compliance 79 RoHS Notice ...79 xPico User Guide 7
  • Lantronix xPico | xPico - User Guide - Page 8
    Connect Mode Options 43 Table 7-6. Manual Connection Address Example 45 Table 7-7. 7-11. Pack Control Options 52 Table 10-1. Firmware Files 67 Table 11-1. Monitor Mode Commands 71 Table -Manager Login Window 19 Figure 4-2. Lantronix Web-Manager 19 Figure 4-3. Network xPico User Guide 8
  • Lantronix xPico | xPico - User Guide - Page 9
    the latest firmware and updating the xPico. 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
  • Lantronix xPico | xPico - User Guide - Page 10
    1: Using This Guide Additional Documentation Visit the Lantronix Web site at www.lantronix.com/support/documentation for the latest documentation and the following additional documentation. Document xPico Quick Start xPico Integration Guide xPico Development Kit Quick Start Com Port Redirector
  • Lantronix xPico | xPico - User Guide - Page 11
    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 access control devices  Handheld instruments  Modems  Time/attendance clocks and terminals xPico User Guide 11
  • Lantronix xPico | xPico - User Guide - Page 12
    Supported protocols include:  ARP, TCP/IP, UDP/IP, BOOTP, ICMP, Telnet, TFTP, AutoIP, DHCP, HTTP, and SNMP for network communications and management.  TCP/IP, UDP/IP, and Telnet for connections to the serial port.  TFTP for firmware xPico xPico and its settings using the xPico a Lantronix product.
  • Lantronix xPico | xPico - User Guide - Page 13
    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 Date Code  Product Model  Country of Origin  Lantronix Datamatrix Barcode  MAC Address Part Number Revision Manufacturing Date
  • Lantronix xPico | xPico - User Guide - Page 14
    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 recommend that you manually assign the IP Lantronix device servers on the local network. xPico User Guide 14
  • Lantronix xPico | xPico - User Guide - Page 15
    dialog box and return to the main window. Accessing the xPico Using DeviceInstaller 1. Click StartPrograms  LantronixDeviceInstaller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
  • Lantronix xPico | xPico - User Guide - Page 16
    Family Type ID Hardware Address Firmware Version Extended Firmware Version Online Status IP Address IP Address was Obtained Subnet Mask Gateway Number of COB partitions supported Number of Ports TCP Keepalive Non-configurable field. Displays the name associated with xPico's current IP address, if
  • Lantronix xPico | xPico - User Guide - Page 17
    True, indicating the xPico's firmware is upgradeable as newer version become available. Non-configurable field. Displays True, indicating configurable pins are available on the xPico. Non-configurable field. Displays False, indicating email triggers are not supported on xPico. Non-configurable field
  • Lantronix xPico | xPico - User Guide - Page 18
    xPico using Web-Manager, Lantronix 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 xPico's xPico. A dialog box appears to prompt for a User Name and Password
  • Lantronix xPico | xPico - User Guide - Page 19
    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
  • Lantronix xPico | xPico - User Guide - Page 20
    (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 20
  • Lantronix xPico | xPico - User Guide - Page 21
    Enter the following (as necessary): IP Address 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. Subnet On the main menu, click Network. 2. Enter the following (as necessary): xPico User Guide 21
  • Lantronix xPico | xPico - User Guide - Page 22
    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
  • Lantronix xPico | xPico - User Guide - Page 23
    bytes. The desired TCP re-transmission timeout value. If the ACK is not received for a packet sent from the xPico device, then the unit will retransmit the data. The valid range is 500-4000 msec. 3. When you are to scroll through the table until the next successful connection. xPico User Guide 23
  • Lantronix xPico | xPico - User Guide - Page 24
    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
  • Lantronix xPico | xPico - User Guide - Page 25
    - 2 wire protocols.  Channel 2: RS232 only 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 25
  • Lantronix xPico | xPico - User Guide - Page 26
    Sequence Match Bytes Send Frame Immediate Send Trailing Bytes Select to enable packing on the xPico. Two firmware-selectable packing algorithms define how and when packets are sent to the network. The is No. Select Yes to clear the input buffer with a connection initiated xPico User Guide 26
  • Lantronix xPico | xPico - User Guide - Page 27
    , 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 27
  • Lantronix xPico | xPico - User Guide - Page 28
    4: Configuration Using Web Manager Figure 4-7. TCP Connection Settings xPico User Guide 28
  • Lantronix xPico | xPico - User Guide - Page 29
    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.  Com Port Cntrl This field is available for configuration only when Active xPico User Guide 29
  • Lantronix xPico | xPico - User Guide - Page 30
    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 displays. 2. In the available fields, enter or modify the following information: xPico User Guide 30
  • Lantronix xPico | xPico - User Guide - Page 31
    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 31
  • Lantronix xPico | xPico - User Guide - Page 32
    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 design. Optional control signal that enables toggling between RS485 xPico User Guide 32
  • Lantronix xPico | xPico - User Guide - Page 33
    reboots the xPico. Apply Defaults 1. Click the Apply Defaults button to set the device server back to the default settings. For details see Default Settings on page 60. 2. Click Yes to set factory settings or click No to cancel. Figure 4-10. Apply Settings and Apply Defaults xPico User Guide 33
  • Lantronix xPico | xPico - User Guide - Page 34
    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 window list, and click the Telnet Configuration tab. Skip steps 1 and 2. xPico User Guide 34
  • Lantronix xPico | xPico - User Guide - Page 35
    MAC Address MAC address 0080A366000E Software version V6.8.0.3 (120921) XPICO AES library version 1.8.2.1 Press Enter for Setup Mode 3. To 1 stop bit, no flow control. 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
  • Lantronix xPico | xPico - User Guide - Page 36
    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 continue, , select option 8 Exit without save from the Change Setup menu. xPico User Guide 36
  • Lantronix xPico | xPico - User Guide - Page 37
    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. of 0 and 2.) This is the most common setting when using DHCP. xPico User Guide 37
  • Lantronix xPico | xPico - User Guide - Page 38
    IP address, which will override this configured value. Note: This setting is applicable only in Manual Connection mode. Set DNS Server IP addr ? Change Telnet/Web-Manager Password Setting the . The password must have 4 characters. Change Telnet/Web-Manager password (N) ? _ xPico User Guide 38
  • Lantronix xPico | xPico - User Guide - Page 39
    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 39
  • Lantronix xPico | xPico - User Guide - Page 40
    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. xPico also supports high-performance baud rates of 460800 and 921600 bits per second. (See CPU Performance on page 55). Baudrate (9600
  • Lantronix xPico | xPico - User Guide - Page 41
    1000 78 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 41
  • Lantronix xPico | xPico - User Guide - Page 42
    : 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 42
  • Lantronix xPico | xPico - User Guide - Page 43
    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 Hostlist d) Datagram Type Directed UDP e) Modem Mode No Echo Data Echo & Modem connection when a connection is not already established. Default setting. xPico User Guide 43
  • Lantronix xPico | xPico - User Guide - Page 44
    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. xPico User Guide 44
  • Lantronix xPico | xPico - User Guide - Page 45
    Table 7-6. Manual Connection Address Example Command String C121.2.4.5/1 C5 C28.10/12 C0.0.0.0/0 Cwww.lantronix.com/80 Autostart 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. xPico User Guide
  • Lantronix xPico | xPico - User Guide - Page 46
    another IP in the hostlist. Hostlist supports a minimum of 1 and a maximum of 12 the port number. The hostlist is disabled for Manual and Modem Modes. The unit does not For Retrycounter, enter the number of times the Lantronix unit should try to make a good network 250. xPico User Guide 46
  • Lantronix xPico | xPico - User Guide - Page 47
    machine, accumulating phone charges for each connection. Modem Mode allows you to replace modems with xPicos, and to use an Ethernet connection instead of a phone call. By not having to has been closed. A remote device, having IP address n.n.n.n, is connecting to this device. xPico User Guide 47
  • Lantronix xPico | xPico - User Guide - Page 48
    to an IP address (x.x.x.x) and a remote port number (pppp). ATDTx.x.x.x Makes a connection to an IP address (x.x.x.x) and the remote port number defined within the unit. xPico User Guide 48
  • Lantronix xPico | xPico - User Guide - Page 49
    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 IP addr after 'RING' Show IP addr after 'RING' (Y) Disable or enable the xPico's ability to show the IP address after RING in Modem Mode. The default is Y
  • Lantronix xPico | xPico - User Guide - Page 50
    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 Channel (port) password (2) Hard disconnect (3) 0 1 1 0 Disable hard disconnect 1 xPico User Guide 50
  • Lantronix xPico | xPico - User Guide - Page 51
    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 51
  • Lantronix xPico | xPico - User Guide - Page 52
    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 52
  • Lantronix xPico | xPico - User Guide - Page 53
    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 53
  • Lantronix xPico | xPico - User Guide - Page 54
    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)? _ xPico User Guide 54
  • Lantronix xPico | xPico - User Guide - Page 55
    to use the higher baud rates on the serial interface (460800 bps and 921600 bps). The standard CPU performance mode supports up to 230400 bps. CPU performance (0=Regular, 1=Low, 2=High): (0) ? Notes:  If a baud rate 1400 bytes. The default is 1400 bytes. MTU Size: (1400) ? _ xPico User Guide 55
  • Lantronix xPico | xPico - User Guide - Page 56
    MAC (N) ? _ Ethernet Connection Type The xPico allows for the Ethernet speed and duplex to be manually configured. Enter 0 for auto-negotiation (default). SNMP Community Name (public): Disable Telnet Setup (N) ? Disable TFTP Firmware Update (N) ? Disable Port 77FEh (N) ? Disable Web Server (N)
  • Lantronix xPico | xPico - User Guide - Page 57
    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 57
  • Lantronix xPico | xPico - User Guide - Page 58
    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 controls whether port 7 echoes characters it receives. Disable ECHO ports (Y) ? _ xPico User Guide 58
  • Lantronix xPico | xPico - User Guide - Page 59
    Standard (AES) to be used by the US government. The xPico supports 128-, 192-, and 256-bit encryption key lengths. Note: Configuring xPico-to-xPico communication. Be sure to configure both modules with the same encryption key.  Third-party application to xPico-encrypted communication: xPico
  • Lantronix xPico | xPico - User Guide - Page 60
    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 can license the Lantronix Encryption Library Suite. See www.lantronix active connection startup) Enabled Enabled Disable 3 xPico User Guide 60
  • Lantronix xPico | xPico - User Guide - Page 61
    timeout Start character for serial channel 1 (or channel 2) All other parameters 250 (msec) 0x0D (CR) 0 Expert Settings Defaults TCP Keepalive time in No SNMP community name public Disable Telnet setup No Disable TFTP Firmware Update No Disable Port 77FEh No Disable Web Server No
  • Lantronix xPico | xPico - User Guide - Page 62
    Purpose Input Active Level: Active Low Features  TCP and UDP can be used.  The protocol supports up to 32 GPIO for future products.  Function configuration can be retrieved.  Input or output selection port for data transfer, the throughput is low, usually up to 1 Kbps. xPico User Guide 62
  • Lantronix xPico | xPico - User Guide - Page 63
    side. Send means from PC to xPico. Response comes from xPico to PC. The protocol allows for are actually available depends on the product. xPico has only eight. The parameters are four pin's function depends on the hardware in which the xPico is embedded, that configuration is only allowed using
  • Lantronix xPico | xPico - User Guide - Page 64
    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 64
  • Lantronix xPico | xPico - User Guide - Page 65
    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. PC -> xPico: 10h, 00h, 00h, 00h, 00h, 00h, 00h, 00h, 00h xPico -> PC: 10h, 03h, 00h, 00h, 00h Command details: xPico User Guide 65
  • Lantronix xPico | xPico - User Guide - Page 66
    , 00h, 00h = 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 eight configurable pins on the xPico. xPico User Guide 66
  • Lantronix xPico | xPico - User Guide - Page 67
    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 Lantronix web site for the latest versions and release notes. Table 10-1. Firmware firmware path of the firmware file in the
  • Lantronix xPico | xPico - User Guide - Page 68
    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 put xpico_6800 X6 tftp -i 192.168.1.111 put xpico_webm_1900.cob WEB1 xPico User Guide 68
  • Lantronix xPico | xPico - User Guide - Page 69
    the serial port of the Lantronix unit. 4. For Device Model, be sure the appropriate xPico module is shown (xPico). 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
  • Lantronix xPico | xPico - User Guide - Page 70
    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). A 0> capital letters. Responses to some of the commands are in Intel Hex format. xPico User Guide 70
  • Lantronix xPico | xPico - User Guide - Page 71
    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 OK. Note: Entering any of the commands listed above generates one of the following command response codes: xPico User Guide 71
  • Lantronix xPico | xPico - User Guide - Page 72
    Table 11-2. Command Response Codes Response 0> 1> 2> 8> 9> Meaning OK; no error No answer from remote device Cannot reach remote device or no answer Wrong parameter(s) Invalid command 11: Monitor Mode xPico User Guide 72
  • Lantronix xPico | xPico - User Guide - Page 73
    network. Make sure that your unit's IP address is unique. When troubleshooting the following problems, make sure that the xPico is powered up. Confirm that you are using a good network connection. Problems and Error Messages Problem/Message When you issue the ARP -S command in Windows, the "ARP
  • Lantronix xPico | xPico - User Guide - Page 74
    12: Troubleshooting Problem/Message When you Telnet to port 1 to assign an IP address to the device server, the Telnet window , 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. xPico User Guide 74
  • Lantronix xPico | xPico - User Guide - Page 75
    12: Troubleshooting Problem/Message You can ping the device server, but not Telnet to the device server on port 9999. The device server appears to be you are using on the network. Also, make sure that port 77FEh is not disabled within the Security settings of the device server. xPico User Guide 75
  • Lantronix xPico | xPico - User Guide - Page 76
    +49 (0) 180 500 13 53 (Germany Only) Email: [email protected] or [email protected] 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
  • Lantronix xPico | xPico - User Guide - Page 77
    ' 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 77
  • Lantronix xPico | xPico - User Guide - Page 78
    A: Binary to Hexadecimal Conversions 4. Click Hex. The hexadecimal value displays. xPico User Guide 78
  • Lantronix xPico | xPico - User Guide - Page 79
    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) • of the homogeneous materials used for this part is above the limit requirement in SJ/T11363-2006. xPico User Guide 79
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79

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