RM024 User Manual
Version 2.3
Americas: +1-800-492-2320 Option 2
Europe: +44-1628-858-940
Hong Kong: +852-2923-0610
www.lairdtech.com/wireless
52
CONN-GUIDE-RAMP24-0413
API
O
PERATION
API Operation is a powerful alternative to the default transparent operation of the RM024 and provides
dynamic packet accounting abilities to the OEM host without requiring extensive programming by the OEM
host. API operation utilizes specific packet formats. The API features can be used in any combination that
suits the OEM’s specific needs and can be different between radios operating on the same network.
API Send Data Complete
API Send Data Complete can be used as a software acknowledgement indicator. When a radio sends an
addressed packet, it looks for a received acknowledgement (transparent to the OEM host). If an
acknowledgement is not received, the packet is retransmitted until one is received or all retries have been
exhausted.
For applications where data loss is not an option, the OEM host may wish to monitor the acknowledgement
process using the API Send Data Complete. If an acknowledgement is not received (failure), the OEM host
can resend the packet to the transceiver. Because the Send Data Complete is reliant upon a successful RF
acknowledgement from the receiving radio, a false positive is not possible but a false negative may occur.
That is, the receiving radio may have received the packet successfully, but the acknowledgement was not
received at the transmitting radio. For broadcast packets, the Send Data Complete always reports success.
API Send Data Complete is enabled when bit-2 of the API Control (Address 0xC1) byte is enabled. The
transceiver sends the OEM host the data shown in
Figure 4
upon receiving an RF acknowledge or exhausting
all attempts.
Figure 4: Send Data Complete Packet Format
API Receive Packet
By default, the source MAC is not included in the received data string sent to the OEM Host. For applications
where multiple radios are sending data, it may be necessary to determine the origin of a specific data packet.
When API Receive Packet is enabled, all packets received by the transceiver include the MAC address of the
source radio as well as an RSSI indicator which can be used to determine the link quality between the two.
API Receive Packet is enabled when bit-0 of the API Control (Address 0xC1) byte is enabled. Upon receiving a
RF packet, the radio sends its OEM host the data as shown in
Figure 5
.
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from
Downloaded from