API operation API frame specifications
XBee/XBee-PRO ZigBee RF Modules User Guide 109
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 Frame Types.
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:
UART data frame structure:
Note MSB = most significant byte, LSB = least significant byte
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.
Length
(Bytes 2-3)
Checksum
(Byte n + 1)
MSB LSB 1 Byte
Start Delimiter
(Byte 1)
0x7E
Frame Data
(Bytes 4-n)
API-specific Structure
To Next Page
Loading...
Need help?
General
