Network Steering#

Callbacks for Network Steering Component.

Callbacks#

void
emberAfPluginNetworkSteeringCompleteCallback(EmberStatus status, uint8_t totalBeacons, uint8_t joinAttempts, uint8_t finalState)

Complete network steering.

int8_t
emberAfPluginNetworkSteeringGetPowerForRadioChannelCallback(uint8_t channel)

Get power for a radio channel.

bool
emberAfPluginNetworkSteeringGetDistributedKeyCallback(EmberKeyData *key)

Get the distributed key.

EmberNodeType
emberAfPluginNetworkSteeringGetNodeTypeCallback(EmberAfPluginNetworkSteeringJoiningState state)

Get the node type.

Callbacks Documentation#

emberAfPluginNetworkSteeringCompleteCallback#

void emberAfPluginNetworkSteeringCompleteCallback (EmberStatus status, uint8_t totalBeacons, uint8_t joinAttempts, uint8_t finalState)

Complete network steering.

Parameters
N/Astatus

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

N/AtotalBeacons

The total number of 802.15.4 beacons that were heard, including beacons from different devices with the same PAN ID. Ver.: always

N/AjoinAttempts

The number of join attempts that were made to get onto an open Zigbee network. Ver.: always

N/AfinalState

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.


Definition at line 216 of file app/framework/plugin/network-steering/network-steering.h

emberAfPluginNetworkSteeringGetPowerForRadioChannelCallback#

int8_t emberAfPluginNetworkSteeringGetPowerForRadioChannelCallback (uint8_t channel)

Get power for a radio channel.

Parameters
N/Achannel

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.


Definition at line 230 of file app/framework/plugin/network-steering/network-steering.h

emberAfPluginNetworkSteeringGetDistributedKeyCallback#

bool emberAfPluginNetworkSteeringGetDistributedKeyCallback (EmberKeyData * key)

Get the distributed key.

Parameters
N/Akey

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


Definition at line 242 of file app/framework/plugin/network-steering/network-steering.h

emberAfPluginNetworkSteeringGetNodeTypeCallback#

EmberNodeType emberAfPluginNetworkSteeringGetNodeTypeCallback (EmberAfPluginNetworkSteeringJoiningState state)

Get the node type.

Parameters
N/Astate

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.


Definition at line 254 of file app/framework/plugin/network-steering/network-steering.h