Network Creator#
API and Callbacks for the Network Creator Component.
This component performs the necessary steps to create a network according to the Base Device Behavior specification. The component performs an active scan followed by an energy scan across a primary channel set to decide which channel(s) are valid candidates for network formation. If the component fails to form a network on any primary channels, it moves to a secondary channel mask. Before every attempt at network formation, this component sets up the stack to use Zigbee 3.0 security.
Modules#
API#
Command the network creator to form a network with arbitrary PAN ID, TX power, and channel.
Stop the network creator process.
Command the network creator to form a network with the given qualities (arguments).
Variables#
The first set of channels that the plugin will scan when forming (hex) <0-0xFFFFFFFF> <f.h>
The second set of channels that the plugin will scan when forming (hex) <0-0xFFFFFFFF> <f.h>
Macros#
API Documentation#
sl_zigbee_af_network_creator_start#
sl_status_t sl_zigbee_af_network_creator_start (bool centralizedNetwork)
Command the network creator to form a network with arbitrary PAN ID, TX power, and channel.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| bool | [in] | centralizedNetwork | Whether or not to form a network using centralized security. If this argument is false, a network with distributed security will be formed. |
Returns
sl_status_t value that indicates either the successful formation of the new network, or the reason that the network formation failed.
SL_STATUS_INVALID_STATE if there is an ongoing scan or a network is already active.
SL_STATUS_FAIL if the scan queue is full.
SL_STATUS_OK if the network creator process has started.
sl_zigbee_af_network_creator_stop#
void sl_zigbee_af_network_creator_stop (void )
Stop the network creator process.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
Stops the network creator formation process.
sl_zigbee_af_network_creator_network_form#
sl_status_t sl_zigbee_af_network_creator_network_form (bool centralizedNetwork, sl_802154_pan_id_t panId, int8_t radioTxPower, uint8_t channel)
Command the network creator to form a network with the given qualities (arguments).
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| bool | [in] | centralizedNetwork | Indicates whether or not to form a network using centralized security. If this argument is false, a network with distributed security will be formed. |
| sl_802154_pan_id_t | [in] | panId | The pan ID of the network to be formed. |
| int8_t | [in] | radioTxPower | The TX power of the network to be formed. |
| uint8_t | [in] | channel | The channel of the network to be formed. |
Commands the network creator to form a centralized or distributed network with specified PAN ID, TX power, and channel.
Returns
sl_status_t value that indicates either the successful formation of the new network, or the reason that the network formation failed.
SL_STATUS_INVALID_STATE if there is an ongoing scan or a network is already active.
SL_STATUS_FAIL if the scan queue is full.
SL_STATUS_OK if the network creator process has started.
Variable Documentation#
sli_zigbee_af_network_creator_primary_channel_mask#
uint32_t sli_zigbee_af_network_creator_primary_channel_mask
The first set of channels that the plugin will scan when forming (hex) <0-0xFFFFFFFF> <f.h>
sli_zigbee_af_network_creator_secondary_channel_mask#
uint32_t sli_zigbee_af_network_creator_secondary_channel_mask
The second set of channels that the plugin will scan when forming (hex) <0-0xFFFFFFFF> <f.h>