manualshive.com logo in svg

Lantronix DeviceLinx Xchip Direct SoC, User Manual

Share
Download
Lantronix DeviceLinx Xchip Direct SoC User Manual Download Page 12

 

DeviceLinx™  XPort Direct/XChip Direct SoC User Guide 

       12

 

2: Introduction 

This chapter summarizes the XPort Direct device networking gateway's features and 
the basic information needed before getting started. 

Capabilities 

The XPort Direct connects devices through a TCP data channel or through a Telnet 
connection to computers or other devices. The XPort Direct also supports UDP 
datagrams.  

Applications 

The XPort Direct connects serial devices such as those listed below to Ethernet 
networks using the IP protocol family.  

‹

 

Personal entertainment devices 

‹

 

POS devices 

‹

 

ATM machines 

‹

 

CNC controllers 

‹

 

Data collection devices 

‹

 

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 

Summary of Contents for DeviceLinx Xchip Direct SoC

Page 1: ...Part Number 900 468 Revision C August 2007 DeviceLinx XPort Direct XChip Direct SoC User Guide ...

Page 2: ...tented technology is a trademark 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 Contacts Lantronix Corporate Headquarters 15353 Barranca Parkway Irvine CA 92618 USA Phone 949 453 3990...

Page 3: ...s or her own expense will be required to take whatever measures may be required to correct the interference Changes or modifications to this device not explicitly approved by Lantronix will void the user s authority to operate this device Date Rev Firmware Comments 1 07 A Initial release 5 07 B 6 1 Added information about product support for RS485 8 07 C 6 5 Added XChip Direct information ...

Page 4: ...tions 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 w...

Page 5: ...e 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 ...

Page 6: ..._______________________________________ 13 IP Address_____________________________________________________________ 13 Port Numbers __________________________________________________________ 13 Assigning an IP Address _____________________________________________ 14 Configuration Methods ______________________________________________ 14 3 Using DeviceInstaller 15 Installing DeviceInstaller ________...

Page 7: ..._________ 34 Show IP addr after RING ____________________________________________ 34 Auto Increment Source Port __________________________________________ 34 Remote IP Address _________________________________________________ 34 Remote Port ______________________________________________________ 34 DisConnMode _____________________________________________________ 34 Flush Mode Buffer Flushing _____...

Page 8: ...________________ 44 Control Protocol____________________________________________________ 45 Guidelines _____________________________________________________________ 45 Commands ____________________________________________________________ 45 Examples_________________________________________________________ 47 9 Firmware Upgrades 49 Obtaining Firmware ________________________________________________...

Page 9: ...________________________________ 59 B Binary to Hexadecimal Conversions 60 Converting Binary to Hexadecimal _____________________________________ 60 Conversion Table _______________________________________________________ 60 Scientific Calculator _____________________________________________________ 60 ...

Page 10: ...e include Chapter Description 2 Introduction Describes the main features of the XPort Direct and the protocols it supports 3 Using DeviceInstaller Provides information for getting your unit up and running using DeviceInstaller to assign an IP address 4 Configuration via Telnet or Serial Port Setup Mode Provides instructions for accessing Setup Mode command line interface using a Telnet connection ...

Page 11: ...lity to create a virtual com port The Com Port Redirector User Guide explains how to use it DeviceInstaller A utility to configure IP addresses and locate Lantronix devices on the local network DeviceInstaller s online Help provides information on using it Additional Documentation The following documentation is also available on the product CD and the Lantronix web site www lantronix com Document ...

Page 12: ...ion to computers or other devices The XPort Direct also supports UDP datagrams Applications The XPort Direct connects serial devices such as those listed below to Ethernet networks using the IP protocol family Personal entertainment devices POS devices ATM machines CNC controllers Data collection devices Universal Power Supply UPS management units Telecommunications equipment Data display devices ...

Page 13: ...re Address The hardware address on the label on the bottom of the unit 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 hardware address It is nee...

Page 14: ... allows a DHCP server to assign an IP address automatically to the XPort Direct If you use DHCP the XPort Direct is assigned a new IP address each time it boots Serial Port Login With this method you connect a terminal or a PC running a terminal emulation program to the unit s serial port CH 1 Configuration Methods After assigning the IP address you have two basic methods for logging into the XPor...

Page 15: ...nformation about DeviceInstaller see the DeviceInstaller online Help To install DeviceInstaller from the Lantronix web site 1 Download DeviceInstaller for your product from the Lantronix website www lantronix com support downloads html 2 Click Setup Exe The installation wizard window displays 3 Respond to the installation wizard prompts Note For more information about DeviceInstaller see the Devic...

Page 16: ...conds 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 recei...

Page 17: ...ardware Address Non configurable field Displays the XPort Direct s hardware or MAC address Firmware Version Non configurable field Displays the firmware currently installed on the XPort Direct Extended Firmware Version Non configurable field Displays the full version nomenclature of the firmware Online Status Non configurable field Displays the XPort Direct s status as online offline unreachable t...

Page 18: ...figurable field Displays 1 65s the XPort Direct s TCP keepalive The default setting is 45 Supports Configurable Pins Non configurable field Displays True Supports Email Triggers Non configurable field Displays False Supports AES Data Stream Non configurable field Displays False Supports 485 Non configurable field Displays True Supports 920K Baudrate Non configurable field Displays False XPort Dire...

Page 19: ...nge 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 5 Setup Mode Server Configuration 6 Setup Mode Channel Configuration and 7 Setup Mode Advanced Settings Note The menus in the configuration chapters show a t...

Page 20: ...he 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 The default serial port settings are 9600 baud 8 bits no parity 1 stop bit no flow control 2 Reset the XPort Direct unit by cycling the unit s power turning the power off and back on Immediately upon resetting th...

Page 21: ...p 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 ...

Page 22: ... 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 000 000 000 000 _ If DHCP is used the third octet of the IP address sets the BootP DHCP AutoIP options The following table shows the bits you can manually configure to force the XPort Direct to disable AutoIP DHCP or BootP To disable an option set the app...

Page 23: ...ask Number of Bits for Host Part 0 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 5 2 Standard IP Network Netmasks Network Class Host Bits Netmask A 24 255 0 0 0 B 16 255 255 0 0 C 8 ...

Page 24: ...the last 6 digits of the MAC hardware 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...

Page 25: ...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 6 1 Serial Port Parameters 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 ...

Page 26: ...en Parity 1 1 Odd Parity 0 1 1 stop bit 0 1 2 stop bits 1 1 1 1 2 stop bits are implemented by the software This might influence performance 2 The RTS pin is used for RS485 transmitter control The following table demonstrates how to build some common Interface Mode settings Table 6 2 Common Interface Mode Settings Common I F Mode Setting Binary Hex RS 232C 8 bit No Parity 1 stop bit 0100 1100 4C R...

Page 27: ...tion 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 TCP Connect Mod...

Page 28: ...specific start character 0 0 1 1 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 Modem Response Numeric 0 1 1 1 1 Data Echo Modem Response Verbose 0 1 1 1 0 Modem Response Only Numeric 0 0 1 1 1 1 Modem Response Only Verbose 0 0 1 1 1 0 a Incoming Connection Never Accept Incoming Rejects all external connectio...

Page 29: ...arriage 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 addr...

Page 30: ...ote IP address and remote port specified when the firmware starts Hostlist If you enable this option the XPort Direct 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 ...

Page 31: ...n 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 accumulating pho...

Page 32: ...ected 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...

Page 33: ...ection to an IP address x x x x and the remote port number defined within the unit ATD0 0 0 0 Forces the unit into Monitor Mode if a remote IP address and port number are defined within the unit ATD Forces the unit into Monitor Mode if a remote IP address and port number are not defined within the unit ATDx x x x Makes a connection to an IP address x x x x and the remote port number defined within...

Page 34: ...estination IP address used with an outgoing connection Remote IP Address 000 000 000 000 _ Note This option does not display when Hostlist is enabled from the ConnectMode prompt see Connect Mode on page 27 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...

Page 35: ...ection 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 Cntrl and Disconnect with EOT mus...

Page 36: ...isconnected 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...

Page 37: ...efault interval is 12 msec 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 ...

Page 38: ...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 36 Telnet Terminal Type This parameter...

Page 39: ...rnate MAC Disabled 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 1s 65s 0s disable 45...

Page 40: ...ion type The XPort Direct 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 10Mbit full duplex 4 100Mbit half duplex or 5 100Mbit full duplex Note Manually configured speed duplex settings only work correctly if the peer or switch also uses a static setting If the ...

Page 41: ...erform network firmware upgrades With this option you can download firmware upgrades over the serial port using DeviceInstaller s Recover Firmware procedure 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 setti...

Page 42: ...N No option enables GPIO control The Y Yes option disables the GPIO control interface Default Settings Option 7 Select 7 to reset the unit s Channel 1 configuration 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 ch...

Page 43: ...TU 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 Telnet setup No Disable TFTP Firmware Update No Disable Port 77FEh No Disable ECHO ports Yes Enable Enhanced password No Disable Port 77F0h No ...

Page 44: ...nd in any combination The initial directions input output and active levels active low or high at boot up can also be configured through 77FE The configurable pins default configuration is Function General Purpose Input Active Level Active Low This chapter describes how the directions active levels and states can be dynamically controlled and probed through special port 77F0 Note For specific conf...

Page 45: ...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 0FFh is returned Command Parameter 1 0 1 2 3 4 When sending a co...

Page 46: ...arameters Response 1 parameter Bytes 1 4 Active levels Bit X 1 means GPIO X is active low 0V when active 3 3V when inactive 0 means it is active high 3 3V when active 0V 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 Command 19h Set Directions Send 2 parameters Bytes 1 4 Mask Bit X 1 means ...

Page 47: ... 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 Examples Example 1 PC sends command 10h to find out which configurable pins are available as GPIO PC XPort Direct 10h 00h 00h 00h 00h 00h 00h 00h 00h XPort Direct PC 10h 03h 00h 00h 00h Command details 10h command 10h 00h 00h 00h ...

Page 48: ...0 is 1 GPIO0 will be changed bit 1 is 0 GPIO1 will remain the same 00h 00h 00h 00h the new states bit 0 is 0 GPIO0 will become 0 bit 1 is ignored since it is masked out Response details 1Bh response to command 1Bh 05h 00h 00h 00h bit 0 is 1 GPIO0 1 bit 1 is 0 GPIO1 0 bit 2 is 1 GPIO2 1 The other bits are ignored because there are only two configurable pins on the XPort Direct ...

Page 49: ...er to the DeviceInstaller online Help for information about reloading firmware using DeviceInstaller The other methods are discussed below Using TFTP Graphical User Interface To download new firmware from a computer 1 Use a TFTP client to send a binary file to the unit ROM to upgrade the unit s internal operational code Note TFTP requires the ROM binary version of the unit s internal operational c...

Page 50: ...6303 rom X7 2 In the Remote file name field enter the current internal operational code Recovering the Firmware Using the Serial Port and DeviceInstaller If for some reason the firmware is damaged you can recover the firmware file by using DeviceInstaller to download the ROM file over the serial port To recover firmware 1 Start DeviceInstaller If your PC has more than one network adapter a message...

Page 51: ...are is connected to this selected port on your PC 6 Click OK to download the file 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...

Page 52: ...y1 to enter Monitor Mode without network connections A 0 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 2 Type M upper case A 0 prompt indicates that you have successfully entered Monitor Mode Monito...

Page 53: ...tion information from the device S0 S1 Se Sf Set configuration to memory page Sets a memory page of configuration information 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 ca...

Page 54: ...ote Entering any of the commands listed above generates one of the following command response codes Table 7 2 Command Response Codes Response Meaning 0 OK no error 1 No answer from remote device 2 Cannot reach remote device or no answer 8 Wrong parameter s 9 Invalid command ...

Page 55: ... 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 XPort Direct the connection fails When you Telnet to port 1 on t...

Page 56: ...not properly plugged into the network When you try to assign an IP with DeviceInstaller 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 not a valid IP for your logical subnet You did not choose the c...

Page 57: ...t disabled Technical Support If you experience an error that is not described in this chapter or if you are unable to fix the error you have the following options To check our online knowledge base or send a question to Technical Support go to http www lantronix com support Technical Support Europe Middle East and Africa Phone 33 0 1 39 30 41 72 Email eu_techsupp lantronix com or eu_support lantro...

Page 58: ...bles Auto IP within the unit AutoIP is an alternative to DHCP that allows hosts to obtain an IP address automatically in smaller networks that may not have a DHCP server A range of IP addresses from 169 254 0 1 to 169 254 255 1 has been explicitly reserved for AutoIP enabled devices Do not use this range of Auto IP addresses over the Internet If your unit cannot find a DHCP server and you have not...

Page 59: ...ss defined other than its own 2 If you are using Windows 95 type ARP A at the DOS command prompt to verify that there is at least one entry in the ARP table If the local machine is the only entry ping another IP address on your network to build a new entry in the ARP table the IP address must be a host other than the machine on which you are working Once there is at least one additional entry in t...

Page 60: ...xample 0100 1100 to a 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 Decimal Binary Hex 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 ...

Page 61: ...B Binary to Hexadecimal Conversions DeviceLinx XPort Direct XChip Direct SoC User Guide 61 4 Click Hex The hexadecimal value displays ...

Page 62: ...Mouser Electronics Authorized Distributor Click to View Pricing Inventory Delivery Lifecycle Information Lantronix XD100100K 01 ...

Reviews:

No comments

Brands by name

Popular brands

Load more brands