Api Types - Digi XBee Product Manual

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
Start Delimiter
0 x7E
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.
XBee / XBee-PRO RF Modules 802.15.4 Product Manual
Start Delimiter Length
(Byte 1) (Bytes 2-3)
0x7E MSB
Length
MSB LSB
API Identifier
API Operation for the XBee/XBee-PRO RF Module
Frame Data
(Bytes 4- n)
LSB API-specific Structure
API Identifier
cmdID
Frame Data
API -specific Structure
Identifier-specific Data
0x8 A cmdData
Status (Byte 5 )
0 = Hardware reset
1 = W atchdog timer reset
2 = Associated
3 = Disassociated
4 = Synchronization Lost
( Beacon -enabled only )
5 = Coordinator realignment
6 = Coordinator started
Checksum
(Byte n + 1)
1 Byte
Identifier-specific Data
cmdData
Checksum
1 Byte
91