Modules#
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.
API#
Command the network creator to form a network with the following qualities.
Stop the network creator process.
Command the network creator to form a centralized network.
Variables#
Macros#
API Documentation#
emberAfPluginNetworkCreatorStart#
EmberStatus emberAfPluginNetworkCreatorStart (bool centralizedNetwork)
Command the network creator to form a network with the following qualities.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| bool | N/A | 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
Status of the commencement of the network creator process.
emberAfPluginNetworkCreatorStop#
void emberAfPluginNetworkCreatorStop (void )
Stop the network creator process.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
Stops the network creator formation process.
emberAfPluginNetworkCreatorNetworkForm#
EmberStatus emberAfPluginNetworkCreatorNetworkForm (bool centralizedNetwork, EmberPanId panId, int8_t radioTxPower, uint8_t channel)
Command the network creator to form a centralized network.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| bool | N/A | 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. |
| EmberPanId | N/A | panId | The pan ID of the network to be formed. |
| int8_t | N/A | radioTxPower | The TX power of the network to be formed. |
| uint8_t | N/A | 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
Status of the commencement of the network creator process.