xPico Wi-Fi Embedded Device Server User Guide Part Number 900-691-R Revision D February 2014
Intellectual Property © 2014 Lantronix, Inc. All rights reserved. No part of the contents of this book may be transmitted or reproduced in any form or by any means without the written permission of Lantronix. Lantronix and xPico are registered trademarks of Lantronix, Inc. in the United States and other countries. U.S. Patents 7,309,260; 8,024,446; 8,219,661; 7,698,405. Additional patents pending. Windows and Internet Explorer are registered trademarks of Microsoft Corporation.
Table of Contents Intellectual Property ________________________________________________________ 2 Warranty _________________________________________________________________ 2 Contacts _________________________________________________________________ 2 Disclaimer ________________________________________________________________ 2 Revision History ___________________________________________________________2 List of Figures _____________________________________________________________8 List of Tables _________
To Configure Network 2 Interface Settings ___________________________________ 24 To View Network 2 Interface Status ________________________________________ 25 Network 2 (wlan0) Link Status _______________________________________________25 To View Network 2 Link Status ____________________________________________ 25 WLAN Profiles ____________________________________________________________ 25 To Configure WLAN Profiles _____________________________________________ 26 To Configure WLAN Profile Settings _____
To View HTTP Status ___________________________________________________ 47 9: Maintenance and Diagnostics Settings 48 File System Settings _______________________________________________________ 48 File System Statistics ___________________________________________________ 48 To View File System Statistics, Compact or Format the File System _______________ 48 File Display ___________________________________________________________ 48 To Display Files _______________________________________________________
Path Format __________________________________________________________ 66 Other Overridable Files _________________________________________________ 67 13: Updating Firmware 68 Obtaining Firmware ________________________________________________________ 68 Loading New Firmware through Web Manager __________________________________ 68 Appendix A: Command Reference 70 Conventions _____________________________________________________________ 70 XML Architecture and Device Control __________________________
End Product Labeling __________________________________________________ 108 Manual Information To the End User ______________________________________ 108 Industry Canada Statement ________________________________________________ 108 Radiation Exposure Statement ___________________________________________ 108 Déclaration d'exposition aux radiations ____________________________________ 108 End Product Labeling __________________________________________________ 109 Plaque signalétique du produit final ________
List of Figures Figure 2-1 xPico Wi-Fi Product Label ________________________________________________ 16 Figure 3-1 Status Page ____________________________________________________________ 18 Figure 3-2 Components of the Web Manager Page ______________________________________ 19 Figure 11-7 Monitor Initialization ____________________________________________________ 60 Figure 11-8 Monitor Polling (1 of 2)___________________________________________________ 61 Figure 11-9 Monitor Polling (2 of 2)______________
List of Tables Table 3-3 Web Manager Pages _____________________________________________________ 20 Table 4-1 Network Interface Settings _________________________________________________ 21 Table 4-2 Network 1 (ap0) Link Settings ______________________________________________ 22 Table 4-3 Network Interface Settings _________________________________________________ 24 Table 4-4 Creating, Deleting or Enabling WLAN Profiles __________________________________ 26 Table 4-5 WLAN Profile Basic Settings ___________
Table D-3 Safety _______________________________________________________________ 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 xPico® Wi-Fi® Embedded Device Server User Guide 10
1: Using This Guide Purpose and Audience This guide provides the information needed to configure, use, and update the xPico® Wi-Fi® embedded device server. It is intended for software developers and system integrators who are embedding this product into their designs. Summary of Chapters The remaining chapters in this guide include: Chapter Description 2: Introduction Main features of the product and the protocols it supports. Includes technical specifications.
1: Using This Guide Additional Documentation Visit the Lantronix Web site at www.lantronix.com/support/documentation for the latest documentation and the following additional documentation. Document Description xPico 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.
2: Introduction This chapter summarizes the basic information and features of the xPico Wi-Fi embedded device server. Key Features Wireless LAN Interface: - IEEE 802.11 b/g and IEEE 802.11n (single stream) - WLAN interface (2.4 GHz only) - IEEE 802.11 d/h/i/j/k/w/r - IEEE 802.11i Support - WEP(Client only), WPA-Personal, WPA2-Personal - u.
2: Introduction - CLI (Serial Monitor Port) - XML Configuration Import and Export (XCR, XML Status Export [XSR]) - WebAPI - Field upgradable firmware (OTA) - Power Management Framework - OEM Support Kit - Simple Customization and device configuration management Security: - 256-bit AES encryption Architecture: - ARM Cortex-M3 class processor with on-chip Flash and SRAM - 1 MB Flash and 128KB SRAM - SPI Flash 1 MB - Zero Host Load Driver Physical Interface: 40-pin Board-to-Bo
2: Introduction Configuration Methods After installation, the xPico Wi-Fi embedded device server requires configuration. For the unit to operate correctly on a network, it must have a unique IP address on the network. These methods may be used for logging into the xPico Wi-Fi and assigning IP addresses and other configurable settings: Web Manager: View and configure settings easily through a web browser using the Lantronix Web Manager. See “Configuration Using Web Manager” on page 17.
2: Introduction Figure 2-1 xPico Wi-Fi Product Label xPico® Wi-Fi® Embedded Device Server User Guide 16
3: Configuration Using Web Manager This chapter describes how to configure the xPico Wi-Fi embedded device server using Web Manager, the Lantronix browser-based configuration tool. The unit’s configuration is stored in nonvolatile memory and is retained without power. All changes take effect immediately, unless otherwise noted.
3: Configuration Using Web Manager 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.
3: Configuration Using Web Manager Web Manager Components The layout of a typical Web Manager page is below. Figure 3-2 Components of the Web Manager Page Items to configure Links to subpages Header Menu Bar Footer Configuration and/or Status Area Information and Help Area Navigating Web Manager The Web Manager provides an intuitive point-and-click interface. A menu bar on the left side of each page provides links you can click to navigate between pages.
3: Configuration Using Web Manager Table 3-3 Web Manager Pages Web Manager Page Description See Page Status Shows product information, network, line status, and tunneling settings. 18 CPM Shows information about the Configurable Pins Manager (CPM) and how to 43 set the configurable pins and roles to work with a device. Device Lets you reboot the device, restore factory defaults and upload new firmware. 49 Diagnostics Lets you perform various diagnostic procedures.
4: Network Settings The Network Settings show the status of the Software enabled Access Point (SoftAP) or WLAN interface/link and let you configure the settings on the device. Interface settings are related to the configuration of the IP and related protocols. Link settings are related to the physical link connection, which carries the IP traffic. The xPico Wi-Fi embedded device server contains two network interfaces.
4: Network Settings To View Network 1 Interface Status Using Web Manager In Network Interface Status, you can view both the current operational settings as well as the settings that would take effect upon a device reboot. To view current access point (ap0) settings, go to Network on the menu and select ap0 -> Interface -> Status.
4: Network Settings Network 1 (ap0) Link Settings (continued) Description Mode Select the desired mode for the link connection from the drop-down menu: Uptime 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.
4: Network Settings Network 2 (wlan0) Interface Configuration This page is used to configure the network 2 interface on the device. To see the effect of these items after a reboot, view the Status page. Table 4-3 Network Interface Settings Network Interface Settings Description State Click to enable or disable the WLAN interface. DHCP Client Click to enable or disable the DHCP client. If enabled, any configured IP address, network mask, gateway or hostname will be ignored.
4: Network Settings Using XML Include in your file: To View Network 2 Interface Status Using Web Manager In Network Interface Status, you can view both the current operational settings as well as the settings that would take affect upon a device reboot. To view current access piont (ap0) settings, go to Network on the menu and select wlan0 -> Interface -> Status.
4: Network Settings WLAN Profile WEP Settings WEP is a simple and efficient security mode encrypting the data via the RC4 algorithm. However, WEP has become more vulnerable due to advances in hacking technology. State of the art equipment can find WEP keys in five minutes. For stronger security, please use WPA, or better, WPA2 with AES (CCMP). WEP is only supported on the STA interface.
4: Network Settings Using CLI To enter the WLAN Profile command level: config -> WLAN Profile Using XML Include in your file: Table 4-5 WLAN Profile Basic Settings WLAN Profile Basic Settings Description Network Name (SSID) Specify the name of the wireless network (SSID.) State Select to enable or disable this profile.
4: Network Settings WLAN Profile Security Settings Description WPAX Passphrase Select the password consists of up to 63 characters. Note: Lantronix recommends using a passphrase of 20 characters or more for maximum security. Spaces and punctuation characters are permitted. The passphrase input is not the same as ASCII input (as used on some products.
4: Network Settings Using XML Not applicable. Table 4-8 WLAN Quick Connect WLAN Quick Connect Settings Description Network Name (search field) Enter a network name and click Scan to search for a network. Scan “” Perform a scan for devices within range of the xPico Wi-Fi. Including the optional network SSID limits the scan to devices configured with the specified network SSID. Omitting the network SSID performs a scan for all devices in range.
5: Interface Settings Line Settings The Line Settings allow configuration of the serial lines (ports). Some settings may be specific to only certain lines. Such settings are noted below. Note: The settings described below apply to both Line 1 and Line 2 unless otherwise noted. Table 5-1 Line Configuration Settings Line Settings Description Name Enter a name or short description for the line, if desired. By default, there is no name specified. A name that contains white space must be quoted.
5: Interface Settings Line Settings Xoff Char Description 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 Gap Timer Set the Gap Timer delay to Set the number of milliseconds to pass from the last character received before the driver forwards the received serial bytes.
5: Interface Settings Serial Perpheral Interface (SPI) Settings SPI settings pertaining to the bus master device can be modified in the xPico Wi-Fi unit. SPI settings, like line settings, allow for the selection of a protocol to be used with SPI. Changes take effect immediately. Table 5-2 SPI Configuration Settings Line Settings Description Name Enter a name or short description for the line, if desired. By default, there is no name specified. This name is for display only.
5: Interface Settings 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.
6: Tunnel Settings The xPico Wi-Fi embedded device server has two lines available for tunneling. Tunnel Settings Tunneling allows serial devices to communicate over a network, without “being aware” of the devices which establish the network connection between them. Tunneling parameters are configured using the Tunnel menu and submenus. The Tunnel settings allow you to configure how the Serial-Network tunneling operates.
6: Tunnel Settings Packing Mode With Packing, data from the serial Line is not sent over the network immediately. Instead, data is queued and sent in segments, when either the timeout or byte threshold is reached. Packing applies to both Accept and Connect Modes. Table 6-2 Tunnel Packing Mode Settings Tunnel Packing Mode Settings Mode Description Configure the Tunnel Packing Mode. Choices are: Timeout Disable = Data not packed. Timeout = data sent after timeout occurs.
6: Tunnel Settings To Configure Tunnel Packing Mode Settings Using Web Manager To configure the Packing mode for a specific tunnel, click Tunnel in the menu and select Tunnel 1 -> Packing. Using CLI To enter the Tunnel command level: config -> Tunnel Using XML Include in your file: Accept Mode In Accept mode, the xPico Wi-Fi listens (waits) for incoming connections from the network.
6: Tunnel Settings Tunnel Accept Mode Settings (continued) Flush Start Character Description Enable or disable the flush start character: Enabled = prevents forwarding of a start character from the Line into the network. Disabled = the flush start character allows forwarding of a start character from the line into the network. Note: This configuration option becomes available when Start Character is the selected Mode.
6: Tunnel Settings Using XML Include in your file: Connect Mode Specifies the conditions for connecting any Accept Mode connection that may be established locally. Table 6-4 Tunnel Connect Mode Settings Tunnel Connect Mode Settings Mode Description Select the method to start the Connect Tunnel: Local Port View and if desired, override the default Local Value values.
6: Tunnel Settings Tunnel Connect Mode Settings Block Network Description Select to enable or disable the block network, which is used for debugging purposes. Enabled: 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.
6: Tunnel Settings To Configure Tunnel Disconnect Mode Settings Using Web Manager To configure the Disconnect Mode for a specific tunnel, click Tunnel in the menu and select Tunnel 1 -> Disconnect. Using CLI To enter the Tunnel command level: config -> Tunnel Using XML Include in your file: Statistics Tunnel statistics contains data counters, error counters, connection time and connection information.
6: Tunnel Settings Modem Emulation Settings Description Verbose Response Select to enable or disable verbose response. If enabled, modem response codes are sent out on the serial line. Response Type Select either Text or Numeric representation for the modem response codes sent out on the serial line. Error Unknown Commands Select to enable or disable error unknown commands. If enabled, ERROR is returned to the serial line for unrecognized AT commands.
6: Tunnel Settings Command Description ATUn Accept unknown commands. (n=0: off, n=1: on). ATVn Verbose mode (n=0: numeric result codes, n=1: text result 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.
7: Configurable Pin Manager The Configurable Pin Manager (CPM) is responsible for the assignment and control of the configurable pins (CPs) available on the xPico Wi-Fi embedded device server. There are eight configurable pins on the xPico Wi-Fi unit. You must configure the CPs by making them part of a role. A CP role may consist of one or more CPs. This increases flexibility when incorporating the xPico Wi-Fi device into another system.
7: Configurable Pin Manager CPM – CPs Status (continued) Active in Role Description Indicates the current active role that uses this pin. If there is currently no role, will display. Click a specific action as desired for the configurable pin: Note: Usage Input Usage Output Usage Unused Assert High Assert Low Mode Push-Pull Mode Weak Pullup Value 0 Value 1 To modify a CP, all roles in which it is a member must be disabled.
7: Configurable Pin Manager Table 7-3 Role Configuration CPM – Role Current Configuration Description CP View or modify the number of the configurable pin assigned to this role. Enter 0 or blank the field to revert to . State View or modify whether the role is enabled or disabled for use. Assert View or modify the polarity of the cp role as High or Low. Mode Shows the number of CPs assigned to the role.
8: Services Settings HTTP Settings Hypertext Transfer Protocol (HTTP) is the transport protocol for communicating hypertext documents on the Internet. HTTP defines how messages are formatted and transmitted. It also defines the actions web servers and browsers should take in response to different commands. HTTP Authentication enables the requirement of usernames and passwords for device access.
8: Services Settings To View HTTP Status Using Web Manager To view HTTP status, click HTTP in the menu and select Status.
9: Maintenance and Diagnostics Settings File System Settings The xPico Wi-Fi embedded device server uses a flash file system to store files. The file system can be formatted and compacted: formatting erases all files while preserving configuration, and compacting reclaims dirty space while preserving all files. The file system also provides statistics and the ability to create, delete, and manipulate files and directories.
9: Maintenance and Diagnostics Settings Using XML Not applicable. File Manipulation The xPico Wi-Fi embedded device server allows for files to be deleted, moved, renamed, and uploaded via HTTP. Directories can be created, deleted, moved, and renamed. To Transfer or Modify File System Files Using Web Manager To create a new file or directory, upload an existing file, copy or move a file, click File System in the menu and select Browse.
9: Maintenance and Diagnostics Settings Note: Go to Chapter 13: Updating Firmware for directions on uploading new firmware. To Save Configuration, Reboot, Restore Factory Defaults or Upload Firmware Using Web Manager To access the area with options to reboot, restore to factory defaults, upload new firmware, click Device in the menu.
9: Maintenance and Diagnostics Settings Diagnostics Settings The xPico Wi-Fi embedded device server has tools for diagnostics and statistics. Options allow for the viewing of hardware, IP sockets, threads, and buffer pools. To View Hardware Status Using WebManager To view hardware information, click Diagnostics in the menu and select Hardware.
10: Advanced Settings XML Import and XML Export The xPico Wi-Fi embedded device server allows for the configuration of devices by using XML configuration records (XCRs). You can export an existing configuration for use on other xPico WiFi devices or import a saved configuration file. XML import and export are only available through the CLI. Note: The xPico Wi-Fi module itself only supports serial TTL signaling on both Lines.
10: Advanced Settings --------------------------------a move cursor to begin of line d delete character under cursor e move cursor to end of line k delete to end of line l redraw line r redraw line u delete to begin of line w delete word to left ---------------------------------b move cursor backward word f move cursor forward word [A previous command [B later command [C move cursor right [D move cursor left delete word to left > 6.
10: Advanced Settings To Configure Performance Using Web Manager To modify performance settings, click Performance in the menu.
11: Monitor The Monitor feature can be used to query and capture desired information during an xPico Wi-Fi serial port to serial device connection. Monitor Settings Through the Monitor feature in Web Manager, you may configure the monitoring of a connected serial device through a sequence of five pages via Explorer, or go to a specific Configuration page to make specific changes. The device monitoring status can be viewed through the Status page.
11: Monitor Explorer Settings Rule Description Click the Edit link to edit a specific rule in the Step 2: Setup Commands page. Two rule configuration fields will open for this rule. When you begin entering information in these fields, additional Rule options become available containing the two rule configuration fields which will also open upon clicking Edit.
11: Monitor Configuration Configure the monitoring of a connected serial device through specific configuration settings pages : Initialization, Control, Poll , Filter, and Data. Access the configuration options displayed in Table 11-2 on the Initialization page. These configuration fields are the same ones in Step 1: Setup Initiation if utilizing Explorer.
11: Monitor Access the configuration options displayed in Table 11-4 on the Poll page. These configuration fields are the same ones in Step 3: Define Filters if utilizing Explorer. Table 11-4 Monitor Poll Settings Poll Settings Message Description Click the Edit link to edit a specific message; this is where a command is entered. Four message fields will open to allow configuration of a specific command.
11: Monitor Access the configuration options displayed in Table 11-6 on the Data page. These configuration fields are the same ones in Step 4: Pick Data if utilizing Explorer. Table 11-6 Monitor Data Settings Data Settings Selector Description Click the Edit link to edit a specific selector. Three selector configuration fields will open for this selector.
11: Monitor Example: Data Capture on a Serial Device Connect the xPico Wi-Fi serial port to a serial device, then query and capture desired information periodically, presenting this information on a Web page. Sample Configuration Connect to the Command Line Interface (CLI) on the EDS2100. The CLI has menu levels, so we will send commands to exit through multiple levels, knowing that an exit at the top level will just return us to the top level. Then we can enter the "enable" command level.
11: Monitor Polling Figure 11-8 Monitor Polling (1 of 2) Periodically your xPico Wi-Fi will send commands to query information from your serial device. STEP 1 - STRATEGY Explore your serial device and determine your strategy for eliciting all of the desired data with the fewest message Commands. STEP 2 - SETUP Use Monitor Explorer or directly configure settings in Monitor Poll Configuration.
11: Monitor Filtering Figure 11-10 Monitor Filtering (1 of 2) The response to each poll will be sliced up according to your filter rules. The objective is to simply slice enough so you can subsequently point to the data fields you want to mine. Note the raw data in the grey box above; it reflects what was received from the serial device. See "Uptime" in the top right region-that's our target for the example. STEP 1 - STRATEGY Carefully examine the form of the response you received from a particular poll.
11: Monitor Note: Some devices might use a variable number of lines to display status depending on the device state. If so, slicing first by lines will not consistently point to the desired data. Instead, consider a different strategy: Rule 1 can use Mode = Delimiters, but set the Delimiter 1 Binary String = caption. Its field 2 contains all of the response following the caption. Use Rule 2 or more to further slice 1.
11: Monitor Presenting STEP 1 - STRATEGY Here you consider your options for sharing the data you have mined. For human users, a Web page presentation is simplest. For machine-to-machine communication, XML might be best. Command Line could be used for either. Figure 11-14 Monitor Presenting STEP 2 - SETUP Automatically your data is available under status on the Web Manager, XML, and CLI. Advanced Web customization can be done with HTML and JavaScript files dropped into the xPico Wi-Fi unit.
11: Monitor Figure 11-16 Monitor XML Commands For XML 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.
12: Branding the xPico Wi-Fi Unit This chapter describes how to brand the Web Manager user interface of your xPico Wi-Fi embedded device server. Web Manager Customization Changing the Presentation You can customize the Web Manager's appearance by modifying index.html and style.css. The style (fonts, colors, and spacing) of the Web Manager is controlled with style.css and the text and graphics are controlled with index.html.
12: Branding the xPico Wi-Fi Unit Note: This path schema is subject to change in the future. Other Overridable Files In addition to index.html, and style.css, a few other presentation-related files can be 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.
13: Updating Firmware Obtaining Firmware Obtain the most up-to-date firmware and release notes for the unit from the Lantronix Web site (www.lantronix.com/support/downloads/) or by using anonymous FTP (ftp://ftp.lantronix.com/). Loading New Firmware 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.
13: Updating Firmware 5. Select the file and click Open. 6. 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.
Appendix A: Command Reference The xPico Wi-Fi embedded device server supports three convenient configuration methods: Web Manager, Command Line Interface (CLI) and Extensible Markup Language (XML). This appendix describes how to configure the xPico Wi-Fi embedded device server using the Command Line Interface (CLI) and/or Extensible Markup Language (XML). CLI provides an interactive mode for accessing the device configuration and management interface.
Appendix A: Command Reference Configuration Using Serial Port Serial Command Mode The serial port can be configured to operate in command mode permanently or to be triggered under specified conditions. See the line Level command description for more information. Boot to CLI Regardless of the configured settings, the CLI can be accessed via Line 1 using fixed settings and the "back door" procedure.
Appendix A: Command Reference Navigating the CLI Hierarchy The CLI is organized into a hierarchy of levels. Each level has a group of commands for a specific purpose. For example, to view diagnostic or device status, one would navigate to the status level where they could then navigate to diagnostics or device. To move to a different level—Enter the name of the level from within its parent level. For example, to enter the file system level, type file system at the enable prompt.
Appendix A: Command Reference Key Combination (continued) Description Ctrl + k Deletes from the current position to the end of the line Ctrl + l Redraws the command line Ctrl + n Displays the next line in the history Ctrl + p Displays the previous line in the history Ctrl + u Deletes entire line and places cursor at start of prompt Ctrl + w Deletes one word back Ctrl + z Exits the current CLI level Understanding the CLI Level Hierarchy The CLI hierarchy is a series of levels.
Appendix A: Command Reference parameters for a xPico Wi-Fi embedded device server, or it may only change the baud rate for a single serial line. Using XCRs is a straightforward and flexible way to manage the configuration of multiple XPico Wi-Fi embedded device servers. Note: For directions on exporting or importing XML, please refer to XML Import and XML Export.
Appendix A: Command Reference An empty or missing element in each present clears the setting to its default. Quick Tour of XML Syntax Declaration The first line, , is called the XML declaration. It is required and indicates the XML version in use (normally version 1.0). The remainder of the file consists of nested XML elements, some of which have attributes and content.
Appendix A: Command Reference Record, Group, Item, and Value Tags A is a logical grouping of configuration parameters and must contain one or more elements. It must have a name attribute and may have an instance attribute. A is a specific grouping of configuration parameters relevant to its parent group. An item takes the name attribute and must contain one or more value elements.
Appendix A: Command Reference XML for xPicoWi-Fi Embedded Device Server configgroup Access Point These settings pertain to the Access Point in the device. Changes will take effect after reboot. configitem SSID value The default value of SSID is XpicoWiFi_hhhhhh, where hhhhhh are the last 6 hex digits from the BSSID. Blank the value to restore the default. SSID may contain up to 32 characters. configitem Channel value No help available. configitem Suite value Suite may be "None", "WPA" or "WPA2".
Appendix A: Command Reference value CP This is the number of the Configurable Pin (CP) assigned to the role. Enter blank or 0 to revert to . Blank the value for "". value State The Enabled State allows the application to use the designated Configurable Pin. Note that some Roles (those containing a ".") are bundled into a group. Enabling / Disabling any one of them also Enables / Disables the rest of the Roles in the same Group. State may be "Enabled" or "Disabled".
Appendix A: Command Reference configitem Access Control value URI The URI must begin with / to refer to the file system. URI may contain up to 255 characters. value AuthType The different AuthType values offer various levels of security. From the least to most secure: None no authentication necessary Basic encodes passwords using Base64 There is no real reason to create an authentication directive using None unless you want to override a parent directive that uses some other AuthType.
Appendix A: Command Reference configitem IP Address value IP Address may be entered alone, in CIDR form, or with an explicit mask: 192.168.1.1 (default mask) 192.168.1.1/24 (CIDR) 192.168.1.1 255.255.255.0 (explicit mask) The IP Address will be displayed always in CIDR, the canonical form. IP Address may contain up to 31 characters. configitem Default Gateway value The Default Gateway is used only if DHCP Client is disabled, and provides the IP Address of the router.
Appendix A: Command Reference configitem Name value The Name is for display purposes only. Name may contain up to 25 characters. configitem State value Enable the State to allow the Serial Line to operate. State may be "Enabled" or "Disabled". configitem Protocol value Protocol selects the application to connect to the Line: None selects no application to connect to the Line. Tunnel sets up the Line to work with the Tunnel application. See the Tunnel configuration options for details.
Appendix A: Command Reference configitem Stop Bits value Stop Bits may be "1" or "2". configitem Flow Control value Flow Control may be "None", "Hardware" or "Software". configitem Xon Char value When specifying Xon Char, prefix decimal with \ or prefix hexadecimal with 0x or prefix a single control character with . These are used when Flow Control is set to Software. Xon Char may contain one character, where J, for example, counts as one.
Appendix A: Command Reference Instance may contain up to 32 characters. value State Enable the State to allow the named Application to hold power on. State may be "Enabled" or "Disabled". configitem Maximum Time Powered Down value Maximum Time Powered Down has units of seconds. Blank the value for "". configitem WKUP Pin Power Up value WKUP Pin Power Up may be "Enabled" or "Disabled". configitem Time Powered Up value Time Powered Up has units of seconds. Blank the value for "".
Appendix A: Command Reference configitem Target Speed value Target Speed selects the target clock speed of the SPI. 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. Target Speed has units of Hz. Blank the value for "".
Appendix A: Command Reference configitem Instance value Instance may contain up to 16 characters. configitem Password value Password may contain up to 32 characters. The value is HIDDEN. configgroup WLAN Profile These settings pertain to a WLAN Profile on the device. In the Security section, choice of Suite, Key Type and Authentication affect the makeup of other configurables in that section. In the Advanced section, if Power Management is enabled, specify the Power Management Interval.
Appendix A: Command Reference The value is HIDDEN. value WPAx Key Type Key Type may be "Passphrase" or "Hex". value WPAx Passphrase Passphrase may contain up to 63 characters. The value is HIDDEN. value WPAx Key Key may contain up to 32 bytes. The value is HIDDEN. value WPAx Encryption Encryption may contain any combination of "CCMP" or "TKIP". configitem Advanced value TX Power Maximum TX Power Maximum has units of dBm. value Power Management Power Management may be "Enabled" or "Disabled".
Appendix A: Command Reference configitem WLAN Profile delete value name name may contain up to 35 characters. configgroup Modem Emulation Connections can be initiated and accepted using Modem "AT" commands incoming from the Serial Line. configitem Listen Port value Specify a Listen Port to accept connections on. Blank the value for "". configitem Echo Pluses value With Echo Pluses enabled, pluses will be echoed back during a "pause +++ pause" escape sequence on the Serial Line.
Appendix A: Command Reference configitem Incoming Connection value Incoming Connection requests may be disabled (ATS0=0), answered automatically (ATS0=1), or answered manually via the ATA command after an incoming RING (ATS0=2 or higher). Incoming Connection may be "Disabled", "Automatic" or "Manual". configitem Connect String value The Connect String is a customized string that is sent to the Serial Line with the CONNECT Modem Response Code. Connect String may contain up to 30 characters.
Appendix A: Command Reference \10 (decimal) End Character may contain one character, where J, for example, counts as one. value Length Sets the Length of response. Response is ended by any configured End Character, Length OR Timeout. Length has units of bytes. value Timeout Sets the Timeout to receive response. Minimum timeout is 100 milliseconds. Response is ended by any configured End Character, Length OR Timeout. Timeout has units of milliseconds. Blank the value for "".
Appendix A: Command Reference value Timeout Sets the Timeout to receive response. Minimum timeout is 100 milliseconds. Response is ended by any configured End Character, Length OR Timeout. Timeout has units of milliseconds. Blank the value for "". configgroup Monitor Poll These settings pertain to Monitor Poll in the device. Poll Message will be processed periodically. Response will overwrite any response captured during initialization or poll.
Appendix A: Command Reference only once. Delay has units of seconds. configgroup Monitor Filter These settings pertain to Monitor Filter in the device. Filter settings will be applied to all received response. Filter results can be used to feed another filter or use as Data Reference. configitem Rule value Source Sets the Source in dot number format. Source defines the input of a filter. E.g. If the source of this Filter is the second trunk of data created by filter 1, Source must be set to "1.2".
Appendix A: Command Reference configgroup Monitor Data These settings pertain to Monitor Data in the device. Data configured here will be accessible through the status of Monitor. configitem Selector value Name Sets Name to enable the data selector. Name may contain up to 16 characters. value Response Sets Response instance to select the source of data. Response instance corresponds to Poll or Control Message instance. Blank the value for "". value Reference Sets the Reference in dot number format.
Appendix A: Command Reference configitem Protocol value The Protocol used on the connection can be TCP. Protocol may be "TCP". configitem Start Character value When the Start Character is received on the Serial Line, it enables the tunnel to listen for a network connection. The Start Character may be designated as a single printable character or as a control character.
Appendix A: Command Reference 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".
Appendix A: Command Reference configgroup Tunnel Connect Tunnel Connect controls how a tunnel behaves when a connection attempt originates locally. configitem Mode value A Connect Tunnel can be started in a number of ways, according to its Mode: Disabled: never started. Always: always started. Any Character: started when any character is read on the Serial Line. Start Character: started when the Start Character is read on the Serial Line.
Appendix A: Command Reference value Port The Host Port is required to enable a Connect Tunnel. It designates the TCP port on the remote host to connect to. Blank the value for "". value Protocol The Protocol used on the connection can be TCP. Protocol may be "TCP". configitem Connections value Connections controls how multiple hosts shall be used with a Connect Tunnel.
Appendix A: Command Reference 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".
Appendix A: Command Reference configitem Flush Line value Flush Line enabled will flush the Serial Line when the Tunnel is disconnected. Flush Line may be "Enabled" or "Disabled". configgroup Tunnel Packing When Tunneling, instead of sending data on the network immediately after being read on the Serial Line, the data can be Packed (queued) and sent in larger chunks. configitem Mode value A Tunnel can be configured to use Packing Mode in the following ways: Disable: data not packed.
Appendix A: Command Reference configitem Trailing Character value The Trailing Character is an optional single printable 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: J 0xA (hexadecimal) \10 (decimal) Disable the Trailing Character by blanking the field to set it to . Trailing Character may contain one character, where J, for example, counts as one.
Appendix B: WebAPI WebAPI is a cloud function API allowing access to configuration and status information of xPico Wi-Fi embedded device server through standard HTTP request. Export Status Group An HTTP POST request can be sent to the device to retrieve status information. Protocol: HTTP Method: Post URL: http:///export/status Parameters: optionalLine: Optional line index for line oriented XML groups optionalGroupList: Optional list of XML groups separated by semicolon.
Appendix B: WebAPI optionalBoolNeedSecret: To retrieve the original value for hidden configuration, set this to "true". CURL example: curl -u admin:PASSWORD http://172.19.100.125/export/config -X POST curl -u admin:PASSWORD http://172.19.100.125/export/config -X POST -d "optionalGroupList=Interface:wlan0" Javascript example: myXmlhttprequest.open( "POST", "/export/config", true ); request.
Appendix B: WebAPI Import Configuration Group An HTTP POST request can be sent to the device to set configuration. Protocol: HTTP Method: Post Content-Type: multipart/form-data URL: http:///import/config Parameters: configrecord: Content of configuration group in XML format. CURL example (configuration is saved in a local file config.xml): curl -u admin:PASSWORD http://172.19.100.125/import/config -X POST -form configrecord=@config.
Appendix C: Technical Support If you are unable to resolve an issue using the information in this documentation, please contact Technical Support. North America Hours: 6:00am - 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.
Appendix C: Technical Support Latin America & Caribbean la_sales@lantronix.com Tel: +1 949 453 3990 Online Support options listed below are available 24 hours a day, 7 days a week at the Lantronix support page at http://www.lantronix.
Appendix D: Compliance (According to ISO/IEC Guide and EN 45014) Manufacturer's Name & Address: Lantronix, Inc. 167 Technology Drive, Irvine, CA 92618 USA Declares that the following product: Product Name Model: xPico® Wi-Fi® Embedded Device Server Conforms to the following standards or other normative documents: Table D-1 Country Certifications Country Specification FCC Part 15, Subpart B, Class B USA ICES-003:2012 Issue 5, Class B ANSI C63.4-2009 USA FCC Part 15, Subpart C (Section 15.247) ANSI C63.
Appendix D: Compliance Table D-3 Safety Country World Wide Specification CB EN 60950-1:2006 + A11:2009 + A1:2010 + A12:2011 In accordance with the council directive 2006/95/EC US, Canada UL 60950-1 (2nd Edition) Hereby, Lantronix, declares that this xPico Wi-Fi is in compliance with the essential requirements and other relevant provisions of Directive 1999/5/EC. Table D-4 Europe – EU Declaration of Conformity cs Česky [Czech] Lantronix, Inc.
Appendix D: Compliance Table D-4 Europe – EU Declaration of Conformity (continued) sl Slovensko [Slovenian] Lantronix, Inc. izjavlja, da je ta xPico Wi-Fi v skladu z bistvenimi zahtevami in ostalimi relevantnimi določili direktive 1999/5/ES. Slovensky [Slovak] Lantronix, Inc. týmto vyhlasuje, že xPico Wi-Fi spĺňa základné požiadavky a všetky príslušné ustanovenia Smernice 1999/5/ES. fi Suomi [Finnish] Lantronix, Inc.
Appendix D: Compliance IMPORTANT NOTE: In the event that these conditions can not be met (for example certain laptop configurations or co-location with another transmitter), then the FCC authorization is no longer considered valid and the FCC ID can not be used on the final product. In these circumstances, the OEM integrator will be responsible for re-evaluating the end product (including the transmitter) and obtaining a separate FCC authorization.
Appendix D: Compliance As long as 2 conditions above are met, further transmitter test will not be required. However, the OEM integrator is still responsible for testing their end-product for any additional compliance requirements required with this module installed.
Appendix D: Compliance Manuel d'information à l'utilisateur final L'intégrateur OEM doit être conscient de ne pas fournir des informations à l'utilisateur final quant à la façon d'installer ou de supprimer ce module RF dans le manuel de l'utilisateur du produit final qui intègre ce module. Le manuel de l'utilisateur final doit inclure toutes les informations réglementaires requises et avertissements comme indiqué dans ce manuel.
Appendix D: Compliance Manufacturer's Contact: Lantronix, Inc.
Appendix E: Binary to Hexadecimal Conversions Many unit configuration procedures require you to assemble a series of options (represented as bits) into a complete command (represented as a byte). The resulting binary value must be converted to a hexadecimal representation. Use this chapter to learn to convert binary values to hexadecimals or to look up hexadecimal values in the tables of configuration options.
Appendix E: Binary to Hexadecimal Conversions Figure E-2 Windows Scientific Calculator 4. Click Hex. The hexadecimal value appears.
