Related Manuals for Lantronix XPico 900-691-R
Summary of Contents for Lantronix XPico 900-691-R
- Page 1 xPico Wi-Fi Embedded Device Server User Guide Part Number 900-691-R Revision D February 2014...
-
Page 2: Intellectual Property
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. -
Page 3: Table Of Contents
Table of Contents Intellectual Property ________________________________________________________ 2 Warranty _________________________________________________________________ 2 Contacts _________________________________________________________________ 2 Disclaimer ________________________________________________________________ 2 Revision History ___________________________________________________________2 List of Figures _____________________________________________________________8 List of Tables _____________________________________________________________9 1: Using This Guide Purpose and Audience _____________________________________________________ 11 Summary of Chapters ______________________________________________________ 11 Additional Documentation ___________________________________________________ 12 2: Introduction Key Features _____________________________________________________________ 13... - Page 4 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 _______________________________________ 26 WLAN Quick Connect ______________________________________________________ 28 To Configure WLAN Quick Connect ________________________________________ 28...
- Page 5 To View HTTP Status ___________________________________________________ 47 9: Maintenance and Diagnostics Settings 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 _______________________________________________________ 48 File Manipulation ______________________________________________________ 49 To Transfer or Modify File System Files _____________________________________ 49 Device Settings ___________________________________________________________ 49...
- Page 6 Path Format __________________________________________________________ 66 Other Overridable Files _________________________________________________ 67 13: Updating Firmware Obtaining Firmware ________________________________________________________ 68 Loading New Firmware through Web Manager __________________________________ 68 Appendix A: Command Reference Conventions _____________________________________________________________ 70 XML Architecture and Device Control __________________________________________ 70 Configuration Using Serial Port _______________________________________________71 Boot to CLI ___________________________________________________________ 71 Navigating the CLI Hierarchy ________________________________________________ 72 Using Keyboard Shortcuts and CLI ____________________________________________ 72...
- Page 7 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 _______________________________________ 109 Manual Information To the End User ______________________________________ 109 Manuel d'information à...
-
Page 8: List Of Figures
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)___________________________________________________ 61 Figure 11-10 Monitor Filtering (1 of 2)_________________________________________________ 62 Figure 11-11 Monitor Filtering (2 of 2)_________________________________________________ 62... -
Page 9: List Of Tables
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 _______________________________________________27 Table 4-6 WLAN Profile Security Settings _____________________________________________ 27 Table 4-7 WLAN Profile Advanced Settings ___________________________________________ 28... - Page 10 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...
-
Page 11: 1: Using This Guide
Appendix B: WebAPI Instructions for viewing status information and configuring a unit through HTTP request. Appendix C: Technical Support Instructions for contacting Lantronix Technical Support. Appendix D: Compliance Lantronix compliance information. Appendix E: Binary to Hexadecimal Instructions for converting binary values to hexadecimals. -
Page 12: Additional Documentation
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 Information about the xPico Wi-Fi hardware, testing the device server Server Integration Guide using the demonstration board, and integrating the unit into your product. -
Page 13: 2: Introduction
USB Interface 2.0 (device) USB2.0 (12 Mbps) Full Speed Device port interfaces for connection to an upstream USB device. Support for USB CDC Serial profile (Future Release, contact Lantronix for more information). GPIO Interface 8 configurable general purpose Input/Output pins... -
Page 14: Protocol Support
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... -
Page 15: Configuration Methods
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. -
Page 16: Figure 2-1 Xpico Wi-Fi Product Label
2: Introduction Figure 2-1 xPico Wi-Fi Product Label xPico® Wi-Fi® Embedded Device Server User Guide... -
Page 17: 3: Configuration Using 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 DHCP. -
Page 18: Status Page
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. Figure 3-1 Status Page xPico® Wi-Fi® Embedded Device Server User Guide... -
Page 19: Web Manager Components
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 Links to configure subpages Header Menu Bar Footer Information Configuration and/or Status Area and Help Area Navigating Web Manager The Web Manager provides an intuitive point-and-click interface. -
Page 20: Table 3-3 Web Manager Pages
3: Configuration Using Web Manager Table 3-3 Web Manager Pages Web Manager Page Description Page Status Shows product information, network, line status, and tunneling settings. Shows information about the Configurable Pins Manager (CPM) and how to set the configurable pins and roles to work with a device. Device Lets you reboot the device, restore factory defaults and upload new firmware. -
Page 21: 4: Network Settings
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. -
Page 22: To View Network 1 Interface Status
Note: This configuration option becomes available only when suites WPA or WPA2 are selected. 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.) ASCII is translated directly into... -
Page 23: To Configure Network 1 Link Settings
4: Network Settings Network 1 (ap0) Link Description Settings (continued) Mode Select the desired mode for the link connection from the drop-down menu: Always Up: when enabled, the SoftAP is always on. Triggered: when enabled, the SoftAP operates in Triggered mode. ... -
Page 24: Network 2 (Wlan0) Interface Configuration
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 Description Settings... -
Page 25: To View Network 2 Interface Status
4: Network Settings Using XML Include in your file: <configgroup name = "Interface" instance = "wlan0"> 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. -
Page 26: To Configure Wlan Profiles
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). -
Page 27: Table 4-5 Wlan Profile Basic Settings
4: Network Settings 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-5 WLAN Profile Basic Settings WLAN Profile Basic Description Settings... -
Page 28: Wlan Quick Connect
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.) -
Page 29: Table 4-8 Wlan Quick Connect
4: Network Settings Using XML Not applicable. Table 4-8 WLAN Quick Connect WLAN Quick Connect Description Settings Network Name (search field) Enter a network name and click Scan to search for a network. Scan “<network SSID>” 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. -
Page 30: 5: Interface Settings
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. -
Page 31: To Configure Line Settings
5: Interface Settings Line Settings Description 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 ... -
Page 32: Serial Perpheral Interface (Spi) Settings
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. -
Page 33: To View Spi Status
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. Using CLI To enter the SPI command level: status -> SPI ... -
Page 34: 6: Tunnel Settings
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. -
Page 35: Packing Mode
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 Description... -
Page 36: To Configure Tunnel Packing Mode Settings
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: ... -
Page 37: To Configure Tunnel Accept Mode Settings
6: Tunnel Settings Tunnel Accept Mode Description Settings (continued) Flush Start Character 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 ... -
Page 38: Connect Mode
6: Tunnel Settings Using XML Include in your file: <configgroup name = "Tunnel Accept" instance = "1"> 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 Description Mode Settings... -
Page 39: To Configure Tunnel Connect Mode Settings
6: Tunnel Settings Tunnel Connect Description Mode Settings Block Network 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. -
Page 40: To Configure Tunnel Disconnect Mode Settings
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: ... -
Page 41: Table 6-7 Modem Emulation Commands And Descriptions
6: Tunnel Settings Modem Emulation Description Settings 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. - Page 42 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. Restore active settings from defaults. AT&F Reset saved settings in NVR to factory defaults. AT&V Display current and saved settings.
-
Page 43: 7: Configurable Pin Manager
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. -
Page 44: Roles
7: Configurable Pin Manager CPM – CPs Status (continued) Description Active in Role Indicates the current active role that uses this pin. If there is currently no role, <available> will display. Click a specific action as desired for the configurable pin: Usage Input ... -
Page 45: To Configure Cpm Settings
7: Configurable Pin Manager Table 7-3 Role Configuration CPM – Role Current Description Configuration View or modify the number of the configurable pin assigned to this role. Enter 0 or blank the field to revert to <No CP Selected>. State View or modify whether the role is enabled or disabled for use. -
Page 46: 8: Services Settings
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. -
Page 47: To View Http Status
8: Services Settings 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: 9: Maintenance And Diagnostics Settings
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. -
Page 49: File Manipulation
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 ... -
Page 50: To Save Configuration, Reboot, Restore Factory Defaults Or Upload Firmware
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, ... -
Page 51: Diagnostics Settings
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. ... -
Page 52: 10: Advanced Settings
To ensure optimal performance when configuring and managing the device using XML, it is required that serial port flow control is enabled. This maybe hardware or soft flow control. Lantronix recommends the use of hardware flow control to ensure the best throughput. To Import or Export XML Configuration 1. -
Page 53: Performance Settings
10: Advanced Settings --------------------------------- ---------------------------------- move cursor to begin of line move cursor backward word delete character under cursor move cursor forward word move cursor to end of line previous command delete to end of line later command redraw line move cursor right redraw line move cursor left... -
Page 54: To Configure Performance
10: Advanced Settings 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: 11: Monitor
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. - Page 56 11: Monitor Explorer Settings Description Rule <Number> 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 <Number> options become available containing the two rule configuration fields which will also open upon clicking Edit.
-
Page 57: Configuration
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. -
Page 58: Table 11-4 Monitor Poll Settings
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 Description Message <Number> 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. -
Page 59: To Configure Monitor
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 Description Selector <Number> Click the Edit link to edit a specific selector. Three selector configuration fields will open for this selector. -
Page 60: Example: Data Capture On A Serial Device
Then we can enter the "enable" command level. Use a null modem cable to connect xPico Wi-Fi unit Line 1 to a Lantronix EDS2100 Line 1. ... -
Page 61: Polling
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. -
Page 62: Filtering
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;... -
Page 63: Data Mining
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. ... -
Page 64: Presenting
11: Monitor Presenting STEP 1 - STRATEGY Here you consider your options for sharing the data Figure 11-14 Monitor Presenting 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. -
Page 65: Data Capture On Spi
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. -
Page 66: 12: Branding The Xpico Wi-Fi Unit
Web Manager files can be overridden with the following procedure: 1. Either create a file from scratch, or edit a copy of the existing Lantronix file. To edit a copy of the original file, do the following: a. Obtain the file by entering the following path in a browser: http://<hostname>/lantronix/resource/main/web_manager/web/<filename>... -
Page 67: Other Overridable Files
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 ... -
Page 68: 13: Updating Firmware
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. - Page 69 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.
-
Page 70: Appendix A: Command Reference
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). -
Page 71: Configuration Using Serial Port
"back door" procedure. The original configured line settings will be restored once the user exits the "back door" CLI, unless any Line 1 settings are changed within the "back door" CLI. To configure the Lantronix xPico Wi-Fi embedded device server locally using a serial port: Note: The xPico Wi-Fi embedded device server requires that flow control be used on the serial port to ensure the best performance when importing XML. -
Page 72: Navigating The Cli Hierarchy
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. -
Page 73: Understanding The Cli Level Hierarchy
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... -
Page 74: Xml Configuration Record Document Type Definition
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... -
Page 75: Quick Tour Of Xml Syntax
Appendix A: Command Reference An empty or missing <value> element in each present <configgroup> clears the setting to its default. Quick Tour of XML Syntax Declaration The first line, <?xml version="1.0" standalone="yes"?>, 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. -
Page 76: Record, Group, Item, And Value Tags
Appendix A: Command Reference Record, Group, Item, and Value Tags A <configgroup> is a logical grouping of configuration parameters and must contain one or more <configitem> elements. It must have a name attribute and may have an instance attribute. A <configitem> 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. -
Page 77: Xml For Xpicowi-Fi Embedded Device Server
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. - Page 78 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 <No CP Selected>. Blank the value for "<No CP Selected>". 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.
- Page 79 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...
- Page 80 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.
- Page 81 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:...
- Page 82 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 <control>.
- Page 83 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 "<Infinite>".
- Page 84 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.
- Page 85 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.
- Page 86 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.
- Page 87 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 "<None>".
- Page 88 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...
- Page 89 Appendix A: Command Reference \10 (decimal) End Character may contain one character, where <control>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.
- Page 90 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 "<Minimum>". configgroup Monitor Poll These settings pertain to Monitor Poll in the device.
- Page 91 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.
- Page 92 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.
- Page 93 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.
- Page 94 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.
- Page 95 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.
- Page 96 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 "<None>". value Protocol The Protocol used on the connection can be TCP. Protocol may be "TCP".
- Page 97 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.
- Page 98 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.
- Page 99 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: <control>J 0xA (hexadecimal) \10 (decimal)
-
Page 100: Appendix B: Webapi
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:... -
Page 101: Take Status Action
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.send( "optionalGroupList= Interface:wlan0" Take Status Action An HTTP POST request can be sent to the device to take a status action. -
Page 102: Import Configuration Group
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://<hostname>/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.xml CURL example (configuration as part of command):... -
Page 103: 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/... -
Page 104: Latin America & Caribbean
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.com/support Download firmware Search and review Frequently asked Questions (FAQs) ... -
Page 105: Appendix D: Compliance
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:... -
Page 106: Table D-3 Safety
Hereby, Lantronix, Inc., declares that this xPico Wi-Fi is in compliance with the English essential requirements and other relevant provisions of Directive 1999/5/EC. Por medio de la presente Lantronix, Inc. declara que el xPico Wi-Fi cumple con los Español [Spanish] requisitos esenciales y cualesquiera otras disposiciones aplicables o exigibles de la Directiva 1999/5/CE. -
Page 107: Federal Communication Commission Interference Statement
Appendix D: Compliance Table D-4 Europe – EU Declaration of Conformity (continued) 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é... -
Page 108: End Product Labeling
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. -
Page 109: End Product Labeling
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. Cet appareil est conçu uniquement pour les intégrateurs OEM dans les conditions suivantes: (Pour utilisation de dispositif module) L'antenne doit être installée de telle sorte qu'une distance de 20 cm est respectée entre l'antenne et les utilisateurs, et... -
Page 110: Manuel D'information À L'utilisateur Final
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. - Page 111 Lantronix, Inc. 167 Technology Drive, Irvine, CA 92618 USA Tel: 949-453-3990 Fax: 949-453-3995 RoHS Notice All Lantronix products in the following families are China RoHS-compliant and free of the following hazardous substances and elements: Lead (Pb) Mercury (Hg) Polybrominated biphenyls (PBB) ...
-
Page 112: Appendix E: Binary To Hexadecimal Conversions
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. -
Page 113: Figure E-2 Windows Scientific Calculator
Appendix E: Binary to Hexadecimal Conversions Figure E-2 Windows Scientific Calculator 4. Click Hex. The hexadecimal value appears. Figure E-3 Hexadecimal Values in the Scientific Calculator xPico® Wi-Fi® Embedded Device Server User Guide...
Need help?
Do you have a question about the XPico 900-691-R and is the answer not in the manual?
Questions and answers