Response frame: Extended Transmit Status - 0x8B
This frame type is used to send payload data as an RF packet to a specific destination using application-layer addressing fields. The behavior of this frame is similar to Transmit Request - 0x10, but with additional fields available for user-defined endpoints, cluster ID, and profile ID.
This frame type is typically used for OTA updates, and serial data transmissions.
Query NP (Maximum Packet Payload Bytes) to read the maximum number of payload bytes that can be sent.
See Maximum payload for additional information on payload size restrictions.
For serial data transmissions, the 0xE8 endpoint should be used for both source and destination endpoints.
The active Digi endpoints are:
For serial data transmissions, the 0x0011 cluster ID should be used.
The following cluster IDs can be used on the 0xE8 data endpoint:
The Digi profile ID of 0xC105 should be used when sending serial data between XBee devices.
The following table provides the contents of the frame. For details on the frame structure, see API frame specifications.
| Offset | Size | Frame Field | Description |
|---|---|---|---|
| 0 | 8-bit | Start Delimiter | Indicates the start of an API frame. |
| 1 | 16-bit | Length | Number of bytes between the length and checksum. |
| 3 | 8-bit | Frame type |
Explicit Addressing Command Request - 0x11 |
| 4 | 8-bit | Frame ID |
Identifies the data frame for the host to correlate with a subsequent response. If set to0, the device will not emit a response frame. |
| 5 | 64-bit | 64-bit destination address |
Set to the 64-bit IEEE address of the destination device. Broadcast address is 0x000000000000FFFF. When using 16-bit addressing, set this field to 0xFFFFFFFFFFFFFFFF. |
| 13 | 16-bit |
Reserved |
Unused, but this field is typically set to 0xFFFE. |
| 15 | 8-bit | Source Endpoint |
Source endpoint for the transmission. Serial data transmissions should use 0xE8. |
| 16 | 8-bit | Destination Endpoint |
Destination endpoint for the transmission. Serial data transmissions should use 0xE8. |
| 17 | 16-bit | Cluster ID |
The Cluster ID that the host uses in the transmission. Serial data transmissions should use 0x11. |
| 19 | 16-bit | Profile ID |
The Profile ID that the host uses in the transmission. Serial data transmissions between XBee devices should use 0xC105. |
| 21 | 8-bit | Broadcast radius |
Sets the maximum number of hops a broadcast transmission can traverse. This parameter is only used for broadcast transmissions. If set to 0 (recommended), the value of NH specifies the broadcast radius. |
| 22 | 8-bit | Transmit options |
See the Transmit options bit field table below for available options. If set to 0, the value of TO specifies the transmit options. |
| 23-n | variable | Command data |
Data to be sent to the destination device. Up to NP bytes per packet. |
| EOF | 8-bit | Checksum | 0xFF minus the 8-bit sum of bytes from offset 3 to this byte (between length and checksum). |
The available transmit options vary depending on the protocol being used. Bitfield options can be combined. Set all unused bits to 0.
|
Bit |
Meaning |
Description |
|---|---|---|
|
0 |
Disable ACK [0x01] |
Disable acknowledgments on all unicasts. |
| 1 |
Disable route discoveries [0x02] |
Disable Route Discovery on all DigiMesh unicasts. |
| 2 |
Unicast NACK [0x04] |
Enable unicast NACK messages on DigiMesh transmissions When set, a failed transmission will generate a Route Information - 0x8D frame for diagnosis. |
| 3 |
Unicast trace route [0x08] |
Enable a unicast Trace Route on DigiMesh transmissions When set, the transmission will generate a Route Information - 0x8D frame. |
| 4 |
Secure Session Encryption [0x10] |
Encrypt payload for transmission across a Secure Session Reduces maximum payload size by 4 bytes. |
| 5 | Reserved | <set this bit to 0> |
| 6,7 | Delivery method |
b’00 = <invalid option> b’01 = Point-multipoint [0x40] b’10 = Directed Broadcast [0x80] b’11 = DigiMesh [0xC0] |
Each example is written without escapes (AP = 1) and all bytes are represented in hex format. For brevity, the start delimiter, length, and checksum fields have been excluded.
Sending a unicast transmission to an XBee device with the 64-bit address of 0013A20012345678 with the serial data "TxData". Transmit options are set to 0, which means the transmission will send using the options set by the TO command. This transmission is identical to a Transmit Request - 0x10 using default settings.
The corresponding Extended Transmit Status - 0x8B response with a matching Frame ID will indicate whether the transmission succeeded.
7E 00 1A 11 87 00 13 A2 00 12 34 56 78 FF FE E8 E8 00 11 C1 05 00 00 54 78 44 61 74 61 B4
| Frame type | Frame ID | 64-bit dest | Reserved | Source EP | Dest EP | Cluster | Profile | Bcast radius | Tx options | Command data |
|---|---|---|---|---|---|---|---|---|---|---|
| 0x11 | 0x87 | 0x0013A200 12345678 |
0xFFFE | 0xE8 | 0xE8 | 0x0011 | 0xC105 | 0x00 | 0x00 | 0x547844617461 |
| Explicit request | Matches response | Destination | Unused | Digi data | Digi data | Data | Digi profile | N/A | Use TO | "TxData" |
Sending a loopback transmission to an device with the 64-bit address of 0013A20012345678 using Cluster ID 0x0012. To better understand the raw performance, retries and acknowledgements are disabled.
The corresponding Extended Transmit Status - 0x8B response with a matching Frame ID can be used to verify that the transmission was sent.
The destination will not emit a receive frame, instead it will return the transmission back to the sender. The source device will emit the receive frame—the frame type is determined by the value of AO—if the packet looped back successfully.
7E 00 1A 11 F8 00 13 A2 00 12 34 56 78 FF FE E8 E8 00 12 C1 05 00 01 54 78 44 61 74 61 41
| Frame type | Frame ID | 64-bit dest | Reserved | Source EP | Dest EP | Cluster | Profile | Bcast radius | Tx options | Command data |
|---|---|---|---|---|---|---|---|---|---|---|
| 0x11 | 0xF8 |
0x0013A200 |
0xFFFE | 0xE8 | 0xE8 | 0x0012 | 0xC105 | 0x00 | 0x01 | 0x547844617461 |
| Explicit request | Matches response | Destination | Unused | Digi data | Digi data | Data | Digi profile | N/A | Disable retries | "TxData" |