WWAH Connectivity Manager#

API and Callbacks for the WWAH Connectivity Manager Component.

Silicon Labs implementation of the Works With All Hubs connectivity functions per the Zigbee WWAH Requirements document. This component should be included by routers and end devices only. This component manages connectivity states to both the hub and, for end devices, to the parent. In the event of connection loss, restoration is performed per the WWAH Connectivity Recovery Procedure as defined in the Zigbee WWAH Requirements specification. The component uses the Trust Center Keepalive component on routers and non-sleepy end devices to determine hub connectivity. On sleepy end devices, it uses the Poll Control Server component to determine hub connectivity. On end devices, this component also uses the End Device Support component to determine parent connectivity.

Modules#

WWAH Connectivity Manager

API#

bool

emberAfPluginWwahConnectivityManagerIsRejoinAlgorithmEnabled(void)

Get rejoin algorithm enabled state.

void

emberAfPluginWwahConnectivityManagerEnableRejoinAlgorithm(uint8_t endpoint)

Enable rejoin algorithm.

void

emberAfPluginWwahConnectivityManagerDisableRejoinAlgorithm(uint8_t endpoint)

Disable rejoin algorithm.

bool

emberAfPluginWwahConnectivityManagerIsBadParentRecoveryEnabled(void)

Get bad parent recovery state.

void

emberAfPluginWwahConnectivityManagerEnableBadParentRecovery(uint16_t badParentRejoinPeriod)

Enable bad parent recovery.

void

emberAfPluginWwahConnectivityManagerDisableBadParentRecovery()

Disable bad parent recovery.

EmberStatus

emberAfPluginWwahConnectivityManagerEnablePeriodicRouterCheckIns(uint16_t checkInInterval)

Enable periodic router checkins.

EmberStatus

emberAfPluginWwahConnectivityManagerDisablePeriodicRouterCheckIns(void)

Disable periodic router checkins.

void

emberAfPluginWwahConnectivityManagerSetRejoinParameters(uint16_t fastRejoinTimeoutSeconds, uint16_t durationBetweenRejoinsSeconds, uint16_t fastRejoinFirstBackoffSeconds, uint16_t maxBackoffTimeSeconds, uint16_t maxBackoffIterations)

Set rejoin parameters.

API Documentation#

emberAfPluginWwahConnectivityManagerIsRejoinAlgorithmEnabled#

bool emberAfPluginWwahConnectivityManagerIsRejoinAlgorithmEnabled (void)

Get rejoin algorithm enabled state.

Parameters

N/A

Returns

bool true if enabled

Definition at line 54 of file app/framework/plugin/wwah-connectivity-manager/wwah-connectivity-manager.h

emberAfPluginWwahConnectivityManagerEnableRejoinAlgorithm#

void emberAfPluginWwahConnectivityManagerEnableRejoinAlgorithm (uint8_t endpoint)

Enable rejoin algorithm.

Parameters

N/A

endpoint

Ver.: always

Definition at line 61 of file app/framework/plugin/wwah-connectivity-manager/wwah-connectivity-manager.h

emberAfPluginWwahConnectivityManagerDisableRejoinAlgorithm#

void emberAfPluginWwahConnectivityManagerDisableRejoinAlgorithm (uint8_t endpoint)

Disable rejoin algorithm.

Parameters

N/A

endpoint

Ver.: always

Definition at line 68 of file app/framework/plugin/wwah-connectivity-manager/wwah-connectivity-manager.h

emberAfPluginWwahConnectivityManagerIsBadParentRecoveryEnabled#

bool emberAfPluginWwahConnectivityManagerIsBadParentRecoveryEnabled (void)

Get bad parent recovery state.

Parameters

N/A

Returns

bool true if enabled

Definition at line 75 of file app/framework/plugin/wwah-connectivity-manager/wwah-connectivity-manager.h

emberAfPluginWwahConnectivityManagerEnableBadParentRecovery#

void emberAfPluginWwahConnectivityManagerEnableBadParentRecovery (uint16_t badParentRejoinPeriod)

Enable bad parent recovery.

Parameters

N/A

badParentRejoinPeriod

Ver.: always

Definition at line 82 of file app/framework/plugin/wwah-connectivity-manager/wwah-connectivity-manager.h

emberAfPluginWwahConnectivityManagerDisableBadParentRecovery#

void emberAfPluginWwahConnectivityManagerDisableBadParentRecovery ()

Disable bad parent recovery.

Definition at line 87 of file app/framework/plugin/wwah-connectivity-manager/wwah-connectivity-manager.h

emberAfPluginWwahConnectivityManagerEnablePeriodicRouterCheckIns#

EmberStatus emberAfPluginWwahConnectivityManagerEnablePeriodicRouterCheckIns (uint16_t checkInInterval)

Enable periodic router checkins.

Parameters

N/A

checkInInterval

Ver.: always

Returns

EmberStatus status code

Definition at line 96 of file app/framework/plugin/wwah-connectivity-manager/wwah-connectivity-manager.h

emberAfPluginWwahConnectivityManagerDisablePeriodicRouterCheckIns#

EmberStatus emberAfPluginWwahConnectivityManagerDisablePeriodicRouterCheckIns (void)

Disable periodic router checkins.

Parameters

N/A

Returns

EmberStatus status code

Definition at line 103 of file app/framework/plugin/wwah-connectivity-manager/wwah-connectivity-manager.h

emberAfPluginWwahConnectivityManagerSetRejoinParameters#

void emberAfPluginWwahConnectivityManagerSetRejoinParameters (uint16_t fastRejoinTimeoutSeconds, uint16_t durationBetweenRejoinsSeconds, uint16_t fastRejoinFirstBackoffSeconds, uint16_t maxBackoffTimeSeconds, uint16_t maxBackoffIterations)

Set rejoin parameters.

Parameters

N/A	fastRejoinTimeoutSeconds	Ver.: always
N/A	durationBetweenRejoinsSeconds	Ver.: always
N/A	fastRejoinFirstBackoffSeconds	Ver.: always
N/A	maxBackoffTimeSeconds	Ver.: always
N/A	maxBackoffIterations	Ver.: always

Definition at line 114 of file app/framework/plugin/wwah-connectivity-manager/wwah-connectivity-manager.h