getWifiConnection.lua
[INDEX]

ABSTRACT

Get the WIFI connection settings

ARGUMENTS

HTTP Arguments submit: POST

Test this API over HTTP - (URL):

DeviceObject

Optional. if specified, then it is ObjectID of network interface (Refer to getNetInterface.lua); otherwise, it is the default WIFI interface.

Test value:

Object
(MUST)

The WIFI connection object name (Get it by listWifiConnection.lua - [field 'Object' of each connection item])

Test value:

RETURNS

Return a JSON style result. The JSON format is:

{
/*OBJECT*/

"Result":
NUMBER

200 means OK, other error code meanings are similar to HTTP Response.

"Status":
"STRING"

Status message. Responsing result status of API executive, if there errors, it will describe reasons.

"Data": {
/*OBJECT*/

"MAC":
"STRING"

The MAC address of this WIFI interface

"SSID":
"STRING"

Connection SSID

"BSSID":
"STRING"

The special BSSID (format is like a MAC address) of SSID (If not configured, it will be empty)

"Uuid":

The WIFI connection Uuid

"AutoConnect":
INTEGER

Auto connection option

1

If find hotspot within the scope, it will connect automatically.

0

Need connect this manually (Refer to connectWifi.lua)

"Security":

Connection security option. It's one of these:

none-none

Open (no password)

none-open

WEP 40/128 bits key (Open)

none-share

WEP 40/128 bits key(Share)

none-open-128

WEP 128 bits passphrase (Open)

none-share-128

WEP 128 bits passphrase (Share)

ieee8021x

IEEE 802.1X Dynamic WEP (Not support current)

wpa-psk

WPA/WPA2 (PSK)

wpa-none

WPA/WPA2 (PSK) for AdHoc

"Psk":

Connection password

"DHCP":
INTEGER

1

Get IP addresses by DHCP

0

Manually set IP addresses

"IP":
"STRING"

Manual specified IP address

"Mask":
"STRING"

Manual specified subnet mask

"Prefix":
"STRING"

The subnet prefix

"Gateway":
"STRING"

Manual specified default gateway

"Dns1":
"STRING"

Specified DNS1 or leave empty

"Dns2":
"STRING"

Specified DNS2 or leave empty

}
}

OTHER NOTES

Device HTTP API, v1.0