Operate in API mode
Frame descriptions
Local AT Command Request - 0x08
Response frame: Local AT Command Response - 0x88
Description
This frame type is used to query or set command parameters on the local device. Any parameter that
is set with this frame type will apply the change immediately. If you wish to queue multiple parameter
changes and apply them later, use the Queue Local AT Command Request - 0x09 instead.
When querying parameter values, this frame behaves identically to Queue Local AT Command Request
- 0x09: You can query parameter values by sending this frame with a command but no parameter
value field—the two-byte AT command is immediately followed by the frame checksum. When an AT
command is queried, a Local AT Command Response - 0x88 frame is populated with the parameter
value that is currently set on the device. The Frame ID of the 0x88 response is the same one set by the
command in the 0x08 request frame.
Format
The following table provides the contents of the frame. For details on frame structure, see API frame
format.
Offset
Size
Frame Field
Description
0
1
3
4
8-bit
16-bit
8-bit
8-bit
Start Delimiter Indicates the start of an API frame.
Length
Number of bytes between the length and checksum.
Frame type
Frame ID
Local AT Command Request - 0x08
Identifies the data frame for the host to correlate with a
subsequent response.
If set to0, the device will not emit a response frame.
AT command
The two ASCII characters that identify the AT Command.
5
16-bit
Parameter
value
(optional)
If present, indicates the requested parameter value to set
the given register.
If no characters are present, it queries the current
parameter value and returns the result in the response.
7-n
variable
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 the local command parameter
Set the NI string of the radio to "End Device".
The corresponding Local AT Command Response - 0x88 with a matching Frame ID will indicate
whether the parameter change succeeded.
7E 00 0E 08 A1 4E 49 45 6E 64 20 44 65 76 69 63 65 38
XBee/XBee-PRO S2C 802.15.4 RF Module User Guide
118
ETC [ ETC ]
