Create Source Route - 0X21 - Digi XBee 3 ZigBee User Manual

Frame descriptions

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
format.
Frame
data
fields Offset
Frame 3
type
Frame ID 4
64-bit 5-12
destination
address
16-bit
13-14
destination
network
address
Route 15
command
options
Number of
16
addresses
Address 1 17
18
Digi XBee® 3 Zigbee® RF Module
Description
This frame type has no response, so the Frame ID is ignored.
MSB first, LSB last. Set to the 64-bit address of the
destination device.
Reserved 64-bit address for the coordinator =
0x0000000000000000
Broadcast = 0x000000000000FFFF.
The 16-bit address of the destination node (required).
Set to 0.
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.
Neighbor of destination
Create Source Route - 0x21
API frame
268