Operate In Api Mode; Api Mode Overview; Api Frame Specifications - Digi XTend vB DigiMesh XTP9B-DPM-001 User Manual

Operate in API mode

API mode overview

As an alternative to Transparent operating mode, you can use API operating mode. API mode requires that
your application communicates data with the device using software frames in a particular order. The API
specifies how to send commands, receive command responses and device status messages from the
device using UART data frames.
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.

API frame specifications

The firmware supports two API operating modes: with escaped characters and without 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:
1. AP = 0: Transparent operating mode, UART serial line replacement with API modes
disabled.
2. AP = 1: API operation.
3. AP = 2: API operation with escaped characters (only possible on UART).
Software flow control (XON and XOFF) uses API mode 2. The XTend vB 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.
API operation (AP parameter = 1)
When you enable this mode, the following diagram illustrates the data frame structure:
XTend vB DigiMesh RF Module User Guide 60