Lantronix 900-691-R manual Appendix B WebAPI, Export Status Group, Export Configuration Group

Page 100

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://<hostname>/export/status

Parameters:

optionalLine: Optional line index for line oriented XML groups

optionalGroupList: Optional list of XML groups separated by semicolon. If omitted, all status groups will be returned.

CURL example:

curl -u admin:PASSWORD http://172.19.100.125/export/status -X POST curl -u admin:PASSWORD http://172.19.100.125/export/status -X POST -d "optionalGroupList=Device"

Javascript example: myXmlhttprequest.open(

"POST",

"/export/status", true

);

request.send(

"optionalGroupList=Device"

);

Export Configuration Group

An HTTP POST request can be sent to the device to retrieve configuration information. Protocol: HTTP

Method: Post

URL: http://<hostname>/export/config

Parameters:

optionalLine: Optional line index for line oriented XML groups

optionalGroupList: Optional list of XML groups separated by semicolon. If omitted, all configuration groups will be returned.

xPico® Wi-Fi® Embedded Device Server User Guide

100

Image 100
Contents Embedded Device Server User Guide Warranty Intellectual PropertyContacts DisclaimerTable of Contents Interface Settings Tunnel SettingsConfigurable Pin Manager Services SettingsMaintenance and Diagnostics Settings Advanced SettingsBranding the xPico Wi-Fi Unit MonitorUpdating Firmware Appendix B WebAPI 100Appendix C Technical Support 103 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 Using This Guide Purpose and AudienceSummary of Chapters 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 SeeNetwork Settings Network 1 Interface ap0 ConfigurationTo Configure Network 1 Interface Settings Network Interface SettingsNetwork 1 ap0 Link Settings Network 1 ap0 Link SettingsNetwork 1 ap0 Link Description Settings To View Network 1 Interface StatusTo Configure Network 1 Link Settings To View Network 1 Link StatusMode UptimeTo Configure Network 2 Interface Settings Network 2 wlan0 Interface ConfigurationNetwork Interface Description Settings Network 2 wlan0 Link Status Wlan ProfilesTo View Network 2 Interface Status To View Network 2 Link StatusTo Configure Wlan Profiles To Configure Wlan Profile SettingsWlan Profile Basic Settings Description Creating, Deleting or Enabling Wlan ProfilesWlan Profile Security Settings Wlan Profile Description Security SettingsTo Configure Wlan Quick Connect Wlan Profile Advanced SettingsWlan Profile Advanced Settings Description Wlan Quick ConnectWlan Quick Connect Description Settings Wlan Quick ConnectScan network Ssid Network Name linkInterface Settings Line SettingsLine Configuration Settings Line Settings DescriptionTo Configure Line Settings Gap TimerTo View Line Status Xoff CharTo Configure SPI Settings Serial Perpheral Interface SPI SettingsSPI Configuration Settings To View SPI Status Tunnel Settings Line SettingsTo View Tunnel Serial Settings Tunnel Line SettingsTunnel Packing Mode Settings Packing ModeTunnel Packing Mode Description Settings To Configure Tunnel Packing Mode Settings Accept ModeTunnel Accept Mode Settings Tunnel Accept Mode Description SettingsTo Configure Tunnel Accept Mode Settings Tunnel Connect Mode Settings Connect ModeTunnel Connect Description Mode Settings To Configure Tunnel Connect Mode Settings Disconnect ModeTunnel Disconnect Mode Settings Tunnel Disconnect Description Mode SettingsModem Emulation Settings To Configure Tunnel Disconnect Mode SettingsModem Emulation Settings StatisticsModem Emulation Commands and Descriptions Tunnel SettingsCommand Description ATZ Configurable Pin Manager Configurable Pin StatusCurrent Configurable Pins CP StatusRoles Active in RoleRole Configuration To Configure CPM SettingsCPM Role Current Description Configuration Services Settings Http SettingsTo Configure Http Settings and Access Control Http SettingsTo View Http Status Maintenance and Diagnostics Settings File System SettingsFile System Statistics File DisplayDevice Settings Device Management SettingsFile Manipulation To Transfer or Modify File System FilesTo Configure Admin User on the Device Admin UserAdmin User Settings Diagnostics Settings To View Hardware StatusTo View IP Socket 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 Monitor Settings Monitor Explorer SettingsExplorer Settings Description MonitorRule Number DisplayConfiguration Monitor Initialization SettingsMonitor Control Settings Initialization Description SettingsMonitor Poll Settings Monitor Filter SettingsPoll Settings Description DelayTo Configure Monitor Monitor Data SettingsData Settings Description 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 Branding the xPico Wi-Fi Unit Web Manager CustomizationChanging the Presentation Path FormatOther Overridable Files Updating Firmware Obtaining Firmware Loading New Firmware through Web ManagerUpdating Firmware Appendix a Command Reference ConventionsXML Architecture and Device Control Convention DescriptionSerial Command Mode Configuration Using Serial PortBoot to CLI Using Keyboard Shortcuts and CLI Navigating the CLI HierarchyTable A-1 Keyboard Shortcuts Key Combination DescriptionAppendix a Command Reference Configuration Using XMLUnderstanding the CLI Level Hierarchy XML Configuration Record Document Type Definition Figure A-3 DTD for XCRsQuick Tour of XML Syntax DeclarationElement Start and End Tags Element AttributesRecord, Group, Item, and Value Tags Figure A-5 XML ExampleConfiggroup Access Point XML for xPicoWi-Fi Embedded Device ServerConfiggroup CPM Configgroup Http Server Configitem StateConfigitem Port Configitem Inactivity TimeoutConfigitem Access Control Configgroup InterfaceConfigitem Dhcp Client Configgroup Line Configitem Name Configitem ProtocolConfigitem Baud Rate Configitem ParityConfiggroup Performance Configgroup SPI Configitem Maximum Time Powered DownConfigitem Wkup Pin Power Up Configitem Time Powered UpConfiggroup Users Configgroup Wlan Profile Configitem InstanceConfigitem Password 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 RuleConfiggroup Monitor Data Configgroup Tunnel AcceptConfigitem Selector Configitem Local PortConfigitem Start Character Configitem Flush Start CharacterConfigitem Flush Line Configitem Block LineConfiggroup Tunnel Line Configitem Block NetworkConfigitem Prompt for Password Configitem DTRConfigitem Host Configgroup Tunnel ConnectValue Address Configitem Connections Configitem Reconnect TimeValue Port Value ProtocolConfiggroup Tunnel Disconnect Configitem Stop CharacterConfigitem Flush 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 commandAppendix C Technical Support North AmericaEurope, Middle East, Africa Emea Japan Asia / Pacific ApacLatin America & Caribbean Online Country Specification Appendix D ComplianceTable D-1 Country Certifications Table D-2 Country Transmitter IDsTable D-3 Safety Table D-4 Europe EU Declaration of ConformityFederal Communication Commission Interference Statement Radiation Exposure StatementIndustry Canada Statement End Product LabelingManual Information To the End User Déclaration dexposition aux radiationsPlaque signalétique du produit final Manuel dinformation à lutilisateur final Antenna RequirementTable D-5 Approved Antennas List Type Gain BrandManufacturers Contact RoHS NoticeAppendix E Binary to Hexadecimal Conversions Converting Binary to HexadecimalConversion Table Scientific CalculatorAppendix E Binary to Hexadecimal Conversions