Route Record Indicator - 0Xa1 - Digi XBee 3 ZigBee User Manual

Frame descriptions

Route Record Indicator - 0xA1

Description
This frame contains the routing information for a remote device on the network. This route
information should be stored in external memory and used in a 0x21 Create Source Route frame to
provide a return route for data transmissions; this eliminates the need to perform a route discovery.
The frame will be emitted out of the node that is acting as a low RAM concentrator when a unicast
data transmission is received from a remote node for the first time. If a previously established route
fails, a new 0xA1 Route Record Indicator will be generated with information about the new route.
Format
The following table provides the contents of the frame. For details on frame structure, see
format.
Frame data fields
Frame type
64-bit source
(remote) address
Source (updater)
16-bit address
Receive options
Number of addresses
Address 1
Address 2 (closer hop)
Address n (neighbor of
source)
Example
Suppose device A is a low RAM concentrator, and device E is sending a unicast message to it.
Device E knows that device A is a low RAM concentrator and will send a route record that traverses
multiple hops en route to the concentrator as shown in the following example:
A < B < C < D < E
In this frame, the following route information is provided:
Device E 64-bit address: 0x0013A200 40401122
Device E 16-bit address: 0x3344
Device D 16-bit address: 0xEEFF
Digi XBee® 3 Zigbee® RF Module
Offset Description
3 0xA1
4-11 The 64-bit address of the device that initiated the route record.
12-13 The 16-bit address of the device that initiated the route record.
0x01 - Packet Acknowledged.
14
0x02 - Packet was a broadcast.
15 The number of addresses in the source route (excluding source
and destination).
16-17 (neighbor of destination)
18-19 Address of intermediate hop
20 Two bytes per 16-bit address.
21
Route Record Indicator - 0xA1
API frame
312