Skip to content

Latest commit

 

History

History
132 lines (98 loc) · 3.89 KB

README.md

File metadata and controls

132 lines (98 loc) · 3.89 KB

Fingerprint 2 Click

Fingerprint 2 Click demo application is developed using the NECTO Studio, ensuring compatibility with mikroSDK's open-source libraries and tools. Designed for plug-and-play implementation and testing, the demo is fully compatible with all development, starter, and mikromedia boards featuring a mikroBUS™ socket.

Click Library

  • Author : MikroE Team
  • Date : jul 2020.
  • Type : UART GSM/IOT type

Software Support

Example Description

This example demonstrates the use of Fingerprint 2 Click board.

Example Libraries

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.Fingerprint2

Example Key Functions

  • fingerprint2_cfg_setup Config Object Initialization function.
void fingerprint2_cfg_setup ( fingerprint2_cfg_t *cfg );
  • fingerprint2_init Initialization function.
err_t fingerprint2_init ( fingerprint2_t *ctx, fingerprint2_cfg_t *cfg );
  • fingerprint2_reg_one_fp This function registrates fingerprint on index.
void fingerprint2_reg_one_fp ( fingerprint2_t *ctx, uint8_t fp_index );
  • fingerprint2_delete_one_fp This function deletes fingerprint on index.
void fingerprint2_delete_one_fp ( fingerprint2_t *ctx, uint8_t fp_index );
  • fingerprint2_reset This function restarts device.
void fingerprint2_reset ( fingerprint2_t *ctx );

Application Init

Initializes the driver, enables the Click board, and then executes a command for registering a fingerprint.

void application_init ( void )
{
    log_cfg_t log_cfg;
    fingerprint2_cfg_t cfg;

    /** 
     * Logger initialization.
     * Default baud rate: 115200
     * Default log level: LOG_LEVEL_DEBUG
     * @note If USB_UART_RX and USB_UART_TX 
     * are defined as HAL_PIN_NC, you will 
     * need to define them manually for log to work. 
     * See @b LOG_MAP_USB_UART macro definition for detailed explanation.
     */
    LOG_MAP_USB_UART( log_cfg );
    log_init( &logger, &log_cfg );
    log_info( &logger, "---- Application Init ----" );

    //  Click initialization.

    fingerprint2_cfg_setup( &cfg );
    FINGERPRINT2_MAP_MIKROBUS( cfg, MIKROBUS_1 );
    fingerprint2_init( &fingerprint2, &cfg );
    
    fingerprint2_reset ( &fingerprint2 );
    Delay_ms ( 1000 );
    
    fp_reg_one( 0 );
    Delay_ms ( 1000 );
}

Application Task

Compares a fingerprint on input to the registered fingerprint and displays the results on the USB UART every 5 seconds.

void application_task ( void )
{    
    fp_compare( );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
}

Note

In the registration state each fingerprint needs to be enrolled 3 times.

Application Output

This Click board can be interfaced and monitored in two ways:

  • Application Output - Use the "Application Output" window in Debug mode for real-time data monitoring. Set it up properly by following this tutorial.
  • UART Terminal - Monitor data via the UART Terminal using a USB to UART converter. For detailed instructions, check out this tutorial.

Additional Notes and Information

The complete application code and a ready-to-use project are available through the NECTO Studio Package Manager for direct installation in the NECTO Studio. The application code can also be found on the MIKROE GitHub account.