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#

sl_status_t

sl_zigbee_af_update_tc_link_key_start(void)

Specify the amount of time to wait after one TCLK update operation completes before beginning a new TCLK update operation.

bool

sl_zigbee_af_update_tc_link_key_stop(void)

Specify the amount of time to wait after one TCLK update operation completes before beginning a new TCLK update operation.

void

sl_zigbee_af_set_tc_link_key_update_timer_ms(uint32_t timeInMilliseconds)

Specify the amount of time to wait after one TCLK update operation completes before beginning a new TCLK update operation.

void

sl_zigbee_af_set_tc_link_key_update_retry_backoff_timer_ms(uint32_t timeInMilliseconds)

Specify the amount of time between each retry after a failure TCLK update.

void

sl_zigbee_af_set_tc_link_key_update_max_attempts_per_iteration(uint8_t maxAttemptsPerIteration)

Specify the maximum number of Trust Center command exchange attempts made before concluding that the exchange has failed.

void

sl_zigbee_af_set_tc_link_key_update_max_iterations(uint8_t maxIterations)

Specify the maximum number of iterations of the TCLK update attempt permitted before a failure is declared using the On-Network TCLK Update procedure.

sl_status_t

sl_zigbee_af_tc_link_key_update_now(void)

Update the TCLK now.

void

sl_zigbee_af_update_tc_link_key_set_delay(uint32_t delayMs)

Specify the amount of time to wait after one TCLK update operation completes before beginning a new TCLK update operation.

void

sl_zigbee_af_update_tc_link_key_set_inactive(void)

Specify the amount of time to wait after one TCLK update operation completes before beginning a new TCLK update operation.

bool

sl_zigbee_af_update_tc_link_key_is_tclk_key_default(void)

Specify the amount of time to wait after one TCLK update operation completes before beginning a new TCLK update operation.

Macros#

#define

SL_ZIGBEE_AF_PLUGIN_UPDATE_TC_LINK_KEY_PLUGIN_NAME "Update TC Link Key"

API Documentation#

sl_zigbee_af_update_tc_link_key_start#

sl_status_t sl_zigbee_af_update_tc_link_key_start (void )

Specify the amount of time to wait after one TCLK update operation completes before beginning a new TCLK update operation.

Parameters

Type	Direction	Argument Name	Description
void	N/A		The time to wait after one TCLK update operation completes before issuing a new TCLK update operation. 0 means stop updating the TCLK.

Returns

None

sl_zigbee_af_update_tc_link_key_stop#

bool sl_zigbee_af_update_tc_link_key_stop (void )

Specify the amount of time to wait after one TCLK update operation completes before beginning a new TCLK update operation.

Parameters

Type	Direction	Argument Name	Description
void	N/A		The time to wait after one TCLK update operation completes before issuing a new TCLK update operation. 0 means stop updating the TCLK.

Returns

None

sl_zigbee_af_set_tc_link_key_update_timer_ms#

void sl_zigbee_af_set_tc_link_key_update_timer_ms (uint32_t timeInMilliseconds)

Specify the amount of time to wait after one TCLK update operation completes before beginning a new TCLK update operation.

Parameters

Type	Direction	Argument Name	Description
uint32_t	N/A	timeInMilliseconds	The time to wait after one TCLK update operation completes before issuing a new TCLK update operation. 0 means stop updating the TCLK.

Returns

None

sl_zigbee_af_set_tc_link_key_update_retry_backoff_timer_ms#

void sl_zigbee_af_set_tc_link_key_update_retry_backoff_timer_ms (uint32_t timeInMilliseconds)

Specify the amount of time between each retry after a failure TCLK update.

Parameters

Type	Direction	Argument Name	Description
uint32_t	N/A	timeInMilliseconds	The maximum amount of time between each retry after a failure TCLK update in milliseconds.

Returns

None

sl_zigbee_af_set_tc_link_key_update_max_attempts_per_iteration#

void sl_zigbee_af_set_tc_link_key_update_max_attempts_per_iteration (uint8_t maxAttemptsPerIteration)

Specify the maximum number of Trust Center command exchange attempts made before concluding that the exchange has failed.

Parameters

Type	Direction	Argument Name	Description
uint8_t	N/A	maxAttemptsPerIteration	The maximum number of Trust Center command exchange attempts made before concluding that the exchange has failed. An attempt is considered as the initial try plus subsequent retries of each of the TCLK update command frames, which includes the Node Descriptor, Request Key, and Verify Key messages. For example, if a value of 3 is passed into this API, then the device will attempt up to 3 Node Descriptor messages, 3 Request Key attempts, and 3 Verify Key messages before concluding that the process is terminated with failure. This entire process is classified as one iteration.

Returns

None

sl_zigbee_af_set_tc_link_key_update_max_iterations#

void sl_zigbee_af_set_tc_link_key_update_max_iterations (uint8_t maxIterations)

Specify the maximum number of iterations of the TCLK update attempt permitted before a failure is declared using the On-Network TCLK Update procedure.

Parameters

Type	Direction	Argument Name	Description
uint8_t	N/A	maxIterations	The maximum number of iterations of the TCLK update attempt permitted before a failure is declared using the On-Network TCLK Update procedure.

Note

sl_zigbee_af_update_tc_link_key_zigbee_key_establishment_cb is issued after max_attempts_per_iteration * max_iterations in the event of total failure.

Returns

None

sl_zigbee_af_tc_link_key_update_now#

sl_status_t sl_zigbee_af_tc_link_key_update_now (void )

Update the TCLK now.

Parameters

Type	Direction	Argument Name	Description
void	N/A

Returns

SL_STATUS_IN_PROGRESS if TCLK update is already in progress, else SL_STATUS_OK

sl_zigbee_af_update_tc_link_key_set_delay#

void sl_zigbee_af_update_tc_link_key_set_delay (uint32_t delayMs)

Specify the amount of time to wait after one TCLK update operation completes before beginning a new TCLK update operation.

Parameters

Type	Direction	Argument Name	Description
uint32_t	N/A	delayMs	The time to wait after one TCLK update operation completes before issuing a new TCLK update operation. 0 means stop updating the TCLK.

Returns

None

sl_zigbee_af_update_tc_link_key_set_inactive#

void sl_zigbee_af_update_tc_link_key_set_inactive (void )

Specify the amount of time to wait after one TCLK update operation completes before beginning a new TCLK update operation.

Parameters

Type	Direction	Argument Name	Description
void	N/A		The time to wait after one TCLK update operation completes before issuing a new TCLK update operation. 0 means stop updating the TCLK.

Returns

None

sl_zigbee_af_update_tc_link_key_is_tclk_key_default#

bool sl_zigbee_af_update_tc_link_key_is_tclk_key_default (void )

Specify the amount of time to wait after one TCLK update operation completes before beginning a new TCLK update operation.

Parameters

Type	Direction	Argument Name	Description
void	N/A		The time to wait after one TCLK update operation completes before issuing a new TCLK update operation. 0 means stop updating the TCLK.

Returns

None