Delayed Join#

API and Callbacks for the Delayed Join Component.

This component is used both for a trust center and a joining device. It provides a set of APIs for setting the acceptable delay for receiving a network key, as well as sending the network key on demand from the app. The following are the minimum conditions to verify before successfully using this component:

  • 1.The trust center must have an acceptable version of a link key for the joining devices.

  • 2.The component must be (re-)activated every time a network is opened or after any other event that changes the trust center (re-)join policy.

API#

void
emberAfPluginDelayedJoinSetNetworkKeyTimeout(uint8_t timeout)

Set the network timeout value.

void
emberAfPluginDelayedJoinActivate(bool activated)

Set the activation state of Delayed Join component.

bool
emberAfPluginDelayedJoinIsActivated(void)

Return true if the TC is delaying in sending the network key to newly joining devices.

Macros#

API Documentation#

emberAfPluginDelayedJoinSetNetworkKeyTimeout#

void emberAfPluginDelayedJoinSetNetworkKeyTimeout (uint8_t timeout)

Set the network timeout value.

Parameters
N/Atimeout

timeout value. Acceptable range 3-255 Ver.: always


Definition at line 57 of file app/framework/plugin/delayed-join/delayed-join.h

emberAfPluginDelayedJoinActivate#

void emberAfPluginDelayedJoinActivate (bool activated)

Set the activation state of Delayed Join component.

Parameters
N/Aactivated

Indicates whether to activate the Delayed Join functionality


Definition at line 64 of file app/framework/plugin/delayed-join/delayed-join.h

emberAfPluginDelayedJoinIsActivated#

bool emberAfPluginDelayedJoinIsActivated (void)

Return true if the TC is delaying in sending the network key to newly joining devices.

Parameters
N/A

Definition at line 69 of file app/framework/plugin/delayed-join/delayed-join.h

Macro Definition Documentation#

EMBER_AF_PLUGIN_DELAYED_JOIN_PLUGIN_NAME#

#define EMBER_AF_PLUGIN_DELAYED_JOIN_PLUGIN_NAME
Value:
"Delayed Join"

Definition at line 43 of file app/framework/plugin/delayed-join/delayed-join.h

EMBER_AF_PLUGIN_DELAYED_JOIN_MAXIMUM_TIMEOUT_SUPPORTED_S#

#define EMBER_AF_PLUGIN_DELAYED_JOIN_MAXIMUM_TIMEOUT_SUPPORTED_S
Value:
65

Definition at line 45 of file app/framework/plugin/delayed-join/delayed-join.h