This page provides detailed information about the byte allocation within different XBee frames in API 1 (API mode without escapes).
0x00- Tx (Transmit) Request: 64 bit-address0x08- AT Command0x81- RX (Receive) Packet: 16-bit Address0x88- AT Command Response0x89- Tx (Transmit) Status
| Frame Parameters | Bytes |
|---|---|
| Start Delimeter | 1 |
| Length | 2 |
| Frame Type | 1 |
| Frame ID | 1 |
| 64-bit Destination Address | 8 |
| Options | 1 |
| RF Data (Payload) | 0 - 256* |
| Checksum | 1 |
*In practice, maximum payload size is actually 100 bytes
Always set to 7E in XBee API Mode
Number of bytes between Length and Checksum fields
Note
The maximum length should be 00 6F or 111 bytes (See RF data)
Specefies XBee API frame type (0x00)
Identifies the UART data frame for the hose to match with subsequent reqponse. If 0, no response is requested
Set to the 64-bit address of the destination XBee module.
Use 00 00 00 00 00 00 FF FF to send a broadcast packet.
Packet payload, up to 256 bytes (256 characters)
Important
Although it is stated that the packet payload can be 0 - 256 bytes, the packet payload can only be up to 100 bytes (100 characters)
FF minus 8-bit sum of bytes between length and checksum fields.
| Frame Parameters | Bytes |
|---|---|
| Start Delimeter | 1 |
| Length | 2 |
| Frame Type | 1 |
| Frame ID | 1 |
| AT Command | 2 |
| Parameter Value | 0 - 256 |
| Checksum | 1 |
Always set to 7E in XBee API Mode
Number of bytes between Length and Checksum fields
Specefies XBee API frame type (0x00)
Identifies the UART data frame for the hose to match with subsequent reqponse. If 0, no response is requested
Two ASCII characters that identify the AT command.
If present, indicates the requested parameter value to set the given register. If no characters are present, get the value of the register.
FF minus 8-bit sum of bytes between length and checksum fields.
| Frame Parameters | Bytes |
|---|---|
| Start Delimeter | 1 |
| Length | 2 |
| Frame Type | 1 |
| 16-bit Source Address | 2 |
| RSSI | 1 |
| Options | 1 |
| RF Data | 0 - 100 |
| Checksum | 1 |
Always set to 7E in XBee API Mode
Number of bytes between Length and Checksum fields
Note
The maximum length should be 00 69 or 105 bytes
Specefies XBee API frame type (0x81)
16-bit network address of the sender device. Can be set in XTCU (Parameter MM).
Note
Set to FF FE if the sender's 16-bit address is unknown
Hexadecimal equivalent of (-dBm) value.
Example:
- For a RX signal strength of -40 dBm, a 28 hexadecimal value (40 decimal) is returned.
Bitfield indicating the Rx indicator options
- bit 0 - [reserved]
- bit 1 - Address broadcast
- bit 2 - PAN broadcast
- bits 3-7 0 [reserved]
Packet payload, up to 100 bytes (100 characters)
FF minus 8-bit sum of bytes between length and checksum fields.
| Frame Parameters | Bytes |
|---|---|
| Start Delimeter | 1 |
| Length | 2 |
| Frame Type | 1 |
| Frame ID | 1 |
| AT Command | 2 |
| Command Status | 1 |
| Command Data | 0 - 256 |
| Checksum | 1 |
Always set to 7E in XBee API Mode.
Number of bytes between Length and Checksum fields.
Specefies XBee API frame type (0x88).
Identifies the UART data frame being reported. If the Frame ID = 0 in AT Command Mode, no AT Command Response will be given.
Two ASCII characters that identify the AT command.
The status of the AT Command
| Status Code | Description |
|---|---|
| 00 | OK |
| 01 | ERROR |
| 02 | Invalid Command |
| 03 | Invalid Parameter |
| 04 | Tx Failure |
Register data in binary format. If the register was set in the AT Command, then this field is not returned.
FF minus 8-bit sum of bytes between length and checksum fields.
| Frame Parameters | Bytes |
|---|---|
| Start Delimeter | 1 |
| Length | 2 |
| Frame Type | 1 |
| Frame ID | 1 |
| Delivery Status | 1 |
| Checksum | 1 |
Always set to 7E in XBee API Mode
Number of bytes between Length and Checksum fields. Should always be 00 03
Specefies XBee API frame type (0x89)
Identifies the UART data frame being reported. If the Frame ID = 0 in the transmit request, no transmit status is given
| ID | Description |
|---|---|
| 00 | Success |
| 01 | An expected MAC acknowledgment never occurred |
| 02 | CCA failure |
| 03 | Packet was purged without being transmitted |
| 04 | Physical error on the interface with the WiFi transceiver |
| 18 | No Buffers |
| 21 | Expected network acknowledgment never occurred |
| 22 | Not joined to network |
| 23 | Self-addressed |
| 24 | Address not found |
| 25 | Route not found |
| 26 | Broadcast relay was not heard |
| 2B | Invalid Binding Table Index |
| 2C | Invalid Endpoint |
| 31 | A software error occurred |
| 32 | Resource Error |
| 40 | CoAP message URI requires a nonzero length URI string terminated with a zero byte |
| 41 | Unrecognized Digi API Frame type |
| 42 | Client made a badly formed CoP request |
| 43 | Server failed to handle CoAP request, perhaps due to a lack of internal resources. The client may try again |
| 44 | CoAP Invalid Status |
| 45 | CoAP Message Timeout, Server did not respond within the expected time |
| 46 | CoAP Message Reset |
| 74 | Data payload too large |
| 75 | Indirect message unrequested |
| 76 | Client socket creation attempt failed |
| 77 | Connection does not exist |
| 78 | Invalid UDP port |
| 79 | Invalid TCP port |
| 7A | Invalid host |
| 7B | Invalid data mode |
| 7C | Invalid interface |
| 7D | Interface not accepting frames |
| 80 | Connection refused |
| 81 | Connection lost |
| 82 | No server |
| 83 | Socket closed |
| 84 | Unknown server |
| 85 | Unknown error |
| 86 | Invalid TLS configuration |
| BB | Key not authorized |
FF minus 8-bit sum of bytes between length and checksum fields.