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#

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

bool

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

void

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

void

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

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
TypeDirectionArgument NameDescription
voidN/A

The time to wait after one TCLK update operation completes before issuing a new TCLK update operation

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
TypeDirectionArgument NameDescription
voidN/A

The time to wait after one TCLK update operation completes before issuing a new TCLK update operation

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
TypeDirectionArgument NameDescription
uint32_tN/AtimeInMilliseconds

The time to wait after one TCLK update operation completes before issuing a new TCLK update operation

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
TypeDirectionArgument NameDescription
voidN/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
TypeDirectionArgument NameDescription
uint32_tN/AdelayMs

The time to wait after one TCLK update operation completes before issuing a new TCLK update operation

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
TypeDirectionArgument NameDescription
voidN/A

The time to wait after one TCLK update operation completes before issuing a new TCLK update operation

Returns

  • None