Api Mode Overview; Api Frame Specifications; Api Operation (Ap Parameter = 1); Api Operation-With Escaped Characters (Ap Parameter = 2) - Digi XBee3 802.15.4 User Manual

Operate in API mode

API mode overview

As an alternative to Transparent operating mode, you can use API operating mode. API mode provides
a structured interface where data is communicated through the serial interface in organized packets
and in a determined order. This enables you to establish complex communication between devices
without having to define your own protocol. The API specifies how commands, command responses
and device status messages are sent and received from the device using the serial interface or the
SPI interface.
We may add new frame types to future versions of the firmware, so we recommend building the ability
to filter out additional API frames with unknown frame types into your software interface.

API frame specifications

The firmware supports two API operating modes: without escaped characters and with escaped
characters. Use the AP command to enable either mode. To configure a device to one of these modes,
set the following AP parameter values:
AP command
setting
AP = 0
AP = 1
AP = 2
Software flow control (XON and XOFF) uses API mode 2. The XBee3 802.15.4 RF Module does not
support software flow control and only supports API mode 2 for compatibility with other XBee devices.
We recommend using API mode 1.
The API data frame structure differs depending on what mode you choose.
The firmware silently discards any data it receives prior to the start delimiter. If the device does not
receive the frame correctly or if the checksum fails, the device discards the frame.

API operation (AP parameter = 1)

We recommend this API mode for most applications. The following table shows the data frame
structure when you enable this mode:
Frame fields
Start delimiter
Length
Frame data
Checksum

API operation-with escaped characters (AP parameter = 2)

Set API to 2 to allow escaped control characters in the API frame. Due to its increased complexity, we
only recommend this API mode in specific circumstances. API 2 may help improve reliability if the
XBee3® 802.15.4 RF Module User Guide
Description
Transparent operating mode, UART serial line replacement with API modes
disabled. This is the default option.
API operation without escaped characters.
API operation with escaped characters (only possible on UART).
Byte Description
1 0x7E
2 - 3 Most Significant Byte, Least Significant Byte
4 - n API-specific structure
n + 1 1 byte
API mode overview
60