XLR PRO operational design
XLR PRO Radio Frequency (RF) Modem User Guide
24
Receive Data Frames (sent out the serial port) include:
•
RF-received data frame
•
Command response
•
Event notifications such as reset and so on
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 XLR PRO that contain address and payload information instead of using
command mode to modify addresses. The XLR PRO 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:
•
Transmitting data to multiple destinations without entering Command Mode
•
Receiving the success or failure status of each transmitted RF packet
•
Identifying the source address of each received packet
Comparing transparent and API operation
The following table compares the advantages of transparent and API modes of operation:
As a general rule of thumb, API mode is recommended when a device:
•
Sends RF data to multiple destinations
•
Sends remote configuration commands to manage devices in the network
•
Receives RF data packets from multiple devices, and the application needs to know which device sent which
packet
Transparent operation features
Simple interface
All received serial data is transmitted unless the XLR PRO is in command mode. The
XLR PRO will act as a serial cable replacement.
Easy to support
It is easier for an application to support transparent operation and command
mode. Integrates easily with existing serial equipment and will work “out of the
box” in many applications.
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. This makes receiving
data from multiple sources easy to identify and manage.
Advanced networking
diagnostics
This allows for diagnosis of RF network problems that may be a result of poor RF
performance or identifying nodes that have lost network connectivity.
Remote configuration
Set/read configuration commands can be sent to remote devices to configure them
as needed using the API. This also includes over-the-air firmware updates.