fingerprint2.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * Permission is hereby granted, free of charge, to any person 
 * obtaining a copy of this software and associated documentation 
 * files (the "Software"), to deal in the Software without restriction, 
 * including without limitation the rights to use, copy, modify, merge, 
 * publish, distribute, sublicense, and/or sell copies of the Software, 
 * and to permit persons to whom the Software is furnished to do so, 
 * subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be 
 * included in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE 
 * OR OTHER DEALINGS IN THE SOFTWARE. 
 */
 
// ----------------------------------------------------------------------------
 
#ifndef FINGERPRINT2_H
#define FINGERPRINT2_H
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"
 
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define FINGERPRINT2_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
  cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX ); \
  cfg.ld1 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
  cfg.gp1 = MIKROBUS( mikrobus, MIKROBUS_CS ); \
  cfg.gp2 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
  cfg.ld2 = MIKROBUS( mikrobus, MIKROBUS_INT )
#define FINGERPRINT2_RETVAL  uint8_t
 
#define FINGERPRINT2_OK           0x00
#define FINGERPRINT2_INIT_ERROR   0xFF
#define FINGERPRINT2_CMD_GET_FW_VER       "<C>GetFWVer</C>"
#define FINGERPRINT2_CMD_GET_DS           "<C>GetDS</C>"
#define FINGERPRINT2_CMD_FP_CMP           "<C>CompareFingerprint</C>"
#define FINGERPRINT2_CMD_FP_REG           "<C>RegisterFingerprint</C>"
#define FINGERPRINT2_CMD_FP_CLR           "<C>ClearRegisteredFp</C>"
#define FINGERPRINT2_CMD_FP_IMG_INFO      "<C>FpImageInformation</C>"
#define FINGERPRINT2_CMD_FP_IMG_SCAN      "<C>ScanFpImage</C>"
#define FINGERPRINT2_CMD_FP_REG_NO        "<C>CheckRegisteredNo</C>"
#define FINGERPRINT2_CMD_LOCK_DEV         "<C>LockDevice</C>"
#define FINGERPRINT2_CMD_UNLOCK_DEV       "<C>UnlockCompareFp</C>"
#define MOD_NUM                           10
#define VAL_CHAR                          48
#define DRV_RX_BUFFER_SIZE 800
#define DRV_TX_BUFFER_SIZE 100
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t rst;
    digital_out_t gp1;
    digital_out_t gp2;
 
    // Input pins 
 
    digital_in_t ld1;
    digital_in_t ld2;
    
    // Modules 
 
    uart_t uart;
 
    char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
    char uart_tx_buffer[ DRV_TX_BUFFER_SIZE ];
 
} fingerprint2_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t rx_pin;
    pin_name_t tx_pin;
    
    // Additional gpio pins 
 
    pin_name_t ld1;
    pin_name_t rst;
    pin_name_t gp1;
    pin_name_t gp2;
    pin_name_t ld2;
 
    // static variable 
 
    uint32_t          baud_rate;     // Clock speed.
    bool              uart_blocking;
    uart_data_bits_t  data_bit;      // Data bits.
    uart_parity_t     parity_bit;    // Parity bit.  
    uart_stop_bits_t  stop_bit;      // Stop bits.    
 
} fingerprint2_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void fingerprint2_cfg_setup ( fingerprint2_cfg_t *cfg );
 
FINGERPRINT2_RETVAL fingerprint2_init ( fingerprint2_t *ctx, fingerprint2_cfg_t *cfg );
 
void fingerprint2_generic_write ( fingerprint2_t *ctx, char *data_buf, uint16_t len );
 
int32_t fingerprint2_generic_read ( fingerprint2_t *ctx, char *data_buf, uint16_t max_len );
 
uint8_t fingerprint2_get_ld1_status ( fingerprint2_t *ctx );
 
uint8_t fingerprint2_get_ld2_status ( fingerprint2_t *ctx );
 
void fingerprint2_set_rst_status ( fingerprint2_t *ctx, uint8_t status );
 
void fingerprint2_set_gp1_status ( fingerprint2_t *ctx, uint8_t status );
 
void fingerprint2_set_gp2_status ( fingerprint2_t *ctx, uint8_t status );
 
void fingerprint2_reset ( fingerprint2_t *ctx );
 
void fingerprint2_reg_one_fp ( fingerprint2_t *ctx, uint8_t fp_index );
 
void fingerprint2_delete_one_fp ( fingerprint2_t *ctx, uint8_t fp_index );
 
#ifdef __cplusplus
}
#endif
#endif  // _FINGERPRINT2_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END