Operating Mode Configuration - Digi XBee Zigbee Mesh Kit User Manual

XBee API mode
Frame fields
Receive
Options
Received Data
Checksum

Operating mode configuration

The API Enable (AP) parameter configures the XBee module to operate using a frame-based API
instead of the default Transparent mode. It allows you to select between the two supported API
modes and the default transparent operation.
Mode AP value Description
Transparent 0
API 1 1
API 2 2
The only difference between API 1 and API 2 is that API 2 operating mode requires that frames use
escape characters (bytes).
Configuration of the serial XBee communication—whether it is transparent, API non-escaped (API 1),
or API escaped (API 2)—does not prevent wireless communication between XBee modules. Since only
the payload portion of the API frame is transmitted over the air, the receiving XBee modules will alter
the packet information based on their AP setting, allowing an API non-escaped module to successfully
communicate with others working in API escaped or Transparent mode.
XBee® Zigbee® Mesh Kit
Offset Example Description
20
0x01
MSB 21
0x48
22
0x65
...
0x6C
24
0x6C
LSB 25
0x6F
26
0x61
API modes are disabled and the module operates in transparent mode
API mode without escaped characters
API mode with escaped characters
Operating mode configuration
Bitfield of supported transmission
options
Supported values include the
following:
0x01 - Packet
n
Acknowledged
0x02 - Packet was a
n
broadcast packet
0x20 - Packet encrypted
n
with APS encryption
0x40 - Packet sent with
n
extended timeout enabled
Up to 255 bytes data received
from the source XBee
Hash sum of frame data bytes
54