(0x01) Network Commissioning Frames
The Network Commissioning command set allows the Host to prompt the Module to either form a network or join an existing network.
Updates to the Zigbee 3.0 Commissioning mechanism have been incorporated into RapidConnect v3.5.0 and above. Network Steering is now the preferred method of joining a new network, while the Network Formation command is used when forming new networks.
( PH:0x01, SH:0x00 ) - Join Network Command
Overview
The Join Network command is sent by the Host to the Module to prompt the Module to scan for and join an existing network.
Payload
Byte Index | Field Name | Notes |
|---|---|---|
0..3 | Channel Mask | Four-byte channel mask. Each bit represents channels 0 – 31. Example: Channel 11 = 0x00000800 or interpreted as a 32-bit bitmap - 0000 0000 0000 0000 0000 1000 0000 0000 - bit 11 would be flipped Channel 13 = 0x00002000 or interpreted as a 32-bit bitmap - 0000 0000 0000 0000 0010 0000 0000 0000 - bit 13 would be flipped Zigbee networks can only operate on channels 11 through 26. To comply with FCC regulations, MMB Networks devices operate at a reduced power level on channel 26. It's not recommended to form a network on this channel as it will have a reduced range. |
4 | Auto Options | Bit 0 = 1 – Auto PAN ID If both bits are “1” and multiple networks exist on the channel, |
5,6 | Short PAN ID | The Short PAN ID of the network that the Module must join. |
7..14 | Extended PAN ID | The Extended PAN ID of the network Module must join to. |
Effect on Receipt
The Module will sequentially scan all channels defined by the Channel Mask. The Module will attempt to join any network with an open Permit Join window and matching the PAN IDs as specified in the command payload. If a join attempt fails, the Module will resume scanning until it has tried all available and applicable networks. The possible Status Responses generated by the Module in response to this command are listed in the following table.
Status Responses to Join Network Command
Status Response | Enum | Description |
|---|---|---|
Success | 0x00 | The Module successfully processed the command, and shall start the scan and join sequence. |
Invalid Call | 0x01 | The Module is already on a network. The command is only valid when the application’s network state is Network Down. |
Invalid Data | 0x02 | No channels have been selected in the Channel Mask defined in the command. |
Allowed Context
Network Down.
Sent By Host/Module
Host.
( PH:0x01, SH:0x01 ) - Form Network Command
Overview
The Form Network command is sent by the Host to the Module to prompt the latter to form a network. Additionally on reception of this command, the application Zigbee Device Type is set to Coordinator.
Payload
Byte Index | Field Name | Notes |
|---|---|---|
0..3 | Channel Mask | 4-byte channel mask. Each bit represents channels 0 – 31. The least significant bit, bit 0, corresponds to channel 0, bit 1 to channel 1, etc. Example: Channel 11 = 0x00000800 or interpreted as a 32-bit bitmap - 0000 0000 0000 0000 0000 1000 0000 0000 - bit 11 would be flipped Channel 13 = 0x00002000 or interpreted as a 32-bit bitmap - 0000 0000 0000 0000 0010 0000 0000 0000 - bit 13 would be flipped Zigbee networks only operate on channels 11-26 (inclusive). If multiple channels are selected, the Module will form a network on the channel with the least interference. Please note: channel 26 is restricted. Networks formed on this channel are in violation of FCC rules and regulations. |
4 | Auto Options | Bit 0 = 1 – Auto PAN ID |
5,6 | Short PAN ID | The Short PAN ID of the new network. |
7..14 | Extended PAN ID | The Extended PAN ID of the new network. |
Effect on Receipt
The Module will sequentially scan all channels defined by the channel mask and select the one with the least interference. It will then attempt to form a network with the Short and Extended PAN ID’s specified by the Host. Otherwise, if the Host has enabled the Auto Options for those parameters, the Module will generate randomized PAN ID’s that do not conflict with any other network within range.
The possible Status Responses generated by the Module in response to this command are listed in the following table. Additionally, when a network is successfully formed, the Module will inform the Host by issuing a Network Status Response indicating the new application network state.
Status Responses to Form Network Command
Status Response | Description |
|---|---|
Success | Module successfully processed the command, and shall start to form network. Host shall wait for a Network Status Response for the final status result |
Invalid Call | Already on a network. The command can only be called in state of Network Down |
Invalid Data | No channels are selected |
Unsupported | Module is configured as a Reduced Function Device. Command is only available for Full Function Device. |
Allowed Context
Network Down.
Sent By Host/Module
Host.
( PH:0x01, SH:0x03 ) - Permit Join Command
Overview
The Permit Join command is sent by the Host to the Module in order to prompt the Module to open its Permit Join window for a given duration.
Payload
Byte Index | Field Name | Notes |
|---|---|---|
0 | Permit Join Duration | The Duration in seconds to permit joining If a value of 0xFF is specified to establish a permanent duration the application will automatically revert the value to 0xFE. This precaution prevents the possibility of setting a permanent join window on a receiving router node and subsequently not closing it (e.g. if a subsequent permit join message is missed). The Host retains the option of refreshing the permit join window to effectively retain a permanent duration, but this is discouraged. |
Effect on Receipt
When the application Zigbee device type is configured as an end device, the Module will ignore this command. When configured as a router, the Module will open its Permit Join window for the specified Permit Join Duration. When configured as a coordinator, the Module will open its Permit Join window for the specified Permit Join Duration and will additionally broadcast a message to prompt all routers on its network to also permit joining.
Allowed Context
Network Up.
Sent By Host/Module
Host.