Request frames:
Description
This frame type is emitted in response to a local AT Command request. Some commands send back multiple response frames; for example, ND (Network Discovery). Refer to individual AT command descriptions for details on API response behavior.
This frame is only emitted if the Frame ID in the request is non-zero.
Format
The following table provides the contents of the frame. For details on frame structure, see API frames.
| Offset | Size | Frame Field | Description |
|---|---|---|---|
0 |
8-bit |
Start Delimiter |
Indicates the start of an API frame. |
1 |
16-bit |
Length |
Number of bytes between the length and checksum. |
3 |
8-bit |
Frame type |
Local AT Command Response - 0x88 |
4 |
8-bit |
Frame ID |
Identifies the data frame for the host to correlate with a prior request. |
5 |
16-bit |
AT command |
The two ASCII characters that identify the AT Command. |
7 |
8-bit |
Command status |
Status code for the host’s request: 0 = OK 1 = ERROR 2 = Invalid command 3 = Invalid parameter |
8-n |
variable |
Command data (optional) |
If the host requested a command parameter change, this field will be omitted. If the host queried a command by omitting the parameter value in the request, this field will return the value currently set on the device. |
EOF |
8-bit |
Checksum |
0xFF minus the 8-bit sum of bytes from offset 3 to this byte (between length and checksum). |
Examples
Each example is written without escapes (AP = 1) and all bytes are represented in hex format. For brevity, the start delimiter, length, and checksum fields have been excluded.
Set local command parameter
Host set the NI string of the local device to "End Device" using a 0x08 request frame.
The corresponding Local AT Command Response - 0x88 with a matching Frame ID is emitted as a response:
7E 00 05 88 01 4E 49 00 DF
| Frame type | Frame ID | AT command | Command Status | Command data |
|---|---|---|---|---|
0x88 |
0xA1 |
0x4E49 |
0x00 |
(omitted) |
Response |
Matches request |
"NI" |
Success |
Parameter changes return no data |
Query local command parameter
Host queries the temperature of the local device—TP command—using a 0x08 request frame.
The corresponding Local AT Command Response - 0x88 with a matching Frame ID is emitted with the temperature value as a response:
7E 00 07 88 01 54 50 00 FF FE D5
| Frame type | Frame ID | AT command | Command Status | Command data |
|---|---|---|---|---|
0x88 |
0x17 |
0x5450 |
0x00 |
0xFFFE |
Response |
Matches request |
"TP" |
Success |
-2 °C |
