fingerprint3  2.0.0.0
Functions

Error type. More...

Functions

void fingerprint3_cfg_setup (fingerprint3_cfg_t *cfg)
 Config Object Initialization function. More...
 
FINGERPRINT3_RETVAL fingerprint3_init (fingerprint3_t *ctx, fingerprint3_cfg_t *cfg)
 Initialization function. More...
 
uint8_t fingerprint3_set_config (fingerprint3_t *ctx, uint32_t addr, uint32_t pass)
 Set config function. More...
 
void fingerprint3_set_rst_pin (fingerprint3_t *ctx, uint8_t rst_pin)
 Set RST pin state function. More...
 
void fingerprint3_generic_write (fingerprint3_t *ctx, char *data_buf, uint16_t len)
 Generic write function. More...
 
int32_t fingerprint3_generic_read (fingerprint3_t *ctx, char *data_buf, uint16_t max_len)
 Generic read function. More...
 
uint8_t fingerprint3_send_package (fingerprint3_t *ctx, uint8_t pkg_id, uint8_t *pkg_content, uint16_t pkg_len)
 Send package function. More...
 
uint8_t fingerprint3_finger_indicator (fingerprint3_t *ctx)
 Finger indicator function. More...
 
uint8_t fingerprint3_aura_control (fingerprint3_t *ctx, uint8_t control, uint8_t speed, uint8_t color, uint8_t times)
 Aura LED control function. More...
 
uint8_t fingerprint3_verify_password (fingerprint3_t *ctx, uint32_t pass)
 Verify password function. More...
 
uint8_t fingerprint3_read_product_info (fingerprint3_t *ctx)
 Read product info function. More...
 
uint8_t fingerprint3_read_system_parameter (fingerprint3_t *ctx)
 Read system parameter function. More...
 
uint8_t fingerprint3_set_security_level (fingerprint3_t *ctx, uint8_t lvl)
 Set security level function. More...
 
uint8_t fingerprint3_hand_shake (fingerprint3_t *ctx)
 Hand shake function. More...
 
uint8_t fingerprint3_check_sensor (fingerprint3_t *ctx)
 Check sensor function. More...
 
uint8_t fingerprint3_soft_reset (fingerprint3_t *ctx)
 Soft reset function. More...
 
uint8_t fingerprint3_read_index_table (fingerprint3_t *ctx, uint8_t *table, uint8_t page)
 Read index table function. More...
 
uint8_t fingerprint3_take_image (fingerprint3_t *ctx)
 Take image function. More...
 
uint8_t fingerprint3_extract_features (fingerprint3_t *ctx, uint8_t char_buffer)
 Extract features function. More...
 
uint8_t fingerprint3_create_template (fingerprint3_t *ctx)
 Create template function. More...
 
uint8_t fingerprint3_store_template (fingerprint3_t *ctx, uint8_t char_buffer, uint16_t location)
 Create template function. More...
 
uint8_t fingerprint3_delete_template (fingerprint3_t *ctx, uint16_t location)
 Delete template function. More...
 
uint8_t fingerprint3_empty_library (fingerprint3_t *ctx)
 Empty the library function. More...
 
uint8_t fingerprint3_load_template (fingerprint3_t *ctx, uint8_t char_buffer, uint16_t location)
 Create template function. More...
 
uint8_t fingerprint3_match_finger (fingerprint3_t *ctx, uint16_t *score)
 Empty the library function. More...
 
uint8_t fingerprint3_search_finger (fingerprint3_t *ctx, uint8_t char_buffer, uint16_t *location, uint16_t *score)
 Empty the library function. More...
 

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
ctxClick object.
controlFINGERPRINT3_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
speedeffective 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
colorFINGERPRINT3_AURA_LED_RED, FINGERPRINT3_AURA_LED_BLUE or FINGERPRINT3_AURA_LED_PURPLE
timeseffective 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.

@description 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
cfgClick configuration structure.

@description 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
ctxClick object.
Returns
Confirmation code or Read errors.

@description This function checks if sensor is okay.

◆ fingerprint3_create_template()

uint8_t fingerprint3_create_template ( fingerprint3_t ctx)

Create template function.

Parameters
ctxClick object.
Returns
Confirmation code or Read errors.

@description 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
ctxClick object.
locationLocation in flash.
Returns
Confirmation code or Read errors.

@description 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
ctxClick object.
Returns
Confirmation code or Read errors.

@description 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
ctxClick object.
char_bufferCharacter buffer - number in the range 1 to 6.
Returns
Confirmation code or Read errors.

@description 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
ctxClick object.
Returns
Logic state of INT pin.

◆ fingerprint3_generic_read()

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

Generic read function.

Parameters
ctxClick object.
data_bufData buffer for read data.
max_lenThe maximum length of data that can be read.
Returns
Number of reads data.

◆ fingerprint3_generic_write()

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

Generic write function.

Parameters
ctxClick object.
data_bufData buffer for sends.
lenNumber of bytes for sends.

◆ fingerprint3_hand_shake()

uint8_t fingerprint3_hand_shake ( fingerprint3_t ctx)

Hand shake function.

Parameters
ctxClick object.
Returns
Confirmation code or Read errors.

@description This function checks if module is okay.

◆ fingerprint3_init()

FINGERPRINT3_RETVAL fingerprint3_init ( fingerprint3_t ctx,
fingerprint3_cfg_t cfg 
)

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

@description 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
ctxClick object.
char_bufferCharacter buffer - number in the range 1 to 6.
locationLocation in flash.
Returns
Confirmation code or Read errors.

@description 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
ctxClick object.
scoreReference to write the matching score to.
Returns
Confirmation code or Read errors ( FINGERPRINT3_CONF_NO_MATCH if features do not match ).

@description 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
ctxClick object.
tableA pointer to a memory block of at least 32 bytes.
pagethe 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.

@description 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
ctxClick object.
Returns
Confirmation code or Read errors.

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

◆ fingerprint3_read_system_parameter()

uint8_t fingerprint3_read_system_parameter ( fingerprint3_t ctx)

Read system parameter function.

Parameters
ctxClick object.
Returns
Confirmation code or Read errors.

@description 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
ctxClick object.
char_bufferCharacter buffer - number in the range 1 to 6.
locationReference to write the matching location to.
scoreReference to write the matching score to.
Returns
Confirmation code or Read errors ( FINGERPRINT3_CONF_NO_MATCH if features do not match ).

@description 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
ctxClick object.
pkg_idPackage Identifier.
pkg_contentPackage Content.
pkg_lenPackage Length ( without checksum bytes ).
Returns
Confirmation code or Read errors.

@description 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
ctxClick object.
addrAddress.
passPassword.
Returns
0 - OK, Other - error.

@description 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
ctxClick object.
pin_state
  • 0 : Inactive.
  • 1 : Active.

@description This function sets state of the RST pin of the Fingerprint 3 Click board.

◆ fingerprint3_set_security_level()

uint8_t fingerprint3_set_security_level ( fingerprint3_t ctx,
uint8_t  lvl 
)

Set security level function.

Parameters
ctxClick object.
lvlSecurity 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.

@description This function sets the security level.

◆ fingerprint3_soft_reset()

uint8_t fingerprint3_soft_reset ( fingerprint3_t ctx)

Soft reset function.

Parameters
ctxClick object.
Returns
Confirmation code or Read errors.

@description 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
ctxClick object.
char_bufferCharacter buffer - number in the range 1 to 6.
locationLocation in flash.
Returns
Confirmation code or Read errors.

@description 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
ctxClick object.
Returns
Confirmation code or Read errors ( FINGERPRINT3_CONF_NO_FINGER if no finger is on the sensor ).

@description 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
ctxClick object.
passPassword.
Returns
Confirmation code or Read errors.

@description This function verifies the password.