API Operation Frame descriptions
XBee/XBee-PRO® S2C ZigBee® RF Module
203
Route Record Indicator - 0xA1
Description
The route record indicator is received whenever a device sends a ZigBee route record command. The
device uses the route record indicator with many-to-one routing to create source routes for devices in
a network.
Format
The following table provides the contents of the frame. For details on frame structure, see API frame
format.
Frame data fields Offset Description
Frame type 3 0xA1
64-bit source
(remote) address
4-11 MSB first, LSB last. The 64-bit address of the device that initiated
the route record.
Source (updater)
16-bit address
12-13 The 16-bit address of the device that initiated the route record.
Receive options 14
0x01 - Packet Acknowledged.
0x02 - Packet was a broadcast.
Number of addresses 15 The number of addresses in the source route (excluding source
and destination).
Address 1 16-17 (neighbor of destination)
Address 2 (closer hop) 18-19 Address of intermediate hop
Address n (neighbor of
source)
20 Two bytes per 16-bit address.
21
Example
Suppose device E sends a route record that traverses multiple hops en route to data collector device A
as shown in the following example.
A B C D E
If device E has the 64-bit and 16-bit addresses of 0x0013A200 40401122 and 0x3344, and if devices B,
C, and D have the following 16-bit addresses:
B = 0xAABB C = 0xCCDD D = 0xEEFF
The data collector sends the above API frame out its serial port.
Frame data fields Offset Example
Start delimiter 0 0x7E
Length MSB 1 0x00