DigiMesh supported frames

Support for API frame types depends on the type of XBee device you are using. The XBee DigiMesh modules included in this kit support the following API frames.

Transmit data frames are sent through the serial input, with data to be transmitted wirelessly to remote XBee modules:

API ID Frame name Description
0x08 AT Command Queries or sets parameters on the local XBee module
0x09 AT Command Queue Parameter Value Queries or sets parameters on the local XBee module without applying changes
0x10 Transmit Request Transmits wireless data to the specified destination
0x11 Explicit Addressing Command Frame Allows application layer fields (endpoint and cluster ID) to be specified for a data transmission
0x17 Remote AT Command Request Queries or sets parameters on the specified remote XBee module

Receive data frames are received through the serial output, with data received wirelessly from remote XBee modules:

API 

ID

Frame name Description
0x88 AT Command Response Displays the response to previous AT command frame
0x8A Modem Status Displays event notifications such as reset, association, and disassociation
0x8B Transmit Status Indicates data transmission success or failure
0x8D Route information packet Displays route information for a wireless transmission
0x8E Aggregate addressing update Indicates the node updated its DH and DL parameters due to the execution of AG command
0x90 Receive Packet Sends wirelessly received data out the serial interface (AO = 0)
0x91 Explicit Rx Indicator Sends wirelessly received data out the serial interface when explicit mode is enabled (AO ≠ 0)
0x92 IO Data Sample Rx Indicator Sends wirelessly received IO data out the serial interface
0x95 Node Identification Indicator Displays received node identification message when explicit mode is disabled (AO = 0)
0x97 Remote AT Command Response Displays the response to previous remote AT command requests

Note To learn more about the structure of some of these frames, see go to the XBee-PRO 900HP and XSC RF Modules User Guide.

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 FF FE 00 00 48 65 6C 6C 6F 6E

Frame fields Offset Example Description
Start delimiter   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:

  • 0x000000000000FFFF - Broadcast address
6 0x13
7 0xA2
8 0x00
9 0x40
10 0xDA
11 0x9D
LSB 12 0x23
16-bit Destination address MSB 13 0xFF Set to 0xFFFE
LSB 14 0xFE
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

Bit values:

  • bit 0 - Disable ACK
  • bit 1 - Disable Route Discovery
  • bit 2 - Enable Unicast NACK messages
  • bit 3 - Enable Unicast Trace Route messages
  • bits 6,7:
    • 01 - Point-Multipoint
    • 10 - Repeater mode (directed broadcast)
    • 11 - DigiMesh (not available on 10k product)

All other bits must be set to '0'.

If this bitfield is '0', then the TO parameter will be used

RF Data MSB 17 0x48 Data that is sent to the destination XBee
18 0x65
... 0x6C
20 0x6C
LSB 21 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 FF FE E8 E8 00 11 C1 05 01 48 65 6C 6C 6F 64

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

5 0x13
6 0xA2
7 0x00
8 0x40
9 0xDA
10 0x9D
LSB 11 0x05
16-bit Source Network Address MSB 12 0xFF Set to 0xFFFE
LSB 13 0xFE
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 bit values include the following:

  • bit 0 - Packet was acknowledged
  • bit 1 - Broadcast packet
  • bits 6,7:
    • 01 - Point-Multipoint
    • 10 - Repeater mode (directed broadcast)
    • 11 - DigiMesh (not available on 10k product)

Other bits should be ignored.

Received Data MSB 21 0x48 Data received from the source XBee
22 0x65
... 0x6C
24 0x6C
LSB 25 0x6F
Checksum   26 0x64 Hash sum of frame data bytes

 

© 2018 Digi International Inc. All rights reserved.
DigiMesh supported frames updated on 13 April 2018 11:18:33 AM