Operate In Api Mode; Api Mode Overview; Use The Ap Command To Set The Operation Mode; Api Frame Format - Digi XBee 3 Cellular LTE-M 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 firmware, so build the ability to filter out additional
API frames with unknown frame types into your software interface.

Use the AP command to set the operation mode

Use AP (API Enable)
AP command
setting
AP = 0
AP = 1
AP = 2
AP = 3
AP = 4
AP = 5
The API data frame structure differs depending on what mode you choose.

API frame format

An API frame consists of the following:
Start delimeter
n
Length
n
Frame data
n
Checksum
n

API operation (AP parameter = 1)

This is the recommended API mode for most applications. The following table shows the data frame
structure when you enable this mode:
Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide
to specify the operation mode:
Description
Transparent operating mode, UART serial line replacement with API modes
disabled. This is the default option.
API operation.
API operation with escaped characters (only possible on UART).
N/A
MicroPython REPL
Bypass mode. This mode is for direct communication with the underlying chip and
is only for advanced users.
API mode overview
247