Frame examples

The following examples of sent and received API frames are expressed in hexadecimal format.

Example: 0x10 - Transmit Request

The following frame is a Transmit Request frame with the following characteristics:

7E 00 13 10 01 00 13 A2 00 40 DA 9D 23 A6 B9 00 00 48 65 6C 6C 6F 0C

Frame fields Offset Example Description
Start delimeter   0 0x7E  
Length   MSB 1 0x00 Number of bytes between the length and the checksum
  LSB 2 0x13
Frame data Frame type 3 0x10 0x10 - Indicates this is a Transmit Request frame
Frame ID 4 0x01

Identifies the data frame for the host to correlate with a subsequent Transmit Status (0x8B) frame.

 

Setting Frame ID to '0' will disable response frame.

64-bit Destination address MSB 5 0x00

Set to the 64-bit address of the destination XBee

The following addresses are also supported:

  • 0x0000000000000000 - Coordinator address

  • 0x000000000000FFFF - Broadcast address
  • 0xFFFFFFFFFFFFFFFF - Unknown address if the destination's 64-bit address is unknown

6 0x13
7 0xA2
8 0x00
9 0x40
10 0xDA
11 0x9D
LSB 12 0x23
16-bit Destination address MSB 13 0xA6

Set to the 16-bit address of the destination XBee, if known.

The following addresses are also supported:

  • 0x0000 - Coordinator address
  • 0xFFFE - Unknwon address if the destination's 16-bit address is unknown, or if sending a broadcast
LSB 14 0xB9
Broadcast Radius 15 0x00 Sets the maximum number of hops a broadcast transmission can occur. If set to '0', the broadcast radius will be set to the maximum hops value.
Options 16 0x00

Bitfield of supported transmission options

 

Supported values include the following:

  • 0x01 - Disable retries
  • 0x20 - Enable APS encryption (if EE = 1)
  • 0x40 - Use the extended transmission timeout for this destination

All other bits must be set to 0.

 

Enabling APS encryption decreases the maximum number of RF payload bytes by 4 (below the value reported by NP).

 

Setting the extended timeout bit causes the stack to set the extended transmission timeout for the destination address.

RF Data MSB 14 0x48 Up to 255 bytes of data that is sent to the destination XBee
15 0x65
... 0x6C
17 0x6C
LSB 18 0x6F
Checksum   22 0x6E Hash sum of frame data bytes

Example: 0x91 - Explicit Rx Indicator

The following frame is an Explicit Rx Indicator frame with the following characteristics:

7E 00 17 91 00 13 A2 00 40 DA 9D 05 00 00 E8 E8 00 11 C1 05 01 48 65 6C 6C 6F 61

Frame fields Offset Example Description
Start delimiter   0 0x7E  
Length   MSB 1 0x00 Number of bytes between the length and the checksum
  LSB 2 0x17
Frame data Frame type 3 0x91 0x91 - Indicates this is a Explicit Rx Indicator frame
64-bit Source Address MSB 4 0x00

64-bit address of sender

 

Set to 0xFFFFFFFFFFFFFFFF (unknown 64-bit address) if the sender's 64-bit address is unknown

5 0x13
6 0xA2
7 0x00
8 0x40
9 0xDA
10 0x9D
LSB 11 0x05
16-bit Source Network Address MSB 12 0x00 16-bit address of sender
LSB 13 0x00
Source Endpoint 14 0xE8 Endpoint of the source that initiated the transmission
Destination Endpoint 15 0xE8 Endpoint of the destination the message is addressed to
Cluster ID 16 0x00 Cluster ID the message was addressed to
17 0x11
Profile ID 18 0xC1 Profile ID the message was addressed to
19 0x05
Receive Options 20 0x01

Bitfield of supported transmission options

Supported values include the following:

  • 0x01 - Packet Acknowledged
  • 0x02 - Packet was a broadcast packet
  • 0x20 - Packet encrypted with APS encryption
  • 0x40 - Packet sent with extended timeout enabled
Received Data MSB 21 0x48 Up to 255 bytes data received from the source XBee
22 0x65
... 0x6C
24 0x6C
LSB 25 0x6F
Checksum   26 0x61 Hash sum of frame data bytes