Network Find#
Callbacks for Network Find Component.
Callbacks#
Finish forming or joining process.
Get radio power for a channel.
Join a network.
Get the energy threshold for a channel.
Get enable scanning all channels.
Callbacks Documentation#
emberAfPluginNetworkFindFinishedCallback#
void emberAfPluginNetworkFindFinishedCallback (EmberStatus status)
Finish forming or joining process.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberStatus | N/A | status | Ver.: always |
This callback is fired when the network-find plugin is finished with the forming or joining process. The result of the operation will be returned in the status parameter.
emberAfPluginNetworkFindGetRadioPowerForChannelCallback#
int8_t emberAfPluginNetworkFindGetRadioPowerForChannelCallback (uint8_t pgChan)
Get radio power for a channel.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | pgChan | Ver.: always |
This callback is called by the framework when it is setting the radio power during the discovery process. The framework will set the radio power depending on what is returned by this callback.
emberAfPluginNetworkFindJoinCallback#
bool emberAfPluginNetworkFindJoinCallback (EmberZigbeeNetwork * networkFound, uint8_t lqi, int8_t rssi)
Join a network.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberZigbeeNetwork * | N/A | networkFound | Ver.: always |
| uint8_t | N/A | lqi | Ver.: always |
| int8_t | N/A | rssi | Ver.: always |
This callback is called by the plugin when a joinable network has been found. If the application returns true, the plugin will attempt to join the network. Otherwise, the plugin will ignore the network and continue searching. Applications can use this callback to implement a network blacklist.
emberAfPluginNetworkFindGetEnergyThresholdForChannelCallback#
int8_t emberAfPluginNetworkFindGetEnergyThresholdForChannelCallback (uint8_t pgChan)
Get the energy threshold for a channel.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | pgChan | Ver.: always |
This callback is called during the energy scan when forming the network. Should the energy level exceed the value returned by this callback, the current channel will not be considered a suitable candidate for forming. Should none of the channels in the channel mask be considered suitable, the scan will fall back on all channels, including those not on the channel mask. The return value is RSSI, in dBm. This callback is called only when the fallback functionality is enabled.
emberAfPluginNetworkFindGetEnableScanningAllChannelsCallback#
bool emberAfPluginNetworkFindGetEnableScanningAllChannelsCallback (void )
Get enable scanning all channels.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
Returns true is the fallback on scanning all channels is enabled, false if not.