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

sl_zigbee_af_wwah_connectivity_manager_is_rejoin_algorithm_enabled(void)

Get rejoin algorithm enabled state.

void

sl_zigbee_af_wwah_connectivity_manager_enable_rejoin_algorithm(uint8_t endpoint)

Enable rejoin algorithm.

void

sl_zigbee_af_wwah_connectivity_manager_disable_rejoin_algorithm(uint8_t endpoint)

Disable rejoin algorithm.

bool

sl_zigbee_af_wwah_connectivity_manager_is_bad_parent_recovery_enabled(void)

Get bad parent recovery state.

void

sl_zigbee_af_wwah_connectivity_manager_enable_bad_parent_recovery(uint16_t badParentRejoinPeriod)

Enable bad parent recovery.

void

sl_zigbee_af_wwah_connectivity_manager_disable_bad_parent_recovery()

Disable bad parent recovery.

sl_status_t

sl_zigbee_af_wwah_connectivity_manager_enable_periodic_router_check_ins(uint16_t checkInInterval)

Enable periodic router checkins.

sl_status_t

sl_zigbee_af_wwah_connectivity_manager_disable_periodic_router_check_ins(void)

Disable periodic router checkins.

void

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

Set rejoin parameters.

API Documentation#

sl_zigbee_af_wwah_connectivity_manager_is_rejoin_algorithm_enabled#

bool sl_zigbee_af_wwah_connectivity_manager_is_rejoin_algorithm_enabled (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

sl_zigbee_af_wwah_connectivity_manager_enable_rejoin_algorithm#

void sl_zigbee_af_wwah_connectivity_manager_enable_rejoin_algorithm (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

sl_zigbee_af_wwah_connectivity_manager_disable_rejoin_algorithm#

void sl_zigbee_af_wwah_connectivity_manager_disable_rejoin_algorithm (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

sl_zigbee_af_wwah_connectivity_manager_is_bad_parent_recovery_enabled#

bool sl_zigbee_af_wwah_connectivity_manager_is_bad_parent_recovery_enabled (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

sl_zigbee_af_wwah_connectivity_manager_enable_bad_parent_recovery#

void sl_zigbee_af_wwah_connectivity_manager_enable_bad_parent_recovery (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

sl_zigbee_af_wwah_connectivity_manager_disable_bad_parent_recovery#

void sl_zigbee_af_wwah_connectivity_manager_disable_bad_parent_recovery ()

Disable bad parent recovery.

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

sl_zigbee_af_wwah_connectivity_manager_enable_periodic_router_check_ins#

sl_status_t sl_zigbee_af_wwah_connectivity_manager_enable_periodic_router_check_ins (uint16_t checkInInterval)

Enable periodic router checkins.

Parameters

N/A

checkInInterval

Ver.: always

Returns

sl_status_t status code

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

sl_zigbee_af_wwah_connectivity_manager_disable_periodic_router_check_ins#

sl_status_t sl_zigbee_af_wwah_connectivity_manager_disable_periodic_router_check_ins (void )

Disable periodic router checkins.

Parameters

N/A

Returns

sl_status_t status code

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

sl_zigbee_af_wwah_connectivity_manager_set_rejoin_parameters#

void sl_zigbee_af_wwah_connectivity_manager_set_rejoin_parameters (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