cc_user_credential_operations.h File Reference

Extended operations for User Credential Command Class. More...

#include "cc_user_credential_io.h"

Include dependency graph for cc_user_credential_operations.h:

Go to the source code of this file.

Functions
u3c_db_operation_result	CC_UserCredential_add_user_and_report (u3c_user_t *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.
u3c_db_operation_result	CC_UserCredential_modify_user_and_report (u3c_user_t *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.
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.
u3c_db_operation_result	CC_UserCredential_add_credential_and_report (u3c_credential_t *p_credential, RECEIVE_OPTIONS_TYPE_EX *p_rx_options)
	Tries to add a new credential to the database and reports the result.
u3c_db_operation_result	CC_UserCredential_modify_credential_and_report (u3c_credential_t *p_credential, RECEIVE_OPTIONS_TYPE_EX *p_rx_options)
	Tries to modify a credential in the database and reports the result.
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.
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.
bool	CC_UserCredential_send_association_report (u3c_credential_metadata_t const *const p_source_metadata, u3c_credential_metadata_t const *const p_destination_metadata, u3c_user_credential_association_report_status_t const status, RECEIVE_OPTIONS_TYPE_EX *const p_rx_options)
	Sends a USER_CREDENTIAL_ASSOCIATION_REPORT frame.
void	CC_UserCredential_delete_all_credentials_of_type (uint16_t uuid, u3c_credential_type filter_type)

Detailed Description

Extended operations for User Credential Command Class.

Copyright

2023 Silicon Laboratories Inc.

All of the functions in this module following the naming pattern CC_UserCredential_<operation>_<object>_and_report are meant to process a request to update the User Credential database and notify the Z-Wave network of the result of the operation. Generally, if the incoming request does not conform to the specification, it will be discarded without any notification. Otherwise, incoming data will be checked against the current state of the database. If the requested operation can be performed and results in a new state, the initiator of the request and the nodes in the Lifeline group will be notified; otherwise, only the initiator will be notified.