Table of Contents
Advertisement
API operation
As an alternative to Transparent Operation, Application Programming Interface (API) Operations are
available. API operation requires that communication with the module be done through a structured
interface (data is communicated in frames in a defined order). The API specifies how commands,
command responses and module status messages are sent and received from the module using a
UART Data Frame.
Please note that Digi may add new API frames to future versions of firmware, so please build into
your software interface the ability to filter out additional API frames with unknown API identifiers.
API frame specifications
Two API modes are supported and both can be enabled using the AP (API Enable) command. Use the
following AP parameter values to configure the module to operate in a particular mode:
•
AP = 1: API Operation
•
AP = 2: API Operation (with escaped characters)
API operation (AP parameter = 1)
When this API mode is enabled (AP = 1), the UART data frame structure is defined as follows:
Figure 32: UART data frame structure.
Any data received prior to the start delimiter is silently discarded. If the frame is not received
correctly or if the checksum fails, the module will reply with a module status frame indicating the
nature of the failure.
API operation - with escape characters (AP parameter = 2)
When this API mode is enabled (AP = 2), the UART data frame structure is defined as follows:
XBee ZNet 2.5 / XBee PRO Znet 2.5 OEM RF Modules Product Manual
MSB = Most Significant Byte, LSB = Least Significant Byte
API frame specifications
59
Advertisement
Table of Contents
