Lantronix XPort manual

Part Number 900-270 Revision E August 2004 XPort™ User Guide[...]

XPort™ User Guide 2 Copyright and Trademark © 2004, Lantronix. All rights reserved. No par t of the contents of this book may b e transmitted or reproduced in any form or by any means without the written permissi on of Lantronix. Printed in the United States of America. XPort, with its patent-pending technolog y, is a trademark of Lantronix. Eth[...]

XPort™ User Guide 3 Disclaimer and Revisions Operation of this equipment in a residentia l area is likely to cause int erference, 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 wi[...]

XPort™ User Guide 4 Contents 1: Using This Guide 7 Purpose and Audience________________________________________________ 7 Chapter Summary ___________________________________________________ 7 Additional Documentation _____________________________________________ 8 2: Introduction 9 Capabilities ____________________________________________________[...]

Contents XPort™ User Guide 5 Using a Telnet Connectio n ________________________________________________ 21 Using the Seri al Port _____________________________________________________ 22 Server Configuration (Net work Configuration) _____________________________ 24 IP Address_____________________________________________________________ 24 Set Ga[...]

Contents XPort™ User Guide 6 Disable TFTP Firm ware Upgrade __________________________________________ 41 Disable Port 77FE (Hex) _________________________________________________ 41 Disable Web Server _____________________________________________________ 41 Disable ECHO Ports_____________________________________________________ 41 Enable Encrypt[...]

XPort™ User Guide 7 1: Using This Guide Purpose and Audience This guide provides the informatio n needed to configure, use and update the X Port™ and is intended for software developers and sy stem integrators who are embed ding the XPort in their designs. The information in this gui de is relevant to XPort with firmware version 1.5 and higher.[...]

1: Using This Guide XPort™ User Guide 8 Additional Documentation The following guides are av ailable on the product CD and the Lantronix web site ( www.lantronix.com ) . XPort Quick Start Provides the steps for getting the XPort evaluation board up and running. XPort Integration Guide Provides information about the XPort hardware, testing the XPo[...]

XPort™ User Guide 9 2: Introduction This chapter summari zes the XPort device server’s features and basic information needed before getting started. Capabilities The XPort device server ha s the following capabilities:  Connects devices through a TCP data channel or through a Telnet connection to computers or to another device serve r. The X[...]

2: Introduction XPort™ User Guide 10 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. Other supported proto cols include:  [...]

2: Introduction XPort™ User Guide 11 Assigning an IP Address For the unit to operate correctly on a netw ork, it must have a unique IP address on the network. There are three basic met hods for logging into the de vice server and assigning the IP address: DHCP: By default, Dynamic Host Co nfiguration Protocol (DHCP) is enabled on the device serve[...]

XPort™ User Guide 12 3: Getting S tarted This chapter covers the steps for getting t he XPort device server online and working. Required Information Hardware Address You need to know the unit’s hardware addre s s (also known as MA C address), which is on the product label. It is in the form at: 00-20-4a-XX-XX-XX, where the XXs are unique number[...]

3: Getting Started XPort™ User Guide 13 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. Click the DeviceInstaller button. The installation wizard window di splays. 4. Respond to the installation wiza rd prompts. Note: For more information about Devi [...]

3: Getting Started XPort™ User Guide 14 Using Web-Manager to Configure the Unit 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 n etwork traffic, how it will handle serial packets, and when to start or close a connection. The unit’[...]

3: Getting Started XPort™ User Guide 15 On the left side of the screen, Web-Manager has the f ollowing menu options (buttons):  Unit Configuration  Server Properties  Port Properties  Factory Settings1  Update Settings  Select Channel 4. Use the menu to navigate to subpages fo r the configuration of serv er settings. 5. When fin[...]

3: Getting Started XPort™ User Guide 16 This page displays the current Server C onfiguration and the Port Configuration settings. Note: The following examples re present typi cal web pages. See the Lantronix web site for the latest ve rsion. Server Properties Click the Server Properties button to display the followin g page: Change the server pro[...]

3: Getting Started XPort™ User Guide 17 characters. (An enhanced password setting of 16 characters is available un der Security Settings on the Telnet Setup Mode window.) Note: You do not need a password to a ccess the Setup Mode window via a serial connection. Port Properties Click the Port Properties button to display the following page: Edit t[...]

3: Getting Started XPort™ User Guide 18 the baud rates 460800 and 921600 bps (see High C P U Perf ormance mode on page 39) Character Size 8, 7 Parity None, Even, Odd Stop Bit 1,2 Flow Control None, XON/XOFF, XON/XOFF Pass C haracters to Host, CTS/RTS (Hardware) Connect Mode Settings UDP Datagram Mode Enable, Disable UDP Datagram Type User Selecta[...]

3: Getting Started XPort™ User Guide 19 On Active Connection Enable, Disable On Passive Connection Enable, Disable At Time To Disconne ct Enable, Disable Packing Algorithm Packing Algorithm Enable, Disable Idle Time Packing Interval 12 ms, Interv al 52 ms, Interval 250 ms, Interval 5000 ms Trailing Characters None, One, Two Send Immediate Afte r [...]

3: Getting Started XPort™ User Guide 20 Factory Settings Click the Factory Settings button to set the device se rver back to the factory default settings . For details see page Factory Defaults on page 43 . Update Settings Click the Update Settings button to send all cha nged settings to the device serv er.[...]

XPort™ User Guide 21 4: Using Setup Mode for Configuration You must configure the unit so that it can communicate on a network with your serial device. You can configure it usi ng a web browser, as descri bed in 3:Getting Started , or using the following procedures locally or remotely:  Use a Telnet connection to configure the unit over the ne[...]

4: Using Setup Mode for Configur ation XPort™ User Guide 22 3. To enter the Setup Mode, press Enter within 5 seconds . The configuratio n settings display, followed by the setup m enu options. Figure 4-2 Setup Menu O ptions Change Setup: 0 Server configuration 1 Channel 1 configuration 3 E-mail settings 5 Expert settings 6 Security 7 Factory defa[...]

4: Using Setup Mode for Configur ation XPort™ User Guide 23 Figure 4-3 Setup Mode Con figuration Paramete rs[...]

4: Using Setup Mode for Configur ation XPort™ User Guide 24 Server Configuration (Network Configuration) The unit’s basic netw ork para meters disp lay when you select Server configuration (option 0 ). The IP Address , Set Gate way IP Address , and Netmas k fields display the current values. Figure 4-4. Serv er Configuration Parameters IP Addre[...]

4: Using Setup Mode for Configur ation XPort™ User Guide 25 DHCP Name If a DHCP server has automatically assi gned the IP addre ss and network settings, you can discover the unit by using the De viceInstaller network sear ch feature. There are three methods for assi gning DHCP names to the unit.  Default DHCP Name : If you do not change the DH[...]

4: Using Setup Mode for Configur ation XPort™ User Guide 26 4800, 9600 (default), 19200, 38400, 576 00, 115200, and 230400 bits per second. XPort-03 and greater units also support high-performance baud rat es of 460800, and 921600 bits per seco nd (see Expert Settings on page 38 ). I/F (Interface) Mode The Interface (I/F) Mode is a bit-coded byte[...]

4: Using Setup Mode for Configur ation XPort™ User Guide 27 Flow Flow control sets the local handshakin g me thod for stopping serial input/output. Use the following table to select flow cont rol options: Table 4-5. Flo w Control Opt ions Flow Control Option Hex No flow control 00 XON/XOFF flow control 01 Hardware handshake with RTS/CTS lines 02 [...]

4: Using Setup Mode for Configur ation XPort™ User Guide 28 Connect Mode Connect Mode defines how the unit make s a connection, and how it reacts to incoming connections over the network. Enter Connect Mode options in hexadeci mal notation. Table 4-7. Connect Mod e Op tion s Connect Mode Option 7 6 5 4 3 2 1 0 Incoming Connection Never accept inc[...]

4: Using Setup Mode for Configur ation XPort™ User Guide 29 Response Character Respo nse A single character is transmitted to the serial port when there is a change in connection state: C = connected, D = disconnected, N = host unreachable. This option is overridden when the Active Start Modem Mode or Active Start Host List is in effect. Default [...]

4: Using Setup Mode for Configur ation XPort™ User Guide 30 Command String Result if remote IP is 129.1.2.3 and remote port is 1234 C0.0.0.0/0 Connects to 129.1.28.10, port 12; enters Monitor Mode Autostart (Automatic Connection) If you enable autostart, the unit automatically connects to the remote IP address and remote port specified when the f[...]

4: Using Setup Mode for Configur ation XPort™ User Guide 31 DisConnTime (00:00) ?: SendChar 1 (00) ? SendChar 2 (00) ? To enable the hostlist: 1. Enter a Connect Mode of 0x20 ( 2 X), where X is any digit. The menu sh ows you a list of current entries already defined in the prod uct. 2. To delete, modify, or add an entry, select Yes . If you enter[...]

4: Using Setup Mode for Configur ation XPort™ User Guide 32 Full Verbose The unit echoes modem commands and respon ds to a command with a message string shown in the table be low. 1-Character Response The unit echoes modem commands a nd responds to a command with a single character response. Table 4-11. Modem Mod e Mess ages Message Meaning Full [...]

4: Using Setup Mode for Configur ation XPort™ User Guide 33  The character string AT H is received, terminated with a carriage return. The unit responds affirmatively according to the selected echo/response mode and drops the network connectio n. The serial interface revert s to accepting command strings. If this sequence is not followed, t he[...]

4: Using Setup Mode for Configur ation XPort™ User Guide 34 Note: To connect an ASCII term inal to a host using the unit for login purposes, use the remote port num ber 23 (Internet standard po rt num ber for Telnet services). DisConnMode This setting determines the conditio ns under which the unit will ca use a network connection to terminate. N[...]

4: Using Setup Mode for Configur ation XPort™ User Guide 35 Function 7 6 5 4 3 2 1 0 Clear when the network connection to or from the device is disconnected 1 Output Buffer (Network to Serial) Clear with a connection that is initiated from the device to the network 1 Clear with a connection initiat ed from the network to the device 1 Clear when t[...]

4: Using Setup Mode for Configur ation XPort™ User Guide 36 Packing Interval: Packing Interval defines how lon g the unit should wait before sending accumulated cha racters. This wa it period is between successive network segments containing data. For alternate packing, the default interval is 12 ms. Trailing Characters: In some applications, CRC[...]

4: Using Setup Mode for Configur ation XPort™ User Guide 37 E-mail Settings Note: You can change the se settings via Telnet or se rial co nnections only, not on the Web-Manager. To configure e-mail set tings via De vic eInstaller, see E-mail Notification in the DeviceInstaller Use r Guide on the CD. The unit can send an e-mail to multiple recipie[...]

4: Using Setup Mode for Configur ation XPort™ User Guide 38 Trigger Setup A trigger event can occur when the unit receives two bytes of a specified seq uence on the serial port, or because of a spe cified combination of conditi ons on the configurable pins. If the serial sequence is set to 00,00 , the trigger is disabled. At the Serial Sequence p[...]

4: Using Setup Mode for Configur ation XPort™ User Guide 39 TCP Keepalive time in seconds This option allows you to change how many secon ds the unit will wait during a silent connection before attempting to see if the currently connected network device is still on the network. If the unit then gets no response, it drops that connection. ARP Cach[...]

4: Using Setup Mode for Configur ation XPort™ User Guide 40 configure one of the configurabl e pins to RS485_TXEN. To change the configurable pins’ settings, use DeviceInstaller or send setup records to port 77FE. Security Settings You can change secu rity settings via Telnet or serial con nections only, not on the Web-Mana ger. We recommend th[...]

4: Using Setup Mode for Configur ation XPort™ User Guide 41 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 u pgrades. With this option, you can d ownload firmware upgrades over the serial p ort using DeviceIns taller’s Recover Firm ware procedure[...]

4: Using Setup Mode for Configur ation XPort™ User Guide 42 Encryption only applies to the port selected for tunneli ng (default 10001), regardless of whether you are using TCP or UDP. Generally, one of two situations applie s.  Encrypted XPort-to-XPort communication (and in the f uture, XPort communication to other Lantronix devi ce servers) [...]

4: Using Setup Mode for Configur ation XPort™ User Guide 43 6. When prompted to cha nge keys, press Y . 7. At the Enter Keys prompts, enter you r encryption key. The encryption keys are entered in hexadecimal. The hexadeci mal values are echoed a s asterisks to prevent onlookers from see ing the key. Hexadecimal values are 0-9 and A-F.  For a [...]

4: Using Setup Mode for Configur ation XPort™ User Guide 44 Expert Settings Defaults TCP keepalive 45 (seconds) ARP cache timeout 600 (seconds) High CPU performance mode (XPort-03 or greater only) Disabled HTTP port number 0 (resulting in an operationa l value of 80) SMTP port number 0 (resulting in an operationa l value of 25) Security Settings [...]

XPort™ User Guide 45 5: GPIO Interface Configurable Pins The XPort has three pins (CP1-3) that you can co nfigure for General Purpose I/O (GPIO). Note: You can also configure the pins for se rial port control lines, such as CTS, RTS, DTR, and DCD, and di agnostic outputs to LED, using DeviceInstall er. You can use these GPIO pins to control dev i[...]

5: GPIO Interface XPort™ User Guide 46 Guidelines The GPIO control protocol is described from the PC si de. 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 by tes long and represent[...]

5: GPIO Interface XPort™ User Guide 47 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 d edicated function (e.g., serial flow control, diagnostics) for configurable pin X. Command 11h, Get Directions Send: No parameters Response: 1 parameter[...]

5: GPIO Interface XPort™ User Guide 48 Command 1Ah, Set Active Levels Send: 2 parameters Bytes 1-4: Mask Bit X 1 means the direction for GPIO X will be upd ated 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 lo w. 0 means it will b[...]

5: GPIO Interface XPort™ User Guide 49 Command details: 1Bh = command 1Bh 01h, 00h, 00h, 00h = the mask that det ermines whi ch 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. Res[...]

XPort™ User Guide 50 6: Updating Firmware Obtaining Firmware You can obtain the most up-to-date firmware an d release notes for the unit from the Lantronix web site ( www.lantronix.com ) or by using anonymous FTP (ftp.lantronix.com). Reloading Firmware There are several ways to update the un it's internal operational cod e (*.ROM): via Devic[...]

6: Updating Firmware XPort™ User Guide 51 Figure 6-1. TFTP Wi ndow After the firmware has been loaded and stor e d, which takes approximately 8 seconds to complete, the unit performs a power reset. Recovering the Firmware Using the Serial Port and DeviceInstaller If for some reason the firmware is dama ged, you can recover the firmware file by us[...]

XPort™ User Guide 52 7: Monitoring the Network Monitor Mode is a command-line inte rface used for diagno stic purposes. There are two ways to enter Monitor Mode: locally via the serial p ort or remotely via the network. Entering Monitor Mode via the Serial Port To enter Monitor Mode locally : 1. Follow the same steps use d for setting the serial [...]

7: Monitoring the Network XPort™ User Guide 53 Table 7-1. Monitor Mode Commands Command Command Name Function VS x.x.x.x Version Queries software header record (16 b ytes) 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[...]

XPort™ User Guide 54 8: T roubleshooting This chapter discusses ho w you can diagnose and fix erro rs quickly without having to contact a dealer or Lantronix. It helps to con nect a terminal to the serial port while diagnosing an error to view summary me ssages that may be displayed. When troubleshooting, always ensure that the phy sical conn ect[...]

8: Troublesho oting XPort™ User Guide 55 Problem/Message Reason Solution The IP address you are trying to assign is not on your logical subnet. Confirm that your PC has an IP address and that it is in the same logical subnet that you are tr ying to assign to the device server. The device server may not be plugged into the net work properly. Make [...]

8: Troublesho oting XPort™ User Guide 56 Problem/Message Reason Solution The device server appears to be set up correctly, but you are not communicating with your device attached to the device server across the network. If you are sure that the serial port setting is correct, then you may not be connecting to the correct socket of the device serv[...]

8: Troublesho oting XPort™ User Guide 57 Technical Support If you are experiencing an error that is not described i n this user guide, or if you are unable to fix the error, you may:  Check our online kn owledge base at http://www.lantro nix.com/support .  Contact Technical Support in the US: Phone: 800-422-7044 (US only) or 949-45 3-7198 F[...]