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

5: Configuration Using Web API

SGX 5150 IoT Device Gateway Command Reference

62

optionalItem NULL optionalItemInstance NULL

action "Renew"

The Renew action causes the device to drop its dynamic IP address and request an address from

the DHCP server.


optionalMethod PushButton (default) or PIN

action "Start WPS"

The ‘Start WPS’ action causes the device start Wi-Fi Protected Setup. optionalMethod can be

used to trigger a Push button or PIN type.


action "Cancel WPS"

The ‘Cancel WPS’ action causes the device cancel a running Wi-Fi Protected Setup task.


action "Trigger Access Point"

The ‘Trigger Access Point’ action causes the device to bring up its access point interface. The

shutdown is as configured.

group "Line" optionalGroupInstance Required


action "Command <value>"

The Command action sends bytes to the Line and picks up bytes in response. The bytes are hex

encoded.

Maximum number of characters to read (n) may be specified; default is unlimited.

Milliseconds total time limit (m) may be specified; default is 1000.

Terminating byte (t) may be specified; default is <None>.

Syntax of <value> is:

[n=<decimal number> ][m=<decimal number> ][t=<hex number> ]<hex bytes to send>

First it must successfully open the Line; select Line Protocol of "None" so it may open it

successfully.

optionalItem "Receiver" optionalItemInstance NULL

action "Receive"

The Receive action picks up characters from the Line.


successfully.

optionalItem "Receiver" optionalItemInstance NULL

action "Hex Receive"

The Hex Receive action picks up bytes from the Line.


successfully.

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 62

group \, action Start WPS

Page 62 highlights