API Operation for the XBee/XBee-PRO RF Module
XBee / XBee-PRO RF Modules 802.15.4 Product Manual 91
API types
Frame data of the UART data frame forms an API-specific structure as follows:
Figure 14: UART Data Frame and API-specific Structure:
The cmdID frame (API-identifier) indicates which API messages will be contained in the cmdData
frame (Identifier-specific data). Refer to the sections that follow for more information regarding the
supported API types. Note that multi-byte values are sent big endian.
Modem Status
API Identifier: 0x8A
RF module status messages are sent from the module in response to specific conditions.
Figure 15: Modem Status frames
AT command
API Identifier Value: 0x08
The “AT Command” API type allows for module parameters to be queried or set. When using this
command ID, new parameter values are applied immediately. This includes any register set with the
“AT Command - Queue Parameter Value” (0x09) API type.
Length
(Bytes 2-3)
Checksum
(Byte n + 1)
MSB LSB 1 Byte
Start Delimiter
(Byte 1)
0x7E
Frame Data
(Bytes 4- n)
API-specific Structure
Identifier-specific Data
cmdData
API Identifier
cmdID
cmdD ata0x8 A
Length ChecksumStart Delimiter Fr ame Data
Identifier-specific DataAPI Identifier
MSB LSB0x7E 1 ByteAPI -specific Str ucture
Status ( Byt e 5 )
0 = Hardware reset
1 = Watchdog timer reset
2 = Associated
3 = Disassociated
4 = Synchronization Lost
(Beacon -enabled only )
5 = Coordinator realignment
6 = Coordinator started