PRELIMINARY DRAFT xPico Wi-Fi Embedded Device Server User Guide Part Number 691-R Revision A July 2013 PRELIMINARY DRAFT
PRELIMINARY DRAFT Copyright & Trademark © 2013 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. DeviceInstaller™ is a trademark of Lantronix, Inc. Windows® and Internet Explorer® are registered trademarks of Microsoft Corporation.
PRELIMINARY DRAFT Table of Contents Copyright & Trademark ______________________________________________________ 2 Warranty _________________________________________________________________ 2 Contacts _________________________________________________________________ 2 Disclaimer ________________________________________________________________ 2 Revision History ___________________________________________________________ 2 List of Figures _____________________________________________________________ 6 List o
PRELIMINARY DRAFT To View Network 2 Interface Status ________________________________________ 21 Network 2 (wlan0) Link Status _______________________________________________21 To View Network 2 Link Status ____________________________________________ 21 WLAN Profiles ____________________________________________________________ 22 To Configure WLAN Profiles _____________________________________________ 22 To Configure WLAN Profile Settings _______________________________________ 23 WLAN Quick Connect ______
PRELIMINARY DRAFT 8: Advanced Settings 36 XML Import and XML Export _________________________________________________ 36 To Import or Export XML Configuration _____________________________________ 36 9: Updating Firmware 37 Obtaining Firmware ________________________________________________________ 37 Loading New Firmware through Web Manager __________________________________ 37 Appendix A: Technical Support 39 Appendix B: Compliance 40 Federal Communication Commission Interference Statement _____
PRELIMINARY DRAFT List of Figures Figure 2-1 xPico Wi-Fi Product Label ________________________________________________ 13 Figure 3-1 Status Page ____________________________________________________________ 15 Figure 3-2 Components of the Web Manager Page ______________________________________ 16 Figure 9-1 Uploading New Firmware _________________________________________________ 37 xPico® Wi-Fi® Embedded Device Server User Guide PRELIMINARY DRAFT 6
PRELIMINARY DRAFT List of Tables Table 3-3 Web Manager Pages _____________________________________________________ 17 Table 4-1 Network Interface Settings _________________________________________________ 18 Table 4-2 Network 1 (ap0) Link Settings ______________________________________________ 19 Table 4-3 Network Interface Settings _________________________________________________ 20 Table 4-4 Creating, Deleting or Enabling WLAN Profiles __________________________________ 22 Table 4-5 WLAN Profile Basic Se
PRELIMINARY DRAFT 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.
PRELIMINARY DRAFT 1: Using This Guide Document (continued) Description xPico Wi-Fi Evaluation Kit Embedded Device Server User Guide Information needed to use the xPico Wi-Fi on the evaluation board. Com Port Redirector Quick Start Instructions for using the Lantronix Windows-based utility to create and Online Help virtual com ports.
PRELIMINARY DRAFT 2: Introduction This chapter summarizes the basic information and features of the xPico Wi-Fi embedded device server. It provides an overview of key features and describes suitable applications. 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 u.FL connector for external antenna Serial Interface: Two Serial CMOS Ports (3.3V, 5V tolerant)1 1200 to 921.
PRELIMINARY DRAFT 2: Introduction Architecture: ARM Cortex-M3 class processor with on-chip Flash and SRAM 1MB Flash and 128KB SRAM SPI Flash 1 MB Power: Input Voltage: 3.
PRELIMINARY DRAFT 2: Introduction Troubleshooting Capabilities The xPico Wi-Fi offers the abilty to view system log messages. 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.
PRELIMINARY DRAFT 2: Introduction Figure 2-1 xPico Wi-Fi Product Label xPico® Wi-Fi® Embedded Device Server User Guide PRELIMINARY DRAFT 13
PRELIMINARY DRAFT 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.
PRELIMINARY DRAFT 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.
PRELIMINARY DRAFT 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.
PRELIMINARY DRAFT 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. 15 Filesystem Shows file system statistics and lets you perform filesystem operations. 34 HTTP Shows HyperText Transfer Protocol (HTTP) status and lets you change the current configuration and authentication settings.
PRELIMINARY DRAFT 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.
PRELIMINARY DRAFT 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 Network 1 -> Interface -> Status.
PRELIMINARY DRAFT 4: Network Settings Using XML via CLI Include in your file: To View Network 1 Link Status Using Web Manager In Network Link Status, you can view the current operational settings. To view current network (ap0) settings, go to Network on the menu and select Network 1 -> Link -> Status.
PRELIMINARY DRAFT 4: Network Settings Network Interface Settings (continued) Description Secondary DNS Enter the IP address of the secondary Domain Name Server. Note: This setting will be used when Static IP is active. To Configure Network 2 Interface Settings Using Web Manager To modify network 2 WLAN interface information, click Network on the menu and select Network 2 > Interface > Configuration.
PRELIMINARY DRAFT 4: Network Settings WLAN Profiles A WLAN profile defines all of the settings necessary to establish a wireless connection with an access point (in infrastructure mode). A maximum of four profiles can exist on the xPico Wi-Fi at a time and only one profile may be active at any given time. xPico Wi-Fi supports dynamic profiles. Dynamic Profiles are the ones created via QuickConnect.
PRELIMINARY DRAFT 4: Network Settings WLAN Profile Basic Settings (continued) Description View or Edit (link to specific profile) Click on a specific WLAN Profile name to edit the WLAN profile basic settings. 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 existing profile (see Table 4-5, Table 4-6 and Table 4-7).
PRELIMINARY DRAFT WLAN Profile Security Settings Description Password Select the password consists of up to 63 characters. 4: Network Settings 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.
PRELIMINARY DRAFT 4: Network Settings 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. Network Name (link) Lists the SSID of a network.
PRELIMINARY DRAFT 5: Line and Tunnel Settings The xPico Wi-Fi embedded device server has one tunnel through which you may view statistics or configure the Accept Mode. The device has two lines and the second line is available for diagnostic and maintenance. 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.
PRELIMINARY DRAFT 5: Line and Tunnel Settings Using Web Manager To configure a specific line, click Line in the menu and select Line 1 -> Configuration (Table 5-1). Using XML via CLI Include in your file: To View Line Status Using Web Manager To view statistics for a specific line, click Line in the menu and select Line 1 -> Status.
PRELIMINARY DRAFT 5: Line and 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 5-3 Tunnel Packing Mode Settings Tunnel Packing Mode Settings Mode Description Configure the Tunnel Packing Mode. Choices are: Threshold Disable = Data not packed.
PRELIMINARY DRAFT 5: Line and 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 XML via CLI Include in your file: Accept Mode In Accept mode, the xPico Wi-Fi listens (waits) for incoming connections from the network. A remote node on the network initiates the connection.
PRELIMINARY DRAFT Tunnel Accept Mode Settings (continued) Flush Line Description Set whether the serial line data buffer is flushed upon a new network connection. Choices are: Block Line Enabled = if Enabled, incoming characters from the serial line will not be forwarded to the network. Instead, they will be buffered and will eventually flow off the serial line if hardware or software flow control is configured.
PRELIMINARY DRAFT 5: Line and Tunnel Settings Table 5-5 Tunnel Disconnect Mode Settings Tunnel Disconnect Mode Settings Description Stop Character Enter the Stop Character which when received on the Serial Line, disconnects the tunnel. The Stop 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: J or 0xA (hexadercimal) or \10 (decimal).
PRELIMINARY DRAFT 6: 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 access to the device.
PRELIMINARY DRAFT HTTP Access Control Settings (continued) Auth Type Description Select the authentication type: Users 6: Services Settings None: no authentication is necessary. Basic: encodes passwords using Base64. Displays the username allowed to access the configured URI. To Configure HTTP Access Control Using Web Manager To configure HTTP Access Control, click HTTP in the menu and select Access Control.
PRELIMINARY DRAFT 7: Maintenance and Diagnostics Settings Filesystem Settings Use the Filesystem to view Statistics. A user may also compact or format the Filesystem. The xPico Wi-Fi embedded device server uses an EXT3 flash file system to store files. This is a journalled file system, which means that changes to the file system are recorded before the actual changes themselves are made.
PRELIMINARY DRAFT 7: Maintenance and Diagnostics Settings System Management Table 7-2 Management Settings System Settings Description Reboot (button) Reboots the device. When rebooted, your browser should be refreshed and redirected to the main status page after 30 seconds. Note: The redirect will not work as expected if the IP address of the devices changes after reboot. After setting the configuration back to the factory defaults, the device will automatically be rebooted.
PRELIMINARY DRAFT 8: 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. Note: The xPico Wi-Fi module itself only supports serial TTL signaling on both Lines.
PRELIMINARY DRAFT 9: 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 System page. To upload new firmware: 1. Select System in the menu bar. The System page appears.
PRELIMINARY DRAFT 9: Updating Firmware 6. Click OK in the confirmation popup which appears. The firmware will be installed and the device will automatically reboot afterwards. 7. Close and reopen the web manager internet browser to view the device’s updated web pages. Note: You may need to increase HTTP Max Bytes in some cases where the browser is sending data aggressively within TCP windows size limit when file (including firmware upgrade) is uploaded from webpage.
PRELIMINARY DRAFT Appendix A: Technical Support If you are unable to resolve an issue using the information in this documentation, please contact Technical Support: Technical Support US Check our online knowledge base or send a question to Technical Support at http://www.lantronix.com/support. Technical Support Europe, Middle East, Africa Phone: +33 13 930 4172 Email: eu_techsupp@lantronix.com or eu_support@lantronix.
PRELIMINARY DRAFT Appendix B: Compliance (According to ISO/IEC Guide and EN 45014) Manufacturer's Name & Address: Lantronix, Inc.
PRELIMINARY DRAFT Appendix B: Compliance Federal Communication Commission Interference Statement This device complies with Part 15 of the FCC 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. This equipment has been tested and found to comply with the limits for a Class B digital device, pursuant to Part 15 of the FCC Rules.
PRELIMINARY DRAFT Manual Information To the End User The OEM integrator has to be aware not to provide information to the end user regarding how to install or remove this RF module in the user’s manual of the end product which integrates this module. The end user manual shall include all required regulatory information/warning as show in this manual. Industry Canada Statement This device complies with RSS-210 of the Industry Canada Rules.
PRELIMINARY DRAFT 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 Canada authorization is no longer considered valid and the IC 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 Canada authorization.
PRELIMINARY DRAFT RoHS Notice All Lantronix products in the following families are China RoHS-compliant and free of the following hazardous substances and elements: Lead (Pb) Cadmium (Cd) Product Family Name Mercury (Hg) Hexavalent Chromium (Cr (VI)) Polybrominated biphenyls (PBB) Polybrominated diphenyl ethers (PBDE) Toxic or hazardous Substances and Elements Lead (Pb) Mercury (Hg) Cadmium (Cd) Hexavalent Chromium (Cr (VI)) Polybrominate d biphenyls (PBB) Polybrominated diphenyl ethers
PRELIMINARY DRAFT Appendix C: 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.
PRELIMINARY DRAFT Appendix C: Binary to Hexadecimal Conversions Figure C-2 Windows Scientific Calculator 4. Click Hex. The hexadecimal value appears.
