APS Link Key Authorization
API and Callbacks for the APS Link Key Authorization Component.
This component enables a better granularity of cluster-specific APS link key security.
API#
Get APS Link key authorization state.
APS link key authorization cluster exempted state.
Exempted cluster list full state.
Get exempt cluster list.
Clear exempt cluster list.
Enable/disable APS link ket authorization.
Add a cluster to the exempted cluster list.
Enable APS link key authorization with exempted cluster list.
Disable link ket authorization with exempt cluster list.
Get APS Link key authorization state.
API Documentation#
sl_zigbee_af_aps_link_key_authorization_is_enabled
bool sl_zigbee_af_aps_link_key_authorization_is_enabled (void )
Get APS Link key authorization state.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
Returns
bool APS link key authorization state
sl_zigbee_af_aps_link_key_authorization_is_cluster_exempted
bool sl_zigbee_af_aps_link_key_authorization_is_cluster_exempted (uint16_t clusterId)
APS link key authorization cluster exempted state.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | N/A | clusterId | Ver.:Always |
Returns
bool exempted state
sl_zigbee_af_aps_link_key_authorization_is_exempt_cluster_list_full
bool sl_zigbee_af_aps_link_key_authorization_is_exempt_cluster_list_full (void )
Exempted cluster list full state.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
Returns
bool cluster list full state
sl_zigbee_af_aps_link_key_authorization_exempt_cluster_list_count
uint8_t sl_zigbee_af_aps_link_key_authorization_exempt_cluster_list_count (void )
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
Get exempt cluster list count.
Returns
uint8_t exempt cluster link count
sl_zigbee_af_aps_link_key_authorization_get_exempt_cluster_list
void sl_zigbee_af_aps_link_key_authorization_get_exempt_cluster_list (uint8_t * exemptListCount, uint16_t * exemptClusterList)
Get exempt cluster list.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t * | N/A | exemptListCount | Ver.:Always |
| uint16_t * | N/A | exemptClusterList | Ver.:Always |
sl_zigbee_af_aps_link_key_authorization_clear_exempt_cluster_list
void sl_zigbee_af_aps_link_key_authorization_clear_exempt_cluster_list (void )
Clear exempt cluster list.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
sl_zigbee_af_aps_link_key_authorization_enable
void sl_zigbee_af_aps_link_key_authorization_enable (bool enable)
Enable/disable APS link ket authorization.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| bool | N/A | enable | enable value Ver.:Always |
sl_zigbee_af_aps_link_key_authorization_add_cluster_exempted
sl_status_t sl_zigbee_af_aps_link_key_authorization_add_cluster_exempted (uint16_t clusterId)
Add a cluster to the exempted cluster list.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | N/A | clusterId | Ver.:Always |
Returns
sl_zigbee_staus_t status code
sl_zigbee_af_aps_link_key_authorization_enable_with_exempt_cluster_list
sl_status_t sl_zigbee_af_aps_link_key_authorization_enable_with_exempt_cluster_list (uint8_t numberExemptClusters, uint8_t * exemptClusterList)
Enable APS link key authorization with exempted cluster list.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | numberExemptClusters | exempt cluster count Ver.:Always |
| uint8_t * | N/A | exemptClusterList | Ver.:Always |
Returns
sl_status_t status code
sl_zigbee_af_aps_link_key_authorization_disable_with_exempt_cluster_list
sl_status_t sl_zigbee_af_aps_link_key_authorization_disable_with_exempt_cluster_list (uint8_t numberExemptClusters, uint8_t * exemptClusterList)
Disable link ket authorization with exempt cluster list.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | numberExemptClusters | exempt cluster count Ver.:Always |
| uint8_t * | N/A | exemptClusterList | Ver.:Always |
Returns
sl_status_t status code