Register Joining Device - 0X24 - Digi XBee 3 ZigBee User Manual

Frame descriptions
Frame data fields
Remote command options
Number of addresses
Address 1
Address 2 (closer hop)
Address 3
Checksum

Register Joining Device - 0x24

Description
Use this frame to securely register a joining device to a trust center. Registration is the process by
which a node is authorized to join the network using a preconfigured link key or installation code that
is conveyed to the trust center out-of-band (using a physical interface and not over-the-air).
If registering a device with a centralized trust center (EO = 2), then the key entry will only persist for
KT seconds before expiring, or until the device joins the network where the key is cleared.
Registering devices in a distributed trust center (EO = 0) is persistent and the key entry will never
expire unless explicitly removed.
To remove a key entry on a distributed trust center, a 0x24 frame should be issued with a null key (key
field is absent from the frame). In a centralized trust center you cannot use this method to explicitly
remove the key entries.
The API 0x24 registration frame will accept all 0xFF's for the device address (EUI) with an install code
as a wild card. You can only register one entry at a time with the trust center in this manner with EUI
with all 0xFF's . Only after the KT time period expires can you enter an additional entry with EUI with
all 0xFF's... We do not recommend this method. A best practice is to specifically set the EUI for every
device with an install code.
Format
The following table provides the contents of the frame. For details on frame structure, see
format.
Frame data
fields
Frame type
Frame ID
Digi XBee® 3 Zigbee® RF Module
Offset Description
3 0x24 Register Joining Device
Identifies the data frame for the host to correlate with a subsequent
4
response. If set to 0, the device does not send a response.
Register Joining Device - 0x24
Offset Example
15 0x00
16 0x03
17 0xEE
18 0xFF
19 0xCC
20 0xDD
21 0xAA
22 0xBB
23 0x01
API frame
270