Secure Remote AT Command Request frame - 0x18
Description
The 0x18 frame is like the 0x17 frame except that it requires a password to function; See KZ (Remote AT Command Password). Use this frame to securely send remote AT commands. The frame requires a correct password to be included as part of the 0x18 command.
If KZ is set:
- The 0x17 frame fails.
- The 0x18 frame only works if it includes the correct password and encryption is enabled.
- Remote commands from other nodes are only accepted if they were sent from a node which also had KZ set.
If KZ is not set:
- You may send 0x17 frames.
- You may send the 0x18 frame with the password field set with ASCII 0.
Format
The following table provides the contents of the frame. For details on frame structure, see API frame format.
|
Frame data fields |
Offset |
Description |
|---|---|---|
|
Frame type |
3 |
0x18 |
|
Frame ID |
4 |
Identifies the frame to correlate with a subsequent remote command response (0x97). |
|
Password Length |
5 |
Specifies how many bytes are in the Password field to follow. Does not include the Length byte itself. |
|
Password |
6 |
The password itself. |
|
64-bit destination address |
7+password length |
The 64-bit address of the destination node which is receiving this command, MSB first, LSB last. |
|
Reserved |
15+password length |
This field is unused for DigiMesh, but it can be used in protocols that support 16-bit addresses, for example Zigbee. For DigiMesh, the value of these two bytes does not matter. |
|
Command Options |
17+password length |
If bit 1 is set (0x02), the remote node immediately applies changes in the AT command. If bit 1 is clear, you must send an AC command for the change to take effect. |
|
AT Command |
18+password length |
Command name: two ASCII characters that identify the command. |
|
Command Parameter |
20+password length |
If present, indicates the parameter value you request for a given register. If no characters are present, it queries the register. Numeric parameter values are given in binary format. |
Example
The following table shows an example frame to send a secure remote AT command to a node at address 0x0013a200 12345678 to set the baud rate to 07, which translates to 115,200 b/s. If the password configured with the KZ command is Nugget, encryption is enabled with EE, and the receiving node is also password protected for remote commands, the baud rate change will apply immediately.
|
Frame data fields |
Offset |
Example |
|---|---|---|
|
Start delimiter |
0 |
0x7E |
|
Length |
1 |
0x00 (MSB) |
|
2 |
0x17 (LSB) |
|
|
Frame type |
3 |
0x18 |
|
Frame ID |
4 |
0x01 |
|
Password Length |
5 |
0x06 |
|
Password |
6 |
0x4E (N) |
|
7 |
0x75 (u) |
|
|
8 |
0x67 (g) |
|
|
9 |
0x67 (g) |
|
|
10 |
0x65 (e) |
|
|
11 |
0x74 (t) |
|
|
64-bit destination address |
12 |
0x00 (MSB) |
|
13 |
0x13 |
|
|
14 |
0xA2 |
|
|
15 |
0x00 |
|
|
16 |
0x12 |
|
|
17 |
0x34 |
|
|
18 |
0x56 |
|
|
19 |
0X78 (LSB) |
|
|
Reserved |
20 |
0xFF |
|
21 |
0xFE |
|
|
Command Options |
22 |
0x02 (apply changes) |
|
AT Command |
23 |
0x42 (B) |
|
24 |
0x44 (D) |
|
|
Command Parameter |
25 |
0x07 |
|
Checksum |
26 |
0x21 |
PDF
