Lantronix XPico 900-691-R, User Manual

Page 1: ...Part Number 900 691 R Revision D February 2014 xPico Wi Fi Embedded Device Server User Guide...

Page 2: ...rranty For details on the Lantronix warranty policy please go to our web site at www lantronix com support warranty Contacts Lantronix Inc Corporate Headquarters 167 Technology Drive Irvine CA 92618 U...

Page 3: ...________________________________________________15 Addresses and Port Numbers ________________________________________________15 Hardware Address _____________________________________________________1...

Page 4: ...__________________________________________________34 Line Settings __________________________________________________________34 To View Tunnel Serial Settings _________________________________________...

Page 5: ...________________________________________51 To View Buffer Pool Status _______________________________________________51 10 Advanced Settings 52 XML Import and XML Export ______________________________...

Page 6: ...______________________________________75 Element Start and End Tags _____________________________________________75 Element Attributes _____________________________________________________75 Record Gr...

Page 7: ...ling __________________________________________________109 Plaque signal tique du produit final _______________________________________109 Manual Information To the End User __________________________...

Page 8: ...1 of 2 _____________________________________________63 Figure 11 13 Monitor Data Mining 2 of 2 _____________________________________________63 Figure 11 14 Monitor Presenting__________________________...

Page 9: ..._39 Table 6 6 Modem Emulation Settings ________________________________________________40 Table 6 7 Modem Emulation Commands and Descriptions _____________________________41 Table 7 1 Current Configur...

Page 10: ...________________________________106 Table D 4 Europe EU Declaration of Conformity _____________________________________106 Table D 5 Approved Antenna s List ___________________________________________...

Page 11: ...n about the Configurable Pin Manager CPM and how to set the configurable pins to work with a device 8 Services Settings Instructions for configuring HTTP settings 9 Maintenance and Diagnostics Setting...

Page 12: ...i Fi Embedded Device Server Integration Guide Information about the xPico Wi Fi hardware testing the device server using the demonstration board and integrating the unit into your product xPico Wi Fi...

Page 13: ...ut delay QuickConnect Dynamic Profiles facilitate easy and rapid connections to access points Host Interface Serial Interface Two Serial CMOS Ports 1200 to 921 6 Kbps Flow control XON XOFF RTS CTS Lin...

Page 14: ...st Load Driver Physical Interface 40 pin Board to Board SMT Connector Certifications FCC IC EU Japan UL CE Warranty 5 Year Limited Protocol Support The xPico Wi Fi embedded device server contains a fu...

Page 15: ...ort on page 52 Command Mode Access the Command Mode CLI by connecting a PC or other host running a terminal emulation program to the unit s serial port See Command Reference on page 70 Addresses and P...

Page 16: ...2 Introduction xPico Wi Fi Embedded Device Server User Guide 16 Figure 2 1 xPico Wi Fi Product Label...

Page 17: ...Manager Web Manager Components Navigating Web Manager Accessing Web Manager To access Web Manager perform the following steps 1 Open a standard web browser Lantronix supports the latest version of Int...

Page 18: ...ager xPico Wi Fi Embedded Device Server User Guide 18 Status Page The Status page is the first to appear after you log into Web Manager The Status page also appears when you click Status tab in Web Ma...

Page 19: ...ween pages Some pages are read only while others let you change configuration settings Note There may be times when you must reboot the xPico Wi Fi for the new configuration settings to take effect Th...

Page 20: ...tus and lets you change the current configuration and authentication settings 46 Line Shows statistics and lets you change the current configuration and Command mode settings of a serial line 34 Modem...

Page 21: ...oftware enabled Access Point ap0 interface Table 4 1 Network Interface Settings To Configure Network 1 Interface Settings Using Web Manager To modify Software enabled Access Point ap0 settings go to N...

Page 22: ...he channel for the SoftAP Suite Specify the security suite to be used for the SoftAP None no authentication or encryption method will be used WPA WiFi Protected Access WPA2 Robust Secure Network Encry...

Page 23: ...nnection from the drop down menu Always Up when enabled the SoftAP is always on Triggered when enabled the SoftAP operates in Triggered mode Triggered AP mode is a means to enable the xPico Wi Fi Soft...

Page 24: ...x space At boot up after the physical link is up the xPico Wi Fi will attempt to obtain IP settings from a DHCP server and will periodically renew these settings with the server Note Click renew on In...

Page 25: ...e instance wlan0 Network 2 wlan0 Link Status This page shows status of a Link on the device To View Network 2 Link Status Using Web Manager To view network 2 link interface information click Network o...

Page 26: ...e Using WebManager Click WLAN Profiles on the menu Using CLI To enter the WLAN Profile command level config WLAN Profile instance Using XML Include in your file configgroup name WLAN Profile instance...

Page 27: ...elect 40 for WEP40 and WEP64 select 104 for WEP104 and WEP128 Note This option is available if WEP suite is selected above TX Key Index Select one of four index listing keys for transmitting data Rece...

Page 28: ...available only when suites WEP WPA or WPA2 are selected WPAx Encryption Select one or more encryption types listed from strongest to least strong At least one selection will have to match the Access...

Page 29: ...a specific Network Name to display the Quick Connect profile If you provide the Password for a specific Quick Connect Profile you can add that profile to your list of WLAN Profiles Up to four WLAN pr...

Page 30: ...ine The default is 9600 A custom speed or any set speed between 1200 and 921600 may be selected 1200 2400 4800 9600 19200 38400 57600 115200 230400 460800 921600 If a custom speed is selected indicate...

Page 31: ...ne command level status Line instance Using XML Look for the status header statusgroup name Line instance 1 Xoff Char Specify the Xoff Character which is used when Flow Control is set to Software Set...

Page 32: ...SPI None selects no application to connect to the SPI Monitor selects Monitor application to connect to the SPI Target Speed Set the target clock speed of the SPI in Hz range is 234 375 KHz 30 MHz The...

Page 33: ...33 To View SPI Status Using Web Manager To view the current status and statistics for the SPI bus master device click SPI in the menu and select Status Using CLI To enter the SPI command level status...

Page 34: ...or informational purposes and must be configured from the Line settings Table 6 1 Tunnel Line Settings To View Tunnel Serial Settings Using Web Manager To view the Serial Settings for a specific tunne...

Page 35: ...et the threshold byte count If the received serial data reaches this threshold then the data will be sent on the network Valid range is 100 to 1450 bytes Default is 512 Note This configuration option...

Page 36: ...Tunnel Accept Mode Settings Tunnel Accept Mode Settings Description Mode Set the method used to start a tunnel in Accept mode Choices are Disable do not accept an incoming connection Always accept an...

Page 37: ...buffered and will eventually flow off the serial line if hardware or software flow control is configured Disabled this is the default setting incoming characters from the Serial Line are sent into the...

Page 38: ...hosts become available for editing submitting as a host is edited Connections Select the type of connection Sequential connections for tunneling will begin from host 1 and proceed in sequence until a...

Page 39: ...ncoming characters from the network will not be forwarded to the serial line but will be buffered and eventually flow off the network side Disabled incoming characters from the network are sent on int...

Page 40: ...Manager To view statistics for a specific tunnel click Tunnel in the menu and select the Tunnel 1 Status Using CLI To enter the Tunnel command level status Tunnel instance Using XML Look for the stat...

Page 41: ...to the serial line for unrecognized AT commands Incoming Connection Select Automatic Manual or Disabled for the handling of incoming connections Connect String Specify a customized string to be sent...

Page 42: ...odes ATXn Command does nothing and returns OK status ATZ Restore active settings from defaults AT F Reset saved settings in NVR to factory defaults AT V Display current and saved settings AT W Save ac...

Page 43: ...nfigurable Pins Table 7 2 CP Status CP Ref Usage Assert Mode Value Roles Active in Role CP1 Pin 35 Input High Push Pull 0 1 available CP2 Pin 26 Input High Push Pull 1 1 available CP3 Pin 28 Input Hig...

Page 44: ...be assigned or unassigned to a configurable pin A role based on its state can trigger outside events Only an enabled role can be a trigger xPico Wi Fi roles available for assignment to a configurable...

Page 45: ...in the menu select Roles Status and then the Detail link to the right of a specific role to view details Using the CLI To enter the CPM command level config CPM Using XML Include in your file configgr...

Page 46: ...TP Server Using XML Include in your file configgroup name HTTP Server Include in your file configgroup name HTTP Server Access Control instance 1 HTTP Settings Description State Select to enable or di...

Page 47: ...ver User Guide 47 To View HTTP Status Using Web Manager To view HTTP status click HTTP in the menu and select Status Using CLI To enter the HTTP Server command level status HTTP Server Using XML Look...

Page 48: ...ystem Using Web Manager To view file system statistiscs compact or format the file system click FIle System in the menu Using CLI To enter the File System command level status File System Using XML Lo...

Page 49: ...the unit before attempting to make any subsequent connections Device Management Table 9 2 Device Management Settings System Settings Description Save Any cached configuration changes are committed so...

Page 50: ...re click Device in the menu Using CLI To enter the Device command level status Device Using XML Look for the status header statusgroup name Device Admin User Table 9 3 Admin User Settings To Configure...

Page 51: ...agnostics Using XML Include in your file statusgroup name Diagnostic Hardware To View IP Socket Status Using WebManager To view IP Sockets information click Diagnostics in the menu and select IP Socke...

Page 52: ...to ensure the best throughput To Import or Export XML Configuration 1 Connect the xPico Wi Fi embedded device server to a PC using A null modem cable for line 1 A USB cable for line 2 The USB driver w...

Page 53: ...figuration text to modify the XML configuration 10 Copy and paste CR all of the text into the terminal emulator connected to the desired xPico Wi Fi embedded device server to import the new configurat...

Page 54: ...rver User Guide 54 To Configure Performance Using Web Manager To modify performance settings click Performance in the menu Using CLI To enter the Performance command level config Performance Using XML...

Page 55: ...submit changes Initial Delay Set the initial delay time in milliseconds before the monitor starts processing the initialization message This field appears in Step 1 Setup Initiation Message Number No...

Page 56: ...ected The third trunk of data created by the binary filter will contain the rest of the input Selector Number Click the Edit link to edit a specific selector in Step 4 Pick Data page Three selector co...

Page 57: ...lso open upon clicking Edit Complete the Message Number fields Command enter the command in binary format printable characters or binary string End Character indicate as a single printable character o...

Page 58: ...f the response Timeout set the timeout length Minimum timeout length is 100 milliseconds Click Submit after making changes to get real time response displayed if you are utilizing Explorer Delay Set t...

Page 59: ...l instance 1 Include in your file configgroup name Monitor Poll instance 1 Include in your file configgroup name Monitor Filter instance 1 Include in your file configgroup name Monitor Data instance 1...

Page 60: ...g the serial device into a known state STEP 1 STRATEGY Explore your serial device and determine your strategy for bringing it to the desired starting state STEP 2 CONNECTION Connect your serial device...

Page 61: ...cter STEP 3 TEST Testing is rapid and simplified using Monitor Explorer You can see the serial device response right in your browser window Sample Configuration Use a single show command to elicit the...

Page 62: ...ltiple fields f so with a dot between them R f you are selecting a particular sliced result from a Rule STEP 3 TEST Testing is rapid and simplified using Monitor Explorer You can see the response data...

Page 63: ...w data is virtual so all of your Filter Rules overlay raw data from each response but you need only care about some of them on a particular Poll message STEP 2 SETUP Use Monitor Explorer or directly c...

Page 64: ...view all of your data under Monitor Status In the Command Line Interface CLI first type status to enter the status menu level then type monitor for the Monitor menu level From there type show for the...

Page 65: ...we start at the root Command Line Interface type xml then xsr dump monitor We see a statusitem name data instance Up time with value containing the present data DATA CAPTURE ON SPI Connect xPico Wi Fi...

Page 66: ...uired 2 Create a path in the file system the entire path can be created in a single step via either the Web Manager or CLI The path is the same as that for the hidden files except for the top level la...

Page 67: ...verridden The complete list is as follows resource main web_manager web index html Main file controlling text and graphics resource main web_manager web style css Style sheet resource main web_manager...

Page 68: ...rmware through Web Manager Upload the firmware using the device Web Manager Device page To upload new firmware 1 Select Device in the menu bar The Device Status page appears Note See Device Settings o...

Page 69: ...Click Upgrade to install the firmware on the xPico Wi Fi embedded device server 7 Click OK in the confirmation pop up which appears The firmware will be installed and the device will automatically reb...

Page 70: ...the future growth of Machine to Machine M2M networks The xPico Wi Fi embedded device server supports XML configuration records that make configuring the device server easy for users and administrator...

Page 71: ...rol be used on the serial port to ensure the best performance when importing XML 1 Connect a terminal or a PC running a terminal emulation program to one of the xPico Wi Fi embedded device server s se...

Page 72: ...a list of all accesss point commands and descriptions at the config access point level To view SPI configurations enter the config level by typing config at the root level and then the SPI level by ty...

Page 73: ...Figure A 2 Root Level Commands below do not affect current configuration settings and are not displayed initially If you type you will see the login sub commands These commands provide diagnostic and...

Page 74: ...IST configgroup name CDATA IMPLIED ATTLIST configgroup instance CDATA IMPLIED ATTLIST configitem name CDATA IMPLIED ATTLIST value name CDATA IMPLIED The xPico Wi Fi DTD rules state the following The X...

Page 75: ...forward slash preceding the name for example configrecord The element content can also contain other child elements Element Attributes The XML element attributes that are name value pairs included in...

Page 76: ...attribute identifies the group item or value It is always quoted as are all XML attributes For example a group that contains serial port parameters has the name line An instance attribute identifies w...

Page 77: ...lt SSID may contain up to 32 characters configitem Channel value No help available configitem Suite value Suite may be None WPA or WPA2 configitem Encryption value Encryption may contain any combinati...

Page 78: ...condition on the pin Assert may be High or Low value Mode Mode indicates if this Configurable Pin is set up for push pull or if it enables an internal weak pullup 5 Volt tolerance In order to sustain...

Page 79: ...fter reboot When an Access Point is enabled DHCP Server will assign IP addresses to the access point s clients DHCP Server manages up to 4 client IP addresses only 3 if wlan0 is enabled The first IP A...

Page 80: ...value Hostname must begin with a letter or number continue with letter number or hyphen and must end with a letter or number If DHCP Client is enabled the Hostname is sent to the remote DHCP Server an...

Page 81: ...Log sets up an output only message log on the device Severity codes in the log are P Emergency A Alert C Critical E Error W Warning N Notice I Informational D Debug Command Line sets up a user interfa...

Page 82: ...acter where control J for example counts as one configitem Gap Timer value The driver forwards received serial bytes after the Gap Timer delay from the last character received By default the delay is...

Page 83: ...e Powered Up has units of seconds Blank the value for Infinite configgroup SPI These settings pertain to the Serial Peripheral Interface SPI Bus Master device Changes take effect immediately configite...

Page 84: ...dge value Clock Edge also known as Clock Phase or CPHA selects the clock edge for latching data First means each bit is latched on the first edge of the clock This is equivalent to CPHA 0 When Idle Cl...

Page 85: ...gs do not work when you reboot the device it will still have the original settings Use the Submit button to both update the WLAN settings and save them to Flash If the device is connecting to an acess...

Page 86: ...ed value TX Power Maximum TX Power Maximum has units of dBm value Power Management Power Management may be Enabled or Disabled value Power Management Interval Power Management Interval has units of be...

Page 87: ...alue With Echo Commands enabled ATE1 characters read on the Serial Line will be echoed while the Line is in Modem Command Mode Echo Commands may be Enabled or Disabled configitem Verbose Response valu...

Page 88: ...tings pertain to Monitor Initialization in the device Monitor will process any initialization message before it starts polling or process any control message Response captured during initialization wi...

Page 89: ...aptured during initialization or poll Response must be read before sending another status action Send or buffer will be reset configitem Message value Command Sets the Command in binary format Binary...

Page 90: ...ain up to 16 bytes value End Character Sets the End Character to indicate end of response Response is ended by any configured End Character Length OR Timeout The End Character may be designated as a s...

Page 91: ...nks separated by Binary String Each trunk will not contain the delimiters Binary filter breaks input into 3 trunks according to Offset and Length Mode may be All Delimiters or Binary value Delimiter B...

Page 92: ...0 indicates the raw response Dot number format could be 0 or two numbers separated by a dot e g 1 2 Reference may contain up to 6 characters configgroup Tunnel Accept Tunnel Accept Mode controls how...

Page 93: ...Character allows forwarding of a start character from the Line into the network Flush Start Character may be Enabled or Disabled configitem Flush Line value Flush Line applies at the time when a conn...

Page 94: ...rom opening network connection in order to enable data transmission The password sent to the unit must be terminated with one of the following 0A Line Feed 00 Null 0D 0A Carriage Return Line Feed 0D 0...

Page 95: ...Start Character may be designated as a single printable character or as a control character Control characters may be input in any of the following forms control J 0xA hexadecimal 10 decimal Start Ch...

Page 96: ...onds before trying to reconnect to the remote host after a previous attempt failed or the connection was closed Blank the display field to restore the default Reconnect Time has units of seconds confi...

Page 97: ...aracter or as a control character Control characters may be input in any of the following forms control J 0xA hexadecimal 10 decimal Disable the Stop Character by blanking the field to set it to None...

Page 98: ...on the Serial Line Mode may be Disable Timeout or Send Character configitem Timeout value If the oldest byte of queued data has been waiting for Timeout milliseconds the queued data will be sent on th...

Page 99: ...e character or control character that is injected into the outgoing data stream right after the Send Character Control characters may be input in any of the following forms control J 0xA hexadecimal 1...

Page 100: ...parated by semicolon If omitted all status groups will be returned CURL example curl u admin PASSWORD http 172 19 100 125 export status X POST curl u admin PASSWORD http 172 19 100 125 export status X...

Page 101: ...P POST request can be sent to the device to take a status action Protocol HTTP Method Post URL http hostname action status Parameters group Required The status group where action is defined optionalGr...

Page 102: ...ring configrecord xml version 1 0 standalone yes Automatically generated XML DOCTYPE configrecord ELEMENT configrecord configgroup ELEMENT configgroup configitem ELEMENT configitem value ELEMENT value...

Page 103: ...m 5 00pm Pacific Time Mon Fri excluding holidays www lantronix com support FTP ftp lantronix com Tel 800 422 7044 US Only Tel 949 453 7198 Fax 949 450 7226 Europe Middle East Africa EMEA www lantronix...

Page 104: ...Send a question to technical support When you report a problem please provide the following information Your name and your company name address and phone number Lantronix model number Lantronix seria...

Page 105: ...Subpart B Class B ICES 003 2012 Issue 5 Class B ANSI C63 4 2009 USA FCC Part 15 Subpart C Section 15 247 ANSI C63 10 2009 FCC Part 2 Section 2 1091 FCC OET Bulletin 65 Supplement C 01 01 IEEE C95 1 C...

Page 106: ...a otras disposiciones aplicables o exigibles de la Directiva 1999 5 CE Greek Lantronix Inc xPico Wi Fi 1999 5 Fran ais French Par la pr sente Lantronix Inc d clare que l appareil xPico Wi Fi est confo...

Page 107: ...t expressly approved by the party responsible for compliance could void the user s authority to operate this equipment This transmitter must not be co located or operating in conjunction with any othe...

Page 108: ...mplies with RSS 210 of the Industry Canada Rules Operation is subject to the following two conditions 1 This device may not cause harmful interference and 2 this device must accept any interference re...

Page 109: ...he transmitter and obtaining a separate Canada authorization NOTE IMPORTANTE Dans le cas o ces conditions ne peuvent tre satisfaites par exemple pour certaines configurations d ordinateur portable ou...

Page 110: ...n and required antenna impedance for each antenna type indicated Antenna types not included in this user s manual having a gain greater than the maximum gain indicated for that type are strictly prohi...

Page 111: ...Lead Pb Mercury Hg Polybrominated biphenyls PBB Cadmium Cd Hexavalent Chromium Cr VI Polybrominated diphenyl ethers PBDE Product Family Name Toxic or hazardous Substances and Elements Lead Pb Mercury...

Page 112: ...to F which are represented as 0 9 A for 10 B for 11 etc To convert a binary value for example 0100 1100 to a hexadecimal representation treat the upper and lower four bits separately to produce a two...

Page 113: ...to Hexadecimal Conversions xPico Wi Fi Embedded Device Server User Guide 113 Figure E 2 Windows Scientific Calculator 4 Click Hex The hexadecimal value appears Figure E 3 Hexadecimal Values in the Sci...