© 2014 Digi International Inc. 21
XBee/XBee-PRO
®
DigiMesh 2.4 User Manual
Transmit Data Frames (received through the DIN pin (pin 3)) include:
• RF Transmit Data Frame
• Command Frame (equivalent to AT commands)
Receive Data Frames (sent out the DOUT pin (pin 2)) include:
• RF-received data frame
• Command response
• Event notifications such as reset, sync status, etc.
The API provides alternative means of configuring modules and routing data at the host
application layer. A host application can send data frames to the module that contain address
and payload information instead of using command mode to modify addresses. The module will
send data frames to the application containing status packets; as well as source, and payload
information from received data packets.
The API operation option facilitates many operations such as the examples cited below:
• Transmitting data to multiple destinations without entering Command Mode
• Receive success/failure status of each transmitted RF packet
• Identify the source address of each received packet
A Comparison of Transparent and API Operation
The following table compares the advantages of transparent and API modes of operation:
Transparent Operation Features
Simple Interface
All received serial data is transmitted unless the module is in
command mode.
Easy to support
It is easier for an application to support transparent operation
and command mode
API Operation Features
Easy to manage
data
transmissions to
multiple
destinations
Transmitting RF data to multiple remotes only requires changing
the address in the API frame. This process is much faster than in
transparent operation where the application must enter AT
command mode, change the address, exit command mode, and
then transmit data.
Each API transmission can return a transmit status frame
indicating the success or reason for failure.
Received data
frames indicate
the sender's
address
All received RF data API frames indicate the source address.
Advanced
addressing
support
API transmit and receive frames can expose addressing fields
including source and destination endpoints, cluster ID and profile
ID.
Advanced
networking
diagnostics
API frames can provide indication of IO samples from remote
devices, and node identification messages.
Remote
Configuration
Set / read configuration commands can be sent to remote devices
to configure them as needed using the API.