Digi XBee - Page 94

API Operation for the XBee/XBee-PRO RF Module
XBee / XBee-PRO RF Modules 802.15.4 Product Manual 95
Figure 23: TX Packet (16-bit address) frames
TX (Transmit) status
API identifier value: 0x89
When a TX Request is completed, the module sends a TX Status message. This message will indicate if
the packet was transmitted successfully or if there was a failure.
Figure 24: TX status frames
Notes:
• “STATUS = 1” occurs when all retries are expired and no ACK is received.
• If transmitter broadcasts (destination address = 0x000000000000FFFF), only
“STATUS = 0 or 2” will be returned.
• “STATUS = 3” occurs when Coordinator times out of an indirect transmission.
Timeout is defined as (2.5 x SP (Cyclic Sleep Period) parameter value).
RX (Receive) packet: 64-bit address
API identifier value: 0x80
When the module receives an RF packet, it is sent out the UART using this message type.
cmdData0x01
Length ChecksumStart Delimiter Frame Data
Identifier-specific DataAPI Identifier
MSB LSB0x7E 1 ByteAPI-specific S tructure
Frame ID (Byte 5)
Identifies the UART data frame for the host to
correlate with a subsequent A CK (acknowledgement ).
Setting Frame ID to ‘0' will disable response frame.
Destination Address (Bytes 6-7)
MSB first, LSB last.
Broadcast = 0xFFFF
Options (Byte 8)
0x01 = Disable ACK
0x04 = Send packet with Broadcast Pan ID
All other bits must be set to 0.
RF Data (Byte(s) 9-n)
Up to 100 Bytes per packet
cmdData0x89
Length ChecksumStart Del imiter Frame Data
Identifier-specific DataAPI Identifier
MSB LSB0x7E 1 ByteAP I-specific Structure
Frame ID (Byte 5) Status (Byte 6)
0 = Success
1 = No ACK (Acknowledgement) received
2 = CCA failure
3 = Purged
Identifies UART data frame being reported.
Note: I f Frame ID = 0 in the TX Request, no
AT Command Response will be given.