Register Joining Device - 0x24
Response frame: Registration Status - 0xA4
Description
This frame type is used 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 pre-configured or installation code-derived link key that is conveyed to the trust center out-of-band—using an interface that is not the Zigbee network.
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 whereby 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 before the KT timeout.
The registration frame will accept all 0xFF's for the device address (EUI) as a wild card. You can only register one entry at a time with the trust center in this manner. Only after the KT period expires can you enter an additional wildcard entry. We do not recommend this method. A best practice is to specifically set the EUI for every device individually.
Format
The following table provides the contents of the frame. For details on frame structure, see API frame format.
| Offset | Size | Frame Field | Description |
|---|---|---|---|
| 0 | 8-bit | Start Delimiter | Indicates the start of an API frame. |
| 1 | 16-bit | Length | Number of bytes between the length and checksum. |
| 3 | 8-bit | Frame type |
Register Joining Device - 0x24 |
| 4 | 8-bit | Frame ID |
Identifies the data frame for the host to correlate with a subsequent response. If set to 0, the device will not emit a response frame. |
| 5 | 64-bit |
64-bit registrant address |
Set to the 64-bit IEEE address of the joining device. Set to 0xFFFFFFFFFFFFFFFF to act as a one-time use wildcard. |
| 13 | 16-bit | Reserved | Not used. Set to 0xFFFE. |
| 15 | 8-bit |
Options |
Bit field of options that apply to device registration:
Note Option values may be combined. Set all unused bits to 0. |
| 16-n |
variable |
Key/Install Code |
When registering using a pre-configured link key, field accepts up to 16-bytes. When registering using an install code, enter the installation code + CRC—I? command—of the joining device. Up to 18-bytes, the CRC can be any endianness. |
| EOF | 8-bit | Checksum | 0xFF minus the 8-bit sum of bytes from offset 3 to this byte—between length and checksum. |
Examples
Each example is written without escapes—AP = 1—and all bytes are represented in hex format. For brevity, the start delimiter, length, and checksum fields have been excluded.
Pre-configured link key registration
A device with the address of 0013A20012345678 needs to join a secured network using a pre-configured link key of 12345. This link key is unknown to the trust center—KY does not match—thus it must be conveyed out-of-band via a registration frame.
The corresponding Registration Status - 0xA4 response with a matching Frame ID will indicate whether the registration succeeded.
7E 00 10 24 5D 00 13 A2 00 12 34 56 78 FF FE 00 01 23 45 4F
| Frame type | Frame ID | 64-bit reg address | Reserved | Options | Key/Install Code |
|---|---|---|---|---|---|
| 0x24 | 0x5D |
0x0013A200 |
0xFFFE | 0x00 | 0x012345 |
| Registration | Matches response |
|
N/A | Key is a link key |
Pre-configured Link Key (KY) |
Installation code-derived link key registration
A device with the address of 0013A20012345678 needs to join a secured network using an install code of 620D28BDAF2A569B54E7377E33C504A099F1. The install code read by the I? command includes the 2-byte CRC, the install code can be read from a device and entered into the frame as-is.
The corresponding Registration Status - 0xA4 response with a matching Frame ID will indicate whether the registration succeeded.
7E 00 1F 24 1C 00 13 A2 00 12 34 56 78 FF FE 01 62 0D 28 BD AF 2A 56 9B 54 E7 37 7E 33 C5 04 A0 99 F1 C4
| Frame type | Frame ID | 64-bit reg address | Reserved | Options | Key/Install Code |
|---|---|---|---|---|---|
| 0x24 | 0x1C |
0x0013A200 |
0xFFFE | 0x01 |
0x620D28BDAF2A569B |
| Registration | Matches response |
|
N/A | Key is an install code | Install code (I?) |
Distributed trust center: link key de-registration
A previously registered device with the 64-bit address of 0013A20012345678 needs to have its registration information removed from a trust center so that the device remains on the network, but can no longer securely join. After de-registration, a remote NR0 command can be issued to remove the device from the network. This example only applies to a distributed trust center network—EO = 0—a centralized trust center will automatically expire the entry after KT seconds.
The corresponding Registration Status - 0xA4 response with a matching Frame ID will indicate whether the de-registration succeeded.
7E 00 0D 24 D5 00 13 A2 00 12 34 56 78 FF FE 00 40
| Frame type | Frame ID | 64-bit reg address | Reserved | Options | Key/Install Code |
|---|---|---|---|---|---|
| 0x24 | 0xD5 |
0x0013A200 |
0xFFFE | 0x00 | (omitted) |
| Registration | Matches response | device to de-register | N/A | N/A | Remove entry |
PDF
