Response frame: Extended Transmit Status - 0x8B
This frame type is used to send payload data as an RF packet to a specific destination. This frame type is typically used for transmitting serial data to one or more remote devices.
The endpoints used for these data transmissions are defined by the SE and EP commands and the cluster ID defined by the CI command—excluding 802.15.4. To define the application-layer addressing fields on a per-packet basis, use the Explicit Addressing Command Request - 0x11 instead.
Query the NP command to read the maximum number of payload bytes that can be sent.
See Maximum payload for additional information on payload size restrictions.
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 |
Transmit Request - 0x10 |
| 4 | 8-bit | Frame ID |
Identifies the data frame for the host to correlate with a subsequent response frame. |
| 5 | 64-bit | 64-bit destination address |
Set to the 64-bit IEEE address of the destination device. Broadcast address is 0x000000000000FFFF. |
| 13 | 16-bit | Reserved
|
Unused, but this field is typically set to 0xFFFE. |
| 15 | 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 to0—recommended—the value of NHspecifies the broadcast radius. |
| 16 | 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. |
| 17-n | variable | Payload 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 a 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.
The corresponding Transmit Status - 0x89 response with a matching Frame ID will indicate whether the transmission succeeded.
7E 00 14 10 52 00 13 A2 00 12 34 56 78 FF FE 00 00 54 78 44 61 74 61 91
| Frame type | Frame ID | 64-bit dest | Reserved |
Bcast radius |
Options | RF data |
|---|---|---|---|---|---|---|
| 0x10 | 0x52 | 0x0013A200 12345678 |
0xFFFE | 0x00 | 0x00 | 0x547844617461 |
| Request | Matches response | Destination | Unused | N/A | Will use TO | "TxData" |
Sending a broadcast transmission of the serial data "Broadcast" to neighboring devices and suppressing the corresponding response by setting Frame ID to 0.
7E 00 17 10 00 00 00 00 00 00 00 FF FF FF FE 01 00 42 72 6F 61 64 63 61 73 74 60
| Frame type | Frame ID | 64-bit dest | Reserved |
Bcast radius |
Tx Options | RF data |
|---|---|---|---|---|---|---|
| 0x10 | 0x00 |
0x00000000 |
0xFFFE | 0x01 | 0x00 | 0x42726F616463617374 |
| Request | Suppress response | Broadcast address | Unused | Single hop broadcast | Will use TO | "Broadcast" |