Error type. More...

Functions
void	fingerprint3_cfg_setup (fingerprint3_cfg_t *cfg)
	Config Object Initialization function.

err_t	fingerprint3_init (fingerprint3_t ctx, fingerprint3_cfg_t cfg)
	Initialization function.

uint8_t	fingerprint3_set_config (fingerprint3_t *ctx, uint32_t addr, uint32_t pass)
	Set config function.

void	fingerprint3_set_rst_pin (fingerprint3_t *ctx, uint8_t rst_pin)
	Set RST pin state function.

void	fingerprint3_generic_write (fingerprint3_t ctx, uint8_t data_buf, uint16_t len)
	Generic write function.

int32_t	fingerprint3_generic_read (fingerprint3_t ctx, uint8_t data_buf, uint16_t max_len)
	Generic read function.

uint8_t	fingerprint3_send_package (fingerprint3_t ctx, uint8_t pkg_id, uint8_t pkg_content, uint16_t pkg_len)
	Send package function.

uint8_t	fingerprint3_finger_indicator (fingerprint3_t *ctx)
	Finger indicator function.

uint8_t	fingerprint3_aura_control (fingerprint3_t *ctx, uint8_t control, uint8_t speed, uint8_t color, uint8_t times)
	Aura LED control function.

uint8_t	fingerprint3_verify_password (fingerprint3_t *ctx, uint32_t pass)
	Verify password function.

uint8_t	fingerprint3_read_product_info (fingerprint3_t *ctx)
	Read product info function.

uint8_t	fingerprint3_read_sys_param (fingerprint3_t *ctx)
	Read system parameter function.

uint8_t	fingerprint3_set_security_lvl (fingerprint3_t *ctx, uint8_t lvl)
	Set security level function.

uint8_t	fingerprint3_hand_shake (fingerprint3_t *ctx)
	Hand shake function.

uint8_t	fingerprint3_check_sensor (fingerprint3_t *ctx)
	Check sensor function.

uint8_t	fingerprint3_soft_reset (fingerprint3_t *ctx)
	Soft reset function.

uint8_t	fingerprint3_read_index_table (fingerprint3_t ctx, uint8_t table, uint8_t page)
	Read index table function.

uint8_t	fingerprint3_take_image (fingerprint3_t *ctx)
	Take image function.

uint8_t	fingerprint3_extract_features (fingerprint3_t *ctx, uint8_t char_buffer)
	Extract features function.

uint8_t	fingerprint3_create_template (fingerprint3_t *ctx)
	Create template function.

uint8_t	fingerprint3_store_template (fingerprint3_t *ctx, uint8_t char_buffer, uint16_t location)
	Create template function.

uint8_t	fingerprint3_delete_template (fingerprint3_t *ctx, uint16_t location)
	Delete template function.

uint8_t	fingerprint3_empty_library (fingerprint3_t *ctx)
	Empty the library function.

uint8_t	fingerprint3_load_template (fingerprint3_t *ctx, uint8_t char_buffer, uint16_t location)
	Create template function.

uint8_t	fingerprint3_match_finger (fingerprint3_t ctx, uint16_t score)
	Empty the library function.

uint8_t	fingerprint3_search_finger (fingerprint3_t ctx, uint8_t char_buffer, uint16_t location, uint16_t *score)
	Empty the library function.

Detailed Description

Error type.

Function Documentation

◆ fingerprint3_aura_control()

uint8_t fingerprint3_aura_control	(	fingerprint3_t *	ctx,
		uint8_t	control,
		uint8_t	speed,
		uint8_t	color,
		uint8_t	times )

Aura LED control function.

Parameters

ctx	Click object.
control	FINGERPRINT3_AURA_CTRL_ON, FINGERPRINT3_AURA_CTRL_OFF, FINGERPRINT3_AURA_CTRL_BREATH, FINGERPRINT3_AURA_CTRL_FLASH, FINGERPRINT3_AURA_CTRL_GRADUAL_ON or FINGERPRINT3_AURA_CTRL_GRADUAL_OFF
speed	effective for FINGERPRINT3_AURA_CTRL_BREATH, FINGERPRINT3_AURA_CTRL_FLASH, FINGERPRINT3_AURA_CTRL_GRADUAL_ON, FINGERPRINT3_AURA_CTRL_GRADUAL_OFF 0 to 255, 0 means 5 seconds per cycle
color	FINGERPRINT3_AURA_LED_RED, FINGERPRINT3_AURA_LED_BLUE or FINGERPRINT3_AURA_LED_PURPLE
times	effective for FINGERPRINT3_AURA_CTRL_BREATH, FINGERPRINT3_AURA_CTRL_FLASH number of cycles: 0 means infinite or 1 to 255

Returns: Confirmation code or Read errors.

This function controls the LED ring of the sensor.

◆ fingerprint3_cfg_setup()

void fingerprint3_cfg_setup ( fingerprint3_cfg_t * cfg )

Config Object Initialization function.

Parameters

cfg	Click configuration structure.

This function initializes click configuration structure to init state.

Note: All used pins will be set to unconnected state.

◆ fingerprint3_check_sensor()

uint8_t fingerprint3_check_sensor ( fingerprint3_t * ctx )

Check sensor function.

Parameters

ctx	Click object.

Returns: Confirmation code or Read errors.

This function checks if sensor is okay.

◆ fingerprint3_create_template()

uint8_t fingerprint3_create_template ( fingerprint3_t * ctx )

Create template function.

Parameters

ctx	Click object.

Returns: Confirmation code or Read errors.

This function combines the features from char_buffer 1 to k into a template k is the char_buffer where the most recent feature extraction was written to the template is written back to char_buffer 1 and 2

◆ fingerprint3_delete_template()

uint8_t fingerprint3_delete_template	(	fingerprint3_t *	ctx,
		uint16_t	location )

Delete template function.

Parameters

ctx	Click object.
location	Location in flash.

Returns: Confirmation code or Read errors.

This function deletes template located at the desired location.

◆ fingerprint3_empty_library()

uint8_t fingerprint3_empty_library ( fingerprint3_t * ctx )

Empty the library function.

Parameters

ctx	Click object.

Returns: Confirmation code or Read errors.

This function deletes all the templates.

◆ fingerprint3_extract_features()

uint8_t fingerprint3_extract_features	(	fingerprint3_t *	ctx,
		uint8_t	char_buffer )

Extract features function.

Parameters

ctx	Click object.
char_buffer	Character buffer - number in the range 1 to 6.

Returns: Confirmation code or Read errors.

This function extracts the features from the finger image in the image buffer and writes them into the character buffer indentified by char_buffer

◆ fingerprint3_finger_indicator()

uint8_t fingerprint3_finger_indicator ( fingerprint3_t * ctx )

Finger indicator function.

Parameters

ctx	Click object.

Returns: Logic state of INT pin.

◆ fingerprint3_generic_read()

int32_t fingerprint3_generic_read	(	fingerprint3_t *	ctx,
		uint8_t *	data_buf,
		uint16_t	max_len )

Generic read function.

Parameters

ctx	Click object.
data_buf	Data buffer for read data.
max_len	The maximum length of data that can be read.

Returns: Number of reads data.

◆ fingerprint3_generic_write()

void fingerprint3_generic_write	(	fingerprint3_t *	ctx,
		uint8_t *	data_buf,
		uint16_t	len )

Generic write function.

Parameters

ctx	Click object.
data_buf	Data buffer for sends.
len	Number of bytes for sends.

◆ fingerprint3_hand_shake()

uint8_t fingerprint3_hand_shake ( fingerprint3_t * ctx )

Hand shake function.

Parameters

ctx	Click object.

Returns: Confirmation code or Read errors.

This function checks if module is okay.

◆ fingerprint3_init()

err_t fingerprint3_init	(	fingerprint3_t *	ctx,
		fingerprint3_cfg_t *	cfg )

Initialization function.

Parameters

ctx	Click object.
cfg	Click configuration structure.

This function initializes all necessary pins and peripherals used for this click.

◆ fingerprint3_load_template()

uint8_t fingerprint3_load_template	(	fingerprint3_t *	ctx,
		uint8_t	char_buffer,
		uint16_t	location )

Create template function.

Parameters

ctx	Click object.
char_buffer	Character buffer - number in the range 1 to 6.
location	Location in flash.

Returns: Confirmation code or Read errors.

This function loads template from flash in location to char_buffer and char_buffer+1.

◆ fingerprint3_match_finger()

uint8_t fingerprint3_match_finger	(	fingerprint3_t *	ctx,
		uint16_t *	score )

Empty the library function.

Parameters

ctx	Click object.
score	Reference to write the matching score to.

Returns: Confirmation code or Read errors ( FINGERPRINT3_CONF_NO_MATCH if features do not match ).

This function compares the recently extracted features with the template in character buffer 1 and 2.

◆ fingerprint3_read_index_table()

uint8_t fingerprint3_read_index_table	(	fingerprint3_t *	ctx,
		uint8_t *	table,
		uint8_t	page )

Read index table function.

Parameters

ctx	Click object.
table	A pointer to a memory block of at least 32 bytes.
page	the index page, a number between 0 (inclusive) and 3 (inclusive) index page 0: location 0 to 255 index page 1: location 256 to 511 index page 2: location 512 to 767 index page 3: location 768 to 1023

Returns: Confirmation code or Read errors.

This function reads the index table a bitfield indicating at which location a template is stored.

Note: The bit index corresponds to the location bit equal 1 means template is stored at that location bit equal 0 means no template is stored at that location e.g. for page 0: template at location k <=> table[k / 8] >> k % 8 & 0x01

◆ fingerprint3_read_product_info()

uint8_t fingerprint3_read_product_info ( fingerprint3_t * ctx )

Read product info function.

Parameters

ctx	Click object.

Returns: Confirmation code or Read errors.

This function reads product info and stores data in the click object product_info structure.

◆ fingerprint3_read_sys_param()

uint8_t fingerprint3_read_sys_param ( fingerprint3_t * ctx )

Read system parameter function.

Parameters

ctx	Click object.

Returns: Confirmation code or Read errors.

This function reads system parameter and stores data in the click object system_parameter structure.

◆ fingerprint3_search_finger()

uint8_t fingerprint3_search_finger	(	fingerprint3_t *	ctx,
		uint8_t	char_buffer,
		uint16_t *	location,
		uint16_t *	score )

Empty the library function.

Parameters

ctx	Click object.
char_buffer	Character buffer - number in the range 1 to 6.
location	Reference to write the matching location to.
score	Reference to write the matching score to.

Returns: Confirmation code or Read errors ( FINGERPRINT3_CONF_NO_MATCH if features do not match ).

This function searches the fingerprint library for a template matching the features in char_buffer.

◆ fingerprint3_send_package()

uint8_t fingerprint3_send_package	(	fingerprint3_t *	ctx,
		uint8_t	pkg_id,
		uint8_t *	pkg_content,
		uint16_t	pkg_len )

Send package function.

Parameters

ctx	Click object.
pkg_id	Package Identifier.
pkg_content	Package Content.
pkg_len	Package Length ( without checksum bytes ).

Returns: Confirmation code or Read errors.

This function sends package and reads response to that package which will be stored in the click object structure. It also checks checksum and header bytes.

◆ fingerprint3_set_config()

uint8_t fingerprint3_set_config	(	fingerprint3_t *	ctx,
		uint32_t	addr,
		uint32_t	pass )

Set config function.

Parameters

ctx	Click object.
addr	Address.
pass	Password.

Returns: 0 - OK, Other - error.

This function verifies password and sets the address, also stores product info and system parameters in the click object structure.

◆ fingerprint3_set_rst_pin()

void fingerprint3_set_rst_pin	(	fingerprint3_t *	ctx,
		uint8_t	rst_pin )

Set RST pin state function.

Parameters

ctx	Click object.
pin_state	0 : Inactive. 1 : Active. This function sets state of the RST pin of the Fingerprint 3 Click board.

◆ fingerprint3_set_security_lvl()

uint8_t fingerprint3_set_security_lvl	(	fingerprint3_t *	ctx,
		uint8_t	lvl )

Set security level function.

Parameters

ctx	Click object.
lvl	Security level - a number between 1 (inclusive) and 5 (inclusive). level 1: false acceptance rate is lowest and false rejection rate is highest level 5: false acceptance rate is highest and false rejection rate is lowest

Returns: Confirmation code or Read errors.

This function sets the security level.

◆ fingerprint3_soft_reset()

uint8_t fingerprint3_soft_reset ( fingerprint3_t * ctx )

Soft reset function.

Parameters

ctx	Click object.

Returns: Confirmation code or Read errors.

This function resets sensor and waits until it is ready.

◆ fingerprint3_store_template()

uint8_t fingerprint3_store_template	(	fingerprint3_t *	ctx,
		uint8_t	char_buffer,
		uint16_t	location )

Create template function.

Parameters

ctx	Click object.
char_buffer	Character buffer - number in the range 1 to 6.
location	Location in flash.

Returns: Confirmation code or Read errors.

This function stores template located in char_buffer and char_buffer+1 to flash at location.

◆ fingerprint3_take_image()

uint8_t fingerprint3_take_image ( fingerprint3_t * ctx )

Take image function.

Parameters

ctx	Click object.

Returns: Confirmation code or Read errors ( FINGERPRINT3_CONF_NO_FINGER if no finger is on the sensor ).

This function detects finger on the sensor, takes image and writes it into the image buffer.

◆ fingerprint3_verify_password()

uint8_t fingerprint3_verify_password	(	fingerprint3_t *	ctx,
		uint32_t	pass )

Verify password function.

Parameters

ctx	Click object.
pass	Password.

Returns: Confirmation code or Read errors.

This function verifies the password.

Functions

Detailed Description

Function Documentation

◆ fingerprint3_aura_control()

◆ fingerprint3_cfg_setup()

◆ fingerprint3_check_sensor()

◆ fingerprint3_create_template()

◆ fingerprint3_delete_template()

◆ fingerprint3_empty_library()

◆ fingerprint3_extract_features()

◆ fingerprint3_finger_indicator()

◆ fingerprint3_generic_read()

◆ fingerprint3_generic_write()

◆ fingerprint3_hand_shake()

◆ fingerprint3_init()

◆ fingerprint3_load_template()

◆ fingerprint3_match_finger()

◆ fingerprint3_read_index_table()

◆ fingerprint3_read_product_info()

◆ fingerprint3_read_sys_param()

◆ fingerprint3_search_finger()

◆ fingerprint3_send_package()

◆ fingerprint3_set_config()

◆ fingerprint3_set_rst_pin()

◆ fingerprint3_set_security_lvl()

◆ fingerprint3_soft_reset()

◆ fingerprint3_store_template()

◆ fingerprint3_take_image()

◆ fingerprint3_verify_password()