For the complete documentation index, see llms.txt. This page is also available as Markdown.

Basic Properties - Property Subgroup 1.2.2.1.nn

SSID - Property 1.2.2.1.1.1

Property Description

Property OID

1.2.2.1.1.1 / 0x010202010101

Name

SSID

Description

The device uses this property to set SSID for WLAN settings. If the SSID is shorter than 32 bytes, all remaining bytes after the SSID should be set to zeros.

Securing Key

None

Min. Len (b)

32

Max. Len (b)

32

Data Type

Binary

Valid Values

Default

None

SSID - Get Request Example

Example (Hex)

AA00 81040122D101 841AD101 81072B06010401F609 850101 890AE208E206E104E102C100

SSID - Get Response Example

Example (Hex)

AA00 81048222D101 820400000000 8482003AD101 81072B06010401F609 850101 892AE228E226E124E122C1204D7953534944000000000000000000000000000000000000000000000

0000000

SSID - Set Request Example

Example (Hex)

AA00 81040121D111 843AD111 81072B06010401F609 850101 892AE228E226E124E122C120 4D79535349440000000000000000000000000000000000000000000000000000

SSID - Set Response Example

Example (Hex)

AA00 81048221D111 820400000000 8482003AD111 81072B06010401F609 850101 892AE228E226E124E122C1204D7953534944000000000000000000000000000000000000000000000

0000000

Password - Property 1.2.2.1.1.2

Property Description

Property OID

1.2.2.1.1.2 / 0x010202010102

Name

Password

Description

The device uses this property to set password for WLAN settings. If the password is shorter than 63 bytes, all remaining bytes after the password should be set to zeros.

For EAP-PEAP authentication, the maximum length of password is 32 bytes. The real password has to be <= 32 bytes, all bytes after the desired password must be set to zeroes.

For security, the Get request for this property will always return a value with 63 zeroes, so you can only set the password and not get it.

Securing Key

None

Min. Len (b)

63

Max. Len (b)

63

Data Type

Binary

Valid Values

Default

None

Password - Get Request Example

Example (Hex)

AA00 81040110D101 841AD101 81072B06010401F609 850101 890AE208E206E104E102C200

Password - Get Response Example

Example (Hex)

AA00 8104820CD101 820400000000 84820059D101 81072B06010401F609 850101 8949E247E245E143E141C23F00000000

Password - Set Request Example

Example (Hex)

AA00 81040112D111 8459D111 81072B06010401F609 850101 8949E247E245E143E141C23F546F744031386342

Password - Set Response Example

Example (Hex)

AA00 81048212D111 820400000000 84820059D111 81072B06010401F609 850101 8949E247E245E143E141C23F546F744031386342

Security Mode - Property 1.2.2.1.1.3

Property Description

Property OID

1.2.2.1.1.3 / 0x010202010103

Name

Security Mode

Description

The device uses this property to determine the authentication method to be used to connect to an WiFi Access Point.

Securing Key

None

Min. Len (b)

1

Max. Len (b)

1

Data Type

Binary

Valid Values

0x00 = PSK (Personal) Mode, requires Property 1.2.2.1.1.2 Password

0x01 = EAP-PEAP (Enterprise) Mode, requires Property 1.2.2.1.1.2 Password, Property 1.2.2.1.1.C Username

Default

None

Security Mode - Get Request Example

Example (Hex)

AA00 81040103D101 841AD101 81072B06010401F609 850101 890AE208E206E104E102C300

Security Mode - Get Response Example

Example (Hex)

AA00 81048203D101 820400000000 8482001BD101 81072B06010401F609 850101 890BE209E207E105E103C30100

Security Mode - Set Request Example

Example (Hex)

AA00 81040104D111 841BD111 81072B06010401F609 850101 890BE209E207E105E103C30101

Security Mode - Set Response Example

Example (Hex)

AA00 81048204D111 820400000000 8482001BD111 81072B06010401F609 850101 890BE209E207E105E103C30101

Static IP Address - Property 1.2.2.1.1.4

Property Description

Property OID

1.2.2.1.1.4 / 0x010202010104

Name

Static_IP_Address

Description

The device uses this property as its IP address in web socket mode if Property 1.2.2.1.1.5 Use DHCP is set to 0000 (Static IP mode).

Securing Key

None

Min. Len (b)

4

Max. Len (b)

4

Data Type

IP4 Format/quad decimal (x.x.x.x)

Valid Values

0.0.0.0 to 255.255.255

Default

None

Static IP Address - Get Request Example

Example (Hex)

AA00 81040105D101 841AD101 81072B06010401F609 850101 890AE208E206E104E102C400

Static IP Address - Get Response Example

Example (Hex)

AA00 81048205D101 820400000000 8482001ED101 81072B06010401F609 850101 890EE20CE20AE108E106C404C0A80177

Static IP Address - Set Request Example

Example (Hex)

AA00 81040111D111 841ED111 81072B06010401F609 850101 890EE20CE20AE108E106C404C0A8016D

Static IP Address - Set Response Example

Example (Hex)

AA00 81048211D111 820400000000 8482001ED111 81072B06010401F609 850101 890EE20CE20AE108E106C404C0A8016D

Use DHCP - Property 1.2.2.1.1.5

Property Description

Property OID

1.2.2.1.1.5 / 0x010202010105

Name

Use_DHCP

Description

The device uses this property to determine if it gets its IP from a DHCP server or uses a static IP.

0000—use static IP address;

othervalue—get IP address from DHCP server

Securing Key

None

Min. Len (b)

4

Max. Len (b)

4

Data Type

Binary

Valid Values

0000 to FFFF

Default

0001

Use DHCP - Get Request Example

Example (Hex)

AA00 81040117D101 841AD101 81072B06010401F609 850101 890AE208E206E104E102C500

Use DHCP - Get Response Example

Example (Hex)

AA00 81048217D101 820400000000 8482001ED101 81072B06010401F609 850101 890EE20CE20AE108E106C50400000001

Use DHCP - Set Request Example

Example (Hex)

AA00 81040116D111 841ED111 81072B06010401F609 850101 890EE20CE20AE108E106C50400000001

Use DHCP - Set Response Example

Example (Hex)

AA00 81048216D111 820400000000 8482001ED111 81072B06010401F609 850101 890EE20CE20AE108E106C50400000001

Static IP Netmask - Property 1.2.2.1.1.6

Property Description

Property OID

1.2.2.1.1.6 / 0x010202010106

Name

Static_IP_Netmask

Description

The device uses this property as its network mask in web socket mode.

Securing Key

None

Min. Len (b)

4

Max. Len (b)

4

Data Type

IP4 Format/quad decimal (x.x.x.x)

Valid Values

0.0.0.0 to 255.255.255.255

Default

None

Static IP Netmask - Get Request Example

Example (Hex)

AA00 81040118D101 841AD101 81072B06010401F609 850101 890AE208E206E104E102C600

Static IP Netmask - Get Response Example

Example (Hex)

AA00 81048218D101 820400000000 8482001ED101 81072B06010401F609 850101 890EE20CE20AE108E106C604FFFFFF00

Static IP Netmask - Set Request Example

Example (Hex)

AA00 81040119D111 841ED111 81072B06010401F609 850101 890EE20CE20AE108E106C604FFFFFF00

Static IP Gateway - Set Request Example

Example (Hex)

AA00 8104011CD111 841ED111 81072B06010401F609 850101 890EE20CE20AE108E106C704C0A801FE

Static IP Gateway - Set Response Example

Example (Hex)

AA00 8104821CD111 820400000000 8482001ED111 81072B06010401F609 850101 890EE20CE20AE108E106C704C0A801FE

Device Name - Property 1.2.2.1.1.8

Property Description

Property OID

1.2.2.1.1.8 / 0x010202010108

Name

Device Name

Description

The device uses this property to set Device Name for WLAN settings. Device Name is registered to the DNS which adds the domain name to create a hostname. Use Hostname to connect to device WebSocket. If the Device Name is shorter than 64 bytes, all remaining bytes after the Device Name should be set to zeros.

Securing Key

None

Min. Len (b)

64

Max. Len (b)

64

Data Type

Binary

Valid Values

Default

None

Device Name - Get Request Example

Example (Hex)

AA00 81040128D101 841AD101 81072B06010401F609 850101 890AE208E206E104E102C800

Device Name - Get Response Example

Example (Hex)

AA00 81048228D101 820400000000 8482005AD101 81072B06010401F609 850101 894AE248E246E144E142C84064662D787878787878780000000000000000000000000000000000000

00000000000000000000000000000000000000000000000000000000000000000000000

Device Name - Set Request Example

Example (Hex)

AA00 81040127D111 845AD111 81072B06010401F609 850101 894AE248E246E144E142C840 64662D78787878787878000000000000000000000000000000000000000000000000000000000000000

000000000000000000000000000000000000000000000

Device Name - Set Response Example

Example (Hex)

AA00 81048227D111 820400000000 8482005AD111 81072B06010401F609 850101 894AE248E246E144E142C84064662D787878787878780000000000000000000000000000000000000

00000000000000000000000000000000000000000000000000000000000000000000000

Wireless Heartbeat Time - Property 1.2.2.1.1.9

Property OID

1.2.2.1.1.9 / 0x010202010109

Name

Property Description

Wireless Heartbeat Time

Description

The device uses this property to set Heartbeat Time for WLAN settings. Device will check the Websocket connection based on this timer setting. The unit is second.

Securing Key

None

Min. Len (b)

1

Max. Len (b)

1

Data Type

Binary

Valid Values

0x00 to 0xFF

Default

0x00 (disabled)

Wireless Heartbeat Time - Get Request Example

Example (Hex)

AA00 8104011AD101 841AD101 81072B06010401F609 850101 890AE208E206E104E102C900

Wireless Heartbeat Time - Get Response Example

Example (Hex)

AA00 8104821AD101 820400000000 8482001BD101 81072B06010401F609 850101 890BE209E207E105E103C90100

Wireless Heartbeat Time - Set Request Example

Example (Hex)

AA00 8104011CD111 841BD111 81072B06010401F609 850101 890BE209E207E105E103C90120

Wireless Heartbeat Time - Set Response Example

Example (Hex)

AA00 8104821CD111 820400000000 8482001BD111 81072B06010401F609 850101 890BE209E207E105E103C90120

Maximum Client Connections - Property 1.2.2.1.1.A

Property Description

Property OID

1.2.2.1.1.A / 0x01020201010A

Name

Maximum Client Connections

Description

The device uses this property to determine how many clients it will allow to connect to its WLAN WebSocket server at one time. Most use cases will only want to allow one client at a time. If more than one client is connected, all outgoing data from the device will be sent to all clients. For example, all notifications and all command responses will be sent to all clients. If more than one client is connected, any client can send a command to the device at any time. Since having more than one client send commands to the device at the same time can result in command collisions and unexpected device behavior, it is recommended that only one client be in charge of sending commands and that other clients only listen to outgoing messages. A use case for allowing more than once client may be to have a second client for diagnostic or monitoring purposes.

Property 2.1.2.5.6.4 Active Client Connections is related.

Securing Key

None

Min. Len (b)

1

Max. Len (b)

1

Data Type

Binary

Valid Values

0x01 – 0x04

Default

0x01

Maximum Client Connections - Get Request Example

Example (Hex)

AA00 8104 0155D101 840F D101 8501 01 8704 02020101 8902 CA00

Maximum Client Connections - Get Response Example

Example (Hex)

AA0081048255D10182040000000084820010D1018501018704020201018903CA0101

Maximum Client Connections - Set Request Example

Example (Hex)

AA00 81040155D111 8410 D111 850101 8704 02020101 8903 CA0101

Maximum Client Connections - Set Response Example

Example (Hex)

AA0081048255D11182040000000084820010D1118501018704020201018903CA0101

Last updated