cc_user_credential_learn.h File Reference

Credential Learn module for Command Class User Credential. More...

#include "CC_UserCredential.h"
#include "zaf_transport_tx.h"
#include "zaf_event_distributor_soc.h"
#include "AppTimer.h"
#include "zpal_power_manager.h"

Include dependency graph for cc_user_credential_learn.h:

Go to the source code of this file.

Functions
bool	is_credential_learn_in_progress ()
void	credential_learn_reset ()
	Cancels the learning process for credentials.
received_frame_status_t	CC_UserCredential_CredentialLearnStart_handler (const u3c_operation_type_t operation_type, const u3c_credential_identifier_t *const p_learn_target, const uint8_t timeout_seconds, RECEIVE_OPTIONS_TYPE_EX *p_rx_options)
	Called upon receiving a Credential Learn Start frame.
received_frame_status_t	CC_UserCredential_CredentialLearnCancel_handler (const cc_handler_input_t *const input)
	Called upon receiving a Credential Learn Cancel frame.
void	CC_UserCredential_learn_event_handler (const uint8_t event, const void *p_data)
	Handles events related to the user credential learning process.

Detailed Description

Credential Learn module for Command Class User Credential.

The Credential Learn module provides functions to start and cancel the local learning process for credentials.

Copyright

2023 Silicon Laboratories Inc.

Function Documentation

CC_UserCredential_CredentialLearnCancel_handler()

received_frame_status_t CC_UserCredential_CredentialLearnCancel_handler

(

const cc_handler_input_t *const

input

)

Called upon receiving a Credential Learn Cancel frame.

Processes a request to cancel an ongoing Credential Learn process.

Parameters

[in]

input

Pointer to the structure containing the input data for the handler.

Returns

The result of the attempt to cancel the learn process.

CC_UserCredential_CredentialLearnStart_handler()

received_frame_status_t CC_UserCredential_CredentialLearnStart_handler	(	const u3c_operation_type_t	operation_type,
		const u3c_credential_identifier_t *const	p_learn_target,
		const uint8_t	timeout_seconds,
		RECEIVE_OPTIONS_TYPE_EX *	p_rx_options )

Called upon receiving a Credential Learn Start frame.

Checks and processes a request to initiate the Credential Learn process, which can either add or replace a credential based on the input data from the local device.

Parameters

[in]	operation_type	The type of operation to be performed at the end of the learning process.
[in]	p_learn_target	Pointer to the identifying data of the targeted credential.
[in]	timeout_seconds	The maximum allowed duration of the learning process.
[in]	p_rx_options	Pointer to the structure containing the received frame 's details.

Returns

The result of the attempt to start the learn process.

CC_UserCredential_learn_event_handler()

void CC_UserCredential_learn_event_handler	(	const uint8_t	event,
		const void *	p_data )

Handles events related to the user credential learning process.

Processes various events generated by the application during the credential learning process.

Parameters

[in]	event	The event identifier.
[in]	p_data	Pointer to the data associated with the event.

credential_learn_reset()

void credential_learn_reset

(

)

Cancels the learning process for credentials.

This function is responsible for canceling the learning process for credentials. It is called when the learning process needs to be stopped or aborted.

is_credential_learn_in_progress()

bool is_credential_learn_in_progress

(

)

Returns

true if a Credential Learn operation is in currently progress