UserCredential#

u3c_db_operation_result_#

u3c_db_operation_result_

u3c_modifier_type_#

u3c_modifier_type_

u3c_credential_type_#

u3c_credential_type_

_u3c_credential_report_type_t_#

_u3c_credential_report_type_t_

u3c_credential_learn_status_#

u3c_credential_learn_status_

u3c_user_credential_association_report_status_t#

u3c_user_credential_association_report_status_t

u3c_user_report_type_t_#

u3c_user_report_type_t_

u3c_user_type_#

u3c_user_type_

u3c_credential_rule_#

u3c_credential_rule_

u3c_user_name_encoding_#

u3c_user_name_encoding_

_u3c_admin_code_operation_result_#

_u3c_admin_code_operation_result_

This operation result can optionally be injected into an Admin Code Report to pass information back to the controlling node, in lieu of another report type.

Reports MUST be sent for Get operations, but MAY be sent for Set operations.

See specification for more requirement details.

u3c_operation_type_t#

u3c_operation_type_t

u3c_event_#

u3c_event_

u3c_db_operation_result#

typedef enum u3c_db_operation_result_ u3c_db_operation_result

u3c_modifier_type#

typedef enum u3c_modifier_type_ u3c_modifier_type

u3c_credential_type#

typedef enum u3c_credential_type_ u3c_credential_type

u3c_credential_report_type_t#

typedef enum _u3c_credential_report_type_t_ u3c_credential_report_type_t

u3c_credential_learn_status#

typedef enum u3c_credential_learn_status_ u3c_credential_learn_status

u3c_user_report_type_t#

typedef enum u3c_user_report_type_t_ u3c_user_report_type_t

u3c_user_type#

typedef enum u3c_user_type_ u3c_user_type

u3c_credential_rule#

typedef enum u3c_credential_rule_ u3c_credential_rule

u3c_user_name_encoding#

typedef enum u3c_user_name_encoding_ u3c_user_name_encoding

u3c_admin_code_operation_result#

typedef enum _u3c_admin_code_operation_result_ u3c_admin_code_operation_result

This operation result can optionally be injected into an Admin Code Report to pass information back to the controlling node, in lieu of another report type.

Reports MUST be sent for Get operations, but MAY be sent for Set operations.

See specification for more requirement details.

u3c_user#

typedef struct u3c_user_ u3c_user

u3c_credential_metadata#

typedef struct u3c_credential_metadata_ u3c_credential_metadata

u3c_credential#

typedef struct u3c_credential_ u3c_credential

u3c_credential_identifier#

typedef struct u3c_credential_identifier_ u3c_credential_identifier

u3c_event_data_validate#

typedef struct u3c_event_data_validate_ u3c_event_data_validate

Payload for CC_USER_CREDENTIAL_EVENT_VALIDATE, received from the application.

u3c_event_data_learn_read_done#

typedef struct u3c_event_data_learn_read_done_ u3c_event_data_learn_read_done

Payload for CC_USER_CREDENTIAL_EVENT_LEARN_READ_DONE, passed to the application.

u3c_credential_learn_event_data#

typedef struct u3c_credential_learn_event_data_ u3c_credential_learn_event_data

Credential Learn information passed to application layer.

u3c_admin_code_metadata_t#

typedef struct u3c_admin_code_metadata_ u3c_admin_code_metadata_t

u3c_event_type#

typedef enum u3c_event_ u3c_event_type

CC_UserCredential_factory_reset#

void CC_UserCredential_factory_reset (void )

Resets the User Credential Command Class database to a blank state, removing all existing users, credentials and the admin code.

CC_UserCredential_init_database#

void CC_UserCredential_init_database (void )

Initializes the User Credential Command Class database to a consistent state.

This function is called automatically by the Z-Wave Application Framework when the application starts.

CC_UserCredential_get_user#

u3c_db_operation_result CC_UserCredential_get_user (uint16_t unique_identifier, u3c_user * user, uint8_t * name)

Copies the data for a given User from the database to an arbitrary location in memory.

Returns

• the result of the operation

CC_UserCredential_get_next_user#

uint16_t CC_UserCredential_get_next_user (uint16_t unique_identifier)

Finds the first or next available User Unique Identifier.

Returns

• The Unique Identifier of the next User if available, otherwise 0

CC_UserCredential_add_user#

u3c_db_operation_result CC_UserCredential_add_user (u3c_user * user, uint8_t * name)

CC_UserCredential_modify_user#

u3c_db_operation_result CC_UserCredential_modify_user (u3c_user * user, uint8_t * name)

Modifies a user in the database.

CC_UserCredential_delete_user#

u3c_db_operation_result CC_UserCredential_delete_user (uint16_t user_unique_identifier)

CC_UserCredential_get_credential#

u3c_db_operation_result CC_UserCredential_get_credential (uint16_t user_unique_identifier, u3c_credential_type credential_type, uint16_t credential_slot, u3c_credential_metadata * credential_metadata, uint8_t * credential_data)

Copies the data for a given Credential from the database to an arbitrary location in memory.

Returns

• the result of the operation

CC_UserCredential_get_next_credential#

bool CC_UserCredential_get_next_credential (uint16_t user_unique_identifier, u3c_credential_type credential_type, uint16_t credential_slot, u3c_credential_type * next_credential_type, uint16_t * next_credential_slot)

Finds the first or next available Credential entry for a given User or Credential Type (set either one of these parameters to 0 to disable filtering by that property).

Set credential_slot to 0 to get the first available Credential matching the filter criteria.

Returns

• true if a subsequent Credential matching the criteria is found

CC_UserCredential_add_credential#

u3c_db_operation_result CC_UserCredential_add_credential (u3c_credential * credential)

Adds a new credential to the database.

Returns

• The result of the operation

CC_UserCredential_modify_credential#

u3c_db_operation_result CC_UserCredential_modify_credential (u3c_credential * credential)

CC_UserCredential_delete_credential#

u3c_db_operation_result CC_UserCredential_delete_credential (u3c_credential_type credential_type, uint16_t credential_slot, credential_slot)

Deletes a Credential.

Returns

• the result of the operation

CC_UserCredential_move_credential#

u3c_db_operation_result CC_UserCredential_move_credential (u3c_credential_type credential_type, uint16_t source_credential_slot, uint16_t destination_user_uid, uint16_t destination_credential_slot)

Moves a credential from one slot to another and/or assigns a credential from one User Unique Identifier to another one.

CC_UserCredential_get_admin_code_info#

u3c_db_operation_result CC_UserCredential_get_admin_code_info (u3c_admin_code_metadata_t * code)

Retrieves the admin code information from the node.

Can be used to ensure node supports the functionality.

Returns

• U3C_DB_OPERATION_SUCCESS if successful

• U3C_DB_OPERATION_ERROR otherwise

CC_UserCredential_set_admin_code#

u3c_db_operation_result CC_UserCredential_set_admin_code (u3c_admin_code_metadata_t * code)

Sets the admin code on the node, if supported.

Returns

• U3C_DB_OPERATION_ERROR_DUPLICATE if Admin Code is a duplicate of an existing PIN Code or Admin Code

• U3C_OPERATION_SUCCESS if successful

• U3C_OPERATION_ERROR otherwise

CC_UserCredential_add_user_and_report#

u3c_db_operation_result CC_UserCredential_add_user_and_report (u3c_user * p_user, uint8_t * p_name, RECEIVE_OPTIONS_TYPE_EX * p_rx_options)

Tries to add a new user to the database and reports the result.

Returns

• The result of the operation

CC_UserCredential_modify_user_and_report#

u3c_db_operation_result CC_UserCredential_modify_user_and_report (u3c_user * p_user, uint8_t * p_name, RECEIVE_OPTIONS_TYPE_EX * p_rx_options)

Tries to modify a user in the database and reports the result.

Returns

• The result of the operation

CC_UserCredential_delete_user_and_report#

u3c_db_operation_result CC_UserCredential_delete_user_and_report (uint16_t uuid, RECEIVE_OPTIONS_TYPE_EX * p_rx_options)

Tries to delete a user from the database and reports the result.

Returns

• The result of the operation

CC_UserCredential_add_credential_and_report#

u3c_db_operation_result CC_UserCredential_add_credential_and_report (u3c_credential * p_credential, RECEIVE_OPTIONS_TYPE_EX * p_rx_options)

Tries to add a new credential to the database and reports the result.

Returns

• The result of the operation

CC_UserCredential_modify_credential_and_report#

u3c_db_operation_result CC_UserCredential_modify_credential_and_report (u3c_credential * p_credential, RECEIVE_OPTIONS_TYPE_EX * p_rx_options)

Tries to modify a credential in the database and reports the result.

Returns

• The result of the operation

CC_UserCredential_delete_credential_and_report#

u3c_db_operation_result CC_UserCredential_delete_credential_and_report (uint16_t uuid, u3c_credential_type credential_type, uint16_t credential_slot, RECEIVE_OPTIONS_TYPE_EX * p_rx_options)

Tries to delete a credential from the database and reports the result.

Returns

• The result of the operation

CC_UserCredential_move_credential_and_report#

u3c_db_operation_result CC_UserCredential_move_credential_and_report (u3c_credential_type credential_type, uint16_t source_credential_slot, uint16_t destination_uuid, uint16_t destination_credential_slot, RECEIVE_OPTIONS_TYPE_EX * p_rx_options)

Tries to assign a credential to a different slot or user.

Returns

• The result of the operation

CC_UserCredential_send_association_report#

bool CC_UserCredential_send_association_report (u3c_credential_metadata const *const p_source_metadata, u3c_credential_metadata const *const p_destination_metadata, u3c_user_credential_association_report_status_t const status, RECEIVE_OPTIONS_TYPE_EX *const p_rx_options, status, p_rx_options)

Sends a USER_CREDENTIAL_ASSOCIATION_REPORT frame.

Returns

• true if the frame was enqueued succesfully.

CC_UserCredential_delete_all_credentials_of_type#

void CC_UserCredential_delete_all_credentials_of_type (uint16_t uuid, u3c_credential_type filter_type)

Deletes all Credentials of a given type for a User.

CC_UserCredential_manufacturer_validate_credential#

bool CC_UserCredential_manufacturer_validate_credential (u3c_credential * credential)

Validates a Credential according to the manufacturer's security rules.

Returns

• True if the Credential conforms to the security rules

CC_UserCredential_manufacturer_validate_admin_pin_code#

bool CC_UserCredential_manufacturer_validate_admin_pin_code (u3c_admin_code_metadata_t * code)

Validates the following conditions and requirements: CC:0083.01.1A.11.011 - Code follows all manufacturer security rules.

Should not be called if AC is not supported.

Returns

• True if all checks pass. If checks do not pass, returns false, and result code populated in code struct.

Note

• result code of a successful check should be ignored, but in practice ensure it is set to ADMIN_CODE_OPERATION_RESULT_NONE in this case.

CC_UserCredential_UserReport_tx#

void CC_UserCredential_UserReport_tx (const u3c_user_report_type_t report_type, const u3c_user *const p_user, const uint8_t *const p_name, const uint16_t next_uuid, RECEIVE_OPTIONS_TYPE_EX * p_rx_options)

Sends one or more User Report frames to the appropriate destinations depending on the type of the report.

CC_UserCredential_CredentialReport_tx#

void CC_UserCredential_CredentialReport_tx (const u3c_credential_report_type_t report_type, const u3c_credential * p_credential, const u3c_credential_type next_credential_type, const uint16_t next_credential_slot, RECEIVE_OPTIONS_TYPE_EX * p_rx_options)

Sends one or more Credential Report frames to the appropriate destinations depending on the type of the report.

CC_User_Credential_UsageNotification_tx#

JOB_STATUS CC_User_Credential_UsageNotification_tx (const uint8_t notification_event, const uint16_t uuid, const uint8_t credential_count, const u3c_credential_metadata *const p_credential_metadata)

Sends a Notification Report frame with Event/State parameters containing the Credential Usage Data.

Returns

• Whether the transmission was successful