background image

Appendix A: Command Reference

xPico® Wi-Fi® Embedded Device Server User Guide

94

configitem Block Network

value
Block Network

 may be enabled for debugging purposes. 

If 

Enabled

, incoming characters from the network will NOT be forwarded to the Serial Line. Instead, they 

will be buffered and will eventually flow off the network side. 
If 

Disabled

 (the normal setting), incoming characters from the network are sent on into the Serial Line. 

Any buffered characters are sent first. 

Block Network

 may be "Enabled" or "Disabled".

configitem Password

value

The 

Password

 can be up to 31 characters in length and must contain only alphanumeric characters and 

punctuation. When set, clients must send the correct password string to the unit within 30 seconds from 
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 00 (Carriage Return / Null) 
If 

Prompt for Password

 is set to Enabled, the user will be prompted for the password upon connection. 

Password

 may contain up to 31 characters.

The value is HIDDEN.

configitem Prompt for Password

value
Prompt for Password

 may be "Enabled" or "Disabled".

configgroup Tunnel Line

The 

Line

 Configuration applies to the Serial Line interface. 

See also the 

Line

 configuration. 

configitem DTR

value

The 

DTR

 options select the conditions in which the 

Data Terminal Ready

 control signal on the Serial 

Line is asserted. 
The 

DTR

 option 

Asserted while connected

 causes DTR to be asserted whenever either a connect or an 

accept mode tunnel connection is active. 

DTR

 may be "Asserted while connected", "Continuously asserted" or "Unasserted".

Summary of Contents for xPico WiFi

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

Page 2: ...arranty 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 USA Toll Free 800 526 8766 Phone 949 453 3990 Fax 949 453 3995 Technical Support Online www lantronix com support Sales Offices For a current list of our domestic and international sales offices go to...

Page 3: ..._________________________________________________15 Addresses and Port Numbers ________________________________________________15 Hardware Address _____________________________________________________15 IP Address ___________________________________________________________15 Port Numbers _________________________________________________________15 Product Information Label _________________________...

Page 4: ...___________________________________________________34 Line Settings __________________________________________________________34 To View Tunnel Serial Settings ___________________________________________34 Packing Mode _________________________________________________________35 To Configure Tunnel Packing Mode Settings _________________________________36 Accept Mode _______________________________...

Page 5: ..._________________________________________51 To View Buffer Pool Status _______________________________________________51 10 Advanced Settings 52 XML Import and XML Export _________________________________________________52 To Import or Export XML Configuration _____________________________________52 Performance Settings ______________________________________________________53 To Configure Performa...

Page 6: ..._______________________________________75 Element Start and End Tags _____________________________________________75 Element Attributes _____________________________________________________75 Record Group Item and Value Tags _________________________________________76 XML for xPicoWi Fi Embedded Device Server ___________________________________77 Appendix B WebAPI 100 Export Status Group _________...

Page 7: ...ling __________________________________________________109 Plaque signalétique du produit final _______________________________________109 Manual Information To the End User ______________________________________109 Manuel d information à l utilisateur final ____________________________________110 Antenna Requirement __________________________________________________110 Appendix E Binary to Hexade...

Page 8: ... 1 of 2 _____________________________________________63 Figure 11 13 Monitor Data Mining 2 of 2 _____________________________________________63 Figure 11 14 Monitor Presenting_____________________________________________________64 Figure 11 15 Monitor CLI Command Level_____________________________________________64 Figure 11 16 Monitor XML Commands________________________________________________65...

Page 9: ...__39 Table 6 6 Modem Emulation Settings ________________________________________________40 Table 6 7 Modem Emulation Commands and Descriptions _____________________________41 Table 7 1 Current Configurable Pins _________________________________________________43 Table 7 2 CP Status ______________________________________________________________43 Table 7 3 Role Configuration _______________________...

Page 10: ..._________________________________106 Table D 4 Europe EU Declaration of Conformity _____________________________________106 Table D 5 Approved Antenna s List ________________________________________________110 Table E 1 Binary to Hexadecimal Conversion _________________________________________112 ...

Page 11: ...on 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 Settings Instructions to maintain the xPico Wi Fi view statistics files and diagnose problems 10 Advanced Settings Provides additional information on security settings available 11 Monitor Instructions for ...

Page 12: ...Wi 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 Evaluation Kit Embedded Device Server Quick Start Guide Instructions for getting the xPico Wi Fi unit up and running xPico Wi Fi Evaluation Kit Embedded Device Server User Guide Information needed to...

Page 13: ...out 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 Line 1 only Lantronix tunneling application Modem Emulation Mode SPI Interface Configurable slave master SPI interface that can be clocked at 30MHz USB Interface 2 0 device USB2 0 12 Mbps Full Speed Dev...

Page 14: ...ost 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 full featured IP stack Supported protocols include IEEE 802 11 b g and IEEE 802 11n single stream WLAN interface 2 4 GHz only 802 11i WPA Personal WPA2 Personal Soft AP with DHCP Server HTTP Server TCP...

Page 15: ...port 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 Port Numbers Hardware Address The hardware address is also referred to as the physical address or MAC address Sample hardware address 00 80 A3 FF FF FF 00 80 A3 FF FF FF IP Address Every device connec...

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 Internet Explorer Mozilla Firefox Safari or Chrome browsers 2 Enter the IP address or hostname of the xPico Wi Fi in the address bar The IP address may have been assigned manually or automatically by DH...

Page 18: ...nager 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 Manager Figure 3 1 Status Page ...

Page 19: ...tween 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 The chapters that follow indicate when a change requires a reboot Anytime you reboot the unit this operation will take some time to complete Please wait a minimum of 10 20 seconds after rebooting the u...

Page 20: ...atus 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 Emulation Lets you view and configure Modem Emulation 40 Monitor Lets you query and capture information during serial port to serial device connection 55 Network Shows status and lets you configure ...

Page 21: ...Software 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 Network on the menu and select ap0 Interface Configuration Using CLI To enter the Interface command level config Interface instance Using XML Include in your file configgroup name Interface instance a...

Page 22: ...the 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 Encryption Select one or more encryption types listed from strongest to least strong CCMP Uses AES as basis and is the strongest encryption option TKIP Uses WEP as the basis but adds extra checks and vari...

Page 23: ...onnection 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 SoftAP via a hardware signal This allows a user to have the SoftAP operating only when an external signal button is activated This might be useful when power consumption is a concern yet the SoftAP is ne...

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 Interface Status page to force DHCP lease renewal IP Address Enter the static IP address to use for the interface You may enter it in one of the following ways Alone i e 192 168 1 1 In CIDR format i e ...

Page 25: ...ce 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 on the menu and select wlan0 Link Status Using CLI To enter the WLAN command level status WLAN Using XML Include in your file configgroup name Interface instance wlan0 WLAN Profiles A WLAN profile def...

Page 26: ...le 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 name Table 4 4 Creating Deleting or Enabling WLAN Profiles To Configure WLAN Profile Settings Using Web Manager To view or edit an existing WLAN profile click WLAN Profiles on the menu and select an ...

Page 27: ...Select 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 Reception is allowed with all four keys Note For operability with some products that generate four identical keys from a passphrase this index must be one This option is available if WEP suite is selecte...

Page 28: ...s 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 Points intended to connect with CCMP Uses AES as basis and is the strongest encryption option TKIP Uses WEP as the basis but adds extra checks and variations for added protection Note In case the enc...

Page 29: ...k 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 profiles may be added and only one may be connected at any given time BSSID Lists the basic service set identifier This is a unique 48 bits address that identifies the access point that creates the wir...

Page 30: ...Line 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 the bits per second in the field which appears Parity Set the Parity of the Line The default is None Note Serial lines do not support the following Data Bit Parity combinations a 7 Data Bits with No...

Page 31: ...ine 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 the prefix in one of the three ways Prefix decimal with prefix hexadecimal and 0x Prefix hexadecimal with 0x Prefix as a single control character with control Gap Timer Set the Gap Timer delay to 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 target speed may be lowered to the closest operating speed capability of the device If so a warning will be noted 0 or clearing the selection selects the minimum speed Idle Clock Level Select the le...

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 SPI Using XML Include in your file statusgroup name SPI instance 1 ...

Page 34: ...for 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 tunnel click Tunnel in the menu and select Tunnel 1 Line Using CLI To enter the Tunnel command level config Tunnel instance Using XML Include in your file configgroup name Tunnel Line instance 1 Tunnel Se...

Page 35: ...Set 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 becomes available when Timeout is the selected Mode Send Character Enter Control Characters in any of the following forms control J 0xA hexadecimal 10 decimal If used the Send Character is a single p...

Page 36: ...3 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 incoming connection default Any Character start waiting for an incoming connection when any character is read on the serial line Start Character start waiting for an incoming connection when the sta...

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 network Any buffered characters are sent first Block Network Set whether Block Network is enabled for debugging purposes Choices are Enabled if Enabled incoming characters from the network will not ...

Page 38: ...l 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 connection is accepted Simultaneous all hosts accepting connetions will be connected Reconnect Time Enter the reconnection time which specifies how long the xPico Wi Fi device server will wait in se...

Page 39: ...incoming 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 into the serial line Any buffered characters are sent first This is the normal setting Tunnel Disconnect Mode Settings Description Stop Character Enter the Stop Character which when received on the Seri...

Page 40: ...b 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 status header statusgroup name line instance 1 Modem Emulation Settings Note The following section describes the steps to view and configure Modem Emulation 1 settings these steps also apply to Modem Emu...

Page 41: ...d 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 with the CONNECT modem response code to the serial line if any Display Remote IP Select to enable or disable display remote IP If enabled the incoming ring sent on the serial line is followed by the ...

Page 42: ...codes 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 active settings to NVR AT Z Restore active settings from NVR A Repeat last command Switches to command mode if entered from serial port during connection Command Description ...

Page 43: ...onfigurable 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 High Push Pull 0 0 available CP4 Pin 30 Input High Push Pull 1 0 available CP5 Pin 32 Input High Push Pull 0 0 available CP6 Pin 34 Input High Push Pull 0 0 available CP7 Pin 27 Input High Push Pull 0 0...

Page 44: ...n 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 pin include the following Role AP Trigger Role Line 1 DSR Role Line 1 DTR Role Line 2 DSR Role Line 2 DTR Role Line 2 Flow CTS Role Line 2 Flow RTS Role SPI CS Role SPI INT Role SPI MISO Role SPI MO...

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 configgroup name cpm Include in your file statusgroup name CPM Roles Include in your file statusgroup name CPM CPs CPM Role Current Configuration Description CP View or modify the number of the configurable ...

Page 46: ...TTP 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 disable the HTTP server Enabled default Disabled Port Enter the port for the HTTP server to use The default 80 will be restored when the field is cleared Inactivity Timeout Enter the amount of time the...

Page 47: ...rver 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 for the status header statusgroup name HTTP Server ...

Page 48: ...System 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 Look for the status header statusgroup name File System File Display It is possible to view the list of existing files and to view their contents To Display Files Using Web Manager To view existing fil...

Page 49: ...g 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 they will apply after a reboot Without saving cached configuration changes are lost after a reboot Reboot button Reboots the device When rebooted your browser should be refreshed and redirected to t...

Page 50: ...are 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 Admin User on the Device Using Web Manager To change the password setting click Users in the menu Using CLI To enter the Users command level config Users Using XML Look for the status header configg...

Page 51: ...iagnostics 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 Sockets Using CLI To enter the IP Sockets command level status Diagnostics IP Sockets Using XML Include in your file statusgroup name Diagnostics IP Sockets To View Buffer Pool Status Using WebManager To ...

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 will automatically install into your PC 2 Configure command line on line and select hardware or software flow control Note If you are using line 2 select software flow control as hardware flow control...

Page 53: ...nfiguration 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 configuration Note Software flow control experiences overrun above 460800 baud Performance Settings Change settings pertaining to performance including application maximum time powered down wake up pin power u...

Page 54: ...erver 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 Include in your file configgroup name Performance ...

Page 55: ...d 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 Note In subsequent screens Commands Control and Poll in Explorer or under Configuration additional Message Number fields will become available to further filter and specify the information you wish to ...

Page 56: ...lected 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 configuration fields will open for this selector When you begin entering information in these fields additional Selector Number options become available containing the three selector configuration fiel...

Page 57: ...also 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 or as a control character Control characters may be input as control J 0xA hexadecimal or 10 decimal Length set the length of the response Timeout set the timeout length Minimum timeout length is 100 ...

Page 58: ...of 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 the initial delay time in milliseconds before the monitor starts processing the initialization message This field appears in Step 1 Setup Initiation Filter Settings Description Rule Number Click the E...

Page 59: ...ol 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 Data Settings Description Selector Number Click the Edit link to edit a specific selector Three selector configuration fields will open for this selector When you begin entering information in these...

Page 60: ...ng 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 to your xPico Wi Fi unit STEP 3 LINE SETTINGS Set serial line speed flow control and character options on both devices so they are compatible On xPico Wi Fi unit select Monitor under Line Protocol S...

Page 61: ...acter 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 EDS2100 device status In Monitor Poll Configuration set Message 1 Command to show 0x0d Testing with this notice that the default Timeout of 100 milliseconds is too fast we sometimes poll before all ...

Page 62: ...ultiple 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 sliced into pieces right in your browser windows Sample Configuration First slice the response into lines point to the one containing Uptime then slice between the caption and the time value Setup a...

Page 63: ...aw 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 configure settings in Monitor Data Configuration Each Selector picks out a distinct data item you wish to subsequently present The Selector Name will be presented as the caption for your data Selector...

Page 64: ...r 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 data In the XML status dump find statusgroup name Monitor then statusitem name data instance the name you gave your data and value contains the data received Sample Configuration We visit our device...

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 SPI port to peripheral device query and capture desired information periodically present on Web page ...

Page 66: ...quired 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 lantronix directory resource main web_manager web 3 Upload your file into the directory in step 2 4 Restart the browser to view the changes To go back to the default files in the firmware image simply ...

Page 67: ...overridden 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 web img bg gif Main background resource main web_manager web img company_logo gif Company logo in header container resource main web_manager web img favicon ico Shortcut icon resource main web_manag...

Page 68: ...irmware 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 on page 49 for options to restore factory defaults or reboot the debice Figure 13 1 Uploading New Firmware 2 Click Firmware Upload 3 Click Okay to confirm uploading a new firmware image You will be re...

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 reboot afterwards 8 Close and reopen the Web Manager internet browser to view the device s updated web pages ...

Page 70: ...r 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 administrators XML configuration records are easy to edit with a standard text editor or an XML editor For a brief overview of XML see Configuration Using XML It provides rules on basic XML syntax a guide to the ...

Page 71: ...trol 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 serial ports 2 Configure the terminal to the following settings 9600 baud 8 bit No parity 1 stop bit Flow control enabled Note Lantronix recommends using hardware flow control 3 Power off the device 4 ...

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 typing SPI To view the tlog type tlog or t at the root level Using Keyboard Shortcuts and CLI One useful shortcut built into xPico Wi Fi embedded device server is that the complete text of a command do...

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 status information only Figure A 2 Root Level Commands config file system help status tlog wlan scan network name xml exit Configuration Using XML The xPico Wi Fi embedded device server provides an E...

Page 74: ...LIST 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 XML document element is a configrecord element This is the root element A configrecord must have one or more configgroup elements and can have a version attribute A configgroup must have one or more c...

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 the start tag after the element name The values must always be quoted using single or double quotes Each attribute name should appear only once in an element Figure A 4 shows an XML example which con...

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 which of several instances is being addressed It is always quoted For example the serial port name in the line configgroup has the instance 1 to indicate serial port 1 or 2 to specify serial port 2 Th...

Page 77: ...ult 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 combination of CCMP or TKIP configitem Passphrase value Passphrase may contain up to 63 characters The value is HIDDEN configitem Mode value Mode may be Always Up or Triggered configitem Uptime value Uptime h...

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 a voltage higher than VDD 0 3 the Mode must be set to Push Pull Mode may be Push Pull or Weak Pullup configgroup HTTP Server These settings pertain to the HTTP Server Changes will take effect after r...

Page 79: ...after 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 Address will be the Access Point s IP Address plus one For example if the Access Point s IP Address is 192 168 0 1 the client addresses will range from 192 168 0 2 to 192 168 0 5 configitem State valu...

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 and may figure into the address assignment This setting is not applicable to the Access Point Hostname may contain up to 63 characters configitem Primary DNS value The Primary DNS is the first choice w...

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 interface containing commands to show device status and to change configuration Simply paste in XML configuration to apply its settings to the device Protocol may be Command Line Modem Emulation Monitor Non...

Page 82: ...racter 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 four character periods at the current baud rate minimum 1 ms Gap Timer has units of milliseconds Blank the value for Four Character Periods configitem Threshold value The driver will forward received...

Page 83: ...me 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 configitem Name value The Name is for display purposes only Name may contain up to 25 characters configitem State value State selects the operating state of the SPI Enabled enables the SPI Disabled disables t...

Page 84: ...Edge 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 Clock Level is Low data is latched on the rising edge When Idle Clock Level is High data is latched on the falling edge Second means each bit is latched on the second edge of the clock This is equivale...

Page 85: ...ngs 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 point on a different wireless channel current connection to the soft AP interface of the device may be dropped due to the switch of channel Reconnect to the soft AP interface in order to continue ac...

Page 86: ...ced 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 beacons 100 ms each configgroup XML Import Control No help available configitem Restore Factory Configuration value Restore Factory Configuration may be Enabled or Disabled configitem Reboot value Rebo...

Page 87: ...value 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 value With Verbose Reponse enabled ATQ0 Modem Response Codes are sent out on the Serial Line Verbose Response may be Enabled or Disabled configitem Response Type value Response Type selects either Text A...

Page 88: ...ttings 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 will be overwritten by any poll or control response configitem Initial Delay value Sets Initial Delay waited before monitor start processing any initialization message Initial Delay has units of millis...

Page 89: ...captured 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 format takes printable characters e g abc for characters a b and c or binary string e g 0xa 0xd for line feed and carriage return Command may contain up to 16 bytes value End Character Sets the End C...

Page 90: ...tain 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 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 End Character may contain one character where co...

Page 91: ...unks 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 Binary String Sets Binary String delimiter in binary format Delimiters break input up to 8 trunks separated by but not containing delimiters A delimiter is recognized if any of the Binary String is co...

Page 92: ...f 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 a tunnel behaves when a connection attempt originates from the network configitem Mode value An Accept Tunnel can be started in a number of ways according to its Mode Disabled never started Always al...

Page 93: ...t 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 connection is accepted from the network If Enabled any buffered characters from the Serial Line will be discarded when a connection is accepted If Disabled any characters received on the Serial Line will...

Page 94: ...from 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 00 Carriage Return Null If Prompt for Password is set to Enabled the user will be prompted for the password upon connection Password may contain up to 31 characters The value is HIDDEN configitem Prom...

Page 95: ...e 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 Character may contain one character where control J for example counts as one configitem Flush Start Character value Enabling Flush Start Character prevents forwarding of a start character from the Lin...

Page 96: ...conds 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 configitem Flush Line value Flush Line applies at the time when a connection is established to the network If Enabled any buffered characters from the Serial Line will be discarded when a connection is es...

Page 97: ...haracter 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 Stop Character may contain one character where control J for example counts as one configitem Flush Stop Character value Enabling Flush Stop Character prevents forwarding of a stop character from the...

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 the network immediately Timeout has units of milliseconds configitem Threshold value If the number of bytes of queued data reaches the Threshold the queued data will be sent on the network immediately ...

Page 99: ...le 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 10 decimal Disable the Trailing Character by blanking the field to set it to None Trailing Character may contain one character where control J for example counts as one ...

Page 100: ...eparated 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 POST d optionalGroupList Device Javascript example myXmlhttprequest open POST export status true request send optionalGroupList Device Export Configuration Group An HTTP POST request can be sent to ...

Page 101: ...TP 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 optionalGroupInstance Optional instance of status group optionalItem Optional item of status group where action is defined optionalItemInstance Optional instance of status item action Required The action to be...

Page 102: ...tring configrecord xml version 1 0 standalone yes Automatically generated XML DOCTYPE configrecord ELEMENT configrecord configgroup ELEMENT configgroup configitem ELEMENT configitem value ELEMENT value PCDATA ATTLIST configrecord version CDATA IMPLIED ATTLIST configgroup name CDATA IMPLIED ATTLIST configgroup instance CDATA IMPLIED ATTLIST configitem name CDATA IMPLIED ATTLIST configitem instance ...

Page 103: ...am 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 com support Tel 31 0 76 52 36 740 Japan japan_sales lantronix com Tel 81 3 6277 8802 Asia Pacific APAC asiapacific_sales lantronix com Tel 852 3428 2338 China Shanghai lantronix com Tel 86 21 6237 8...

Page 104: ...s 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 serial number MAC address Firmware version on the Web Manager Status page or via CLI at the Status Device level Description of the problem Status of the unit when the problem occurred please try to includ...

Page 105: ...5 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 Canada Canada RSS 210 Issue 8 2010 12 Canada RSS Gen Issue 3 2010 12 ANSI C63 10 2009 RSS 102 Issue 4 2010 12 EU EN 300 328 V1 8 1 2012 06 EN 301 489 1 V1 9 2 2011 09 EN 301 489 17 V2 2 1 2012 09 EN 5...

Page 106: ...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 conforme aux exigences essentielles et aux autres dispositions pertinentes de la directive 1999 5 CE Italiano Italian Con la presente Lantroni...

Page 107: ...xpressly 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 other antenna or transmitter Radiation Exposure Statement This equipment complies with FCC radiation exposure limits set forth for an uncontrolled environment This equipment should be installed and operated ...

Page 108: ...ies 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 received including interference that may cause undesired operation Ce dispositif est conforme à la norme CNR 210 d Industrie Canada applicable aux appareils radio exempts de licence Son fonctionnement est ...

Page 109: ...ransmitter 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 de certaines co localisation avec un autre émetteur l autorisation du Canada n est plus considéré comme valide et l ID IC ne peut pas être utilisé sur le produit final Dans ces circonstances l intégrate...

Page 110: ...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 prohibited for use with this device Ce dispositif a été conçu pour fonctionner avec une antenne ayant un gain maximal de PIFA antenne avec dBi 2 5 Une antenne à gain plus élevé est strictement interdite par les ...

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 Hg Cadmium Cd Hexavalent Chromium Cr VI Polybrominate d biphenyls PBB Polybrominated diphenyl ethers PBDE DSC 0 0 0 0 0 0 EDS 0 0 0 0 0 0 IntelliBox 0 0 0 0 0 0 MatchPort 0 0 0 0 0 0 Micro 0 0 0 0 0 ...

Page 112: ...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 to a hexadecimal representation treat the upper and lower four bits separately to produce a two digit hexadecimal number in this case 4C Use the following table to convert values from binary to hexadecimal Scientific Calculator Another simple way to convert binary to hexadecimal is to use a sc...

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 Scientific Calculator ...

Reviews: