fingerprint4  2.1.0.0
Main Page

Fingerprint 4 click

Fingerprint 4 Click is an adapter Click boardâ„¢ used to interface a compatible fingerprint sensor with the host MCU. This board features FINGERPRINTS BM-Lite Module, a complete biometric fingerprint solution ready to be used out-of-the-box. The BM-Lite Module combines superior biometric performance and a high standard of quality components to offer a comprehensive embedded solution for increased security and enhanced user convenience. It uses a 3D pixel sensing technology that can read virtually any finger, dry or wet, alongside simple serial commands with a configurable communication interface to enroll and verify. Its protective coating helps in protection against ESD, scratches, impact, and everyday wear and tear.

click Product page


Click library

  • Author : Stefan Filipovic
  • Date : Sep 2022.
  • Type : SPI type

Software Support

We provide a library for the Fingerprint 4 Click as well as a demo application (example), developed using MikroElektronika compilers. The demo can run on all the main MikroElektronika development boards.

Package can be downloaded/installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Library Description

This library contains API for Fingerprint 4 Click driver.

Standard key functions :

Example key functions :

  • fingerprint4_version This function reads out version information from the device. The response contains a variable length string that contains version information of the device.
    err_t fingerprint4_version ( fingerprint4_t *ctx, char *version, uint8_t len );
  • fingerprint4_identify_finger This function captures and identifies finger against existing templates in Flash storage.
    err_t fingerprint4_identify_finger ( fingerprint4_t *ctx, uint32_t timeout, uint16_t *template_id, bool *match );
  • fingerprint4_wait_finger_not_present This function waits until no finger is detected on the sensor.
    err_t fingerprint4_wait_finger_not_present ( fingerprint4_t *ctx, uint32_t timeout );

Example Description

This example demonstrates the use of the Fingerprint 4 click boards by registering 3 fingerprints and

then waiting until a finger is detected on the sensor and identifying if the fingerprint matches one of those stored in the Flash storage.

The demo application is composed of two sections :

Application Init

Initializes the driver and reads the sensor firmware version, then resets the sensor and removes all

stored fingerprint templates. After that it registers 3 new fingerprint templates and stores them in the Flash storage.

void application_init ( void )
{
log_cfg_t log_cfg;
fingerprint4_cfg_t fingerprint4_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
fingerprint4_cfg_setup( &fingerprint4_cfg );
FINGERPRINT4_MAP_MIKROBUS( fingerprint4_cfg, MIKROBUS_1 );
if ( FINGERPRINT4_RES_OK != fingerprint4_init( &fingerprint4, &fingerprint4_cfg ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
fingerprint4_reset_device ( &fingerprint4 );
fingerprint4.phy_rx_timeout = FINGERPRINT4_DEFAULT_PHY_RX_TIMEOUT_MS;
uint8_t version[ 50 ] = { 0 };
if ( FINGERPRINT4_RES_OK == fingerprint4_version ( &fingerprint4, version, 50 ) )
{
log_printf( &logger, " FW version: %s\r\n", version );
log_printf( &logger, "---------------------------------\r\n\n" );
}
fingerprint4_error_check( "Sensor reset", fingerprint4_sensor_reset ( &fingerprint4 ) );
fingerprint4_error_check( "Remove all templates", fingerprint4_template_remove_all ( &fingerprint4 ) );
fingerprint4_register_fingerprints ( &fingerprint4, LOCATION_IN_FLASH, NUMBER_OF_FINGERPRINTS );
log_info( &logger, " Application Task " );
}

Application Task

Waits until a finger is detected on the sensor, takes an image of the finger and checks if there's

a fingerprint in the library that matches the one it has just read. If it finds a match, a fingerprint template ID will be displayed. All data is being logged on the USB UART where you can track the program flow.

void application_task ( void )
{
uint16_t template_id;
bool match;
log_printf( &logger, " Put your finger on the sensor.\r\n" );
err_t error_flag = fingerprint4_identify_finger ( &fingerprint4, FINGERPRINT4_INFINITE_TIMEOUT, &template_id, &match );
if ( error_flag )
{
fingerprint4_error_check( "Identify finger", error_flag );
}
else
{
if ( match )
{
log_printf( &logger, " >>>>> Fingerprint MATCH - Template ID: %u <<<<<\r\n", template_id );
}
else
{
log_printf( &logger, " >>>>> NO MATCH in the library <<<<<\r\n" );
}
}
log_printf( &logger, " Lift the finger of the sensor.\r\n" );
log_printf( &logger, "---------------------------------\r\n\n" );
}

The full application code, and ready to use projects can be installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Other Mikroe Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.Fingerprint4

Additional notes and informations

Depending on the development board you are using, you may need USB UART click, USB UART 2 Click or RS232 Click to connect to your PC, for development systems with no UART to USB interface available on the board. UART terminal is available in all MikroElektronika compilers.


fingerprint4_cfg_t
Fingerprint 4 Click configuration object.
Definition: fingerprint4.h:331
FINGERPRINT4_MAP_MIKROBUS
#define FINGERPRINT4_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: fingerprint4.h:238
fingerprint4_version
err_t fingerprint4_version(fingerprint4_t *ctx, char *version, uint8_t len)
Fingerprint 4 version function.
fingerprint4_template_remove_all
err_t fingerprint4_template_remove_all(fingerprint4_t *ctx)
Fingerprint 4 template remove all function.
fingerprint4_wait_finger_not_present
err_t fingerprint4_wait_finger_not_present(fingerprint4_t *ctx, uint32_t timeout)
Fingerprint 4 wait finger not present function.
fingerprint4_reset_device
void fingerprint4_reset_device(fingerprint4_t *ctx)
Fingerprint 4 reset device function.
application_task
void application_task(void)
Definition: main.c:119
fingerprint4_identify_finger
err_t fingerprint4_identify_finger(fingerprint4_t *ctx, uint32_t timeout, uint16_t *template_id, bool *match)
Fingerprint 4 identify finger function.
NUMBER_OF_FINGERPRINTS
#define NUMBER_OF_FINGERPRINTS
Definition: main.c:30
fingerprint4_init
err_t fingerprint4_init(fingerprint4_t *ctx, fingerprint4_cfg_t *cfg)
Fingerprint 4 initialization function.
fingerprint4_t
Fingerprint 4 Click context object.
Definition: fingerprint4.h:300
FINGERPRINT4_INFINITE_TIMEOUT
#define FINGERPRINT4_INFINITE_TIMEOUT
Definition: fingerprint4.h:200
FINGERPRINT4_RES_OK
@ FINGERPRINT4_RES_OK
Definition: fingerprint4.h:371
fingerprint4_sensor_reset
err_t fingerprint4_sensor_reset(fingerprint4_t *ctx)
Fingerprint 4 sensor reset function.
FINGERPRINT4_DEFAULT_PHY_RX_TIMEOUT_MS
#define FINGERPRINT4_DEFAULT_PHY_RX_TIMEOUT_MS
Fingerprint 4 timeout setting.
Definition: fingerprint4.h:199
application_init
void application_init(void)
Definition: main.c:72
LOCATION_IN_FLASH
#define LOCATION_IN_FLASH
Definition: main.c:29
fingerprint4_cfg_setup
void fingerprint4_cfg_setup(fingerprint4_cfg_t *cfg)
Fingerprint 4 configuration object setup function.