Operate in API mode API mode overview
XBee®/XBee-PRO SX RF Module User Guide
112
API mode overview
By default, the XBee/XBee-PRO SX RF Module acts as a serial line replacement (Transparent
operation), it queues all UART data that it receive through the DI pin for RF transmission. When the
device receives an RF packet, it sends the data out the DO pin with no additional information.
The following behaviors are inherent to Transparent operation:
n If device parameter registers are to be set or queried, a special operation is required for
transitioning the device into Command Mode.
API operating mode is an alternative to transparent mode. API mode is a frame-based protocol that
allows you to direct data on a packet basis. It can be particularly useful in large networks where you
need to control the destination of individual data packets or when you need to know which node a
data packet was sent from. The device communicates UART data in packets, also known as API
frames. This mode allows for structured communications with serial devices. It is helpful in managing
larger networks and is more appropriate for performing tasks such as collecting data from multiple
locations or controlling multiple devices remotely.
Use the AP command to set the operation mode
Use API Enable to specify the operation mode:
AP command
setting Description
AP = 0
Transparent operating mode, UARTserial line replacement with API modes
disabled. This is the default option.
AP = 1
API operation.
AP = 2
API operation with escaped characters (only possible on UART).
The API data frame structure differs depending on what mode you choose.
API frame format
An API frame consists of the following:
n Start delimeter
n Length
n Frame data
n Checksum
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:
To Next Page
Loading...
Need help?
General
