Frame descriptions Create Source Route - 0x21
Digi XBee® 3 Zigbee® RF Module
268
Create Source Route - 0x21
Description
This frame creates a source route in the device. A source route specifies the complete route a packet
traverses to get from source to destination. For best results, use source routing with many-to-one
routing.
There is no response frame for this frame type. Take care when generating source routes. An
incorrectly formatted frame will be silently rejected by the radio or cause unexpected results.
Note Both the 64-bit and 16-bit destination addresses are required when creating a source route.
These are obtained when the device receives a Route Record Indicator (0xA1) frame.
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
Frame ID 4 This frame type has no response, so the Frame ID is ignored.
64-bit
destination
address
5-12
MSB first, LSB last. Set to the 64-bit address of the
destination device.
Reserved 64-bit address for the coordinator =
0x0000000000000000
Broadcast = 0x000000000000FFFF.
16-bit
destination
network
address
13-14 The 16-bit address of the destination node (required).
Route
command
options
15 Set to 0.
Number of
addresses
16
The number of addresses in the source route (excluding
source and destination). A route can only traverse across 30
hops. If this number is 0 or exceeds the maximum hop count,
the frame is silently discarded and a route will not be created.
Address 1 17 Neighbor of destination
18