Home

XPort/XChip User Guide

1. DeviceLinx XPort XChip SoC User Guide 24 4 Configuration Using Web Manager automatically Enable is the default DHCP Select Enable to permit the Dynamic Host Configuration Protocol DHCP to assign a leased IP address to the XPort unit automatically Enable is the default AutolP Select Enable to permit the XPort to generate an IP in the 169 254 x x address range with a Class B subnet Enable is the default DHCP Host Name Enter the desired host name for the XPort Note Disabling BOOTP DHCP and AutolP 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 Onthe main menu click Apply Settings Static IP Address Configuration You manually assign an IP address to the unit and enter related network settings To assign an IP address manually 1 Onthe main menu click Network 2 Select Use the following IP configuration 3 Enter the following as necessary IP Address If DHCP is not used to assign IP addresses enter it manually in decimal dot notation The IP address must be set to a unique value in the network Subnet Mask A subnet mask defines the number of bits taken from the IP address that are assigned for the host part Default Gateway The gateway address or router allows communication to other LAN segments The gateway address should be the IP address of the
2. Name Configurable field A name that identifies the XPort Double click the field type in the value and press Enter to complete This name is not visible on other PCs or laptops using Devicelnstaller DeviceLinx XPort XChip SoC User Guide 19 3 Using Devicelnstaller DHCP Device Name Non configurable field Displays the name associated with XPort s current IP address if the IP address was obtained dynamically To change the DHCP device name see Configuration Using Web Manager or Configuration via Telnet or Serial Port Setup Mode 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 Devicelnstaller 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 Devicelnstaller Device Family Non configurable field Displays the XPort s device family as XPort Type Non configurable field Displays the device type as XPort 03 04 ID Non configurable field Displays the XPort s ID embedded within the box Hardware Address Non configurable field Displays the XPort s hardware or MAC address Firmware Version Non configurable field Displays the firmware currently installed on the X
3. 7 When prompted reset the device Status messages and a progress bar at the bottom of the screen show the progress of the file transfer When the file transfer completes the message Successful Click OK to Close appears 8 Click the OK button to complete this procedure Note For more information see Recovering Firmware in the Devicelnstaller online Help DeviceLinx XPort XChip SoC User Guide 81 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 42 2 Instead of typing three x keys however 3 Type zzz or xx1 to enter Monitor Mode with network connections 4 Type yyy or yy1 to enter Monitor Mode without network connections A 0 gt prompt indicates that you have successfully entered Monitor Mode Entering Monitor Mode Using the Network Port To enter Monitor Mode using a Telnet connection 1 Establish a Telnet session to the configuration port 9999 The following message appears MAC address 66264A825A97 Software version U6 1 6 G RC 516 5 gt KPTEXE AES library version 1 8 2 1 Press Enter for Setup Mode 2 Type M upper case A 0 gt prompt indicates that you
4. Trigger 2 Serial trigger input disabled Channel 1 Match 00 Trigger inputl X Trigger input2 X Trigger input3 X Message Priority Min notification interval 1 s Re notification interval 0s Trigger 3 Serial trigger input disabled Channel 2 Match 00 DeviceLinx XPort XChip SoC User Guide 62 8 Setup Mode Advanced Settings Trigger inputl X Trigger input2 X Trigger input3 X Message Priority L Min notification interval 1 Re notification interval 0 Server 0 0 0 0 0 _ s s 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 The current value is displayed in parentheses Unit name Domain Name Enter the email server s domain name The current value is displayed in parentheses Domain name _ Recipient 1 Enter the full email address of the trigger email recipient The current value is displayed in parentheses Recipient 1 _ Recipient 2 Enter the full email address of the trigger email recipient The current value is displayed in parentheses Recipient 2 _ Trigger 1 A trigger event occurs when the unit receives the specified trigger inp
5. Indicates a connection is established on channel 1 Link Status Indicates the Ethernet link state Status LED 1 Indicates channel 1 status and extended diagnostics when status LED 3 is lit Status LED 3 Indicates errors and configurations HW Flow Control In RTS Allows for flow control on the connection with hardware handshaking HW Flow Control Out CTS Allows for flow control on the connection with hardware handshaking RS485 Tx Enable 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 Onthe main menu click Apply Settings DeviceLinx XPort XChip SoC User Guide 39 4 Configuration Using Web Manager Apply Settings 1 To save and apply the configuration changes to the device server click the Apply Settings button Note Clicking OK on each page does not change the configuration on the device OK tells the XPort what changes to use Apply Settings makes the changes permanent and reboots the XPort 2 Click Yes to set factory settings or click No to cancel Apply Factory Defaults Click the Apply Factory Defaults button to set the device server back to the default settings For details see Default Settings on page 71 DeviceLinx XPort XChip SoC User Guide 40 5 Configuration via Telnet or Serial Port
6. With Active Mdm Ctrl In Accepts external connection requests only when the Modem Control In input is asserted With Start Character Attempts to connect when it receives a specific start character from the serial port The default start character is carriage return Manual Connection Attempts to connect when directed by a command string received from the serial port Auto Start Automatically connects to the remote IP address and port after booting up Start Character If Active Connect is set to With Start Character enter the start character in this field Modem Mode Indicates the on screen response type when in Modem Mode if Modem Mode is enabled Show IP Address After Ring Indicates whether to display the remote IP address upon connection The default setting is Yes Endpoint Configuration Local Port Enter the local port number Auto increment for active connect Select to auto increment the local port number for new outgoing connections The range of auto incremented port numbers is 50 000 to 59 999 and loops back to the beginning when the maximum range is reached DeviceLinx XPort XChip SoC User Guide 33 4 Configuration Using Web Manager Remote Port Enter the remote port number Remote Host Enter the IP address of the remote device Common Options Telnet Com Port Cntril This field is available for configuration only when Ac
7. 05h 00h 00h 00h Command details 1Bh command 1Bh 01h 00h 00h 00h the mask that determines which GPIOs will be changed bit 0 is 1 GPIOO will be changed bit 1 is 0 gt GPIO1 will remain the same OO 00h 00h 00h the new states bit 0 is 0 gt GPIOO will become 0 bit 1 is ignored since it is masked out Response details 1Bh response to command 1Bh 05h 00h 00h 00h bit 0 is 1 GPIOO 1 bit 1 is 0 GPIO1 0 bit 2 is 1 gt GPIO2 1 The other bits are ignored because there are only three configurable pins on the XPort DeviceLinx XPort XChip SoC User Guide 78 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 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 ROM using Devicelnstaller the preferred way using TFTP or using the serial port You can also update the unit s internal Web interface COB using TFTP or Devicelnstaller Here are typical names for those files Check the Lantronix web site for the latest versions and release notes Table 10 1 Firmware Files XPT_6100 rom XPT_webm_1300 cob
8. Please refer to the Devicelnstaller online Help for information about reloading firmware using Devicelnstaller The other methods are discussed below Using TFTP Graphical User Interface To download new firmware from a computer 1 Use a TFTP client to put a binary file to the unit ROM to upgrade the unit s internal operational code and COB to upgrade its internal web interface Note TFTP requires the rom binary version of the unit s internal operational code 2 Inthe TFTP server field enter the IP address of the unit being upgraded 3 Select Upload operation and Binary format 4 Enter the full path of the firmware file in the Local file name field 5 In the Remote file name field enter the current internal operational code or WEB1 to WEB6 for the internal web interface DeviceLinx XPort XChip SoC User Guide 79 10 Firmware Upgrades Figure 10 1 TFTP Window TFTP Client TFTP server 172 20 206 64 z Upload Now Operation bh Upload v Format Binary S LU Local file name Weird Solutions Let 6507 rom KI i Settings Remote file name x5 Help 0 Copyright 1996 2002 Weird Solutions Inc All rights reserved 6 Click the Upload Now button to transfer the file to the unit The unit performs a power reset after the firmware has been loaded and stored After the firmware has been loaded and stored which takes approximately 8 seconds to complete the unit performs a p
9. abnormal use or a virus Any replacement Software will be warranted for the remainder of the original warranty period or thirty 30 days whichever is longer To exercise this remedy contact Lantronix Attn Lantronix Sales Lantronix Inc 15353 Barranca Parkway Irvine CA 92618 DISCLAIMER OF WARRANTIES The Limited Warranty that appears above is the only express warranty made and is provided in lieu of any other express warranties if any created by any documentation or packaging Lantronix and its suppliers provide the Software AS IS AND WITH ALL FAULTS LANTRONIX HEREBY DISCLAIMS ALL WARRANTIES EXPRESS IMPLIED OR STATUTORY INCLUDING BUT NOT LIMITED TO MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE NON INFRINGEMENT TITLE QUIET ENJOYMENT QUIET POSSESSION OR CORRESPONDENCE TO DESCRIPTION LIMITATION OF LIABILITY AND REMEDIES IN NO EVENT SHALL LANTRONIX OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL INCIDENTAL INDIRECT OR CONSEQUENTIAL DAMAGES WHATSOEVER DAMAGES FOR LOSS OF PROFITS OR CONFIDENTIAL OR OTHER INFORMATION FOR BUSINESS INTERRUPTION FOR PERSONAL INJURY FOR LOSS OF PRIVACY FOR FAILURE TO MEET ANY DUTY INCLUDING THAT OF GOOD FAITH OR OF REASONABLE CARE FOR NEGLIGENCE AND FOR ANY OTHER PECUNIARY OR OTHER LOSS WHATSOEVER ARISING OUT OF OR IN ANY WAY RELATED TO THE USE OF OR INABILITY TO USE THE SOFTWARE THE PROVISION OF OR FAILURE TO PROVIDE SUPPORT SERVICES OR OTHERWISE UNDER OR IN CONNECTION WITH ANY PROVISION O
10. 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 The IP address must be in standard decimal dot notation and may be a partial address representing the least significant 1 2 or 3 bytes of the remote IP address The period is required between each pair of IP address numbers If present the port number must follow the IP address must be presented as a decimal number in the range 1 65535 and must be preceded by a forward slash ASCII 0x2F The slash separates the IP address and the port number If you omit the port number from a command string the internally stored remote port number starts a connection If a partial IP address is presented in a command string it is interpreted to be the least significant bytes of the IP address and uses the internally stored remote IP address to provide the most significant bytes of the IP address If the IP address entered is 0 0 0 0 0 the device server enters Monitor Mode For example if the remote IP address already configured in the unit is 129 1 2 3 then an example command string would be C3 7 This would connect to 129 1 2 3 and port 7 You may also use a different ending for the connection string For example C
11. 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 Too much data arriving before a device is prepared to manage it causes lost or retransmitted data None is the default Baud Rate 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 DeviceLinx XPort XChip SoC User Guide 29 4 Configuration Using Web Manager 4800 9600 default 19200 38400 57600 115200 230400 460800 or 921600 Data Bits Indicates the number of bits in a transmitted data package The default is 8 Parity Checks for the parity bit The default is None Stop Bits The stop bit follows the data and parity bits in serial communication It indicates the end of transmission The default is 1 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 The alternate packing algorithm minimizes th
12. Accessing Web Manager Using Devicelnstaller A 22 Network Configuration sonvrernrrnnnnrrnnnnvnnorrrnnnvnnnn venn nnnnnrnnnnnnnnnnnnnnennennnrnennnnnnennenennn 23 Network Mode 24 Automatic IP Address Configuration 24 Static IP Address Configuration 25 Ethernet Configuration 25 Server Configuraion vener vennnvnnnn vanen nnnrnnrennnrnennnnnnennenrrnresnnrnnennnnnenneennn 26 DeviceLinx XPort XChip SoC User Guide 7 Contents Server Configuration 27 Advanced 27 Host List Configuration sssrinin daiane dE EEN bann 27 Retry Settings 28 Host Information 28 Channel 1 Gonfigur tioh uuuru mms vinterstid Eed enge 28 Serial Settings 29 Connection Settings TCP 31 Connection Settings UDP 35 Email Configuration c ccccccceeceeceeeeeeeeeeeeeeeeeaeeeeaaeeeeaeeseaeeesaaesesaaeseeeeseaeeesaeeseneeenaees 36 Recipients 37 Trigger Configuration 37 Conditions 38 Message Properties 38 Configurable Pin Betting oegtgeeee eege Zeteee eege ia aa aa a 38 Configurable Pin Functions 39 Apply Settings ET 40 Apply Factory Defaults 2 cscs tesancecevesec etancenvpeahacedebancaeveeshacedebancee i a eaaa 40 Configuration via Telnet or Serial Port Setup Mode 41 Accessing Setup Mode nnna 41 Telnet Connection 41 Serial Port Connection 42 Exiting Setup Mode cies cei vin hetset Gumbeseed dividere 43 Setup Mode Server Configuration 44 Server Configuration Option OI 44 IP ele 44 Set Gateway IP Addre
13. DeviceLinx XPort XChip SoC User Guide 69 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 Initial configuration information including the encryption key is sent in clear text over the network To configure AES encryption on the XPort Enable Encryption N Y Key length in bits 0 128 Change Keys N Y Enter Keys KLEK EK EK EK EK EK KKK EK EK EK EK EK EK KE 1 When prompted to enable encryption select Y 2 When prompted enter the encryption key length The XPort supports 128 192 and 256 bit encryption key lengths 3 When prompted to change keys select Y 4 Atthe Enter Keys prompt enter your encryption key The encryption keys are entered in hexadecimal The hexadecimal values are echoed as asterisks to prevent onlookers from seeing the key Hexadecimal values are 0 9 and A F For a 128 bit key length enter 32 hexadecimal characters Fora 192 bit key length enter 48 hexadecimal characters Fora 256 bit key length enter 64 hexadecimal characters 5 Continue pressing Enter until you return to the Change Setup m
14. Devicelnstaller 4 Configuration Using Web Manager OT Configuration via Telnet or Serial Port Setup Mode op Setup Mode Server Configuration N Setup Mode Channel Configuration 8 Setup Mode Advanced Settings 9 GPIO Interface Describes the main features of the XPort and the protocols it supports Provides information for getting your unit up and running using Devicelnstaller to assign an IP address Details using the Web Manager to set parameters such as port and server properties Provides instructions for accessing Setup Mode command line interface using a Telnet connection through the network or a terminal or terminal emulation program through the serial port Details the network server settings Details the serial port settings Details email expert and security settings and explains how to reset the unit to factory default values Provides instructions for configuring the three General Purpose I O pins CP1 3 DeviceLinx XPort XChip SoC User Guide 13 1 Using This Guide 10 Firmware Upgrades 11 Monitor Mode 12 Troubleshooting A Binary to Hexadecimal Conversions Additional Documentation Provides instructions for obtaining the latest firmware and updating the XPort Provides instructions for accessing and using the command line interface for monitoring the network and diagnosing problems Describes common problems and error messages and how to c
15. In 0 Telnet Com Port Cntrl and terminal type setup 1 Channel port password g 1 Hard disconnect 0 Disable hard disconnect 1 State LED off with connection 1 Disconnect with EOT D 1 1 The Telnet Com Port Control feature is used in conjunction with Com Port Redirector The unit sends the Terminal Type upon an outgoing connection 2 A password is required for a connection to the serial port from the network 3 The TCP connection closes even if the remote site does not acknowledge the disconnection 4 When there is a network connection to or from the serial port the state LED turns off instead of blinking 5 When Ctrl D or Hex 04 is detected the connection is dropped Both Telnet Com Port Cnirl and Disconnect with EOT must be enabled for Disconnect with EOT to function properly Ctrl D is only detected going from the serial port to the network 6 When Modem Control In transitions from a high state to a low state the network connection to or from the serial port drops Flush Mode Buffer Flushing Using this parameter you can control line handling and network buffers with connection startup and disconnect FlushMode 0 _ You can also select between two different packing algorithms Note All bit positions in the table that are blank represent don t care bits for that particular option which can be set to either a 0 or 1 value
16. MAC Address 00 20 4A A5 C8 FC ke Connection Settings Channel 1 Protocol UDP ze Serial Settings Datagram Mode Email N Datagram Type 00 e AcceptIncoming ves Endpoint Configuration Se Local Port 10001 Remote Port 0 Configurable Pins Apply Settings Remote Host 0 0 0 0 O Use Broadcast Device Address Table Apply Defaults Dev Addr 0 0 jo Dev Addr 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 DeviceLinx XPort XChip SoC User Guide 35 4 Configuration Using Web Manager Endpoint Configuration Local Port Enter the local port number Remote Port Enter the port number of the remote device Remote Host Enter the IP address of the remote device Use Broadcast Select to broadcast the UDP datagram The default is not to broadcast Note Datagrams are sent as subnet directed broadcasts Device Address Table The table is enabled when Datagram Type is set to FD Enter values between 1 and 255 to identify units on the local
17. States including Puerto Rico Guam and all other territories dependencies and possessions of the United States or Canada without a U S Commerce Department export license or an applicable license exception Recipient agrees not to directly or indirectly export or re export the Software or portions thereof other than to Canada without first obtaining an export license or determining that an exception is applicable LIMITED WARRANTY Lantronix warrants that the Software will perform substantially in accordance with the accompanying materials for a period of ninety 90 days from DeviceLinx XPort XChip SoC User Guide 4 the date of receipt AS TO ANY DEFECTS DISCOVERED AFTER THE NINETY 90 DAY PERIOD THERE IS NO WARRANTY OR CONDITION OF ANY KIND Any supplements or updates to the Software including without limitation any service packs or hot fixes provided after the expiration of the ninety day Limited Warranty period if any are not covered by any warranty or condition express implied or statutory 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 This Limited Warranty is void if failure of the Software has resulted from accident abuse misapplication
18. TCP DeviceLinx XPort XChip SoC User Guide 49 7 Setup Mode Channel Configuration Connect Mode Connect Mode defines how the unit makes a connection and how it reacts to incoming connections over the network ConnectMode CO _ Enter Connect Mode options in hexadecimal notation Note All bit positions in the table that are blank represent don t care bits for that particular option which can be set to either a 0 or 1 value Table 7 6 Connect Mode Options a Incoming Connection Never accept incoming 0 0 0 Accept with active Modem Control In 0 1 0 Always Accept 1 1 0 b Response Nothing quiet 0 Character response C connect D disconnect N unreachable c Active Startup No active startup 0 With any character 0 With active Modem Control In 0 o o o o With a specific start character 0 Manual connection 0 1 0 0 Autostart 0 1 0 1 Hostlist 0 0 1 0 d Datagram Type Directed UDP 1 1 0 0 e Modem Mode No Echo 0 0 1 1 Data Echo amp Modem Response 0 1 1 1 1 Numeric Data Echo amp Modem Response Verbose Modem Response Only Numeric 0 0 1 1 1 1 Modem Response Only Verbose 0 0 1 1 1 0 DeviceLinx XPort XChip SoC User Guide 50 7 Setup Mode Channel Configuration a Incoming Connection Never Accept Incoming Rejects all external connection attempts Accept with ac
19. 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 Set Gateway IP Address N Y Gateway IP addr 0 0 0 0 _ Number of Bits for Host Part A netmask defines the number of bits taken from the IP address that are assigned for the host part Netmask Number of Bits for Host Part O default 0 _ Note Class A 24 bits Class B 16 bits Class C 8 bits The unit prompts for the number of host bits to be entered then calculates the netmask which appears in standard decimal dot notation for example 255 255 255 0 when the saved parameters display Table 6 2 Standard IP Network Netmasks A 24 255 0 0 0 B 16 255 255 0 0 8 255 255 255 0 Set DNS Server IP Address The DNS server allows the name of a remote machine to be resolved automatically The default is N No indicating the DNS server address has not been set To set the DNS server address type 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 lt N Change Telnet Web Manager Password Setting the Telnet Web Man
20. bits no parity 1 stop bit no flow control Note The XPort always uses these serial port settings on boot up 3 Reset the XPort 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 DeviceLinx XPort XChip SoC User Guide 42 5 Configuration via Telnet or Serial Port Setup Mode Note The easiest way to enter Setup Mode is to hold down the x key at the terminal or emulation while resetting the unit You must do this within three seconds of resetting the XPort At this point the screen display is the same as when you use a Telnet connection To continue go to step 4 above in Error Reference source not found Telnet Connection 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 select option 8 Exit without save from the Change Setup menu DeviceLinx XPort XChip SoC User Guide 43 6 Setup Mode Server Configuration This chapter explains how to configure the network settings Note Current values appear 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 Addres
21. have successfully entered Monitor Mode Monitor Mode Commands The following commands are available in Monitor Mode Many commands have an IP address as an optional parameter xxx xxx xxx xxx If you enter the IP address the command is applied to another unit with that IP address If you do not enter the IP address the command is executed locally Note All commands must be in capital letters Responses to some of the commands are in Intel Hex format DeviceLinx XPort XChip SoC User Guide 82 11 Monitor Mode Table 11 1 Monitor Mode Commands VS x x X X Version Queries software header record 16 bytes of unit with IP address X X X X GC Xx x X X Get Configuration Gets configuration of unit with IP address x x x x as hex records 120 bytes SC Xx 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 AT ARP Table Shows the unit s ARP table entries TT TCP Connection Shows all incoming and outgoing TCP Table connections NC Network Shows the unit s IP address gateway subnet Connection mask and DNS server RS Reset Resets the unit s power QU Quit Exits diagnostics mode GO G1 Ge Get configuration Gets a memory page of configuration information Gf from memory page from the device SO S1 Se Sf Set configuration to Sets a memory page of conf
22. 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 4 Onthe main menu click Apply Settings Email Configuration 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 Onthe main menu select Email The Email Settings window opens LANTRONIX Figure 4 9 Email Settings Firmware Version V6 6 0 1RC2 MAC Address 00 20 4A A5 C8 FC Email Settings Network Server er i Serial Tunnel Server IP Address 0 0 0 0 Server Port Se Hostlist s l Channel 1 Domain Name Unit Name Recipients Recipient 1 Email Address iaMMmYS tm Configurable Pins Recipient 2 gt Conter Apply Settings DeviceLinx XPort XChip SoC User Guide 36 4 Configuration Using Web Manager 2 Configure the following fields Server IP Address Enter the IP address of the mail server Server Port Enter the port number on the email server Domain Name Enter the email server s domain
23. router connected to the same LAN segment as the unit The gateway address must be within the local network DNS Server The DNS server allows the name of a remote machine to be resolved automatically Enter the IP address of the DNS server 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 4 When you are finished click the OK button 5 On the main menu click Apply Settings Ethernet Configuration You must specify the speed and direction of data transmission DeviceLinx XPort XChip SoC User Guide 25 4 Configuration Using Web Manager To specify how data will be transmitted 1 Onthe main menu click Network 2 Enter the following as necessary Auto Negotiate With this option the Ethernet port auto negotiates the speed and duplex with the hardware endpoint to which it is connected This is the default If this option is not selected the complete the fields that become available Speed The speed of data transmission The default is 100 Mbps Duplex The direction of data transmission The default is Full 3 When you are finished click the OK button 4 Onthe 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
24. serial channel Increasing CPU clock speed consumes more power and generates more heat This reduces the maximum operating temperature specification See the appropriate product brief for details 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 See 11 Monitor Mode Disable Monitor Mode bootup N _ HTTP Port Number This option allows the configuration of the web server port number The valid range is 1 65535 The default HTTP port number is 80 HTTP Port Number 80 _ SMTP Port Number This option allows the configuration of the email port number The valid range is 1 65535 The default SMTP port number is 25 SMTP Port Number 25 _ Note When configuring the HTTP or SMTP port number take note of the reserved port numbers on page 49 RS 485 TX Enable Active Level Note The following applies to XPort model XP1004000 03 XPort 485 This option allows the selection of the active level either active high or active low for the RS485_TXEN signal The default is active low This setting only applies if one of the configurable pins for the RS485 TXEN functionality is selected For the RS 485 interface mode to operate correctly DeviceLi
25. subnet that you are trying to assign to the device server The device server may not be plugged into the network properly Make sure that the Link LED is lit If the Link LED is not lit then the device server is not properly plugged into the network When you try to assign an IP with Devicelnstaller you get the following No response from device Verify the IP Hardware Address and Network Class Please try again The cause is most likely one of the following The hardware address you specified is incorrect The IP address you are trying to assign is nota valid IP for your logical subnet You did not choose the correct subnet mask Double check the parameters that you specified Note You cannot assign an IP address to a device server through a router The device server is not communicating with the serial device to which it is attached The most likely reason is the wrong serial settings were chosen The serial settings for the serial device and the device server must match The default serial settings for the device server are RS 232 9600 baud 8 character bits no parity 1 stop bit no flow control When you try to enter the setup mode on the device server using the serial port you get no response The issue is most likely something covered in the previous problem or possibly you have Caps Lock on Double check everything in the problem above Confirm th
26. the Software remain with Lantronix LIMITATION ON REVERSE ENGINEERING DECOMPILATION AND DISASSEMBLY Recipient may not reverse engineer decompile or disassemble the Software Recipient may not copy the Software or transfer it to other devices other than those specified above without the express prior written consent of Lantronix UPGRADES To use Software identified as an upgrade Recipient must first be licensed for the Software identified by Lantronix as eligible for the upgrade After upgrading Recipient may no longer use the Software that formed the basis for upgrade eligibility Once installed the Software replaces the component being upgraded and the Software may be used in accordance with the terms of this FLA unless additional terms are provided along with such upgrade EXPORT Recipient agrees not to export or re export the Software or portions thereof to any country person or entity subject to U S export restrictions Recipient specifically agrees not to export or re export the Software or portions thereof i to any country subject to a U S embargo or trade restriction ii to any person or entity who Recipient knows or has reason to know will utilize the Software or portions thereof in the Software of nuclear chemical or biological weapons or iii to any person or entity who has been denied export privileges by the U S government If the Software contains strong encryption and cannot be exported outside of the United
27. the unit reverts to command mode When an active connection is in effect the unit terminates the connection if it receives the following sequence from the attached serial device 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 The character string ATH is received terminated with a carriage return The unit responds affirmatively according to the selected echo response mode and drops the network connection The serial interface reverts to accepting command strings DeviceLinx XPort XChip SoC User Guide 55 7 Setup Mode Channel Configuration If this sequence is not followed the unit remains in data transfer mode Table 7 9 Modem Mode Commands 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 or number pppp ATDTX x x x pppp ATDTx X x x Makes a connection to an IP address x x x x and the remote port er number defined within the unit ATDO 0 0 0 Forces the unit into Monitor Mode if a remote IP address and port number are defined within the unit Forces the unit into Monitor Mode if a remote IP address and port AE number are not defined within the unit ATDXX XX Makes a connection to an IP a
28. 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 Devicelnstaller 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 Devicelnstaller Web Manager Through a web interface configure the XPort and its settings using the XPort s Web Manager See 4 Configuration Using Web Manager Serial amp Telnet Ports There are two approaches to accessing Serial Mode Make a Telnet connection to the network port 9999 or connect a terminal or a PC running a terminal emulation program to the unit s serial port See 5 Configuration via Telnet or Serial Port Setup Mode Addresses and Port Numbers Hardware Address The hardware address is also referred to as the 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 Example 00 20 4A 14 01 18 Note Make note of the MAC address It is needed to locate the XPort using Devicelnstaller DeviceLinx XPort XChip SoC User Guide 16 2 Introduction IP Address Every device connected to an IP network must have a unique IP address This address is used to reference the specific unit The XPort is automatically assigned an IP a
29. wire 1 1 DeviceLinx XPort XChip SoC User Guide 48 7 Setup Mode Channel Configuration 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 Flow Control Options No flow control 00 XON XOFF flow control 01 Hardware handshake with RTS CTS lines 02 XON XOFF pass characters to host 05 Port Number The setting represents the source port number in TCP connections It is the number that identifies the channel for remote initiating connections Port No 10001 _ The default setting for Port 1 is 10001 The range is 1 65535 except for the following reserved port numbers Table 7 5 Reserved Port Numbers 1 1024 Reserved well known ports 9999 Telnet setup 14000 14009 Reserved for Redirector 30704 Reserved 77F0h 30718 Reserved 77FEh WARNING We recommend that you not use the reserved port numbers for this setting as incorrect operation may result 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
30. 1 is low use the Connect Mode option CO for making a connection to the device server from the network Use Connect Mode option C1 or C5 fora connection to the network from the device server See the full list of Connect Mode options in Connect Mode When connecting to the Web Your computer is not Make sure that port 30718 Manager within the device able to connect to port 77FEh is not blocked with server the No Connection 30718 77FEh on the any router that you are using With The Device Server device server on the network Also make message displays sure that port 77FEh is not disabled within the Security settings of the device server DeviceLinx XPort XChip SoC User Guide 87 12 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 Technical Support US Check our online knowledge base or send a question to Technical Support at http www lantronix com Support Phone 800 422 7044 US Only 949 453 7198 Technical Support Europe Middle East and Africa Phone 83 0 1 39 30 41 72 49 0 180 500 13 53 Germany Only Email eu techsuppQlantronix com or eu supportQlantronix 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
31. 2 entries Each entry contains the IP address and the port number The hostlist is disabled for Manual and Modem Modes The unit does not accept a data connection from a remote device when the hostlist option is enabled Figure 7 2 Hostlist Option Baudrate 960 gt I F Mode 4C gt Flow gt Port No lt 1 1 gt ConnectMode lt 25 gt Send in Modem Mode CY Auto increment source port lt N Hostlist i IP 172 619 666 661 Port 66823 Hi IP 172 019 000 002 Port 83061 63 IP 172 619 666 663 Port 16661 Change Hostlist ND Y i IP address 172 gt 19 gt lt 9 gt lt 1 gt Port lt 23 Hi IP address 172 gt lt 9819 gt gt lt 962 gt Port 3 1 gt 3 IP address 172 lt 19 gt gt lt 9683 gt Port lt 1 1 gt B4 IP address Hostlist Bi IP 172 619 666 661 Port 88623 02 IP 172 619 668 662 Port 63061 172 619 666 663 Port 16661 C HH lt 9080 gt lt 900 gt CDA Change Hostlist ND N Hostlist Retrycounter lt 3 Hostlist Retrytimeout lt 250 gt DisConnMode lt gt FlushMode 68 gt DisConnTime 66 68 SendChar 1 lt 00 gt SendChar 2 lt O m To enable the hosilist 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 Todelete modify or add an en
32. 50 1 23 would connect you to 129 1 50 1 and port 23 If an IP address does not follow the first command string character which is C the subsequent character string is interpreted as the host name and domain to be used in DNS lookup This character string can include a destination port number as well The port number can be preceded by either a forward slash or a colon Table 7 7 Manual Connection Address Example C121 2 4 5 1 Complete override connection is started with host 121 2 4 5 port 1 C5 Connects to 129 1 2 5 port 1234 C28 10 12 Connects to 129 1 28 10 port 12 C0 0 0 0 0 Enters Monitor Mode Cwww lantronix com 80 Tries to connect to the Lantronix web server if the lt hostname domain gt www lantronix com is configured in the DNS server database DeviceLinx XPort XChip SoC User Guide 52 7 Setup Mode Channel Configuration Autostart Automatic If you enable Autostart the unit automatically connects to the Connection remote IP address and remote port specified when the firmware starts Hostlist If you enable this option the device server scrolls through the hostlist until it connects to a device listed in the hostlist table Once it connects the unit stops trying to connect to any others If this connection fails the unit continues to scroll through the table until it is able to connect to another IP in the hostlist Hostlist supports a minimum of 1 and a maximum of 1
33. F THIS FLA EVEN IN THE EVENT OF THE FAULT TORT INCLUDING NEGLIGENCE STRICT LIABILITY BREACH OF CONTRACT OR BREACH OF WARRANTY OF LANTRONIX OR ANY SUPPLIER AND 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 APPLICABLE LAW If this Software is acquired in the United States this FLA is governed by the laws of the State of California without reference to any conflict of laws principles All disputes arising out of this FLA in the United States shall be subject to the exclusive jurisdiction of the state and federal courts located in Orange County California and the parties agree to submit to the personal and exclusive jurisdiction and venue of these courts If this Software is acquired in Canada unless expressly prohibited by local law this FLA is governed by the laws in force in the Province of Ontario Canada and in respect of any dispute which may arise hereunder Recipient consents to the jurisdiction of the federal and provincial courts sitting in Toronto Ontario If this Software was otherwise acquired outside the United States then local law may apply DeviceLinx XPort XChip SoC User Guide 5 ENTIRE AGREEMENT This FLA including any addendum or amendment to this FLA which i
34. Guide 10 Contents Recovering the Firmware Using the Serial Port and Devicelnstaller 81 11 Monitor Mode 82 Entering Monitor Mode Using the Serial Port 82 Entering Monitor Mode Using the Network Pont 82 Monitor Mode Commands 82 12 Troubleshooting 85 Problems and Error Messages 85 Technical Support E 88 A Binary to Hexadecimal Conversions 89 Converting Binary to Hexadechmal 89 Conversion Table 89 Scientific Calculator 89 List of Tables Table 6 1 BootP DHCP AutolP options nens 44 Table 6 2 Standard IP Network Netmasks seseesseesseesseesseessennrnsnrnsnnnrnnnrnnnennnsennsnn nens 45 Table 7 1 Interface Mode Options ccccccececeeeeeeeeeeeeeceeeeecaeeesaaeseeeeeeeeeeesaeeeseaeeeeeeeeaas 48 Table 7 2 Common Interface Mode Settings ccceccceceeeeeeeeeeeeeeeeeeeeeeeaeeeeaeeeeeeeeeeeeees 48 Table 7 3 Interface Mode Options rarnrnnnnvnnnnrrnnnnrnnnnnvnnenrvnnnr renn nnnnnnnnnrrnrensnnnnnnnnnnennenennn 48 Table 7 4 Flow Control Options asreronnvnnnrrrnnnrnnannvnnonnvnnnrrennnrnnnnnnnnenrenrnrresnnrnesnnnenenneeenn 49 Table 7 5 Reserved Port Numbers ennnnnnvnnonnnnvnnnnnnnvnnevnnnvnnennnnvnnnnnnsnnnennnseneennnnnnsennnnene 49 Table 7 6 Connect Mode Options marrrnrnvrnrnrrvnnnrnnnnnnnnenvvnnnrnnnnnnnnnnnnnrrnrennnrnennnnnnennenennne 50 Table 7 7 Manual Connection Address Example ronrrnnnrrnnnnrnnnnnvnnonrnnnnrrennnrnnnnnnnnrnnenenn 52 Table 7 8 Modem Mode Mess
35. LANTRONIX Xrort DeviceLinx XChip SoC DeviceLinx XPort XChip SoC User Guide Part Number 900 270 Revision L June 2010 Copyright and Trademark 2009 2010 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 DeviceLinx and XPort are registered trademarks of Lantronix Ethernet is a trademark of XEROX Corporation UNIX is a registered trademark of The Open Group Windows 95 Windows 98 Windows 2000 Windows NT and Windows XP are trademarks of Microsoft Corp Netscape is a trademark of Netscape Communications Corporation Warranty For details on the Lantronix warranty replacement policy please go to our Web site at www lantronix com support warranty Contacts Lantronix Corporate Headquarters 167 Technology Irvine CA 92618 USA Toll Free 800 526 8766 Phone 949 453 3995 Fax 949 450 7249 Technical Support Online www lantronix com support Sales Offices For a current list of our domestic and international sales offices go to the Lantronix web site at www lantronix com about contact DeviceLinx XPort XChip SoC User Guide 2 Disclaimer 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 corre
36. Port Extended Firmware Version Non configurable field Displays the full version nomenclature of the firmware Online Status Non configurable field Displays the XPort s status as online offline unreachable the XPort is on a different subnet or busy the XPort is currently performing a task IP Address Non configurable field Displays the XPort s current IP address To change the IP address see Assigning an IP Address on page 18 IP Address was Obtained Non configurable field Indicates whether the current IP address on the XPort was set manually or assigned by DHCP Subnet Mask Non configurable field Displays the XPort s current subnet mask To change the subnet mask see Assigning an IP Address on page 18 Gateway Non configurable field Displays the XPort s current gateway To change the gateway see Assigning an IP Address on page 18 Number of COB Non configurable field Displays the number of COB partitions partitions supported supported Number of Ports Non configurable field Displays the number of ports on the XPort DeviceLinx XPort XChip SoC User Guide 20 3 Using Devicelnstaller TCP Keepalive Non configurable field Displays 1 65s the XPort s TCP keepalive value The default setting is 45 Telnet Enabled Non configurable field Permits Telnet sessions Telnet Port Non configurable field Displays the XPort s po
37. Port 485 and later units only Disable Monitor Mode bootup No RS485 tx enable active low HTTP Port Number 80 1 65535 SMTP Port Number 25 1 65535 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 Defaults Disable SNMP No SNMP community name public Disable Telnet setup No Disable TFTP Firmware Update No Disable Port 77FEh No Disable Web Server No Disable Web Setup No Disable ECHO ports Yes Enable Encryption No Enable Enhanced Password No Disable Port 77FOh No DeviceLinx XPort XChip SoC User Guide 72 8 Setup Mode Advanced Settings Email Settings Priority L Min notification interval 1 second All other parameters 0 e g email notification and triggers are disabled DeviceLinx XPort XChip SoC User Guide 73 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 Devicelnstaller You can use these GPIO pins to control devices such as relays servers lights monitor switches sensors and even processes such as data transfer You can set
38. Response Codes 0 gt OK no error 1 gt No answer from remote device 2 gt Cannot reach remote device or no answer 8 gt Wrong parameter s 9 gt Invalid command DeviceLinx XPort XChip SoC User Guide 84 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 Make sure that your unit s IP address is unique When troubleshooting the following problems make sure that the XPort is powered up Confirm that you are using a good network connection Problems and Error Messages When you issue the ARP S command in Windows the ARP entry addition failed 5 message displays Your currently logged in user does not have the correct rights to use this command on this PC Have someone from your IT department log you in with sufficient rights When you attempt to assign an IP address to the unit by the ARP method the Press Enter to go into Setup Mode error described below message displays Now when you Telnet to the device server the connection fails When you Telnet to port 1 on the device
39. 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 The series of prompts at which you enter configuration settings is called Setup Mode Note Detailed information about other setup methods is available from your Lantronix Sales Associate The unit s configuration is stored in nonvolatile memory and is retained without power You can change the configuration at any time The unit performs a reset after the configuration has been changed and stored This chapter tells you how to access Setup Mode and the general procedure for using it To complete the configuration continue with 6 Setup Mode Server Configuration 7 Setup Mode Channel Configuration and 8 Setup Mode Advanced Settings Note The menus in the configuration chapters show a typical device Your device may have different configuration options Accessing Setup Mode Telnet Connection To configure the unit over the network establish a Telnet connection to port 9999 Note You can also use Devicelnstaller to access Telnet Select the device from the main window list and click the Telnet Configuration tab Skip steps 1 and 2 De
40. TP to perform network firmware upgrades With this option you can download firmware upgrades over the serial port using Devicelnstaller s Recover Firmware procedure See 10 Firmware Upgrades Disable TFTP Firmware Update N Disable Port 77FE Hex 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 Port 77FE is a setting that allows Devicelnstaller Web Manager and custom programs to configure the unit remotely You may wish to disable this capability for security purposes Disable Port 77FEh N _ The default setting is the N No option which enables remote configuration You can configure the unit by using Devicelnstaller web pages Telnet or serial configuration The Y Yes option disables remote configuration and web sites Note The Y Yes option disables many of the GUI tools for configuring the unit including the embedded Web Manager tool Disable Web Server This setting defaults to the N option The Y Yes option disables the web server f Disable Web Server N _ Disable Web Setup The Y Yes option disables configuration using the Web Manager This setting defaults to the N option f Disable Web Setup N _ Disable ECHO Ports This setting controls whether port 7 echoes characters it receives Disable ECHO ports Y _
41. Table 7 11 Flush Mode Options Input Buffer Serial to Network Clear with a connection initiated from the device to the network 1 Clear with a connection initiated from the network to the device 1 DeviceLinx XPort XChip SoC User Guide 58 7 Setup Mode Channel Configuration 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 1 Clear with a connection initiated from the network to the device 1 Clear when the network connection to or from the device is disconnected 1 Alternate Packing Algorithm Pack Control Enable 1 Pack Control The 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 The alternate packing algorithm minimizes the packet count on the network and is especially useful in applications in a routed Wide Area Network WAN Adjusting parameters in this mode can economize the network data stream Pack control settings are enabled in Flush Mode Set this value to 00 if you do not need specific functions Note All bit positions in the table that are blank represent don t care bits for that particular option w
42. ager password prevents unauthorized access to the setup menu through a Telnet connection to port 9999 or through web pages The password must have 4 characters Change Telnet Web Manager password N _ DeviceLinx XPort XChip SoC User Guide 45 6 Setup Mode Server Configuration An enhanced password setting for Telnet access only of 16 characters is available under Security Settings Option 6 on page 67 Note You do not need a password to access the Setup Mode window by a serial connection DHCP Name If a DHCP server has automatically assigned the IP address and network settings you can discover the unit by using the Devicelnstaller network search feature There are three methods for assigning DHCP names to the unit 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 0 then the last option in Server configuration is Change DHCP device name This option allows you to change the DHCP name to an alphanumeric name LTX in our example Change DHCP device name not set N Y Enter new DHCP device name LTX Numeric DHCP Name You can change t
43. ages rrrnnnnnnvvnnnnnnrnnnnnnnrnnnnnnnvnnnnennrnnsrennrnnsernnrnesrennrnnennnnnne 55 Table 7 9 Modem Mode Commands rrnnnnvnnnnrrnnnnvnnnnnvnnenrnnnnrrnnnnvnnnnnnnrnnrennnrnesnnrnnennenennne 56 Table 7 10 Disconnect Mode Options nant 58 Table 7 11 Flush Mode Options c ccceccceceeeeeeeeeeeeeeceeeeeeeaeeeeaaeseeeeeeeeeescaeeeeaeeeeeeeeaas 58 Table 7 12 Pack Control Options cccecccececeeeeeeeeeeeeeseeeeecaeeesaaeseeeeeseeesseaeeetaaeeeeeeeeaas 59 Table 10 1 Firmware Files nannan tann nn nnen 79 Table 11 1 Monitor Mode Commande 83 Table 11 2 Command Response Codes 84 DeviceLinx XPort XChip SoC User Guide 11 Contents List of Figures Figure 4 1 Web Manager Login Window rrrnnnnnnrrnnnnnnrrnnnannrrnnrrnnrrnnrennrrenrennrrnnsennrannrenn 23 Figure 4 2 Lantronix Web Manager A 23 Figure 4 3 Network Settings c cccecccceeseeeeeeeceeeeeeaeeeeeeeeeeeeecaeeeeaaeseeeeeseeeeesaeeeeeeseeeees 24 Figure 4 4 Server Settings mnonnnnnnrrnnnnvnnnnnvnnnr vnr nrnnnnnnnnnn vener nnnnnnnnnnnennnnrennrnnsnnnenenneeenn 26 Figure 4 5 Hostlist Gettings nenn nenn 28 Figure 4 6 Channel Serial Settings cccccccceseeeeseeceeeeeceeeeeeaeeeeaeeseeeeeseaeeesaeeeeeeeeeeees 29 Figure 4 7 TCP Connection Settings rreronnrnnnrvvnnnrnnnnnrnnnnvnnrnr rennene venner rennnrnnennnnnenneeenn 32 Figure 4 8 UDP Connection Geittngs nenn nena 35 Figure 4 9 Email Gettings A 36 Figure 4 10 Email Trigger Se
44. at Caps Lock is not on DeviceLinx XPort XChip SoC User Guide 86 12 Troubleshooting You can ping the device There may be an IP Turn the device server off server but not Telnet to the address conflict on your and then issue the following device server on port 9999 network commands at the DOS prompt of your computer You are not Telneting to port 9999 ARP D X X X X X X X X is the IP of the device server The Telnet configuration port PING X X X X X X X X is 9999 is disabled the IP of the device server within the device server g If you get a response then security settings there is a duplicate IP address on the network If you do not get a response use the serial port to verify that Telnet is not disabled The device server appears to If you are sure that the You can check to see be set up correctly but you serial port setting is whether there is a socket are not communicating with correct then you may connection to or from the your device attached to the not be connecting to the device server by checking device server across the correct socket of the the state of CP1 if it has network device server been configured for LED1 functionality Another possibility is that the device server is If the state of CP1 is blinking not set up correctly to consistently or is completely make a good socket off then there is a good connection to the socket connection network If the state of CP
45. ating phone charges for each connection Modem Mode allows you to replace modems with XPorts and to use an Ethernet connection instead of a phone call By not having to change communications applications you avoid potentially expensive phone calls To select Modem Mode set the Connect Mode to C6 no echo D6 echo with full verbose D7 echo with numeric response CF modem responses only numeric response or CE modem responses only full verbose Note If the unit is in Modem Mode and the serial port is idle the unit can still accept network TCP connections to the serial port if Connect Mode is set to C6 no echo D6 echo with full verbose D7 echo with numeric response CF modem responses only numeric response or CE modem responses only full verbose Without Echo In Modem Mode echo refers to the echo of all of the characters entered in command mode it does not mean to echo data that is transferred Quiet Mode without echo refers to the modem not sending an answer to the commands received or displaying what was typed Data Echo amp Full Verbose The unit echoes modem commands and responds Modem Response to acommand 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 responds to a command with a message string shown in the table belo
46. ay blank all zeros Click Next 6 Click the Assign button and wait several seconds until a confirmation message displays Click Finish 7 Select the device from the main window list and select Ping from the Tools menu The Ping Device dialog box shows the IP address of the selected unit 8 From the Tools menu click the Ping button The results display in the Status window Click the Clear Status button to clear the window so you can ping the device again Note If you do not receive Reply messages make sure the unit is properly attached to the network and that the IP address assigned is valid for the particular network segment you are working with If you are not sure check with your systems administrator 9 Click the Close button to close the dialog box and return to the main window Accessing the XPort Using Devicelnstaller 1 Click Start gt Programs gt Lantronix gt Devicelnstaller gt Devicelnstaller 2 Click the XPort folder The list of available Lantronix XPort devices displays 3 Expand the list of XPorts by clicking the symbol next to the XPort icon Select the XPort unit by clicking on its IP address to view its configuration Viewing the Current Configuration Devicelnstaller provides a view of the unit s configuration To view the unit s current settings 1 Follow the instructions above to locate the XPort 2 Inthe right pane click the Device Details tab The current XPort configuration displays
47. ceLinx XPort XChip SoC User Guide 21 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 In this chapter we describe how to configure the XPort using Web Manager Lantronix s browser based configuration tool For information on using Setup Mode our command line configuration interface see 5 Configuration via Telnet or Serial Port Setup Mode Note The examples in this section show a typical device Your device may have different configuration options Accessing Web Manager Using Devicelnstaller Note For more information on Devicelnstaller see 3 Using Devicelnstaller 1 Run Devicelnstaller and search for the list of available Lantronix device servers Click on the XPort folder The list of available XPorts displays Expand the list of XPorts by clicking the symbol next to the XPort icon 2 3 4 Select the XPort unit by clicking its hardware address 5 Inthe right pane click the Web Configuration tab 6 To view the XPort s Web Manager in the current Devicelnstaller window clic
48. 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 RECIPIENT AGREES TO BE BOUND BY THE TERMS OF THIS FLA BY OPENING THIS SEALED MEDIA PACKAGE INSTALLING DOWN LOADING OR OTHERWISE USING THE SOFTWARE OR THE PRODUCT IN WHICH THE SOFTWARE MAY BE EMBEDDED IF YOU DO NOT AGREE DO NOT OPEN INSTALL OR USE THE SOFTWARE OR PRODUCT IN WHICH IT MAY BE EMBEDDED YOU MAY RETURN IT TO YOUR PLACE OF PURCHASE FOR A FULL REFUND GRANT OF LICENSE Subject to the following terms and conditions Lantronix Inc Lantronix grants to the Recipient a non exclusive non transferable fully paid and royalty free license to use the Software solely in the form of the object code or binary firmware image provided This license is not a sale Recipient may not rent lease or lend the Software Lantronix may cancel this FLA if Recipient does not abide by its terms and conditions This License applies to updates or supplements to the original Software unless we provide other terms along with the update or supplement This software is may only be used on Lantronix XChip LANTRONIX Part Numbers XCP1001000 01 XCP100100S 01 and XCP100100K 01 products RESERVATION OF RIGHTS Lantronix reserves all rights not expressly granted to Recipient in this FLA Title and copyrights to
49. ct the interference Note Changes or modifications to this device not explicitly approved by Lantronix will void the user s authority to operate this device Revision History 1 07 A Initial release 5 07 B Added information about product support for RS485 8 07 C Added XChip Direct information 11 03 C Revised for version 1 6 of the firmware 4 04 D Information to support XPort 03 8 04 E Added XPort 485 functionality Updated common settings for all models 10 04 E Updates 3 05 G Added reference documentation 1 06 H 6 3 Revised for version 6 1 of the firmware 8 07 6 5 Added XChip information 8 08 J 6 6 Revised for version 6 6 of the firmware 9 09 K Updated for XPort 04 removed XPort 01 references 6 10 L 6 7 Minor technical corrections Lantronix address updated DeviceLinx and XPort trademark information updated For the latest revision of this product document please check our online documentation at www lantronix com support documentation If you use a previous version of the firmware go to the Lantronix FTP site at ftp ftp lantronix com pub to find the earlier documentation DeviceLinx XPort XChip SoC User Guide 3 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
50. d later models also support high performance baud rates of 460800 and 921600 bits per second See CPU Performance on page 66 Baudrate 9600 _ DeviceLinx XPort XChip SoC User Guide 47 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 _ The following table displays available I F Mode options Note All bit positions in the table that are blank represent don t care bits for that particular option which can be set to either a 0 or 1 value Table 7 1 Interface Mode Options RS 232C 1 0 0 7 Bit 110 8 Bit 1l1 No Parity 0 0 Even Parity 1 1 Odd Parity 0 1 1 stop bit O J1 2 stop bits 1 1 1 2 stop bits are implemented by the software This might influence performance The following table demonstrates how to build some common Interface Mode settings Table 7 2 Common Interface Mode Settings RS 232C 8 bit No Parity 1 stop bit 0100 1100 4C RS 232C 7 bit Even Parity 1 stop bit 0111 1000 78 I F Mode XPort 485 only Additional settings for RS 422 4 wire and RS 485 2 wire are available on the XPort 485 Note All bit positions in the table that are blank represent don t care bits for that particular option which can be set to either a 0 or 1 value Table 7 3 Interface Mode Options RS 422 485 Di RS 485 2
51. ddress x x x x and the remote port EE number defined within the unit ATH Hangs up the connection Entered as ATH Enables or disables connections from the network going to the serial port n 0 disables the ability to make a connection from the network to the serial port ATSO n n 1 9 enables the ability to make a connection from the network to the serial port n gt 1 9 is invalid Enables or disables character echo and responses n 0 disables character echo and responses ATEn n 1 enables character echo and responses Enables numeric response or full verbose n 0 enables numeric response ATVn n 1 enables full verbose Note The unit recognizes these AT commands as single commands such as ATEO or ATV1 it does not recognize compound commands such as ATEOV DeviceLinx XPort XChip SoC User Guide 56 7 Setup Mode Channel Configuration Send the Escape Sequence in Modem Mode Send in Modem Mode Y _ Disable or enable the XPort s ability to send the escape sequence The default is Y Yes send the escape sequence Show IP addr after RING Show IP addr after RING lt v gt 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 wi
52. ddress on DHCP enabled networks as it is DHCP enabled by default Port Numbers Every TCP connection and every UDP datagram is defined by a destination IP address and a port number For example a Telnet application commonly uses port number 23 A port number is similar to an extension on a phone system The unit s serial channel port can be associated with a specific TCP UDP port number Port number 9999 is reserved for access to the unit s Setup configuration Mode window Ports 0 1024 are reserved as well For more information on reserved port numbers see to Table 7 5 Reserved Port Numbers on page 49 DeviceLinx XPort XChip SoC User Guide 17 3 Using Devicelnstaller This chapter covers the steps for getting the XPort device server online and viewing its current configuration Note Devicelnstaller 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 For instructions on using Devicelnstaller to configure the IP address and related settings or for more advanced features see the Devicelnstaller Online Help Installing Devicelnstaller To install Devicelnstaller 1 Download the latest version of Devicelnstaller from http www lantronix com downloads 2 Run the executable to start the installation process 3 Respond to the installation wizard prompts If p
53. 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 CPU Performance Mode Select the XPort s performance mode Higher performance settings require more energy Regular is 48 Mhz High is 88 Mhz The default is Regular HTTP Server Port This option allows the configuration of the web server port number The valid range is 1 65535 The default port is 80 Config Server Port Not applicable for this product 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 3 When you are finished click the OK button 4 Onthe main menu click Apply Settings Host List Configuration The XPort 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 The host list supports a minimum of 1 and a maximum of 12 entries Each entry contains an IP address and a port number DeviceL
54. e four bytes long and represent GPIOs 0 31 with GPIOO in bit 0 of the first byte Little Endian Parameter bits for configurable pins not configured as GPIOs are undefined for Get commands and ignored on Set commands Every command consists of nine bytes one command type of one byte and two parameters of four bytes each Command Parameter 1 Parameter 2 0 1 2 3 4 5 6 7 8 On some commands one or all parameters are ignored For UDP command type and parameters need to be in the same datagram Responses to valid commands are always five bytes long consisting of the returned command byte and as parameters in the current or updated values In case of an invalid command only one byte with value OFFh is returned Command Parameter 1 0 1 2 3 4 When sending a command TCP and UDP wait for the response before sending the next command Commands Byte 0 Command Types 10h Get functions 1th Get directions input or output 12h Get active levels high active or low active 13h Get current states active or not active 19h Set directions 1Ah Set active levels 1Bh Set current states There is no Set functions command Since the pin s function depends on the hardware in which the XPort is embedded that configuration is only allowed using 77FE Settings changed by any of the Set commands are not stored and are lost when the unit is po
55. e packet count on the network and is especially useful in applications in a routed Wide Area Network WAN Adjusting parameters in this mode can economize the network data stream Disabled by default Idle Gap Time Select the maximum time for inactivity The default time is 12 milliseconds Match 2 Byte Sequence Use to indicate the end of a series of data to be sent as one group The sequence must occur sequentially to indicate end of the data collection to the XPort The default is No Match Bytes Use to indicate the end of a series of data to be sent as one group Set this value to 00 if specific functions are not needed Send Frame Immediate After the detection of the byte sequence indicates whether to send the data frame or the entire buffer Select Yes to send only the data frame The default setting is No Send Trailing Bytes Select the number of bytes to send after the end of sequence characters The default is None Flush Input Buffer Serial to Network With Active Connect Select Yes to clear the input buffer with a connection that is initiated from the device to the network The default is No With Passive Connect Select Yes to clear the input buffer with a connection initiated from the network to the device The default is No At Time of Disconnect Select Yes to clear the input buffer when the network connection to or from the device is disconnected The default i
56. efaults Mod E 8 odem Escape Sequence x Pass Through yYes O No Show IP Address After RING ves O No Endpoint Configuration Local Port 10001 Remote Port 0 o Auto increment for active connect Remote Host 0 0 0 0 Terminal Name Common Options Telnet Com Port Cntr Disable v Connect Response Use er Hostlist O Yes ONo LED Blink Disconnect Mode On Mdm Ctrl In Drop Oves Ono Check EOT Ctrl D ves No Hard Disconnect O ves ONo Inactivity Timeout 0 0 mins secs DeviceLinx XPort XChip SoC User Guide 32 4 Configuration Using Web Manager 2 Inthe 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 Password If Password Required was set to Yes enter the password for passive connections Connect Mode Active Connection Active Connect Select None to disable Active Connect Otherwise indicate the connection type from the drop down list With Any Character Attempts to connect when any character is received from the serial port
57. enu 6 From the Change Setup menu select option 9 to save and exit Encryption only applies to the port selected for data tunneling default 10001 regardless of whether you are using TCP or UDP Generally one of these situations applies Encrypted XPort to XPort communication Be sure to configure both XPort devices with the same encryption key Third party application to XPort encrypted communication XPort uses standard AES encryption protocols To communicate successfully products and applications on the peer side must use the same protocols and the same encryption key as the XPort DeviceLinx XPort XChip SoC User Guide 70 8 Setup Mode Advanced Settings Lantronix Secure Com Port Redirector provides an encrypted connection from Windows based applications to the XPort Information about SCPR is at www lantronix com device networking utilities tools scpr A 30 day trial version of SCPR is available Note Developers can license the Lantronix Encryption Library Suite See www lantronix 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 The Y Yes option allows you to set an extended security password of 16 characters for protecting Telnet and Web Page access Enable Enhanced Password Y _ Disable Port 77F0 Hex Port 77F0 is a
58. he DHCP name by specifying the last octet of the IP address 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 DeviceLinx XPort XChip SoC User Guide 46 7 Setup Mode Channel Configuration This chapter explains how to configure the serial port 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 Serial Port Parameters Baudrate lt 96 gt I F Mode 4C gt Flow CBO Port No lt 1 1 gt ConnectMode lt C gt Send in Modem Mode lt Y gt Show IP addr after RING CY gt Auto increment source port lt N Remote IP Address 6 gt gt lt 900 gt lt 688 Remote Port DisConnMode lt gt FlushMode lt gt DisConnTime lt gt SendChar 1 gt SendChar 2 lt gt Baudrate 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 bits per second XPort 03 an
59. hich can be set to either a 0 or 1 value Table 7 12 Pack Control Options Packing Interval Interval 12ms 0 0 Interval 52ms 0 1 Interval 250ms 1 0 Interval 5sec 1 4 Trailing Characters None 0 0 One 0 1 Two 1 0 Send Characters 2 Byte Send Character Sequence 1 Send Immediately After Send chars 1 DeviceLinx XPort XChip SoC User Guide 59 7 Setup Mode Channel Configuration Packing Interval Packing Interval defines how long the unit should wait before sending accumulated characters This wait period is between successive network segments containing data For alternate packing the default interval is 12 ms Trailing Characters In some applications CRC Checksum or other trailing characters follow the end of sequence 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 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 unit sends immediately after recognizing the transmit condition sendchar or timeout Noite A transmission might occur if status information needs
60. ide 67 8 Setup Mode Advanced Settings Figure 8 3 Security Settings Disable SNMP lt N gt SNMP Community Name Cpublic gt Disable Telnet Setup ND Disable TFTP Firmware Update lt N Disable Port 77FEh N gt Disable Web Server lt N Disable Web Setup CN Disable ECHO ports gt Enable Encryption lt N gt Enable Enhanced Password lt N gt Disable Port 77F h lt N gt 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 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 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 _ DeviceLinx XPort XChip SoC User Guide 68 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 TF
61. iguration information memory page on the device GM Get MAC address Shows the unit s 6 byte MAC address ss Set Security record Sets the Security record without the encryption key and length parameters The entire record must still be written but the encryption specific bytes do not need to be provided they can be null since they are not overwritten SA Scan Initiates a wireless scan if the wireless interface is enabled Reports any stations found including BSSID SSID and RSSI If SA is followed by a string the string is used to filter SSIDs before reporting If the BSS does not broadcast its SSID only the BSSID and RSSI are returned NS Network Status Reports the network interfaces statuses Includes potentially negotiated parameters like speed duplex for Ethernet or BSSID encryption authentication for wireless interfaces co Set IP address Example hostbits gateway c9192 168 0 10 8 192 168 0 1 10001 and DNS server IP 192 168 1 10 with 192 168 0 10 IP address of the XPort 8 number of hostbits DeviceLinx XPort XChip SoC User Guide 83 11 Monitor Mode 192 168 0 1 gateway IP address 10001 port number of the XPort 192 168 1 10 IP address of the DNS Server The XPort stores the setup and performs a reset It sends an X before the reset if the command was OK Note Entering any of the commands listed above generates one of the following command response codes Table 11 2 Command
62. inx XPort XChip SoC User Guide 27 4 Configuration Using Web Manager Note The host list is disabled for Manual and Modem Mode The unit does not accept a data connection from a remote device when the hostlist option is enabled To configure the XPort s host list 1 Onthe main menu click Hostlist Figure 4 5 Hostlist Settings LANTRON IX i Firmware Version V6 6 0 1RC2 MAC Address 00 20 4A A5 C8 FC ker Hostlist Settings Network Server Serial Tunnel Retry Settings Retry Counter 3 Retry Timeout 250 Host Information No Host Address Host Address 0 0 0 0 0 0 0 0 Email Trigger 1 0 0 0 0 4 0 0 0 0 Configurable Pins 0 0 0 0 0 0 0 0 Apply Settings Apply Defaults 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 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 Reiry Timeout Enter the duration in milliseconds 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 Onthe main menu click Apply Settings Channel 1 Configuration The Channel 1 c
63. is to use a scientific calculator such as the one available on Windows operating systems For example 1 On the Windows Start menu click Programs gt Accessories gt Calculator 2 Onthe View menu select Scientific The scientific calculator displays 3 Select Bin Binary and type the number to convert DeviceLinx XPort XChip SoC User Guide 89 A Binary to Hexadecimal Conversions 4 Click Hex The hexadecimal value displays DeviceLinx XPort XChip SoC User Guide 90
64. k the Go button To open the Web Manager in a web browser click the External Browser button 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 A dialog box appears to prompt for a User name and Password DeviceLinx XPort XChip SoC User Guide 22 4 Configuration Using Web Manager Figure 4 1 Web Manager Login Window A User name Password Connect to 172 18 11 190 Welcome to 172 18 11 190 Mi remember my password 7 Perform one of the following If no Telnet password has been defined default leave both fields blank and click OK Ifa Telnet password has been defined leave the username blank type in the password and then click OK The Web Manager displays Network Server Serial Tunnel Hostlist Apply Settings Apply Defaults LANTRONIX Figure 4 2 Lantronix Web Manager Firmware Version V6 6 0 1RC2 MAC Address 00 20 4A A5 C8 FC Home Channel 1 TM E X PO Device Server Configuration Manager Version 1 7 0 1RC1 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
65. ll 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 Response 1 parameter Bytes 1 4 Updated active levels Command 1Bh Set States Send 2 parameters Bytes 1 4 Mask Bit X 1 means the state for GPIO X will be updated with the value in the second parameter 0 means the state for that GPIO will not change Bytes 5 8 New States Bit X 1 means GPIO X will become active 0 means it will become inactive Response 1 parameter Bytes 1 4 Updated states DeviceLinx XPort XChip SoC User Guide 77 9 GPIO Interface Examples Example 1 PC sends command 10h to find out which configurable pins are available as GPIO PC gt XPort 10h 00h 00h 00h 00h 00h 00h 00h 00h XPort gt PC 10h 03h 00h 00h 00h Command details 10h command 10h 00h 00h 00h 00h ignored 00h 00h 00h 00h ignored Response details 10h response to command 10h 03h 00h 00h 00h bits 0 and 1 are 1 gt CP1 and CP2 are configured as GPIOs bit 2 is 0 gt CP3 is configured as either serial control or diagnostics The other bits are ignored because there are only three configurable pins on the XPort Example 2 PC sends command 1Bh to change the current states of GPIO 0 and 1 PC gt XPort 1Bh 01h 00h 00h 00h 00h 00h 00h 00h XPort gt PC 1Bh
66. name Unit Name Enter the user name used by the XPort to send email messages Spaces are not permitted Recipients Recipient 1 Email Address Enter the email address designated to receive email notifications Recipient 2 Email Address Enter an additional email address designated to receive email notifications 3 When you are finished click the OK button 4 Onthe main menu click Apply Settings Trigger Configuration A trigger event occurs when the unit receives the specified trigger input resulting from a specified combination of conditions on the configurable pins 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 Onthe 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 Zi Email Trigger Settings Network Server Trigger 1 Conditions Configurable Pins Serial Trigger Trigger Input 1 None vi C Enable Serial Trigger Input Trigger Input 2 None ei Channel Trigger Input 3 None vi Data Size o Byte Match Data ox wi in He Apply Settings Message Properties Apply Factory Defaults Message Priority Low e Min Notification Interval 1 sees Re no
67. nx XPort XChip SoC User Guide 66 8 Setup Mode Advanced Settings configure one of the configurable pins to RS485 TXEN To change the configurable pins settings use Devicelnstaller 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 Enable alternate MAC N _ Ethernet Connection Type The XPort allows for the Ethernet speed and duplex to be manually configured Enter 0 for auto negotiation default To select the speed and duplex enter one of the following 2 10Mbit half duplex 3 1 OMbit full duplex A 100Mbit half duplex or 5 100Mbit full duplex Ethernet connection type 0 _ Security Settings Option 6 Note You can change security settings by means of Telnet or serial connections only not on the Web Manager We recommend that you set security over the dedicated network or over the serial setup to prevent eavesdropping CAUTION Disabling both Telnet Setup and Port 77FE will prevent users from accessing the setup menu from the network Disabling Port 77FE also disables the Web from configuring the device Select 7 to configure security settings DeviceLinx XPort XChip SoC User Gu
68. on 2 62 Mail Server 63 Unit Name 63 Domain Name 63 Recipient 1 63 Recipient 2 63 Trigger 1 63 Trigger 2 64 Trigger 3 64 Expert Settings Option Bi 64 TCP Keepalive time in seconds 65 ARP Cache timeout in seconds 65 CPU Performance 66 DeviceLinx XPort XChip SoC User Guide 9 Contents Disable Monitor Mode at bootup 66 HTTP Port Number 66 SMTP Port Number 66 RS 485 TX Enable Active Level 66 MTU Size 67 Enable alternate MAC 67 Ethernet Connection Type 67 Security Settings Option Gi 67 Disable SNMP 68 SNMP Community Name 68 Disable Telnet Setup 68 Disable TFTP Firmware Upgrade 69 Disable Port 77FE Hex 69 Disable Web Server 69 Disable Web Setup 69 Disable ECHO Ports 69 Enable Encryption 70 Enable Enhanced Password 71 Disable Port 77F0 Hex 71 Default Settings Option 21 71 Channel 1 Configuration Defaults 71 Expert Settings Defaults 72 Security Settings Defaults 72 Email Settings 73 9 GPIO Interface 74 Configurable Pins rannrnnonnvnnnrrnnnnvnnnnnvnnonvonnnrrnannrnnnnnnnnnnrennnrnesnnnnnnnnenennresnnrnsennnenenveeenn 74 Features 74 Control Protocol edu Eege dE eege ines heterosis ieee emcee 75 Guidelines 75 Commands 75 Ee 10 0 EE OR EP NO 78 10 Firmware Upgrades 79 Obtaming attert 79 Reloading le 79 Using TFTP Graphical User Interface 79 Using TFTP Command Line Interface 80 DeviceLinx XPort XChip SoC User
69. onfiguration defines how the serial port responds to network and serial communication DeviceLinx XPort XChip SoC User Guide 28 4 Configuration Using Web Manager Serial Settings To configure the channel s serial settings 1 Onthe main menu click Serial Settings under Channel 1 to display the Serial Settings window Figure 4 6 Channel Serial Settings LANTRONIX Firmware Version V6 6 0 1RC2 MAC Address 00 20 4A A5 C8 FC Serial Settings Network Server Channel 1 Serial Tunnel Disable Serial Port Hostlist Channel 1 Port Settings S Protocol RS232 i Flow Control None Connection j Baud Rate 9600 v Data Bits 8 v Parity None Stop Bits 1 3 Pack Control Configurable Pins C Enable Packing Apply Settings Idle Gap Time 12 msec Apply Defaults Match 2 Byte Sequence Yes No Send Frame Immediate wes No r Ox 00 ox 00 A Match Bytes ae Send Trailing Bytes None O One O Two ex Flush Mode Flush Input Buffer With Active Connect Ces No With Passive Connect Oves No Flush Output Buffer With Active Connect Yes No With Passive Connect Ces No At Time of Disconnect O Yes No At Time of Disconnect Oves No 2 Inthe available fields enter the following information Channel 1 Disable Serial Port When selected disables communication through the serial
70. ontact Lantronix Technical Support Provides instructions for converting binary numbers to hexadecimals Visit the Lantronix Web site at www lantronix com support documentation for the latest documentation and the following additional documentation XPort Quick Start XPort Integration Guide XChip Reference Platform Integration Guide Com Port Redirector User Guide Devicelnstaller Online Help Provides the steps for getting the XPort evaluation board up and running Provides information about the XPort hardware testing the XPort using the evaluation board and integrating the XPort into your product Provides information about XChip hardware technical specifications and integration Provides information on using the Windows based utility to create a virtual com port Provides information on using Devicelnstaller to configure IP addresses and locate Lantronix devices on the network DeviceLinx XPort XChip SoC User Guide 14 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 Has three
71. ower reset Using TFTP Command Line Interface To download new firmware from a computer 1 Enter the following from a TFTP command line interface tftp i lt ip address gt put lt local filename gt lt destination file name gt The following examples demonstrate the TFTP command sequence to download the rom file and the cob file tftp i 192 168 1 111 put XPT 6100 rom X5 tftp i 192 168 1 111 put XPT webm 1300 cob WEB1 DeviceLinx XPort XChip SoC User Guide 80 10 Firmware Upgrades Recovering the Firmware Using the Serial Port and Devicelnstaller If for some reason the firmware is damaged you can recover the firmware file by using Devicelnstaller to download the ROM file over the serial port To recover firmware 1 Start Devicelnstaller 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 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 device is shown XPort 03 04 or XP485 5 For Firmware File click the Browse button and go to the location where the firmware file resides Note Make sure the XPort on which you are recovering firmware is connected to this selected port on your PC 6 Click OK to download the file
72. parameters on the Server Settings page Figure 4 4 Server Settings LANTRON IX i Firmware Version V6 6 0 1RC2 MAC Address 00 20 4A A5 C8 FC ker Server Settings Network Serial Tunnel Server Configuration Hostlist Telnet Password Channel 1 Retype Password Advanced ARP Cache Timeout secs TCP Keepalive secs 45 600 Monitor Mode Bootup Enable Disable CPU Performance Mode O Low Regular O High HTTP Server Port 80 Apply Settings Apply Defaults Config Server Port 30710 MTU Size 1400 DeviceLinx XPort XChip SoC User Guide 26 4 Configuration Using Web Manager To configure the XPort s device server settings 1 Onthe main menu click Server 2 Configure or modify the following fields Server Configuration Telnet Password Enter the password required for Telnet access Retype Password Re enter the password required for Telnet access Advanced ARP Cache Timeout When the unit communicates with another device on the network it adds an entry into its ARP table ARP Cache timeout defines the number of seconds 1 600 before it refreshes this table TCP Keepalive TCP Keepalive time defines how many seconds the unit waits during an inactive connection before checking its status If the unit does not receive a response it drops that connection Enter a value between 0 and 60 seconds 0
73. programmable I O pins used to monitor or control attached devices Applications The XPort device server connects serial devices such as those listed below to Ethernet networks using the IP protocol family K A AAA ATM machines CNC controllers Data collection devices Environmental sensors Universal Power Supply UPS management units Telecommunications equipment Data display devices Security alarms and access control devices Handheld instruments Modems Time attendance clocks and terminals DeviceLinx XPort XChip SoC User Guide 15 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 AutolP DHCP HTTP and SNMP for network communications and management TCP UDP and Telnet for connections to the serial port TFTP for firmware and web page updates IP for addressing routing and data block handling over the network User Datagram Protocol UDP for typical datagram applications in which devices interact with other devices without maintaining a point to point connection SMTP for email transmission Configuration Methods For the unit to operate correctly on a network it must have a
74. rdware 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 Onthe main menu click Configurable Pins The Configurable Pins page opens DeviceLinx XPort XChip SoC User Guide 38 4 Configuration Using Web Manager Figure 4 11 Configurable Pins Settings LANTRONIX Network Server Serial Tunnel cp Function Firmware Version V6 6 0 1RC2 MAC Address 00 20 4A A5 C8 FC Configurable Pin Settings Direction Active Level Hostlist General Purpose WO Input O output Low O High Channel 1 General Purpose UO Input O output Low O High General Purpose I O Input O output Low O High Apply Settings Apply Defaults 2 Configure or modify the following fields for each pin Function From the drop down menu select the purpose of the specified pin See Configurable Pin Functions below for a description of each available function Direction Select whether the pin inputs or outputs Active Level Select the signal active level Low or High Configurable Pin Func tions General Purpose UO Monitors input using the 77F0 port or controls output by the 77F0 port Modem Control In DTR Allows for control of the connection and disconnection of channel 1 Modem Control Out DCD
75. rompted to select an installation type select Typical Assigning an IP Address The unit s IP address must be configured before it can work correctly on a network You have several options for assigning an IP to your unit We recommend that you manually assign the IP address over the network using Devicelnstaller Note To use a serial connection instead of an Ethernet connection to configure the device see 5 Configuration via Telnet or Serial Port Setup Mode on page 42 The unit s IP address is normally set to 0 0 0 0 at the factory The hardware address is on the product label The unit is DHCP enabled as the default To assign an IP address manually 1 Click Start gt Programs gt Lantronix gt Devicelnstaller gt Devicelnstaller If your PC has more than one network adapter a message displays Select an adapter and click OK Note If the unit already has an IP address e g DHCP has assigned an IP address click the Search icon and select the unit from the list of Lantronix device servers on the local network DeviceLinx XPort XChip SoC User Guide 18 3 Using Devicelnstaller e Click the Assign IP icon If prompted enter the hardware address on the product label and click Next Select Assign a specific IP address and click Next a e O 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 gatew
76. rop when Modem Control In transitions from an asserted state to not asserted state The default setting is No Hard Disconnect When set to Yes the TCP connection closes even if the remote site does not acknowledge the disconnect request Check EOT Ctrl D Select Yes to drop the connection when Ctrl D or Hex 04 is detected Both Telnet Com Port Cnirl and Check EOT Ctrl D must be enabled for Disconnect with EOT to function properly Ctrl D is only detected going from the serial port to the network The default setting is No 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 To disable the inactivity timeout enter 00 00 DeviceLinx XPort XChip SoC User Guide 34 4 Configuration Using Web Manager 3 When you are finished click the OK button 4 Onthe main menu click Apply Settings Connection Settings UDP To configure a channel s UDP settings 1 Onthe main menu click Connection The Connection Settings window for the selected channel displays 2 Inthe available fields enter or modify the following information Network Server Serial Tunnel Hostlist Channel 1 Connect Protocol Figure 4 8 UDP Connection Settings LANTRON X Firmware Version V6 6 0 1RC2
77. rt Number 25 1 65535 MTU Size 512 1400 0 resulting in an operational value of 1400 Enable alternate MAC No OEM use only Ethernet connection type 0 resulting in auto negotiation TCP Keepalive time in seconds This option allows you to change how many seconds the unit waits during a silent connection before attempting to see if the currently connected network device is still on the network If the unit gets no response it drops that connection TCP Keepalive time in s ls 65s Os disable 45 _ ARP Cache timeout in seconds Whenever the unit communicates with another device on the network it adds an entry into its ARP table The ARP Cache timeout option allows you to define how many seconds 1 600 the unit will wait before timing out this table ARP Cache timeout in s 1s 600s 600 DeviceLinx XPort XChip SoC User Guide 65 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 Notes Ifa 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
78. rt for Telnet sessions Web Enabled Non configurable field Permits configuration through Web Manager Web Port Non configurable field Displays the XPort s port for Web Manager configuration Maximum Baud Rate Supported Non configurable field Displays the XPort s maximum baud rate Note the XPort may not currently be running at this rate Firmware Upgradeable Non configurable field Displays True indicating the XPort s firmware is upgradeable as newer version become available 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 Supports 485 Non configurable field Displays True if the XPort supports the RS 485 protocol Supports 920K Baud Rate Non configurable field Displays True XPort supports baud rates up to 920 Kbps Supports HTTP Server Non configurable field Displays True Supports HTTP Setup Non configurable field Displays True Supports 230K Baud Rate Non configurable field Displays True Supports GPIO Non configurable field Displays True indicating the XPort supports communication via General Purpose Input Output GPIO Devi
79. s and Netmask fields display the current values IP Address lt 172 gt lt 619 gt lt 205 gt lt 152 gt Set Gateway IP Address lt Y gt Gateway IP addr lt 172 gt lt 9819 gt lt 8 gt lt 9 1 gt Netmask Number of Bits for Host Part default gt lt gt Set DNS Server IP addr lt N Change Telnet Web Manager password lt N IP Address If DHCP is not used to assign IP addresses enter the IP address manually The IP address must be set to a unique value in the network Enter each octet and press Enter between each section The current value displays in parentheses IP Address 0 0 0 0 _ If DHCP is used the third octet of the IP address sets the BootP DHCP AutolP options The following table shows the bits you can manually configure to force the XPort to disable AutolP DHCP or BootP To disable an option set the appropriate bit Table 6 1 BootP DHCP AutolP options AutolP 0 DHCP 1 BootP 2 For example if the third octet is 0 0 5 0 the AutolP and BootP options are disabled only DHCP is enabled The value 5 results from adding the binary equivalents of 0 and 2 This is the most common setting when using DHCP DeviceLinx XPort XChip SoC User Guide 44 6 Setup Mode Server Configuration Set Gateway IP Address Netmask The gateway address or router allows communication to other LAN segments The gateway address should be the IP
80. s No DeviceLinx XPort XChip SoC User Guide 30 4 Configuration Using Web Manager Flush Output Buffer Network to Serial With Active Connect Select Yes to clear the output buffer with a connection that is initiated from the device to the network The default is No With Passive Connect Select Yes to clear the output buffer with a connection initiated from the network to the device The default is No At Time of Disconnect Select Yes to clear the output buffer when the network connection to or from the device is disconnected The default is No 3 When you are finished click the OK button 4 Onthe main menu click Apply Settings Connection Settings TCP To configure a channel s TCP settings 1 Onthe main menu click Connection The Connection Settings window for the channel displays DeviceLinx XPort XChip SoC User Guide 31 4 Configuration Using Web Manager Network Server Serial Tunnel Hostlist Figure 4 7 TCP Connection Settings LANTRONIX Channel 1 Connect Protocol Channel 1 Protocol TCP v Firmware Version V6 6 0 1RC2 MAC Address 00 20 4A A5 C8 FC Connection Settings Connect Mode Passive Connection Active Connection Accept F S A Incoming Yes e Active Connect None w Password Saile i Configurable Pins Required Oves No Start Character o od tin Hex rn Password Modem Mode None vi Apply D
81. s included with the Software is the entire agreement between Recipient and Lantronix relating to the Software and the support services if any and supersedes all prior or contemporaneous oral or written communications proposals and representations with respect to the Software or any other subject matter covered by this FLA To the extent the terms of any Lantronix policies or programs for support services conflict with the terms of this FLA the terms of this FLA shall control DeviceLinx XPort XChip SoC User Guide Contents Copyright and Trademark vnr nrnnnnnnnnervennnrnnnnnnnsnnnnnrnnrennnnneennnnnrnnnnennn 2 Wanani RR NN 2 Gp EEE tdci EER Eed anaes 2 Ne UE 3 Revision e tee EE 3 XChip License Agreement 4 1 Using This Guide 13 Purpose and E Une 13 Chapter Summary anjsase snadder ue eege Ea RRA aaia 13 Additional Documentation 14 2 Introduction 15 Capabilitie EE 15 eelere TT 15 Protocol e ee TEE 16 Configuration Methods issis naain ia aaia 16 Addresses and Port Numbers AA 16 Hardware Address 16 IP Address 17 Port Numbers 17 3 Using Devicelnstaller 18 Installing Devicelnstall r iua auvnanmnamdnmninndpaninnedmdee ikm 18 Assigning E Tale 18 Accessing the XPort Using Devicelnstaller rrrnnnrrnnnnnnronnnnrrrrnnnnnanrnnnnrrnnnnnernnrnnnnn 19 Viewing the Current Configuration eorrvrannrrnannvnnerrennnr renn nrnnnnnnnnenrenrnrnvennrnnsnnnnrnnnnn 19 4 Configuration Using Web Manager 22
82. server you are only assigning a temporary IP address When you Telnet into port 9999 and do not press Enter quickly the device server reboots causing it to lose the IP address Telnet back to Port 1 Wait for it to fail then Telnet to port 9999 again Make sure you press Enter quickly When you Telnet to port 9999 the Press Enter to go into Setup Mode message displays However nothing happens when you press Enter or your connection is closed You did not press Enter quickly enough You only have 5 seconds to press Enter before the connection is closed Telnet to port 9999 again but press Enter as soon as you see the Press Enter to go into Setup Mode message DeviceLinx XPort XChip SoC User Guide 85 12 Troubleshooting 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 In some forms of Unix the Ethernet address is segmented with colons 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
83. setting that allows a custom application to query or set the three XPort configurable pins when they are functioning as general purpose I O GPIO You may want to disable this capability for security purposes The default setting is the N No option which enables GPIO control The Y Yes option disables the GPIO control interface Disable Port 77F0h _ Default Settings Option 7 Select 7 to reset the unit s Channel 1 configuration email settings and expert settings to the default settings The server configuration settings for IP address gateway IP address and netmask remain unchanged The configurable pins settings also remain unchanged The specific settings that this option changes are listed below Channel 1 Configuration Defaults Baudrate 9600 I F Mode 4C 1 stop bit no parity 8 bit RS 232C Flow 00 Port number 10001 Connect Mode CO always accept incoming connection no active connection startup Send in Modem Mode Enabled Show IP addr after RING Enabled Auto increment source port Disable DeviceLinx XPort XChip SoC User Guide 71 8 Setup Mode Advanced Settings Hostlist retry counter 3 Hostlist retry timeout 250 msec Start character for serial channel 1 0x0D CR All other parameters 0 Expert Settings Defaults TCP Keepalive time in s 45 ARP Cache timeout in s 600 CPU Performance 0 Regular applies to XPort 03 X
84. ss AAA 45 Netmask Number of Bits for Host Part 45 Set DNS Server IP Address AAA 45 Change Telnet Web Manager Password 45 DHCP Name ee 46 Setup Mode Channel Configuration 47 Channel 1 Option NEE 47 BaUdrate EEE 47 IF Interface Mode mrrnnnonnnnnnvovnnnnnvnvnnnnnvnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnsnnnnnnnnnnnnnnnnnnnnnnn 48 VF Mode XPort 485 Only iustnsmidedanseiinidenrmetfedndgedrntkdinidesntfrnsidedanttbde 48 DeviceLinx XPort XChip SoC User Guide 8 Contents OE NN E 49 Port Hu 49 Gonne t Mode mun manustimuatdusin din dE dE NEE 50 a Incoming Connection 51 b Response 51 c Active Startup 51 d Datagram Type 54 e Modem Mode 54 Send the Escape Sequence in Modem Mode sssssssssnnnssrrssssnnnnrnnnsernnnene 57 Show IP addr after DIN 57 Auto Increment Source Port uriamarnsadsmaternmeuaelmnmeidte 57 Rule Ce 57 Remote POM saa 57 DisConnMocde AA 57 Flush Mode Buff r Flushing sssini sasssa E E 58 Pack CONTON annsatte eked tesa eee ats need EEN adel 59 Packing Interval 60 Trailing Characters 60 Send Characters 60 DisConnTime Inactivity Timeout ceeeceeeeeeeeeeeeeeeeeeeeeecaeeeeaaeseeeeeseaeeesaeeneneeesaees 60 Send Characterg ke 60 Telnet Terminal Tvpe ek 61 Channel Port Password rrrrannrrnannvnnenrennnvrnnnnrnnsnnnnnerrnnnnransnnrnnennenesrresnnrnnennnenenreeen 61 8 Setup Mode Advanced Settings 62 Email Settings Opti
85. th each new connection Remote IP Address This is the destination IP address used with an outgoing connection Remote IP Address 0 0 0 0 _ Note This option does not display when Hostlist is enabled from the ConnectMode prompt see Connect Mode on page 50 for more information Remote Port You must set the remote TCP port number for the unit to make outgoing connections This parameter defines the port number on the target host to which a connection is attempted Remote Port 0 _ To connect an ASCII terminal to a host using the unit for login purposes use the remote port number 23 Internet standard port number for Telnet services Note This option does not display when Hostlist is enabled from the ConnectMode prompt see Connect Mode on page 50 for more information DisConnMode This setting determines the conditions under which the unit will cause a network connection to terminate DisConnMode 0 _ DeviceLinx XPort XChip SoC User Guide 57 7 Setup Mode Channel Configuration Notes In DisConnMode Disconnect Mode Modem Control In drop either drops the connection or is ignored All bit positions in the table that are blank represent don t care bits for that particular option which can be set to either a 0 or 1 value Table 7 10 Disconnect Mode Options Disconnect when Modem Control In is not asserted 1 Ignore Modem Control
86. the configurable parameters on the Network Settings page DeviceLinx XPort XChip SoC User Guide 23 4 Configuration Using Web Manager Figure 4 3 Network Settings LANTRON IX Firmware Version V6 6 0 1RC2 MAC Address 00 20 4A A5 C8 FC ke Network Settings Server Serial Tunnel Network Mode Wired Only Hostlist IP Configuration Ch 11 ete Obtain IP address automatically Auto Configuration Methods BOOTP Enable Disable DHCP Enable Disable 3 AutolP Enable Disable Configurable Pins Apply Settings Apply Defaults DHCP Host Name Use the following IP configuration IP Address 172 18 23 52 Subnet Mask 0 0 0 0 Default Gateway 0 0 0 0 DNS Server 0 0 0 0 Ethernet Configuration Auto Negotiate Speed 100 Mbps 10 Mbps Duplex Full Half Network Mode 1 Click Network from the main menu 2 Note the following Network Mode Wired Only is the only choice lt 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 Onthe main menu click Network 2 Select Obtain IP address automatically 3 Enter the following as necessary BOOTP Select Enable to permit the Bootstrap Protocol BOOTP server to assign the IP address from a pool of addresses
87. the functions for the three pins independently and in any combination The initial directions input output and active levels active low or high at boot up can also be configured through 77FE for example by using Devicelnstaller This chapter describes how the directions active levels and states can be dynamically controlled and probed through special port 77F0 The configurable pins default configuration is Function General Purpose Input Active Level Active Low Features TCP and UDP can be used The protocol supports up to 32 GPIO for future products Function configuration can be retrieved Input or output selection can be retrieved and controlled Active low or high selection can be retrieved and controlled o Active or inactive selection can be retrieved and controlled 77F0 can be disabled Every change of state active inactive requires a command over TCP or UDP and thus is not very fast If you use this port for data transfer the throughput is low usually up to 1 Kbps DeviceLinx XPort XChip SoC User Guide 74 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 ar
88. tification Interval 0 secs DeviceLinx XPort XChip SoC User Guide 37 4 Configuration Using Web Manager 2 Configure or modify the following fields Conditions Configurable Pins Select the condition from the drop down menu for the configurable pins Repeat for each Trigger Input field Enable Serial Trigger Enabling this option causes specified serial communications Input to count as a trigger input Channel Select the channel prompting the trigger For the XPort there is only one channel Data Size Select the data size prompting the trigger Match Data Enter the data which when it appears in the communication stream prompts a trigger Note All of the conditions must match for the XPort to send an email notification Message Properties Message The subject line of the trigger event email to the specified recipient s Priority The priority level for the email Min Notification Interval The minimum time allowed between individual triggers If a trigger event occurs within the minimum interval since the last trigger it is ignored Re notification Interval The time interval in which a new email message is sent to the recipient s when a single trigger event remains active 3 When you are finished click the OK button 4 Onthe main menu click Apply Settings Configurable Pin Settings There are three configurable ha
89. tive 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 Enter only one name When this option is enabled the unit also reacts to the end of record EOR and binary options which can be used for applications such as terminal emulation to IBM hosts Connect Response A single character is transmitted to the serial port when there is a change in connection state Default setting is None Use Hostlist If this option is set to True the device server scrolls through the host list until it connects to a device listed in the host list table Once it connects the unit stops trying to connect to any others If this connection fails the unit continues to scroll through the table until it connects to another IP in the host list The host list is disabled for Manual Mode and for Modem Mode The unit will not accept a data connection from a remote device when the host list option is enabled LED Select Blink for the status LEDs to blink upon connection or None for no LED output Disconnect Mode On Mdm_Cirl_In Drop Set to Yes for the network connection to or from the serial port to disconnect d
90. tive Modem Control In Accepts external connection requests only when the Modem Control In input is asserted Cannot be used with Modem Mode Always Accept Accepts any incoming connection when a connection is not already established Default setting 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 CoBos device will be provided when you use verbose mode This option is overridden when the Active Start Modem Mode or Active Start Host List is in effect Default setting is Nothing quiet c Active Startup No Active Startup Does not attempt to initiate a connection under any circumstance Default setting With Any Character Attempts to connect when any character is received from the serial port With active Modem Control In Attempts to connect when the Modem Control In input changes from not asserted to asserted With a Specific Start Character Attempts to connect when it receives a specific start character from the serial port The default start character is carriage return DeviceLinx XPort XChip SoC User Guide 51 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
91. to be exchanged or an acknowledgment needs to be sent DisConnTime Inactivity Timeout Use this parameter to set an inactivity timeout The unit drops the TCP connection to the local port 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 DisConnTime 0 0 To disable the inactivity timeout enter 00 00 Range is 0 disabled to 5999 seconds 99 minutes 59 seconds Default is 0 Send Characters Enter up to two characters in hexadecimal representation in sendchar SendChar 1 0 _ SendChar 2 0 _ If the unit receives a character on the serial line that matches one of these characters it sends the character immediately along with any awaiting characters to the TCP connection This action minimizes the response time for specific protocol characters on the serial line for example ETX EOT Setting the first sendchar to 00 disables the recognition of the characters Alternatively the unit can interpret two characters as a sequence see Pack Control on page 59 DeviceLinx XPort XChip SoC User Guide 60 7 Setup Mode Channel Configuration Telnet Terminal Type This parameter displays only if you enabled the terminal type option in Disconnect Mode With this option enabled you can use the terminal name for the Telnet terminal type Enter only one name With terminal t
92. try select Yes If you enter an IP address of 0 0 0 0 that entry and all others after it are deleted DeviceLinx XPort XChip SoC User Guide 53 7 Setup Mode Channel Configuration 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 5 For Retrytimeout enter the number of seconds the unit should wait before failing an attempted connection The time is stored as units of milliseconds in the range of 10 65535 The default is 250 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 e Modem Mode In Modem Emulation Mode the unit presents a modem interface to the attached serial device It accepts AT style modem commands and handles the modem signals correctly Normally there is a modem connected to a local PC and a modem connected to a remote machine A user must dial from the local PC to the remote machine accumul
93. ttings rrrenonnrnrnrrnnnrnnnnnrnnenvnnnrrrennnrnnennnnrerrennnrnnennnnnenneeenn 37 Figure 4 11 Configurable Pins Settings rrrnnrvnonnvnnrnvvnrnr vnr nrnnnnnnnnenrnnrrrrennnrnnennennenneeenn 39 Figur 5 1 MAG ee 42 Figure 5 2 Setup Menu Optons vnr nrnnnnnnnnnnvenenrresnnrnnennvenenneeen 42 Figure 7 1 Serial Port Parameters uannnnrnnrnnnnvnnannvnnnnnvnnnrrnnnnrnnnnnnnnnnvnnnnrresnnrnnennvnnennenenr 47 Figur 7 2 el E de le EE 53 Figure 8 1 Gud EEN 62 Figure 8 2 Expert Settings EE 65 Figure 8 3 S curity Settings ET 68 Figure 10 1 TETP line e 80 DeviceLinx XPort XChip SoC User Guide 12 1 Using This Guide Purpose and Audience This guide covers DeviceLinx XPort Device Server Module XPort 03 version e g XP1001xxx 03R and XPort 04 version e g XP1001xxx 04R 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 All references to XChip in this document relate to the combination of the physical chip and the licensed firmware that delivers the XPort functionality EX100000 02R XPort firmware XCP1001000 01 XChip Chapter Summary The remaining chapters in this guide include 2 Introduction 3 Using
94. ut because of a specified combination of conditions on the configurable pins DeviceLinx XPort XChip SoC User Guide 63 8 Setup Mode Advanced Settings Enable serial trigger input N Trigger inputl A I X X Trigger inputl A I X X Trigger inputl A I X X Message Priority L Minimum notification interval 1 s Re notification interval 0 s Set the configurable pins to Active I Inactive or X Don t Care Active can mean active low or active high If the configurable pins are all set to b Don t Care then they are disabled If both the serial sequence and the configurable pins are disabled the trigger is disabled To change the configurable pins settings send setup records to Port 77FE Message The subject line of the trigger event email to the specified recipient s Priority The priority level for the trigger even email Enter L for normal priority or H for high priority Minimum notification The minimum time allowed between individual triggers If a interval trigger event occurs within the minimum interval since the last trigger it is ignored Re notification interval Indicates the time interval at which a new email message is sent to the recipient s when a single trigger event remains active Trigger 2 Refer to Trigger 1 for details on completing these fields Note Each trigger is independent of the others Each condition within an indi
95. viceLinx XPort XChip SoC User Guide 41 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 MAC address 66264AASCS8FC Software version V6 6 1RC2 68671 gt KPTEXE AES library version 1 8 2 1 Press Enter for Setup Mode 3 To enter Setup Mode press Enter within 5 seconds The configuration settings display followed by the Change Setup menu Figure 5 2 Setup Menu Options Change Setup Server 1 Channel 1 E mail Expert Security Defaults Exit without save Save and exit Your choice m vi D I N T GA 4 Select an option on the menu by entering the number of the option in the Your choice field and pressing Enter 5 To enter a value for a parameter type the value and press Enter or to confirm a current value just press Enter 6 When you are finished save the new configuration option 9 The unit reboots Serial Port Connection To configure the unit through a serial connection 1 Connect a console terminal or PC running a terminal emulation program to your unit s serial port 2 Setthe terminal emulator serial port settings to 9600 baud 8
96. vidual trigger must be met before the unit sends the email Trigger 3 Refer to Trigger 1 for details on completing these fields Note Each trigger is independent of the others Each condition within an individual trigger must be met before the unit sends the email Expert Settings Option 5 Note You can change the Enable alternate MAC setting using telnet or serial connections only It is not available through the Web Manager CAUTION Only an expert should change these parameters You must definitely know the consequences the changes might have DeviceLinx XPort XChip SoC User Guide 64 8 Setup Mode Advanced Settings Figure 8 2 Expert Settings TCP Keepalive time in s is 65s s disable gt 45 gt ARP Cache timeout in s Cis 6 s gt 6009 CPU performance lt Regular 1 Low 2 High gt lt Disable Monitor Mode bootup ND RS485 tx enable active CR low 1 high gt lt HTTP Port Number 86 SMTP Port Number oe MTU Size 512 1400 lt 149 gt Enable alternate MAC ND Ethernet connection type lt The default settings are listed below TCP Keepalive time ins 45 1s 65s Os disable ARP Cache timeout in s 600 1s 600s CPU Performance Regular applies to XPort 03 XPort 485 and later units only Disable Monitor Mode bootup No RS485 tx enable Active low HTTP Port Number 80 1 65535 SMTP Po
97. w Numeric Response The unit does not echo modem commands and responds to a command with a numeric response DeviceLinx XPort XChip SoC User Guide 54 7 Setup Mode Channel Configuration Table 7 8 Modem Mode Messages Full Verbose OK Command was executed without error CONNECT A network connection has been established NO CARRIER A network connection has been closed BING n n n n SE device having IP address n n n n is connecting to this Numeric Response 0 OK 1 Connected 2 Ring 3 No Carrier 4 Error Received commands must begin with the two character sequence AT and be terminated with a carriage return character The unit ignores any character sequence received not starting with AT and only recognizes and processes single AT style commands The unit treats compound AT commands as unrecognized commands If the Full Verbose option is in effect the unit responds to an unrecognized command string that is otherwise formatted correctly begins with AT and ends with carriage return with the OK message and takes no further action If the Numeric Response option is in effect the unit responds to an unrecognized command string that is otherwise formatted correctly with the OK message and takes no further action When an active connection is in effect the unit transfers data and does not process commands received from the serial interface When a connection is terminated or lost
98. wered down or rebooted DeviceLinx XPort XChip SoC User Guide 75 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 Command 12h Get Active Levels Send No parameters Response 1 parameter Bytes 1 4 Active levels Bit X 1 means GPIO X is active low OV when active 3 3V when inactive 0 means it is active high 3 3V when active OV when inactive Command 13h Get Current States Send No parameters Response 1 parameter Bytes 1 4 States Bit X 1 means GPIO X is active 0 means it is inactive DeviceLinx XPort XChip SoC User Guide 76 9 GPIO Interface Command 19h Set Directions 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 direction for that GPIO will not change Bytes 5 8 New Directions Bit X 1 means GPIO X will become an output 0 means it will become an input Response 1 parameter Bytes 1 4 The updated directions Command 1Ah Set Active Levels Send 2 parameters Bytes 1 4 Mask Bit X 1 means the direction for GPIO X wi
99. your company name address and phone number Lantronix model number Lantronix MAC number Software version on the first screen shown when you Telnet to port 9999 Description of the problem Status of the unit when the problem occurred please try to include information on user and network activity at the time of the problem DeviceLinx XPort XChip SoC User Guide 88 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 To convert a binary value for example 0100 1100 toa hexadecimal representation the upper and lower four bits are treated separately resulting in a two digit hexadecimal number in this case 4C Use the following table to convert values from binary to hexadecimal 0 0000 0 1 0001 1 2 0010 2 3 0011 3 4 0100 4 5 0101 5 6 0110 6 7 0111 7 8 1000 8 9 1001 9 10 1010 A 11 1011 B 12 1100 C 13 1101 D 14 1110 E 15 1111 F Scientific Calculator Another simple way to convert binary to hexadecimals
100. ype option enabled the unit also reacts to the EOR end of record and binary options useful for applications like terminal emulation to IBM hosts 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 DeviceLinx XPort XChip SoC User Guide 61 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 Devicelnstaller see Email Notification in the Devicelnstaller online Help 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 PIO when selected as user I O functions Optionally use a two byte serial string to initiate a trigger To configure email configuration settings select Email option 3 from the Change Setup menu Figure 8 1 Email Settings E mail Mail server 0 0 0 0 Unit Domain Recipient 1 Recipient 2 Trigger 1 Serial trigger input disabled Channel 1 Match 00 Trigger inputl Trigger input2 Trigger input3 Message Priority L EE Min notification interval 1 s Re notification interval 0s

XPort/XChip User Guide

Contents

Download Pdf Manuals

Related Search

Related Contents