Lantronix xDirect User Manual

Lantronix xDirect User Manual

Serial-to-ethernet device server
Hide thumbs Also See for xDirect:
Table of Contents

Advertisement

xDirect

User Guide

Part Number 900-653-R
Revision A September 2012

Advertisement

Table of Contents
loading
Need help?

Need help?

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

Questions and answers

Summary of Contents for Lantronix xDirect

  • Page 1: User Guide

    User Guide Part Number 900-653-R Revision A September 2012...
  • Page 2: Copyright & Trademark

    Copyright & Trademark © 2012 Lantronix, Inc. 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. Lantronix® is a registered trademark and xDirect™ and DeviceInstaller™ are trademarks of Lantronix, Inc.
  • Page 3: Table Of Contents

    Installing DeviceInstaller ____________________________________________________ 18 Assigning an IP Address ____________________________________________________ 18 Adding the Unit to the Manage List ____________________________________________ 19 Accessing the xDirect Using DeviceInstaller _____________________________________ 19 Viewing the Current Configuration ____________________________________________ 19 Next Step ____________________________________________________________ 21 Assigning the IP Address: Serial Port Login _____________________________________ 21...
  • Page 4 Table of Contents 5: Configuration Using Web Manager Accessing xDirect Using DeviceInstaller ________________________________________ 22 Network Configuration ______________________________________________________ 24 Network Mode ________________________________________________________ 24 Automatic IP Address Configuration ________________________________________ 24 Static IP Address Configuration ___________________________________________ 25 Ethernet Configuration __________________________________________________ 25 Server Configuration _______________________________________________________ 26...
  • Page 5 Flush Mode (Buffer Flushing) ________________________________________________ 52 Pack Control _____________________________________________________________ 53 Packing Interval _______________________________________________________ 53 Trailing Characters ____________________________________________________ 53 Send Characters ______________________________________________________ 53 DisConnTime (Inactivity Timeout) _____________________________________________ 54 Send Characters _________________________________________________________ 54 Telnet Terminal Type ______________________________________________________ 54 Channel (Port) Password ___________________________________________________ 54 xDirect User Guide...
  • Page 6 Recovering the Firmware Using the Serial Port and DeviceInstaller _______________ 62 11: Monitor Mode Entering Monitor Mode Using the Serial Port ____________________________________ 64 Entering Monitor Mode Using the Network Port __________________________________ 64 Monitor Mode Commands ___________________________________________________ 65 xDirect User Guide...
  • Page 7 DHCP __________________________________________________________________ 77 AutoIP __________________________________________________________________ 77 BOOTP _________________________________________________________________ 78 ARP and Telnet __________________________________________________________ 78 Appendix E: Binary to Hexadecimal Conversions Converting Binary to Hexadecimal ____________________________________________ 79 Conversion Table ______________________________________________________ 79 Scientific Calculator ____________________________________________________ 79 Appendix F: Compliance xDirect User Guide...
  • Page 8: List Of Figures

    Figure 2-4 Sample Hardware Address ________________________________________________ 15 Figure 3-1 xDirect with PoE Connected to a Serial Device and Network ______________________ 16 Figure 3-2 Standard xDirect (without PoE) Connected to a Serial Device and Network __________ 16 Figure 5-1 Web Manager Login Window ______________________________________________ 22...
  • Page 9: List Of Tables

    List of Tables Table 4-1 xDirect Configuration in DeviceInstaller _______________________________________ 19 Table 7-2 BootP/DHCP/AutoIP options _______________________________________________39 Table 7-3 Standard IP Network Netmasks _____________________________________________ 40 Table 8-2 Interface Mode Options ___________________________________________________ 43 Table 8-3 Common Interface Mode Settings ___________________________________________ 43 Table 8-4 Flow Control Options _____________________________________________________ 44...
  • Page 10: 1: Using This Guide

    Using this Guide Purpose and Audience This guide provides the information needed to configure, use, and update the xDirect device server. It is for system administrators and those responsible for installing and maintaining the xDirect. Chapter Summary The remaining chapters in this guide include:...
  • Page 11: Additional Documentation

    Provides instructions for using the Windows-based utility to configure DeviceInstaller Online Help the xDirect and other Lantronix device servers. Explain and demonstrate assigning an IP address to the xDirect and “Live” Tutorials on the setting up the xDirect and Com Port Redirector.
  • Page 12: 2: Introduction

    PC, smartphone, or tablet from anywhere.
  • Page 13: Figure 2-1 Serial Tunneling Example

    Universal Power Supply (UPS) Management Units  Using a method called serial tunneling, the xDirect encapsulates serial data into packets and transports them over Ethernet. Using two xDirect units, connected by a network, virtual serial connections can extend across a facility or around the world.
  • Page 14: Protocol Support

    DeviceInstaller: Configure the IP address and related settings and view current settings on  the xDirect using a Graphical User Interface (GUI) on a PC attached to a network. You will need the latest version of DeviceInstaller. See Chapter 4: Using DeviceInstaller.
  • Page 15: Product Information Label

     Figure 2-3 Product Label The first three bytes of the hardware address are fixed and identify the unit as a Lantronix product. The fourth, fifth, and sixth bytes are unique numbers assigned to each unit. Figure 2-4 Sample Hardware Address...
  • Page 16: 3: Installation Of Xdirect

    Installation of xDirect This chapter describes how to install your xDirect and get it up and running in the shortest possible time. Package Contents Verify and inspect the contents of the xDirect package using the following list. If any item is missing or damaged, contact your place of purchase immediately.
  • Page 17: Required Information

    3: Installation of xDirect 4. For non-PoE xDirect unit, supply power to your unit using the power supply that was included in the packaging. Note: The provided power supply is 5 VDC 1A. For all xDirect units power can also be supplied via pin 9 (+) and pin 5 (-) on the DB9F connector (voltage range = 5 VDC to 15 VDC).
  • Page 18: 4: Using Deviceinstaller

    Using DeviceInstaller This chapter covers the steps for getting the xDirect device server online and for viewing its current configuration. Note: DeviceInstaller is a free utility program provided by Lantronix that discovers, configures, upgrades, and manages Lantronix Device Servers. It can be downloaded from the Lantronix website at www.lantronix.com/support/downloads.
  • Page 19: Adding The Unit To The Manage List

    2. Click the xDirect folder. The list of available Lantronix xDirect devices displays. 3. Expand the list of xDirects by clicking the + symbol next to the xDirect icon. Select the xDirect unit by clicking on its IP address to view its configuration.
  • Page 20 Non-configurable field. Displays the xDirect’s status as online, offline, Online Status unreachable (the xDirect is on a different subnet), or busy (the xDirect is currently performing a task). Non-configurable field. Displays the xDirect’s current IP address. To IP Address...
  • Page 21: Next Step

    General Purpose Input Output (GPIO). Next Step Now that the xDirect unit has an IP address and other initial settings, you can configure it. 1. Double-click the unit in the list. Details about the unit display. 2. You have the following options: To configure the unit using a Web browser, click the Web Configuration tab.
  • Page 22: 5: Configuration Using Web Manager

    2. Click on the xDirect folder. The list of available xDirect products display. 3. Expand the list of xDirect units by clicking the + symbol next to the xDirect icon. 4. Select the xDirect unit by clicking its hardware address.
  • Page 23: Figure 5-2 Lantronix Web Manager

    5: Configuration Using Web Manager Figure 5-2 Lantronix Web Manager 8. Navigate between pages by clicking links in the left pane of the Web Manager window. xDirect User Guide...
  • Page 24: Network Configuration

    Network Mode 1. Click Network from the main menu. 2. Note the following: For the xDirect, Wired Only is the only choice. It enables the Ethernet Network Mode network connectivity. Automatic IP Address Configuration An IP address can be assigned automatically. You then enter related network settings.
  • Page 25: Static Ip Address Configuration

    5: Configuration Using Web Manager Select Enable to permit the xDirect to generate an IP in the 169.254.x.x address AutoIP range with a Class B subnet. Enable is the default. Enter the name of the host on the network providing the IP address.
  • Page 26: 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 5-4 Server Settings To configure the xDirect device server settings: 1. On the main menu, click Server. 2. Configure or modify the following fields:...
  • Page 27 The desired TCP re-transmission timeout value. If the ACK is not received TCP Re-transmission for a packet sent from the xDirect device, then the unit will retransmit the timeout (ms) data. The valid range is 500-4000 msec. The default is 500.
  • Page 28: Host List Configuration

    Host List Configuration The xDirect 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. If this connection fails, the unit continues to scroll through the table until the next successful connection.
  • Page 29: Channel 1 Configuration

    Flow control manages data flow between devices in a network to ensure it Flow Control is processed efficiently. Too much data arriving before a device is prepared to manage it causes lost or retransmitted data. None is the default. xDirect User Guide...
  • Page 30: Pack Control

    The stop bit follows the data and parity bits in serial communication. It Stop Bits indicates the end of transmission. The default setting is 1. Pack Control Select to enable packing on the xDirect. Enable Packing Two firmware-selectable packing algorithms define how and when packets are sent to the network.
  • Page 31: Connection Settings - Tcp

    2. In the available fields, enter or modify the following information: Connect Protocol From the drop-down menu, select TCP. Protocol Connect Mode: Passive Connection Select Yes to accept incoming connections. The default setting is Yes. Accept Incoming xDirect User Guide...
  • Page 32: Connect Mode: Active Connection

    The default setting is No. If Password Required was set to Yes, enter the password for passive Password connections. Disable or enable the xDirect’s ability to send the escape sequence. The Modem Escape Sequence default is Yes (send the escape sequence). Pass Through Connect Mode: Active Connection Select None (default) to disable Active Connect.
  • Page 33: Disconnect Mode

    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: xDirect User Guide...
  • Page 34: Connect Protocol

    Device Address Table 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. 3. When you are finished, click the OK button.
  • Page 35: Apply Settings

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

    The series of prompts at which you enter configuration settings is called Setup Mode. Note: Detailed information about other setup methods are available from your Lantronix Sales Associate. The unit’s configuration is stored in nonvolatile memory and is retained without power. You can change the configuration at any time.
  • Page 37: Figure 6-2 Setup Menu Options

    Remote IP adr: --- none ---, Port 00000 Disconn Mode : 00 Flush Mode : 00 *** Expert TCP Keepalive : 45s ARP cache timeout: 600s CPU performance: Regular Monitor Mode @ bootup : enabled HTTP Port Number : 80 MTU Size: 1400 xDirect User Guide...
  • Page 38: Serial Port Connection

    The default serial port settings are 9600 baud, 8 bits, no parity, 1-stop bit, no-flow control. 2. Reset the xDirect 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 39: 7: 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 xDirect to disable AutoIP, DHCP, or BootP. To disable an option, set the appropriate bit.
  • Page 40: Set Gateway Ip Address

    Y. At the prompt, enter the DNS server address. If the device is DHCP enabled, the DHCP server provides the DNS server IP address, which will override this configured value. Note: This setting is applicable only in Manual Connection mode. Set DNS Server IP addr ((N) ? xDirect User Guide...
  • Page 41: Change Telnet Configuration Password

    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). xDirect User Guide...
  • Page 42: 8: Setup Mode: Channel Configuration

    The unit and attached serial device, such as a modem, must agree on a speed or baud rate to use for the serial connection. Valid baud rates are 300, 600, 1200, 2400, 4800, 9600 (default), 19200, 38400, 57600, 115200, and 230400 baud. xDirect also supports high-performance baud rates of 460800 and 921600 bits per second. See CPU Performance (on page 55).
  • Page 43: I/F (Interface) Mode

    RS-485 2-wire, 8-bit, No Parity, 1 stop bit 0101 1101 RS-422, 8-bit, Odd Parity, 1 stop bit Flow Flow control sets the local handshaking method for stopping serial input/output. The default setting is 00. Flow (00) ? _ xDirect User Guide...
  • Page 44: Port Number

    Connect Mode Connect Mode defines how the unit makes a connection, and how it reacts to incoming connections over the network. ConnectMode (C0) ? _ Enter Connect Mode options in hexadecimal notation. The default setting is C0. xDirect User Guide...
  • Page 45: A) Incoming Connection

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

    Table 8-7 Manual Connection Address Example Command String Result if remote IP is 129.1.2.3 and remote port is 1234 Complete override; connection is started with host 121.2.4.5, port 1. C121.2.4.5/1 Connects to 129.1.2.5, port 1234. Connects to 129.1.28.10, port 12. C28.10/12 xDirect User Guide...
  • Page 47: Host List Option (Hostlist)

    Command String Result if remote IP is 129.1.2.3 and remote port is 1234 Enters Monitor Mode. C0.0.0.0/0 Tries to connect to the Lantronix web server if the <hostname:domain> Cwww.lantronix.com/80 (www.lantronix.com) is configured in the DNS server database. Host List Option (Hostlist)
  • Page 48: D) Datagram Type

    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. The range is 1-15, with the default set to 3.
  • Page 49: Table 8-9 Modem Mode Messages

    The character sequence +++ is received, with no more than one second between each two  characters. No serial data is received for one second after the last + character. At this time, the unit  responds affirmatively per the selected echo/response mode. xDirect User Guide...
  • Page 50: Send The Escape Sequence (+++) In Modem Mode

    Send the Escape Sequence (+++) in Modem Mode Send ‘+++’ in Modem Mode (Y) ? _ Disable or enable the xDirect’s ability to send the escape sequence. The default setting is Y (Yes) (send the escape sequence). Show IP Address after 'RING' Show IP addr after “RING”...
  • Page 51: Auto Increment Source Port

    8: Setup Mode: Channel Configuration Disable or enable the xDirect'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.
  • Page 52: Flush Mode (Buffer Flushing)

    State LED off with connection Disconnect with EOT (^D) (1) The Telnet Com Port Control feature is used in conjunction with Com Port Redirector. The xDirect sends the Terminal Type upon an outgoing connection. (2) A password is required for a connection to the serial port from the network.
  • Page 53: Pack Control

    0 (disabled). If Send Immediately After Characters is not set, any characters already in the serial buffer  are included in the transmission after a "transmit" condition is found. If this option is set, the xDirect User Guide...
  • Page 54: Disconntime (Inactivity Timeout)

    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. The default setting is all 0s. xDirect User Guide...
  • Page 55: 9: Setup Mode: Advanced Settings

    If a baud rate of 460 Kbps or 920 Kbps is set and the high performance mode is disabled, the  operation of the serial channel would be out of the specified error tolerance, thereby leading to inconsistent speed settings on the two ends of the serial channel. xDirect User Guide...
  • Page 56: Monitor Mode At Bootup

    This feature allows the configuration of the desired TCP re-transmission timeout value. If the ACK is not received for a packet sent from the xDirect device, then the unit will retransmit the data. The valid range is 500-4000 msec. Default is 500.
  • 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) ? _ xDirect User Guide...
  • Page 58: Disable Tftp Firmware Update

    Note: Configuring encryption should be done through a local connection to the serial port of the xDirect, or via a secured network connection. Initial configuration information, including the encryption key, is sent in clear text over the network. To configure AES encryption on the xDirect:...
  • Page 59: Enable Enhanced Password

    Enter Keys: **-**-**-**-**-**-**-**-**-**-**-**-**-**-**-** 1. When prompted to enable encryption, select Y. 2. When prompted, enter the encryption key length. The xDirect supports 128-, 192-, and 256-bit encryption key lengths. 3. When prompted to change keys, select Y. 4. At the Enter Keys prompt, enter your encryption key. The encryption keys are entered in hexadecimal.
  • Page 60: Channel 1 Configuration Defaults

    Alternate MAC 0 (auto-negotiate) Ethernet Connection Type Security Settings Defaults Disable SNMP public SNMP community name Disable Telnet setup Disable TFTP Firmware Update Disable Port 77FEh Disable Web Server Disable Web Setup Disable ECHO ports Enable Enhanced Password xDirect User Guide...
  • Page 61: 10: Firmware Upgrades

    10: Firmware Upgrades Obtaining Firmware You can obtain the most up-to-date firmware and release notes for the unit from the Lantronix web site (www.lantronix.com/support/downloads) or by using anonymous FTP (ftp.lantronix.com/pub). Reloading Firmware There are several ways to update the unit's internal operational code (*.ROM): using DeviceInstaller (the preferred way), using TFTP, or using the serial port.
  • Page 62: Using Tftp: Command Line Interface

    5. For Firmware File, click the Browse button and go to the location where the firmware file resides. Note: Make sure the xDirect on which you are recovering firmware is connected to this selected port on your PC. xDirect User Guide...
  • Page 63 When the file transfer completes, the message “Successful, Click OK to Close” displays. 8. Click the OK button to complete this procedure. Note: For more information, see Recovering Firmware in the DeviceInstaller online Help. xDirect User Guide...
  • Page 64: 11: Monitor Mode

    2. Click OK. The following information and login prompts display (see Figure 11-1). Figure 11-1 MAC Address and Login Prompt *** Lantronix xDirect 232 Device Server *** MAC address 00204A9D028B Software version V6.9.0.0RC3 (120828) XDIRECT AES library version 1.8.2.1 User Name :admin...
  • Page 65: Monitor Mode Commands

    SSIDs before reporting. If the BSS does not broadcast its SSID, only the BSSID and RSSI are returned. Network Status Reports the network interfaces’ statuses. Includes potentially negotiated parameters like speed/duplex for Ethernet or BSSID, encryption, authentication for wireless interfaces. xDirect User Guide...
  • Page 66: Table 11-3 Command Response Codes

    192.168.0.1 = gateway IP address 10001 = port number of the xDirect 192.168.1.10 = IP address of the DNS Server The xDirect stores the setup and performs a reset. It sends an X before the reset if the command was OK. Note:...
  • Page 67: Appendix A: Troubleshooting And Contact Info

    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 68: Serial Leds

    Appendix A: Troubleshooting and Contact Info Serial LEDs Two serial LEDs on top of the xDirect unit, directly adjacent to the “X” Power/Status LED, indicate transmit and receive data activity: Table A-3 Serial LEDs Serial LED Color Condition Indicates transmit data activity.
  • Page 69 Settings (on page 29) http://ltxfaq.custhelp.com/app/answers/list. Enter 1119 in the keyword search field to retrieve the FAQ 1119 for instructions. Look for the tutorial that is titled “Assigning an IP address using Device Installer” under the CoBos tutorials. xDirect User Guide...
  • Page 70 You can check to see whether there is a up correctly, but you are not port settings are correct, then socket connection to or from the XDIRECT communicating with your device you may not be connecting to by looking at the Status LED.
  • Page 71: Technical Support

    When you report a problem, please provide the following information: Your name, and your company name, address, and phone number  Lantronix model number  Lantronix serial number/MAC address  Firmware version (on the first screen shown when you Telnet to the device)  Description of the problem ...
  • Page 72: Appendix B: Connections And Pinouts

    Figure B-1 Single Serial Port and Ethernet Port on xDirect Serial Port Pinouts The xDirect has one female DB9 DCE serial port that supports one of three pinouts depending on the model of your xDirect unit: Figure B-2 DB9F in RS232 Mode (All Models) Figure B-3 DB9F in RS422/485 (4-Wire) Mode (xDirect485 &...
  • Page 73: Ethernet Connector Pinouts

    Figure B-4 DB9F in RS485 (2-Wire) Mode (xDirect485 & PoE Models) Ethernet Connector Pinouts The xDirect supports 10/100 Mbps half or full duplex Ethernet through an RJ45 connector. For PoE option, the xDirect is compliant as an IEEE 802.3af Power Device, Class . Power connections can be established via data pins (1 &...
  • Page 74: Power Jack (Mini Usb-B)

    The 5 VDC power supply included with standard xDirect devices (and not included the xDirect PoE model) connects to standard xDirect units through a mini USB connector on the side of the device. Figure B-7 Mini USB Power Port Connector on Standard xDirect Units...
  • Page 75: Appendix C: Technical Specifications

    5 to 15 VDC  Pin 9 (+) and pin 5 (-)  Note: If using a null modem gender (Lantronix P/N 140-448-R), Pin 9 can be used to power the unit. Optional PoE Redundant IEEE 802.3af PoE standard-compliant PD ...
  • Page 76 -40° to +75°C, or c) use a power supply that has similar rated temperature to that of xDirect so that the power supply and xDirect can be placed in the same environment.
  • Page 77: Appendix D: Alternative Ways To Assign An Ip Address

    If a DHCP server is found, but it denies the request for an IP address, the unit does not attach to the network, but waits and retries. AutoIP can be disabled by setting the unit’s IP address to 0.0.1.0. This setting enables DHCP but disables AutoIP. xDirect User Guide...
  • Page 78: Bootp

    191.12.3.77 9999 Note: The IP address you just set is temporary and reverts to the default value when the unit’s power is reset, unless you configure the unit with a static IP address and store the changes permanently. xDirect User Guide...
  • Page 79: Appendix E: Binary To Hexadecimal Conversions

    1. On the Windows Start menu, click Programs -> 1010 Accessories -> Calculator. 2. On the View menu, select Scientific. The 1011 scientific calculator appears. 1100 3. Click Bin (Binary), and type the number you want to convert. 1101 1110 1111 xDirect User Guide...
  • Page 80: Figure E-2 Windows Scientific Calculator

    Appendix E: Binary to Hexadecimal Conversions Figure E-2 Windows Scientific Calculator 4. Click Hex. The hexadecimal value appears. Figure E-3 Hexadecimal Values in the Scientific Calculator xDirect User Guide...
  • Page 81: Appendix F: Compliance

    167 Technology Drive, Irvine, CA 92618 USA Tel: 800-526-8766 Tel: 949-453-3990 Fax: 949-450-7249 Declares that the following product: Product Name Model: xDirect Device Server Conforms to the following standards or other normative documents: Safety UL 60950-1, 2nd Edition  CAN/CSA-C22.2 No. 60950-1-07, 2nd Edition ...
  • Page 82 Appendix F: Compliance RoHS Notice All Lantronix products in the following families are China RoHS-compliant and free of the following hazardous substances and elements: Lead (Pb) Mercury (Hg) Polybrominated biphenyls (PBB)    Cadmium (Cd) Hexavalent Chromium (Cr (VI)) Polybrominated diphenyl ethers (PBDE) ...

Table of Contents