16-bit Transmit Request - 0x01
Response frame: Transmit Status - 0x89
Description
This frame type is used to send serial payload data as an RF packet to a remote device with a corresponding 16-bit network address.
Note This frame format is deprecated and should only be used by customers who require compatibility with legacy Digi RF products. For new designs, we encourage you to use Transmit Request - 0x10 to initiate API transmissions.
Format
The following table provides the contents of the frame. For details on frame structure, see API frame format.
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 |
16-bit Transmit Request - 0x01 |
4 | 8-bit | Frame ID |
Identifies the data frame for the host to correlate with a subsequent response. If set to 0, the device will not emit a response frame. |
5 | 16-bit |
Destination address |
Set to the 16-bit network address of the destination device. If set to 0xFFFF, the broadcast address is used. |
7 | 8-bit |
Options |
A bit field of options that affect the outgoing transmission:
Note Option values may be combined. Set all unused bits to 0. |
8-n | variable | RF data |
The serial data to be sent to the destination. Use NP to query the maximum payload size that can be supported based on current settings. |
EOF | 8-bit | Checksum | 0xFF minus the 8-bit sum of bytes from offset 3 to this byte (between length and checksum). |
Examples
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.
16-bit unicast
Sending a unicast transmission to a device with the 16-bit address of 1234 with the serial data "TxData".
The corresponding Transmit Status - 0x89 response with a matching Frame ID will indicate whether the transmission succeeded.
7E 00 0B 01 87 12 34 00 54 78 44 61 74 61 EB
Frame type | Frame ID | 16-bit dest address | Tx options | RF data |
---|---|---|---|---|
0x01 | 0x87 | 0x1234 | 0x00 | 0x547844617461 |
Input | Matches response |
|
|
"TxData" |
16-bit broadcast
Sending a broadcast transmission of the serial data "Broadcast" and suppressing the corresponding response by setting Frame ID to 0.
7E 00 0E 01 00 FF FF 00 42 72 6F 61 64 63 61 73 74 6D
Frame type | Frame ID | 16-bit dest address | Tx options | RF data |
---|---|---|---|---|
0x01 | 0x00 |
0xFFFF |
0x00 | 0x42726F616463617374 |
Input | Suppress response | Broadcast address |
|
"Broadcast" |