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 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#
emberAfApsLinkKeyAuthorizationIsEnabled
bool emberAfApsLinkKeyAuthorizationIsEnabled (void )
Get APS Link key authorization state.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
Returns
bool APS link key authorization state
emberAfApsLinkKeyAuthorizationIsClusterExempted
bool emberAfApsLinkKeyAuthorizationIsClusterExempted (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
emberAfApsLinkKeyAuthorizationIsExemptClusterListFull
bool emberAfApsLinkKeyAuthorizationIsExemptClusterListFull (void )
Exempted cluster list full state.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
Returns
bool cluster list full state
emberAfApsLinkKeyAuthorizationExemptClusterListCount
uint8_t emberAfApsLinkKeyAuthorizationExemptClusterListCount (void )
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
Get exempt cluster list count
Returns
uint8_t exempt cluster link count
emberAfApsLinkKeyAuthorizationGetExemptClusterList
void emberAfApsLinkKeyAuthorizationGetExemptClusterList (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 |
emberAfApsLinkKeyAuthorizationClearExemptClusterList
void emberAfApsLinkKeyAuthorizationClearExemptClusterList (void )
Clear exempt cluster list.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
emberAfApsLinkKeyAuthorizationEnable
void emberAfApsLinkKeyAuthorizationEnable (bool enable)
enable/disable APS link ket authorization
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| bool | N/A | enable | enable value Ver.:Always |
emberAfApsLinkKeyAuthorizationAddClusterExempted
EmberStatus emberAfApsLinkKeyAuthorizationAddClusterExempted (uint16_t clusterId)
add a cluster to exempted cluster list
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | N/A | clusterId | Ver.:Always |
Returns
EmberStaus status code
emberAfApsLinkKeyAuthorizationEnableWithExemptClusterList
EmberStatus emberAfApsLinkKeyAuthorizationEnableWithExemptClusterList (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
EmberStatus status code
emberAfApsLinkKeyAuthorizationDisableWithExemptClusterList
EmberStatus emberAfApsLinkKeyAuthorizationDisableWithExemptClusterList (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
EmberStatus status code