Lantronix SGX 5150 IoT Device Gateway SGX 5150 Command Reference - Page 61

5: Configuration Using Web API

SGX 5150 IoT Device Gateway Command Reference

61

Note:

When you see “NULL” after optionalGroupInstance, optionalItem, or

optionalItemInstance, it means that item or instance should be omitted.

group "Clock" optionalGroupInstance NULL

optionalItem NULL optionalItemInstance NULL

action "Current Time <value>"

The format for setting time is YYYY-MM-DD hh:mm:ss, where the hours are in 24-hour format. The

xPico Wi-Fi supports dates in the range 2007-01-01 00:00:00 to 2039-12-31 23:59:59 UTC.

group "Device" optionalGroupInstance NULL


action "Save"

The Save action works like the "write" command. Any cached configuration changes are

committed, so they will apply after a reboot.

Without a Save, any cached configuration changes are lost after a reboot.


action "Reboot"

The Reboot action shuts the device down and restarts it. Any cached configuration changes (those

which have not been saved) are lost.


action "Factory Defaults"

The Factory Defaults action restores the device configuration as it came from the factory. Any user

changes to configuration are lost.


action "Firmware Upload"

The Firmware Upload action boots up the OTA loader. Then the OTA loader will allow you to

browse for the file to upload.

group "Filesystem" optionalGroupInstance NULL


action "Format"

Format clears out the flash file system, preserving only system configuration data. Be careful! All

other files are destroyed.

group "Interface" optionalGroupInstance Required


optionalHost NULL port Required optionalProtocol NULL (defaults to UDP)

data Required

action "Send"

The Send action causes the device to send a UDP/TCP packet to the bridged host.

The data bytes are hex encoded but sent as binary.

Section	Page
PremierWave® 2050 SGX 5150 IoT Device Gateway Command Reference	1
Intellectual Property	2
Warranty	2
Contacts	2
Disclaimer	2
Open Source Software	3
Revision History	3
Table of Contents	4
List of Figures	6
List of Tables	7
1: About This Guide	8
Chapter Summaries	8
Conventions	8
Additional Documentation	9
2: Overview	10
XML Architecture and Control	10
Command Line Interface	10
Web API	10
3: Command Line Interface	11
Configuration Using Telnet	11
Configuration Using the Serial Lines	11
Serial Command Mode	11
Serial Recovery	11
To configure the SGX 5150 IoT device gateway locally using a serial port:	12
Navigating the CLI Hierarchy	12
Using Keyboard Shortcuts and CLI	13
Understanding the CLI Level Hierarchy	13
4: Configuration Using XML	16
XML Configuration Record Document Type Definition	16
Quick Tour of XML Syntax	17
Declaration	17
Element Start and End Tags	17
Element Attributes	17
Record, Group, Item, and Value Tags	18
Importing and Exporting an XML Configuration File	20
Best Practices	20
Exporting	20
Importing	20
XML Configuration Groups	21
XML Status Record Groups and Items	44
5: Configuration Using Web API	58
Overview	58
Device Actions API	58
File System API	58
Device Actions API	58
Export Status Group	58
Parameters:	58
CURL example:	58
Javascript example:	59
Export Configuration Group	59
Parameters:	59
CURL example:	59
Javascript example:	59
Import Configuration Group	59
Parameters:	59
CURL example (configuration is saved in a local file config.xml):	59
CURL example (configuration as part of command):	60
HTTP example:	60
Take Status Action	60
Parameters:	60
Actions Definitions	60
group \	61
group \	61
group \	61
group \	61
group \	62
group \	63
group \	63
File System Web API	63
HTTP GET	64
HTTP PUT	64
HTTP MKCOL	65
HTTP DELETE	66

Lantronix SGX 5150 IoT Device Gateway SGX 5150 Command Reference - Page 61

group \, action Factory Defaults

Page 61 highlights