Supported frames
Support for API frame types depends on the type of XBee you are using. The 802.15.4 XBee 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 XBees:
API ID |
Frame name |
Description |
---|---|---|
0x08 |
AT Command |
Queries or sets parameters on the local XBee |
0x09 |
AT Command Queue Parameter Value |
Queries or sets parameters on the local XBee without applying changes |
0x10 |
Transmit Request |
Transmits wireless data to the specified destination |
0x11 |
Explicit Addressing Command Frame |
Allows Zigbee application layer fields (endpoint and cluster ID) to be specified for a wireless data transmission |
0x17 |
Remote AT Command Request |
Queries or sets parameters on the specified remote XBee module |
0x21 | Create Source Route | Creates a source route in the module |
0x24 | Register Joining Device | Registers a module with the Trust Center |
Receive data frames are received through the serial output, with data received wirelessly from remote XBees:
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, disassociation, and so on. |
0x8B | Transmit Status | Indicates wireless data transmission success or failure |
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 |
0x94 | XBee Sensor Read Indicator | Sends wirelessly received sensor sample (from a Digi 1-wire sensor adapter) 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 |
0x98 | Extended Modem Status | Displays what is happening during the association when Verbose Join is enabled (DC10) |
0xA0 | Over-the-Air Firmware Update Status | Provides a status indication of a firmware update transmission attempt |
0xA1 | Router Record Indicator | Displays the multiple route hopes after a Zigbee route record command |
0xA3 | Many-to-One Route Request Indicator | Indicates a many-to-one route request is received |
0xA5 | Join Notification Status | Indicates a module attempts to join, rejoin, or leave the network |
For more information about the structure of some of these frames, see the XBee/XBee-PRO Zigbee RF Module User Guide.