Update TC Link Key#

API and Callbacks for the Update TC Link Key Component.

This component provides the functionality to update the trust center link key of a device on a Zigbee R21+ network. The device also requests the trust center link key periodically if the trust center is pre-R21. After the trust center is upgraded to R21+, if not already R21+, the periodic request for a trust center link key update passes and the link key is updated.

Modules#

Update TC Link Key Update

API#

EmberStatus
emberAfPluginUpdateTcLinkKeyStart(void)

Change the time between two subsequent update TC link key calls.

bool
emberAfPluginUpdateTcLinkKeyStop(void)

Change the time between two subsequent update TC link key calls.

void
emberAfPluginSetTCLinkKeyUpdateTimerMilliSeconds(uint32_t timeInMilliseconds)

Change the time between two subsequent update TC link key calls.

void
emberAfPluginUpdateTcLinkKeySetDelay(uint32_t delayMs)

Change the time between two subsequent update TC link key calls.

void
emberAfPluginUpdateTcLinkKeySetInactive(void)

Change the time between two subsequent update TC link key calls.

Macros#

API Documentation#

emberAfPluginUpdateTcLinkKeyStart#

EmberStatus emberAfPluginUpdateTcLinkKeyStart (void)

Change the time between two subsequent update TC link key calls.

Parameters
N/A

Definition at line 63 of file app/framework/plugin/update-tc-link-key/update-tc-link-key.h

emberAfPluginUpdateTcLinkKeyStop#

bool emberAfPluginUpdateTcLinkKeyStop (void)

Change the time between two subsequent update TC link key calls.

Parameters
N/A

Definition at line 71 of file app/framework/plugin/update-tc-link-key/update-tc-link-key.h

emberAfPluginSetTCLinkKeyUpdateTimerMilliSeconds#

void emberAfPluginSetTCLinkKeyUpdateTimerMilliSeconds (uint32_t timeInMilliseconds)

Change the time between two subsequent update TC link key calls.

Parameters
N/AtimeInMilliseconds

Definition at line 74 of file app/framework/plugin/update-tc-link-key/update-tc-link-key.h

emberAfPluginUpdateTcLinkKeySetDelay#

void emberAfPluginUpdateTcLinkKeySetDelay (uint32_t delayMs)

Change the time between two subsequent update TC link key calls.

Parameters
N/AdelayMs

Definition at line 79 of file app/framework/plugin/update-tc-link-key/update-tc-link-key.h

emberAfPluginUpdateTcLinkKeySetInactive#

void emberAfPluginUpdateTcLinkKeySetInactive (void)

Change the time between two subsequent update TC link key calls.

Parameters
N/A

Definition at line 83 of file app/framework/plugin/update-tc-link-key/update-tc-link-key.h

Macro Definition Documentation#

EMBER_AF_PLUGIN_UPDATE_TC_LINK_KEY_PLUGIN_NAME#

#define EMBER_AF_PLUGIN_UPDATE_TC_LINK_KEY_PLUGIN_NAME
Value:
"Update TC Link Key"

Definition at line 43 of file app/framework/plugin/update-tc-link-key/update-tc-link-key.h