Lantronix 900-691-R manual Appendix a Command Reference, Conventions, Convention Description

Page 70

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. It is most suited for system and network administrators comfortable with using similar interfaces on Enterprise IT and Networking products. It is also helpful as a quick tool for access via the product's serial ports or console/ management ports. XML provides an extensible mode for software developers.

For more information about the Web Manager, see the Chapter 3: Configuration Using Web Manager.

Conventions

The table below lists and describes the conventions used in this book.

Convention

Description

 

 

Bold text

Default parameters.

 

 

Italic text

Required values for parameters

 

 

Brackets [ ]

Optional parameters.

 

 

Angle Brackets < >

Possible values for parameters.

 

 

Pipe

Choice of parameters.

 

 

 

Warning

Warning:

Means that you are in a situation that could cause

 

equipment damage or bodily injury. Before you work on any

 

equipment, you must be aware of the hazards involved with electrical

 

circuitry and familiar with standard practices for preventing accidents.

 

 

Note

Note: Means take notice. Notes contain helpful suggestions, information,

 

or references to material not covered in the publication.

 

 

 

Caution

Caution:

Means you might do something that could result in faulty

 

equipment operation, or loss of data.

 

 

Screen Font

CLI terminal sessions and examples of CLI input.

(Courier New)

 

 

 

 

 

XML Architecture and Device Control

XML is a fundamental building block for the future growth of Machine-to-Machine (M2M) networks. The xPico Wi-Fi embedded device server supports XML configuration records that make configuring the device server easy for users and administrators. XML configuration records are easy to edit with a standard text editor or an XML editor.

For a brief overview of XML, see Configuration Using XML. It provides rules on basic XML syntax, a guide to the specific XML tags used, and a guide to using XML configuration records.

xPico® Wi-Fi® Embedded Device Server User Guide

70

Image 70
Contents Embedded Device Server User Guide Contacts WarrantyIntellectual Property DisclaimerTable of Contents Configurable Pin Manager Interface SettingsTunnel Settings Services SettingsBranding the xPico Wi-Fi Unit Maintenance and Diagnostics SettingsAdvanced Settings MonitorAppendix C Technical Support 103 Updating FirmwareAppendix B WebAPI 100 105Appendix E Binary to Hexadecimal Conversions 112 XPico Wi-Fi Product Label List of FiguresList of Tables XPico Wi-Fi Embedded Device Server User Guide Summary of Chapters Using This GuidePurpose and Audience Chapter DescriptionAdditional Documentation Document DescriptionKey Features IntroductionTroubleshooting Capabilities Protocol SupportAddresses and Port Numbers Configuration MethodsProduct Information Label XPico Wi-Fi Product Label Configuration Using Web Manager Accessing Web ManagerStatus StatusNavigating Web Manager Web Manager ComponentsHelp Area Web Manager Pages Web Manager Description SeeTo Configure Network 1 Interface Settings Network SettingsNetwork 1 Interface ap0 Configuration Network Interface SettingsNetwork 1 ap0 Link Description Settings Network 1 ap0 Link SettingsNetwork 1 ap0 Link Settings To View Network 1 Interface StatusMode To Configure Network 1 Link SettingsTo View Network 1 Link Status UptimeTo Configure Network 2 Interface Settings Network 2 wlan0 Interface ConfigurationNetwork Interface Description Settings To View Network 2 Interface Status Network 2 wlan0 Link StatusWlan Profiles To View Network 2 Link StatusWlan Profile Basic Settings Description To Configure Wlan ProfilesTo Configure Wlan Profile Settings Creating, Deleting or Enabling Wlan ProfilesWlan Profile Security Settings Wlan Profile Description Security SettingsWlan Profile Advanced Settings Description To Configure Wlan Quick ConnectWlan Profile Advanced Settings Wlan Quick ConnectScan network Ssid Wlan Quick Connect Description SettingsWlan Quick Connect Network Name linkLine Configuration Settings Interface SettingsLine Settings Line Settings DescriptionTo View Line Status To Configure Line SettingsGap Timer Xoff CharTo Configure SPI Settings Serial Perpheral Interface SPI SettingsSPI Configuration Settings To View SPI Status To View Tunnel Serial Settings Tunnel SettingsLine Settings Tunnel Line SettingsTunnel Packing Mode Settings Packing ModeTunnel Packing Mode Description Settings Tunnel Accept Mode Settings To Configure Tunnel Packing Mode SettingsAccept Mode Tunnel Accept Mode Description SettingsTo Configure Tunnel Accept Mode Settings Tunnel Connect Mode Settings Connect ModeTunnel Connect Description Mode Settings Tunnel Disconnect Mode Settings To Configure Tunnel Connect Mode SettingsDisconnect Mode Tunnel Disconnect Description Mode SettingsModem Emulation Settings Modem Emulation SettingsTo Configure Tunnel Disconnect Mode Settings StatisticsModem Emulation Commands and Descriptions Tunnel SettingsCommand Description ATZ Current Configurable Pins Configurable Pin ManagerConfigurable Pin Status CP StatusRoles Active in RoleRole Configuration To Configure CPM SettingsCPM Role Current Description Configuration To Configure Http Settings and Access Control Services SettingsHttp Settings Http SettingsTo View Http Status File System Statistics Maintenance and Diagnostics SettingsFile System Settings File DisplayFile Manipulation Device SettingsDevice Management Settings To Transfer or Modify File System FilesTo Configure Admin User on the Device Admin UserAdmin User Settings To View IP Socket Status Diagnostics SettingsTo View Hardware Status To View Buffer Pool StatusTo Import or Export XML Configuration Advanced SettingsXML Import and XML Export Performance Settings Performance SettingsModem Emulation Settings Description To Configure Performance Explorer Settings Description Monitor SettingsMonitor Explorer Settings MonitorRule Number DisplayMonitor Control Settings ConfigurationMonitor Initialization Settings Initialization Description SettingsPoll Settings Description Monitor Poll SettingsMonitor Filter Settings DelayData Settings Description To Configure MonitorMonitor Data Settings Selector NumberExample Data Capture on a Serial Device InitializationPolling Monitor Polling 1Filtering 10 Monitor Filtering 1Data Mining 12 Monitor Data Mining 1Presenting Data Capture on SPI Changing the Presentation Branding the xPico Wi-Fi UnitWeb Manager Customization Path FormatOther Overridable Files Updating Firmware Obtaining Firmware Loading New Firmware through Web ManagerUpdating Firmware XML Architecture and Device Control Appendix a Command ReferenceConventions Convention DescriptionSerial Command Mode Configuration Using Serial PortBoot to CLI Table A-1 Keyboard Shortcuts Using Keyboard Shortcuts and CLINavigating the CLI Hierarchy Key Combination DescriptionAppendix a Command Reference Configuration Using XMLUnderstanding the CLI Level Hierarchy XML Configuration Record Document Type Definition Figure A-3 DTD for XCRsElement Start and End Tags Quick Tour of XML SyntaxDeclaration Element AttributesRecord, Group, Item, and Value Tags Figure A-5 XML ExampleConfiggroup Access Point XML for xPicoWi-Fi Embedded Device ServerConfiggroup CPM Configitem Port Configgroup Http ServerConfigitem State Configitem Inactivity TimeoutConfigitem Access Control Configgroup InterfaceConfigitem Dhcp Client Configgroup Line Configitem Baud Rate Configitem NameConfigitem Protocol Configitem ParityConfiggroup Performance Configitem Wkup Pin Power Up Configgroup SPIConfigitem Maximum Time Powered Down Configitem Time Powered UpConfiggroup Users Configitem Password Configgroup Wlan ProfileConfigitem Instance Configitem BasicConfiggroup XML Import Control Configgroup Modem Emulation Configgroup Monitor Initialization Value Timeout Configgroup Monitor ControlValue Length Configgroup Monitor Poll Configitem DelayConfiggroup Monitor Filter Configitem RuleConfigitem Selector Configgroup Monitor DataConfiggroup Tunnel Accept Configitem Local PortConfigitem Flush Line Configitem Start CharacterConfigitem Flush Start Character Configitem Block LineConfigitem Prompt for Password Configgroup Tunnel LineConfigitem Block Network Configitem DTRConfigitem Host Configgroup Tunnel ConnectValue Address Value Port Configitem ConnectionsConfigitem Reconnect Time Value ProtocolConfigitem Flush Stop Character Configgroup Tunnel DisconnectConfigitem Stop Character Configitem Modem ControlConfiggroup Tunnel Packing Configitem Send CharacterConfigitem Trailing Character Appendix B WebAPI Export Configuration GroupExport Status Group Take Status Action Appendix B WebAPIImport Configuration Group Curl example configuration as part of commandEurope, Middle East, Africa Emea Appendix C Technical SupportNorth America Japan Asia / Pacific ApacLatin America & Caribbean Online Table D-1 Country Certifications Country SpecificationAppendix D Compliance Table D-2 Country Transmitter IDsTable D-3 Safety Table D-4 Europe EU Declaration of ConformityFederal Communication Commission Interference Statement Radiation Exposure StatementManual Information To the End User Industry Canada StatementEnd Product Labeling Déclaration dexposition aux radiationsPlaque signalétique du produit final Table D-5 Approved Antennas List Manuel dinformation à lutilisateur finalAntenna Requirement Type Gain BrandManufacturers Contact RoHS NoticeConversion Table Appendix E Binary to Hexadecimal ConversionsConverting Binary to Hexadecimal Scientific CalculatorAppendix E Binary to Hexadecimal Conversions