LIMITATION ON REMEDIES. If the Software does not meet this Limited Warranty, Recipient’s exclusive remedy shall be, at Lantronix’s option (a) return of the price paid (if any) for the Software, or (b) repair or replacement of the Software, that does not meet this Limited Warranty and that is returned to Lantronix with proof of purchase.
Page 5
EVEN IF LANTRONIX OR ANY SUPPLIER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. The entire liability of Lantronix and any of its suppliers under any provision of this FLA for all of the foregoing shall be limited to the greater of the amount actually paid by Recipient for the Software or U.S.$5.00.
1: Using This Guide Purpose and Audience This guide covers DeviceLinx XPort™ Direct Device Gateway Module (XPD1001xxx-01) and the DeviceLinx XChip™ Direct SoC (XCD1001xxx-01). It provides the information needed to configure, use and update the XPort™ Direct firmware and is intended for OEMs and system integrators who are embedding the XPort Direct or XChip Direct in their end product designs.
Lantronix devices on the local network. DeviceInstaller's online Help provides information on using it. Additional Documentation The following documentation is also available on the product CD and the Lantronix web site (www.lantronix.com). Document Description Provides information about the XPort Direct...
2: Introduction This chapter summarizes the XPort Direct device networking gateway's features and the basic information needed before getting started. Capabilities The XPort Direct connects devices through a TCP data channel or through a Telnet connection to computers or other devices. The XPort Direct also supports UDP datagrams.
Ethernet address or the MAC address. The first three bytes of the Ethernet address are fixed and read 00-20-4A, identifying the unit as a Lantronix product. The fourth, fifth, and sixth bytes are unique numbers assigned to each unit.
2: Introduction Assigning an IP Address 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 assigning the IP address: DeviceInstaller: Assign an IP address and view the current configuration using a Graphical User Interface (GUI) on a PC attached to a network.
For more information about DeviceInstaller, see the DeviceInstaller online Help. To install DeviceInstaller from the Lantronix web site: 1. Download DeviceInstaller for your product from the Lantronix website (www.lantronix.com/support/downloads.html). 2. Click Setup.Exe. The installation wizard window displays. 3. Respond to the installation wizard prompts.
Accessing the XPort Direct Using DeviceInstaller 1. Click Start Programs Lantronix DeviceInstaller DeviceInstaller. 2. Click the XPort Direct folder. The list of available Lantronix XPort Direct units displays. 3. Expand the list of XPort Directs by clicking the + symbol next to the XPort Direct icon.
Page 17
3: Using DeviceInstaller 1. Follow the instructions above to locate the XPort Direct. 2. In the right pane, click the Device Details tab. The current XPort Direct configuration displays. Name Configurable field. A name that identifies the XPort Direct. Double-click the field, type in the value, and press Enter to complete.
Page 18
3: Using DeviceInstaller Subnet Mask Non-configurable field. Displays the XPort Direct’s current subnet mask. To change the subnet mask, see Assigning an IP Address on page 15. Gateway Non-configurable field. Displays the XPort Direct’s current gateway. To change the gateway, see Assigning an IP Address on page 15.
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 power. You can change the configuration at any time. The unit performs a reset after the configuration has been changed and stored.
4: Configuration via Telnet or Serial Port (Setup Mode) Figure 4-1. MAC Address 3. To enter Setup Mode, press Enter within 5 seconds. The configuration settings display, followed by the Change Setup menu. Figure 4-2. Setup Menu Options 4. Select an option on the menu by entering the number of the option in the Your choice? field and pressing Enter.
4: Configuration via Telnet or Serial Port (Setup Mode) 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.
5: 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.
5: 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.
5: Setup Mode: Server Configuration DHCP Name If a DHCP server has automatically assigned the IP address and network settings, this address does not appear in the unit’s Setup Mode. You can discover the unit by using Monitor Mode. (See 10: Monitor Mode.) Note: When you enter Monitor Mode from the serial port with network...
6: 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: Converting Binary to Hexadecimal.) 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.
6: 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: All bit positions in the table that are blank represent “don’t care” bits for that particular option, which can be set to a value of 0 or 1. Table 6-1.
6: Setup Mode: Channel Configuration Table 6-3. Flow Control Options Flow Control Option No flow control XON/XOFF flow control Hardware handshake with RTS/CTS lines XON/XOFF pass characters to host Port Number The setting represents the source port number in TCP connections. It is the number that identifies the channel for remote initiating connections.
6: Setup Mode: Channel Configuration Table 6-5. Connect Mode Options Connect Mode Option a) Incoming Connection Never accept incoming Accept with active Modem Control In Always Accept b) Response Nothing (quiet) Character response (C=connect, D=disconnect, N=unreachable) c) Active Startup No active startup With any character With active Modem Control In With a specific start character...
6: Setup Mode: Channel Configuration b) Response Character Response A single character is transmitted to the serial port when there is a change in connection state: C = connected, D = disconnected, N = host unreachable. The IP address of the host connecting to the XPort Direct will be provided when you use verbose mode.
Page 30
6: Setup Mode: Channel Configuration Figure 6-2. 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, C121.2.4.5/1 port 1. Connects to 129.1.2.5, port 1234. C28.10/12 Connects to 129.1.28.10, port 12.
3. After completing the hostlist, repeat the previous step if necessary to edit the hostlist again. 4. For Retrycounter, enter the number of times the Lantronix unit should try to make a good network connection to a hostlist entry that it has successfully ARPed.
Page 32
6: Setup Mode: Channel Configuration Data Echo & Modem Full Verbose: The unit echoes modem commands and responds to Response a command with a message string shown in the table below. Numeric Response: The unit echoes modem commands and responds to a command with a numeric response. Modem Responses Full Verbose: The unit does not echo modem commands and Only...
Page 33
6: Setup Mode: Channel Configuration No serial data is received for one second. 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.
6: Setup Mode: Channel Configuration Send the Escape Sequence (+++) in Modem Mode Send ‘+++’ in Modem Mode (Y) ? _ Disable or enable the XPort Direct’s ability to send the escape sequence. The default is Y (Yes) (send the escape sequence). Show IP addr after 'RING' Disable or enable the XPort Direct's ability to show the IP address after RING in Modem Mode.
6: Setup Mode: Channel Configuration Notes: In DisConnMode (Disconnect Mode), modem_control_in either drops the connection or is ignored. Note: All bit positions in the table that are blank represent “don’t care” bits for that particular option, which can be set to a value of 0 or 1. Table 6-7.
6: Setup Mode: Channel Configuration Table 6-8. Flush Mode Options Function Input Buffer (Serial to Network) Clear with a connection initiated from the device to the network Clear with a connection initiated from the network to the device Clear when the network connection to or from the device is disconnected Output Buffer (Network to Serial) Clear with a connection initiated from the device to the network Clear with a connection initiated from the network to the device...
6: Setup Mode: Channel Configuration DisConnTime (Inactivity Timeout) Use this parameter to set an inactivity timeout. The unit drops the connection if there is no activity on the serial line before the set time expires. Enter time in the format mm:ss, where m is the number of minutes and s is the number of seconds.
7: Setup Mode: Advanced Settings Expert Settings (Option 5) Caution: Only an expert should change these parameters. You must definitely know the consequences the changes might have. Figure 7-1. Expert Settings The default settings are listed below: Setting Default TCP Keepalive time in s (1s –...
7: Setup Mode: Advanced Settings Disable Monitor Mode at bootup This option allows you to disable all entries into Monitor Mode during startup, except for the ‘xxx’ sequence. This prevents entry using yyy, zzz, xx1, and yy1 key sequences (only during the bootup sequence). The default for Monitor Mode at bootup is N (No).
7: Setup Mode: Advanced Settings Figure 7-2. Security Settings Disable Telnet Setup Note: If you choose to disable this option, keep in mind that disabling both Telnet Setup and Port 77FE will prevent users from accessing the setup menu from the network. This setting defaults to the N (No) option.
7: Setup Mode: Advanced Settings Disable ECHO ports (Y) ? _ 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. The Y (Yes) option allows you to set an extended security password of 16-characters for protecting Telnet access.
Active Level: Active Low This chapter describes how the directions, active levels, and states can be dynamically controlled and probed through special port 77F0. Note: For specific configuration information contact Lantronix customer support. Features TCP and UDP can be used.
8: 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 Direct. Response comes from XPort Direct to PC. The protocol allows for control of up to 32 GPIOs. How many are actually available depends on the product.
Page 46
8: 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...
8: 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.
Page 48
8: 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 →...
(ftp.lantronix.com). Reloading Firmware To update the unit's internal operational code (*.ROM), use TFTP or DeviceInstaller. Following is a typical name for the file. Check the Lantronix web site for the latest versions and release notes. Table 9-1. Typical Firmware File ROM File xptd_6303.rom...
Firmware Upgrade window displays. 3. For Port on PC, enter the COM port on the PC that is connected to the serial port of the Lantronix unit. 4. For Device Model, be sure the appropriate XPort Direct device displays. DeviceLinx™ XPort Direct/XChip Direct SoC User Guide...
Page 51
9: Firmware Upgrades 5. For Firmware File, click the Browse button and go to the location where the firmware file resides. Note: Make sure the unit on which you are recovering firmware is connected to this selected port on your PC. 6.
10: 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.
Page 53
Reports the network interfaces’ statuses. Includes potentially negotiated parameters like speed/duplex or encryption, or BSSID and for Ethernet authentication for wireless interfaces of applicable Lantronix products). Responses to some of the commands are in Intel Hex format. DeviceLinx™ XPort Direct/XChip Direct SoC User Guide...
Page 54
10: Monitor Mode Note: Entering any of the commands listed above generates one of the following command response codes: Table 7-2. Command Response Codes Response Meaning 0> OK; no error 1> No answer from remote device 2> Cannot reach remote device or no answer 8>...
This chapter discusses how you can diagnose and fix errors quickly without having to contact a reseller 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 56
11: Troubleshooting Problem/Message Reason Solution When you Telnet to port 1 to You may have entered Confirm that the Ethernet assign an IP address to the XPort the Ethernet address address that you entered with Direct, the Telnet window does incorrectly with the ARP the ARP command is correct.
Technical Support Europe, Middle East, and Africa Phone: +33 (0) 1 39 30 41 72 Email: eu_techsupp@lantronix.com or eu_support@lantronix.com 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 company name, address, and phone number ...
IP address, gateway address, and subnet mask when the unit boots up. You can use the DeviceInstaller software to search the network for the DHCP- assigned IP address and add it to the list of Lantronix units retrieved. Note: This DHCP address does not appear in the unit’s Setup Mode. You can determine your unit’s DHCP-assigned IP address in Monitor Mode.
A: Alternative Ways to Assign an IP Address AutoIP can be disabled by setting the unit’s IP address to 0.0.1.0. This setting enables DHCP but disables AutoIP. BOOTP Similar to DHCP, but for smaller networks. Automatically assigns the IP address for a specific duration of time.
Page 60
B: 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.
Page 61
B: Binary to Hexadecimal Conversions 4. Click Hex. The hexadecimal value displays. DeviceLinx™ XPort Direct/XChip Direct SoC User Guide...
Need help?
Do you have a question about the DeviceLinx XPort Direct and is the answer not in the manual?
Questions and answers