DeviceLinx™ XPort/XChip SoC User Guide Part Number 900-270 Revision I August 2007
Copyright and Trademark © 2005, 2007 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. Printed in the United States of America. XPort, with its patent-pending technology, is a trademark of Lantronix. Ethernet is a trademark of XEROX Corporation. UNIX is a registered trademark of The Open Group.
Disclaimer and Revisions Operation of this equipment in a residential area is likely to cause interference, in which case the user, at his or her own expense, will be required to take whatever measures may be required to correct the interference. Changes or modifications to this device not explicitly approved by Lantronix will void the user's authority to operate this device. Date Rev. Firmware Comments 1/07 A Initial release 5/07 B Added information about product support for RS485.
XChip License Agreement IMPORTANT- READ CAREFULLY: This Firmware License Agreement ("FLA") is a legal agreement between the Recipient (either an individual or a single entity) (“Recipient”) and Lantronix Inc. (“Lantronix”) for the computer software (including firmware) accompanying this FLA, which may include associated media, printed materials, and "online" or electronic documentation (collectively the "Software"). An amendment or addendum to this FLA may accompany the Software.
LIMITATION OF LIABILITY AND REMEDIES.
Contents Copyright and Trademark _____________________________________________ 2 Contacts __________________________________________________________ 2 Disclaimer and Revisions _____________________________________________ 3 XChip License Agreement_____________________________________________ 4 1: About This Guide 10 Purpose and Audience ______________________________________________ 10 Chapter Summary __________________________________________________ 10 Additional Documentation _________________________
Contents Connection Settings - TCP ________________________________________________ 29 Connection Settings - UDP ________________________________________________ 31 Email Settings _____________________________________________________ 33 Trigger Configuration ____________________________________________________ 33 Configurable Pin Settings ____________________________________________ 35 Apply Settings _____________________________________________________ 36 Apply Factory Defaults __________________________
Contents DisConnMode _____________________________________________________ 53 Flush Mode (Buffer Flushing) _________________________________________ 54 Pack Control ______________________________________________________ 55 Packing Interval_________________________________________________________ 55 Trailing Characters ______________________________________________________ 55 Send Characters ________________________________________________________ 56 DisConnTime (Inactivity Timeout) ________________________
Contents Disable Web Setup ______________________________________________________ 65 Disable ECHO Ports _____________________________________________________ 65 Enable Encryption _______________________________________________________ 66 Enable Enhanced Password_______________________________________________ 67 Disable Port 77F0 (Hex) __________________________________________________ 67 Default Settings (Option 7) ___________________________________________ 67 Channel 1 Configuration Defaults ____________
1: About This Guide Purpose and Audience This guide covers DeviceLinx™ XPort Device Server Module (version XP1001xxx-01, e.g., XPort-03) and the DeviceLinx XChip SoC (XCP1001xxx-01). It provides the information needed to configure, use, and update the XPort firmware and is intended for OEMs and system integrators who are embedding the XPort or XChip in their end product designs. Note: The XChip is a deployment-ready Device Server SoC coprocessor bundled with the XPort firmware.
1: About This Guide 11: Monitor Mode Provides instructions for accessing and using the command line interface for monitoring the network and 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 converting binary numbers to hexadecimals. Additional Documentation The following guides are available on the product CD and the Lantronix web site (www.lantronix.
2: Introduction This chapter summarizes the XPort device server’s features and the basic information needed to get started. Capabilities The XPort device server has the following capabilities: Connects devices through a TCP data channel or through a Telnet connection to computers or to another device server. The XPort also supports UDP datagrams. Contains a web [HTTP] server allowing presentation of custom content and easy configuration through a browser.
2: Introduction Protocol Support The XPort device server uses the Internet Protocol (IP) for network communications. It uses the Transmission Control Protocol (TCP) to assure that no data is lost or duplicated, and that everything sent to the connection arrives correctly at the target. Supported protocols include: ARP, UDP, TCP, ICMP, Telnet, TFTP, AutoIP, DHCP, HTTP, and SNMP for network communications and management. TCP, UDP, and Telnet for connections to the serial port.
2: Introduction Configuration Methods For the unit to operate correctly on a network, it must have a unique IP address on the network. There are three basic methods for logging into the device server to assign an IP address and configure the unit: DeviceInstaller: Assign an IP address and view the current XPort configuration using a Graphical User Interface (GUI) on a PC attached to a network. (See 3: Using DeviceInstaller.
3: Using DeviceInstaller This chapter covers the steps for getting the XPort device server online and viewing its current configuration. Installing DeviceInstaller To install DeviceInstaller: 1. Insert the product CD into your CD-ROM drive. The CD automatically starts and displays the main window. 2. If the CD does not launch automatically: a) Click the Start button on the Task Bar and select Run. b) Enter your CD drive letter, colon, backslash, Launch.exe (e.g., D:\Launch.exe). 3.
3: Using DeviceInstaller 2. Click the Assign IP icon . 3. If prompted, enter the hardware address (on the product label) and click Next. 4. Select Assign a specific IP address and click Next. 5. Enter the IP address. The Subnet mask displays automatically based on the IP address; if desired, you may change it. On a local network, you can leave the Default gateway blank (all zeros). Click Next. 6. Click the Assign button and wait several seconds until a confirmation message displays. Click Finish. 7.
3: Using DeviceInstaller Group Configurable field. A group name to categorize the XPort. Double-click the field, type in the value, and press Enter to complete. This group name is not visible on other PCs or laptops using DeviceInstaller. Comments Configurable field. Information about the XPort. Double-click the field, type in the value, and press Enter to complete. This description or comment is not visible on other PCs or laptops using DeviceInstaller. Device Family Non-configurable field.
3: Using DeviceInstaller TC P Keepalive Non-configurable field. Displays 1-65s, the XPort’s TCP keepalive value. The default setting is 45. Supports Configurable Pins Non-configurable field. Displays True, indicating configurable pins are available on the XPort. Supports Email Triggers Non-configurable field. Displays True, indicating email triggers are available on the XPort. Supports AES Data Stream Non-configurable field. Displays True if the XPort unit supports AES encryption.
4: Configuration Using Web Manager You must configure the unit so that it can communicate on a network with your serial device. For example, you must set the way the unit will respond to serial and network traffic, how it will handle serial packets, and when to start or close a connection. The unit’s configuration is stored in nonvolatile memory and is retained without power. You can change the configuration at any time. The unit performs a reset after you change and store the configuration.
4: Configuration Using Web Manager Note: Alternatively, to open Web-Manager, open your web browser and enter the IP address of the XPort. (With firmware 1.8 or earlier, your browser must be JAVA-enabled to use Web-Manager. With firmware 6.1.0.0 and later, your web browser does not need to be JAVA-enabled.) The XPort prompts for a User name and Password. Figure 4-1. Web-Manager Login Window 8.
4: Configuration Using Web Manager 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 configurable parameters on the Network Settings page.
4: Configuration Using Web Manager Figure 4-3. Network Settings Network Mode 1. Click Network from the main menu. 2. Note the following: Network Mode Wired Only is the only choice. It enables the Ethernet network connectivity. Automatic IP Address Configuration An IP address can be assigned automatically. You then enter related network settings. To assign an IP address automatically: 1. On the main menu, click Network. 2. Select Obtain IP address automatically. 3.
4: Configuration Using Web Manager 169.254.x.x address range with a Class B subnet. Enable is the default. DHCP Host Name Enter the name of the host on the network providing the IP address. Note: Disabling BOOTP, DHCP, and AutoIP (all three checkboxes) is not advised as the only available IP assignment method will then be ARP or serial port. 4. When you are finished, click the OK button. 5. On the main menu, click Apply Settings.
4: Configuration Using Web Manager Duplex: The direction of data transmission. The 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 configurable parameters on the Server Settings page. Figure 4-4. Server Settings To configure the XPort’s device server settings: 1. On the main menu, click Server. 2.
4: Configuration Using Web Manager unit does not receive a response, it drops that connection. Enter a value between 0 and 60 seconds. 0 disables keepalive. The default setting is 45. Monitor Mode @ Bootup Select Disable to disable entry into the monitor mode using the 'yyy' or 'xx1' key sequence at startup. This field prevents the unit from entering monitor mode by interpreting the stream of characters that are received during the device server's initialization at startup.
4: Configuration Using Web Manager Figure 4-5. Hostlist Settings 2. Enter or modify the following fields: Retry Settings Retry Counter Enter the value for the number of times the XPort should attempt to retry connecting to the host list. Retry Timeout Enter the duration (in seconds) the XPort should abandon attempting a connection to the host list. Host Information Host Address Enter or modify the host’s IP address. Port Enter the target port number. 3. When you are finished, click the OK button.
4: Configuration Using Web Manager Figure 4-6. Channel Serial Settings 2. In the available fields, enter the following information: Channel 1 Disable Serial Port When selected, disables communication through the serial port. The serial port is enabled by default. Port Settings Protocol From the drop-down menu, select the protocol type for the selected channel. Flow Control Flow control manages data flow between devices in a network to ensure it is processed efficiently.
4: Configuration Using Web Manager Pack Control Enable Packing Select to enable packing on the XPort. Two firmware-selectable packing algorithms define how and when packets are sent to the network. The standard algorithm is optimized for applications in which the unit is used in a local environment, allowing for very small delays for single characters, while keeping the packet count low.
4: Configuration Using Web Manager Connection Settings - TCP To configure a channel’s TCP settings: 1. On the main menu, click Connection. The Connection Settings window for the channel displays. Figure 4-7.
4: Configuration Using Web Manager 2. In the available fields, enter or modify the following information: Connect Protocol Protocol From the drop-down menu, select TCP. Connect Mode: Passive Connection Accept Incoming Select Yes to accept incoming connections. The default is Yes. Password Required Determines whether a password is required for an incoming passive connection. This field is not available when a password is set for Telnet mode.
4: Configuration Using Web Manager Common Options Telnet Com Port Cntrl This field is available for configuration only when Active Connect is set to None. Select Enable to permit Telnet communication to the unit. The Telnet Com Port Cntrl feature is used in conjunction with the Com Port Redirector (CPR) utility. (See the CPR online Help for details.) Terminal Name This field is available for configuration only when Telnet Mode is set to Enable. Use the terminal name for the Telnet terminal type.
4: Configuration Using Web Manager 2. In the available fields, enter or modify the following information: Figure 4-8. UDP Connection Settings Connect Protocol Protocol Select UDP from the drop-down menu. Datagram Mode Datagram Type Configures the remote IP or network broadcast address and the remote port. Enter 01 for directed or broadcast UDP. The default setting is 00. Accept Incoming Select Yes to accept incoming UDP datagrams. Endpoint Configuration Local Port Enter the local port number.
4: Configuration Using Web Manager Email Settings The unit sends an email to multiple recipients when a specific trigger event occurs. There are three separate triggers, based on any combination of the configurable pins selected as user I/O functions. Optionally, use a two-byte serial string to initiate a trigger. Each trigger is independent of the others. Each condition within an individual trigger must be met before the unit will send the email. To configure the XPort’s email settings: 1.
4: Configuration Using Web Manager Set the configurable pins to Active, Inactive, or None. The configurable pins are disabled if they are all set to None. If both the serial sequence and the configurable pins are disabled, the trigger is disabled. To configure the XPort’s email trigger settings: 1. On the main menu, click Trigger 1, Trigger 2, or Trigger 3 to configure the desired trigger settings. The Email Trigger Settings page opens. Figure 4-10. Email Trigger Settings 2.
4: Configuration Using Web Manager sent to the recipient(s) when a single trigger event remains active. 3. When you are finished, click the OK button. 4. On the main menu, click Apply Settings. Configurable Pin Settings There are three configurable hardware pins on the XPort unit. For each pin, configure the pin function, communication direction, and activity level. For more information, see 9:GPIO Interface. To configure the XPort’s Configurable Pins: 1. On the main menu, click Configurable Pins.
4: Configuration Using Web Manager HW Flow Control Out (CTS) Allows for flow control on the connection with hardware handshaking. RS485 Tx Enable Note: This function applies to XPort model XP1004000-03 (XPort-485). Allows for control of the RS485 Tx Output Enable signal. This function must be mapped to one of the CPs for the RS485 interface mode to operate correctly. 3. When you are finished, click the OK button. 4. On the main menu, click Apply Settings. Apply Settings 1.
5: Configuration via Telnet or Serial Port (Setup Mode) You must configure the unit so that it can communicate on a network with your serial device. As an alternative to using a web browser, as described in the previous chapter, you can use the following procedures remotely or locally: Use a Telnet connection to configure the unit over the network. Use a terminal or terminal emulation program to access the serial port locally.
5: Configuration via Telnet or Serial Port (Setup Mode) To establish a Telnet connection: 1. From the Windows Start menu, click Run and type the following command, where x.x.x.x is the IP address, and 9999 is the unit’s fixed network configuration port number: Windows: telnet x.x.x.x 9999 UNIX: telnet x.x.x.x:9999 2. Click OK. The following information displays. Figure 5-1. MAC Address 3. To enter Setup Mode, press Enter within 5 seconds.
5: Configuration via Telnet or Serial Port (Setup Mode) At this point, the screen display is the same as when you use a Telnet connection. To continue, go to step 4 in Telnet Connection, above. Exiting Setup Mode To exit setup mode: You have two options: To save all changes and reboot the device, select option 9 Save and exit from the Change Setup menu. All values are stored in nonvolatile memory. To exit the configuration mode without saving any changes or rebooting.
6: Setup Mode: Server Configuration This chapter explains how to configure the network settings. Note: Current values display in parentheses. Server Configuration (Option 0) The unit’s basic network parameters display when you select Server configuration (option 0). The IP Address, Set Gateway IP Address, and Netmask fields display the current values. IP Address : (000) .(000) .(000) .
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 default is N (No), meaning the gateway address has not been set. To set the gateway address, type Y and enter the address.
6: Setup Mode: Server Configuration Default DHCP Name: If you do not change the DHCP name, and you are using an IP of 0.0.0.0, then the DHCP name defaults to CXXXXXX (XXXXXX is the last 6 digits of the MAC address shown on the label on the bottom/side of the unit). For example, if the MAC address is 00-20-4A-12-34-56, then the default DHCP name is C123456. Custom DHCP Name: You can create your own DHCP name. If you are using an IP address of 0.0.0.
7: Setup Mode: Channel Configuration This chapter explains how to configure the serial port. Notes: Current values display in parenthesis. You must enter some values in hexadecimal notation. (See A: Binary to Hexadecimal Conversions.) Channel 1 (Option 1) Select Channel 1 (option 1) from the Change Setup menu to define how the serial port responds to network and serial communications. The following sections describe the configurable parameters within the Channel configuration menu. Figure 7-1.
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) ? _ Note: If you are attempting to select an I/F Mode bit that pertains to RS-422/485 on XP1001000-01 or XP1001000-03, a” WARNING: RS422/485 I/F Modes Not Supported” message displays. RS422/485 settings are available on the XP1004000-03 (XPort-485).
7: Setup Mode: Channel Configuration Table 7-3. Interface Mode Options I/F Mode Option 1 0 RS-422/485 7 6 5 4 3 2 0 1 RS-485 2-wire 1 1 Flow Flow control sets the local handshaking method for stopping serial input/output. Flow (0) ? _ Use the following table to select flow control options: Table 7-4.
7: Setup Mode: Channel Configuration Use Port 0 for the outgoing local port to change with each connection. The port range is 50,000 to 59,999. Each subsequent connection increments the number by 1 (it wraps back around to 50,000). Only use this automatic port increment feature to initiate a connection using TCP. Set the port to a non-zero value when the unit is in a passive mode or when using UDP instead of TCP.
7: Setup Mode: Channel Configuration Connect Mode Option 7 6 5 4 No Echo 0 Data Echo & Modem Response (Numeric) 3 2 1 0 0 1 1 0 1 1 1 1 Data Echo & Modem Response (Verbose) 0 1 1 1 0 Modem Response Only (Numeric) 0 0 1 1 1 1 Modem Response Only (Verbose) 0 0 1 1 1 0 e) Modem Mode a) Incoming Connection Never Accept Incoming Rejects all external connection attempts.
7: Setup Mode: Channel Configuration Manual Connection Attempts to connect when directed by a command string received from the serial port. The first character of the command string must be a C (ASCII 0x43), and the last character must be either a carriage return (ASCII 0x0D) or a line feed (0x0A). No blanks or space characters may be in the command string. Between the first and last command string characters must be a full or partial destination IP address and may be a destination port number.
7: Setup Mode: Channel Configuration Figure 4-7. Hostlist Option To enable the hostlist: 1. Enter a Connect Mode of 0x20 (2X), where X is any digit. The menu shows you a list of current entries already defined in the product. 2. To delete, modify, or add an entry, select Yes. If you enter an IP address of 0.0.0.0, that entry and all others after it are deleted. 3. After completing the hostlist, repeat the previous step if necessary to edit the hostlist again. 4.
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. When the UDP option is in effect, the unit never attempts to initiate a TCP connection because it uses UDP datagrams to send and receive data.
7: Setup Mode: Channel Configuration Table 4-11. Modem Mode Messages Message Meaning Full Verbose OK Command was executed without error. CONNECT A network connection has been established. NO CARRIER A network connection has been closed. RING n.n.n.n. A remote device, having IP address n.n.n.n, is connecting to this device.
7: Setup Mode: Channel Configuration 7-7. Modem Mode Commands Modem Mode Command Function ATDTx.x.x.x,pppp or 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 Makes a connection to an IP address (x.x.x.x) and the remote port number defined within the unit. ATD0.0.0.0 Forces the unit into Monitor Mode if a remote IP address and port number are defined within the unit.
7: Setup Mode: Channel Configuration Disable or enable the XPort's ability to show the IP address after RING in Modem Mode. The default is Y (Yes), to show the IP address. Auto Increment Source Port Auto increment source port (N) ? _ Y (Yes) auto increment the source port. The XPort increments the port number used with each new connection. Remote IP Address This is the destination IP address used with an outgoing connection.
7: Setup Mode: Channel Configuration Table 7-8. Disconnect Mode Options Disconnect Mode Option Disconnect when Modem Control In is not asserted 7 (6) Ignore Modem Control In 6 5 4 3 2 1 0 1 0 Telnet Com Port Cntrl and terminal type setup(1) 1 Channel (port) password (2) 1 Hard disconnect (3) 0 Disable hard disconnect 1 State LED off with connection (4) 1 Disconnect with EOT (^D) (5) 1 (1) The Telnet Com Port Control feature is used in conjunction with Com Port Redirector.
7: Setup Mode: Channel Configuration Function 7 Enable 1 6 5 4 3 2 1 0 Pack Control The packing algorithms defines how and when packets are sent to the network. The standard algorithm is optimized for applications in which the unit is used in a local environment, allowing for very small delays for single characters, while keeping the packet count low.
7: Setup Mode: Channel Configuration In some applications, CRC, Checksum, or other trailing characters follow the end-ofsequence character; this option helps to adapt frame transmission to the frame boundary. Send Characters If 2-Byte Send Character Sequence is enabled, the unit interprets the sendchars as a 2-byte sequence; if this option is not enabled, the unit interprets them independently.
7: Setup Mode: Channel Configuration 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.
8: Setup Mode: Advanced Settings Email Settings (Option 3) Note: You can change these settings using Telnet, a serial connection, or Web-Manager with firmware versions 6.1.0.0 or later. Earlier versions do not allow you to configure email triggers using Web Manager. To configure email settings using DeviceInstaller, see Email Notification in the DeviceInstaller online Help. The unit sends an email to multiple recipients when a specific trigger event occurs.
8: Setup Mode: Advanced Settings Channel: 2 Match: 00 Trigger input1: X Trigger input2: X Trigger input3: X Message : Priority: L Min. notification interval: 1 s Re-notification interval : 0 s Server (0.0.0.0) ? ( 0) _ Mail Server Enter the IP address of the mail server. Enter each 3-digit section and press Enter between each section inputted. The current value is displayed in parentheses. Mail Server (0.0.0.0) ? ( 0) _ Unit Name Enter the username used by the XPort to send email messages.
8: Setup Mode: Advanced Settings Enable serial trigger input (N) ? Trigger input1 [A/I/X] (X) ? Trigger input1 [A/I/X] (X) ? Trigger input1 [A/I/X] (X) ? Message () ? Priority (L) ? Minimum notification interval (1 s) ? Re-notification interval (0 s) ? Set the configurable pins to A = Active, I = Inactive, or X = Don’t Care. Active can mean active low or active high. If the configurable pins are all set to X (Don’t Care), then they are disabled.
8: Setup Mode: Advanced Settings Figure 8-2.
8: Setup Mode: Advanced Settings CPU Performance This option applies to XPort-03 and later units only. It allows you to increase the CPU performance required to use the higher baud rates on the serial interface (460 Kbps and 920 Kbps). The standard CPU performance mode supports up to 230400 Kbps.
8: Setup Mode: Advanced Settings configure one of the configurable pins to RS485_TXEN. To change the configurable pins’ settings, use DeviceInstaller or send setup records to port 77FE. MTU Size The Maximum Transmission Unit (MTU) is the largest physical packet size a network can transmit for TCP and UDP. Enter between 512 and 1400 bytes. The default is 1400 bytes. MTU Size: (1400) ? _ Enable alternate MAC If necessary, enable the alternate MAC address (if specified in the OEM setup record).
8: Setup Mode: Advanced Settings Figure 8-3. Security Settings Disable SNMP This setting allows you to disable the SNMP protocol on the unit for security reasons. Disable SNMP (N) ? _ SNMP Community Name The SNMP Community Name is a required field for NMS to read or write to a device. Enter a string of 1 to 13 characters. SNMP Community Name (public): _ The default entry is public. The current value is displayed in parentheses.
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 Firmware procedure. (See 10:Firmware Upgrades.
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 XPort supports 128-, 192-, and 256-bit encryption key lengths. Note: Configuring encryption should be done through a local connection to the serial port of the XPort, or via a secured network connection.
8: Setup Mode: Advanced Settings at http://www.lantronix.com/device-networking/software-services/scpr.html A 30-day trial version of SCPR is included on the CD. Note: Developers can license the Lantronix Encryption Library Suite. See http://www.lantronix.com/device-networking/utilities-tools/. Enable Enhanced Password This setting defaults to the N (No) option, which allows you to set a 4-character password that protects Setup Mode by means of Telnet and web pages.
8: Setup Mode: Advanced Settings Expert Settings Defaults TCP Keepalive time in s 45 ARP Cache timeout in s 600 CPU Performance 0 (Regular) (applies to XPort-03, XPort-485, and later units only) Disable Monitor Mode @ bootup No RS485 tx enable active low HTTP Port Number (1-65535) 80 SMTP Port Number (1-65535) 25 MTU Size (512 – 1400) 0 (resulting in an operational value of 1400) Alternate MAC Disabled ( for OEM use only) Ethernet Connection Type 0 (auto-negotiate) Security Settings Def
9: GPIO Interface Configurable Pins The XPort has three pins (CP0-2) 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. You can use these GPIO pins to control devices such as relays, servers, lights, monitor switches, sensors, and even processes such as data transfer.
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 XPort. Response comes from XPort to PC. The protocol allows for control of up to 32 GPIOs. How many are actually available depends on the product. XPort has only three. The parameters are four bytes long and represent GPIOs 0-31, with GPIO0 in bit 0 of the first byte (Little Endian).
9: GPIO Interface Command 10h, Get Functions Send: No parameters Response: 1 parameter Bytes 1-4: Functions Bit X 1 means general purpose I/O available to the user. 0 means dedicated function (e.g., serial flow control, diagnostics) for configurable pin X. Command 11h, Get Directions Send: No parameters Response: 1 parameter Bytes 1-4: Directions Bit X 1 means GPIO X is an output. 0 means it is an input.
9: GPIO Interface Command 1Ah, Set Active Levels Send: 2 parameters Bytes 1-4: Mask Bit X 1 means the direction for GPIO X will be updated with the value in the second parameter. 0 means the active type for that GPIO will not change. Bytes 5-8: New Active Levels Bit X 1 means GPIO X will become active low. 0 means it will become active high.
9: GPIO Interface Command details: 1Bh = command 1Bh 01h, 00h, 00h, 00h = the mask that determines which GPIOs will be changed. bit 0 is 1 → GPIO0 will be changed. bit 1 is 0 → GPIO1 will remain the same. 00h, 00h, 00h, 00h = the new states bit 0 is 0 → GPIO0 will become 0. bit 1 is ignored since it is masked out.
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) or by using anonymous FTP (ftp.lantronix.com). Reloading Firmware Note: For details on upgrading to version 6.1.0.0(or higher) from pre-6.1.0.0, see the XPort Upgrade Notice on the Lantronix ftp site (ftp.lantronix.com). There are several ways to update the unit's internal operational code (*.
10: Firmware Upgrades 5. In the Remote file name field, enter the current internal operational code or WEB1 for the internal Web interface. For firmware releases 6.1 and later, the TFTP destination files for XPort-01, XPort-03, and XPort 485 are X4, X5, and X5, respectively. For firmware 1.8 and earlier, the TFTP destination files for XPort-01, XPort-03, and XPort 485 are X1, X2, and X3, respectively. 6. Click the Upload Now button to transfer the file to the unit. Figure 10-1.
10: Firmware Upgrades Recovering the Firmware Using the Serial Port and DeviceInstaller If for some reason the firmware is damaged, you can recover the firmware file by using DeviceInstaller to download the *.ROM file over the serial port. To recover firmware: 1. Start DeviceInstaller. If your PC has more than one network adapter, a message displays. Select an adapter and click OK. 2. From the Tools menu, select Advanced/Recover Firmware. The Serial Port Firmware Upgrade window displays. 3.
11: Monitor Mode Monitor Mode is a command-line interface used for diagnostic purposes. There are two ways to enter Monitor Mode: locally using the serial port or remotely using the network. Entering Monitor Mode Using the Serial Port To enter Monitor Mode locally: 1. Follow the same steps used for setting the serial configuration parameters (see Serial Port on page 38). 2. Instead of typing three x keys, however: a) Type zzz (or xx1) to enter Monitor Mode with network connections.
11: Monitor Mode 11-1. Monitor Mode Commands Command Command Name Function VS x.x.x.x Version Queries software header record (16 bytes) of unit with IP address x.x.x.x. GC x.x.x.x Get Configuration Gets configuration of unit with IP address x.x.x.x as hex records (120 bytes). SC x.x.x.x Send Configuration Sets configuration of unit with IP address x.x.x.x from hex records. PI x.x.x.x Ping Pings unit with IP address x.x.x.x to check device status.
11: Monitor Mode Note: Entering any of the commands listed above generates one of the following command response codes: Table 7-2.
12: Troubleshooting This chapter discusses how you can diagnose and fix errors quickly without having to contact a dealer or Lantronix. It helps to connect a terminal to the serial port while diagnosing an error to view summary messages that may display. When troubleshooting, always ensure that the physical connections (power cable, network cable, and serial cable) are secure. Note: Some unexplained errors might be caused by duplicate IP addresses on the network.
Troubleshooting Problem/Message Reason Solution When you Telnet to port 1 to assign an IP address to the device server, the Telnet window does not respond for a long time. You may have entered the Ethernet address incorrectly with the ARP command. Confirm that the Ethernet address that you entered with the ARP command is correct. The Ethernet address may only include numbers 0-9 and letters A-F. In Windows and usually in Unix, the segments of the Ethernet address are separated by dashes.
Troubleshooting Problem/Message Reason Solution You can ping the device server, but not Telnet to the device server on port 9999. There may be an IP address conflict on your network Turn the device server off and then issue the following commands at the DOS prompt of your computer: You are not Telneting to port 9999. The Telnet configuration port (9999) is disabled within the device server security settings.
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: To check our online knowledge base or send a question to Technical Support, go to http://www.lantronix.com/support. Technical Support Europe, Middle East, and Africa Phone: +33 (0) 1 39 30 41 72 Email: eu_techsupp@lantronix.com or eu_support@lantronix.
A: Binary to Hexadecimal Conversions Many of the unit’s configuration procedures require assembling a series of options (represented as bits) into a complete command (represented as a byte). Convert the resulting binary value to a hexadecimal representation. Converting Binary to Hexadecimal Following are two simple ways to convert binary numbers to hexadecimals. Conversion Table Hexadecimal digits have values ranging from 0 to F, which are represented as 0-9, A (for 10), B (for 11), etc.
Binary to Hexadecimal Conversions 3. Select Bin (Binary), and type the number to convert. 4. Click Hex. The hexadecimal value displays.
