cc_user_credential_config_api.h File Reference

#include "CC_UserCredential.h"

Include dependency graph for cc_user_credential_config_api.h:

Go to the source code of this file.

Functions
bool	cc_user_credential_is_user_type_supported (u3c_user_type user_type)
uint16_t	cc_user_credential_get_max_user_unique_idenfitiers (void)
uint8_t	cc_user_credential_get_max_length_of_user_name (void)
bool	cc_user_credential_is_credential_type_supported (u3c_credential_type credential_type)
bool	cc_user_credential_is_credential_learn_supported (u3c_credential_type credential_type)
bool	cc_user_credential_is_credential_rule_supported (u3c_credential_rule credential_rule)
uint8_t	cc_user_credential_get_number_of_supported_credential_types (void)
uint16_t	cc_user_credential_get_max_credential_slots (u3c_credential_type credential_type)
uint8_t	cc_user_credential_get_min_length_of_data (u3c_credential_type credential_type)
uint8_t	cc_user_credential_get_max_length_of_data (u3c_credential_type credential_type)
uint8_t	cc_user_credential_get_max_hash_length (u3c_credential_type type)
uint8_t	cc_user_credential_get_cl_recommended_timeout (u3c_credential_type credential_type)
uint8_t	cc_user_credential_get_cl_number_of_steps (u3c_credential_type credential_type)
bool	cc_user_credential_is_all_users_checksum_supported (void)
bool	cc_user_credential_is_user_checksum_supported (void)
bool	cc_user_credential_is_credential_checksum_supported (void)
bool	cc_user_credential_get_admin_code_supported (void)
bool	cc_user_credential_get_admin_code_deactivate_supported (void)

Detailed Description

User Credential Command Class configuration API.

Copyright

2024 Silicon Laboratories Inc.

Function Documentation

cc_user_credential_get_admin_code_deactivate_supported()

bool cc_user_credential_get_admin_code_deactivate_supported

(

void

)

Checks whether the Admin Code Deactivate functionality is supported by the application.

Returns

true if Admin Code Deactivate is supported

cc_user_credential_get_admin_code_supported()

bool cc_user_credential_get_admin_code_supported

(

void

)

Checks whether the Admin Code functionality is supported by the application.

Returns

true if Admin Code is supported

cc_user_credential_get_cl_number_of_steps()

uint8_t cc_user_credential_get_cl_number_of_steps

(

u3c_credential_type

credential_type

)

Gets the number of steps required to complete the Credential Learn process for a specific credential type.

Parameters

[in]

credential_type

The specific credential type

Returns

The number of steps required to complete the Credential Learn process

cc_user_credential_get_cl_recommended_timeout()

uint8_t cc_user_credential_get_cl_recommended_timeout

(

u3c_credential_type

credential_type

)

Gets the configured recommended Credential Learn timeout for a specific credential type.

Parameters

[in]

credential_type

The specific credential type

Returns

The recommended Credential Learn timeout (in seconds)

cc_user_credential_get_max_credential_slots()

uint16_t cc_user_credential_get_max_credential_slots

(

u3c_credential_type

credential_type

)

Gets the configured maximum number of slots for a specific credential type.

Parameters

[in]

credential_type

The specific credential type

Returns

The maximum number of credential slots for this credential type

cc_user_credential_get_max_hash_length()

uint8_t cc_user_credential_get_max_hash_length

(

u3c_credential_type

type

)

Gets the configured maximum hash length for a specific credential type. If the credential type is supported by the application, a maximum hash length of 0 implies that credentials of this type must always be read back when sent in a report.

Parameters

[in]

type

The specific credential type

Returns

The maximum allowed hash length for this credential type (in bytes), if supported

cc_user_credential_get_max_length_of_data()

uint8_t cc_user_credential_get_max_length_of_data

(

u3c_credential_type

credential_type

)

Gets the configured maximum length of the credential data for a specific credential type.

Parameters

[in]

credential_type

The specific credential type

Returns

The maximum allowed data length for this credential type (in bytes)

cc_user_credential_get_max_length_of_user_name()

uint8_t cc_user_credential_get_max_length_of_user_name

(

void

)

Gets the configured maximum user name length.

Returns

The maximum length of a user name (in bytes)

cc_user_credential_get_max_user_unique_idenfitiers()

uint16_t cc_user_credential_get_max_user_unique_idenfitiers

(

void

)

Gets the configured maximum number of supported user unique identifiers.

Returns

The maximum number of supported UUIDs

cc_user_credential_get_min_length_of_data()

uint8_t cc_user_credential_get_min_length_of_data

(

u3c_credential_type

credential_type

)

Gets the configured minimum length of the credential data for a specific credential type.

Parameters

[in]

credential_type

The specific credential type

Returns

The minimum allowed data length for this credential type (in bytes)

cc_user_credential_get_number_of_supported_credential_types()

uint8_t cc_user_credential_get_number_of_supported_credential_types

(

void

)

Gets the number of credential types configured as supported by the application.

Returns

The number of supported credential types

cc_user_credential_is_all_users_checksum_supported()

bool cc_user_credential_is_all_users_checksum_supported

(

void

)

Returns whether All Users Checksum is supported.

Returns

true if All Users Checksum is supported, false otherwise.

cc_user_credential_is_credential_checksum_supported()

bool cc_user_credential_is_credential_checksum_supported

(

void

)

Checks whether the Credential Checksum functionality is supported by the application.

Returns

true if Credential Checksum is supported

cc_user_credential_is_credential_learn_supported()

bool cc_user_credential_is_credential_learn_supported

(

u3c_credential_type

credential_type

)

Checks whether the Credential Learn functionality is supported for a specific credential type by the application.

Parameters

[in]

credential_type

The specific credential type

Returns

true if Credential Learn is supported for this credential type

cc_user_credential_is_credential_rule_supported()

bool cc_user_credential_is_credential_rule_supported

(

u3c_credential_rule

credential_rule

)

Checks whether a specific credential rule is supported by the application.

Parameters

[in]

credential_rule

The specific credential rule

Returns

true if this credential rule is supported

cc_user_credential_is_credential_type_supported()

bool cc_user_credential_is_credential_type_supported

(

u3c_credential_type

credential_type

)

Checks whether the application is configured to support a specific credential type.

Parameters

[in]

credential_type

The specific credential type

Returns

true if this credential type is supported

cc_user_credential_is_user_checksum_supported()

bool cc_user_credential_is_user_checksum_supported

(

void

)

Checks whether the User Checksum functionality is supported by the application.

Returns

true if User Checksum is supported

cc_user_credential_is_user_type_supported()

bool cc_user_credential_is_user_type_supported

(

u3c_user_type

user_type

)

Checks whether the application is configured to support a specific user type.

Parameters

[in]

user_type

The requested user type

Returns

true if this user type is supported