Driver Operations Biometrics driver operations More...

#include <zephyr/drivers/biometrics.h>

Data Fields
biometric_api_get_capabilities	get_capabilities
	REQ Get biometric sensor capabilities.
biometric_api_attr_set	attr_set
	OPT Set a biometric sensor attribute.
biometric_api_attr_get	attr_get
	OPT Get a biometric sensor attribute.
biometric_api_enroll_start	enroll_start
	REQ Start biometric enrollment.
biometric_api_enroll_capture	enroll_capture
	REQ Capture enrollment samples.
biometric_api_enroll_finalize	enroll_finalize
	REQ Finalize enrollment.
biometric_api_enroll_abort	enroll_abort
	OPT Abort enrollment.
biometric_api_template_store	template_store
	OPT Store biometric template.
biometric_api_template_read	template_read
	OPT Read biometric template.
biometric_api_template_delete	template_delete
	REQ Delete biometric template.
biometric_api_template_delete_all	template_delete_all
	OPT Delete all biometric templates.
biometric_api_template_list	template_list
	OPT List stored template IDs.
biometric_api_match	match
	REQ Perform biometric matching.
biometric_api_led_control	led_control
	OPT Control biometric sensor LED.

Detailed Description

Driver Operations Biometrics driver operations

This is the driver API structure any Biometrics driver needs to define. It contains function pointers to the operations the driver implements, as well as any other driver-specific constant data.

Members marked with REQ MUST be set by the driver, whereas those marked with OPT are optional.

See also: DEVICE_DT_INST_DEFINE(); DEVICE_DT_DEFINE(); DEVICE_API()

Field Documentation

◆ attr_get

biometric_api_attr_get biometric_driver_api::attr_get

OPT Get a biometric sensor attribute.

◆ attr_set

biometric_api_attr_set biometric_driver_api::attr_set

OPT Set a biometric sensor attribute.

◆ enroll_abort

biometric_api_enroll_abort biometric_driver_api::enroll_abort

OPT Abort enrollment.

◆ enroll_capture

biometric_api_enroll_capture biometric_driver_api::enroll_capture

REQ Capture enrollment samples.

◆ enroll_finalize

biometric_api_enroll_finalize biometric_driver_api::enroll_finalize

REQ Finalize enrollment.

◆ enroll_start

biometric_api_enroll_start biometric_driver_api::enroll_start

REQ Start biometric enrollment.

◆ get_capabilities

biometric_api_get_capabilities biometric_driver_api::get_capabilities

REQ Get biometric sensor capabilities.

◆ led_control

biometric_api_led_control biometric_driver_api::led_control

OPT Control biometric sensor LED.

◆ match

biometric_api_match biometric_driver_api::match

REQ Perform biometric matching.

◆ template_delete

biometric_api_template_delete biometric_driver_api::template_delete

REQ Delete biometric template.

◆ template_delete_all

biometric_api_template_delete_all biometric_driver_api::template_delete_all

OPT Delete all biometric templates.

◆ template_list

biometric_api_template_list biometric_driver_api::template_list

OPT List stored template IDs.

◆ template_read

biometric_api_template_read biometric_driver_api::template_read

OPT Read biometric template.

◆ template_store

biometric_api_template_store biometric_driver_api::template_store

OPT Store biometric template.

The documentation for this struct was generated from the following file:

zephyr/drivers/biometrics.h

Data Fields