Api Serial Exchanges; At Command Frames; Transmit And Receive Rf Data; Remote At Commands - Digi XLR PRO User Manual

Operate in API mode
To verify: Add all bytes (include checksum, but exclude the delimiter and length). If the checksum is
correct, the sum will equal 0xFF.

API serial exchanges

You can use the Frame ID field to assign an identifier to each outgoing API frame. This Frame ID, if
non-zero, can correlate between the outgoing frames and the associated responses.

AT command frames

The following image shows the API frame exchange that takes place at the serial interface when
sending an AT command request to read or set an XLR PRO parameter. To disable the response, set
the frame ID to 0 in the request.

Transmit and receive RF data

The following image shows the API exchanges that take place at the serial interface when sending RF
data to another device. The transmit status frame is always sent at the end of a data transmission
unless the frame ID is set to 0 in the TX request. If the packet cannot be delivered to the destination,
the transmit status frame indicates the cause of failure. The received data frame type (standard 0x90,
or explicit 0x91) is set by the AP command.

Remote AT commands

The following image shows the API frame exchanges that take place at the serial interface when
sending a remote AT command. A remote command response frame is not sent out the serial
interface if the remote device does not receive the remote command.

Code to support future API frames

If your software application supports the API, you should make provisions that allow for new API
frames in future firmware releases. For example, you can include the following section of code on a
host microprocessor that handles serial API frames that are sent out the device's DOUT pin:
XLR PRO Radio Frequency (RF) Module User Guide

API serial exchanges

83