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#

EmberStatus

emberAfPluginNetworkCreatorStart(bool centralizedNetwork)

Command the network creator to form a network with the following qualities.

void

emberAfPluginNetworkCreatorStop(void)

Stop the network creator process.

EmberStatus

emberAfPluginNetworkCreatorNetworkForm(bool centralizedNetwork, EmberPanId panId, int8_t radioTxPower, uint8_t channel)

Command the network creator to form a centralized network.

Variables#

uint32_t

sli_zigbee_af_network_creator_primary_channel_mask

uint32_t

sli_zigbee_af_network_creator_secondary_channel_mask

Macros#

#define

EMBER_AF_PLUGIN_NETWORK_CREATOR_PLUGIN_NAME "NWK Creator"

API Documentation#

emberAfPluginNetworkCreatorStart#

EmberStatus emberAfPluginNetworkCreatorStart (bool centralizedNetwork)

Command the network creator to form a network with the following qualities.

Parameters

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.

Definition at line 69 of file app/framework/plugin/network-creator/network-creator.h

emberAfPluginNetworkCreatorStop#

void emberAfPluginNetworkCreatorStop (void )

Stop the network creator process.

Parameters

N/A

Stops the network creator formation process.

Definition at line 75 of file app/framework/plugin/network-creator/network-creator.h

emberAfPluginNetworkCreatorNetworkForm#

EmberStatus emberAfPluginNetworkCreatorNetworkForm (bool centralizedNetwork, EmberPanId panId, int8_t radioTxPower, uint8_t channel)

Command the network creator to form a centralized network.

Parameters

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.
N/A	panId	The pan ID of the network to be formed.
N/A	radioTxPower	The TX power of the network to be formed.
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.

Definition at line 92 of file app/framework/plugin/network-creator/network-creator.h

Variable Documentation#

sli_zigbee_af_network_creator_primary_channel_mask#

uint32_t sli_zigbee_af_network_creator_primary_channel_mask

Definition at line 49 of file app/framework/plugin/network-creator/network-creator.h

sli_zigbee_af_network_creator_secondary_channel_mask#

uint32_t sli_zigbee_af_network_creator_secondary_channel_mask

Definition at line 50 of file app/framework/plugin/network-creator/network-creator.h

Macro Definition Documentation#

EMBER_AF_PLUGIN_NETWORK_CREATOR_PLUGIN_NAME#

#define EMBER_AF_PLUGIN_NETWORK_CREATOR_PLUGIN_NAME

Value:

"NWK Creator"

Definition at line 44 of file app/framework/plugin/network-creator/network-creator.h