Modules#
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.
API#
Get rejoin algorithm enabled state.
Enable rejoin algorithm.
Disable rejoin algorithm.
Get bad parent recovery state.
Enable bad parent recovery.
Disable bad parent recovery.
Enable periodic router checkins.
Disable periodic router checkins.
Set rejoin parameters.
API Documentation#
emberAfPluginWwahConnectivityManagerIsRejoinAlgorithmEnabled#
bool emberAfPluginWwahConnectivityManagerIsRejoinAlgorithmEnabled (void )
Get rejoin algorithm enabled state.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
Returns
bool true if enabled
emberAfPluginWwahConnectivityManagerEnableRejoinAlgorithm#
void emberAfPluginWwahConnectivityManagerEnableRejoinAlgorithm (uint8_t endpoint)
Enable rejoin algorithm.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | Ver.: always |
emberAfPluginWwahConnectivityManagerDisableRejoinAlgorithm#
void emberAfPluginWwahConnectivityManagerDisableRejoinAlgorithm (uint8_t endpoint)
Disable rejoin algorithm.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | Ver.: always |
emberAfPluginWwahConnectivityManagerIsBadParentRecoveryEnabled#
bool emberAfPluginWwahConnectivityManagerIsBadParentRecoveryEnabled (void )
Get bad parent recovery state.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
Returns
bool true if enabled
emberAfPluginWwahConnectivityManagerEnableBadParentRecovery#
void emberAfPluginWwahConnectivityManagerEnableBadParentRecovery (uint16_t badParentRejoinPeriod)
Enable bad parent recovery.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | N/A | badParentRejoinPeriod | Ver.: always |
emberAfPluginWwahConnectivityManagerDisableBadParentRecovery#
void emberAfPluginWwahConnectivityManagerDisableBadParentRecovery ()
Disable bad parent recovery.
emberAfPluginWwahConnectivityManagerEnablePeriodicRouterCheckIns#
EmberStatus emberAfPluginWwahConnectivityManagerEnablePeriodicRouterCheckIns (uint16_t checkInInterval)
Enable periodic router checkins.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | N/A | checkInInterval | Ver.: always |
Returns
EmberStatus status code
emberAfPluginWwahConnectivityManagerDisablePeriodicRouterCheckIns#
EmberStatus emberAfPluginWwahConnectivityManagerDisablePeriodicRouterCheckIns (void )
Disable periodic router checkins.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
Returns
EmberStatus status code
emberAfPluginWwahConnectivityManagerSetRejoinParameters#
void emberAfPluginWwahConnectivityManagerSetRejoinParameters (uint16_t fastRejoinTimeoutSeconds, uint16_t durationBetweenRejoinsSeconds, uint16_t fastRejoinFirstBackoffSeconds, uint16_t maxBackoffTimeSeconds, uint16_t maxBackoffIterations)
Set rejoin parameters.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | N/A | fastRejoinTimeoutSeconds | Ver.: always |
| uint16_t | N/A | durationBetweenRejoinsSeconds | Ver.: always |
| uint16_t | N/A | fastRejoinFirstBackoffSeconds | Ver.: always |
| uint16_t | N/A | maxBackoffTimeSeconds | Ver.: always |
| uint16_t | N/A | maxBackoffIterations | Ver.: always |