Network Steering#
Callbacks for Network Steering Component.
Callbacks#
Complete network steering.
Get power for a radio channel.
Get the distributed key.
Get the node type.
Callbacks Documentation#
emberAfPluginNetworkSteeringCompleteCallback#
void emberAfPluginNetworkSteeringCompleteCallback (EmberStatus status, uint8_t totalBeacons, uint8_t joinAttempts, uint8_t finalState)
Complete network steering.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberStatus | N/A | status | On success this will be set to EMBER_SUCCESS to indicate a network was joined successfully. On failure this will be the status code of the last join or scan attempt. Ver.: always |
| uint8_t | N/A | totalBeacons | The total number of 802.15.4 beacons that were heard, including beacons from different devices with the same PAN ID. Ver.: always |
| uint8_t | N/A | joinAttempts | The number of join attempts that were made to get onto an open Zigbee network. Ver.: always |
| uint8_t | N/A | finalState | The finishing state of the network steering process. From this, one is able to tell on which channel mask and with which key the process was complete. Ver.: always |
This callback is fired when the Network Steering plugin is complete.
emberAfPluginNetworkSteeringGetPowerForRadioChannelCallback#
int8_t emberAfPluginNetworkSteeringGetPowerForRadioChannelCallback (uint8_t channel)
Get power for a radio channel.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | channel | The channel that the plugin is inquiring about the power level. Ver.: always |
This callback is fired when the Network Steering plugin needs to set the power level. The application has the ability to change the max power level used for this particular channel.
emberAfPluginNetworkSteeringGetDistributedKeyCallback#
bool emberAfPluginNetworkSteeringGetDistributedKeyCallback (EmberKeyData * key)
Get the distributed key.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberKeyData * | N/A | key | to the distributed key struct |
This callback is fired when the Network Steering plugin needs to set the distributed key. The application set the distributed key from Zigbee Alliance through this callback or the network steering will use the default test key.
Returns
true if the key is loaded successfully, otherwise false. level. Ver.: always
emberAfPluginNetworkSteeringGetNodeTypeCallback#
EmberNodeType emberAfPluginNetworkSteeringGetNodeTypeCallback (EmberAfPluginNetworkSteeringJoiningState state)
Get the node type.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberAfPluginNetworkSteeringJoiningState | N/A | state | The current EmberAfPluginNetworkSteeringJoiningState. |
This callback allows the application to set the node type that the network steering process will use in joining a network.
Returns
An ::EmberNodeType value that the network steering process will try to join a network as.