fingerprint2 2.0.0.0
fingerprint2.h File Reference

This file contains API for Fingerprint 2 Click driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"

Go to the source code of this file.

Data Structures

struct  fingerprint2_t
 Click ctx object definition. More...
 
struct  fingerprint2_cfg_t
 Click configuration structure definition. More...
 

Macros

#define FINGERPRINT2_MAP_MIKROBUS(cfg, mikrobus)
 
#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
 

Functions

void fingerprint2_cfg_setup (fingerprint2_cfg_t *cfg)
 Config Object Initialization function.
 
FINGERPRINT2_RETVAL fingerprint2_init (fingerprint2_t *ctx, fingerprint2_cfg_t *cfg)
 Initialization function.
 
void fingerprint2_generic_write (fingerprint2_t *ctx, char *data_buf, uint16_t len)
 Generic write function.
 
int32_t fingerprint2_generic_read (fingerprint2_t *ctx, char *data_buf, uint16_t max_len)
 Generic read function.
 
uint8_t fingerprint2_get_ld1_status (fingerprint2_t *ctx)
 Generic function for reading ld1 pin status.
 
uint8_t fingerprint2_get_ld2_status (fingerprint2_t *ctx)
 Generic function for reading ld2 pin status.
 
void fingerprint2_set_rst_status (fingerprint2_t *ctx, uint8_t status)
 Generic function for setting rst pin status.
 
void fingerprint2_set_gp1_status (fingerprint2_t *ctx, uint8_t status)
 Generic function for setting gp1 pin status.
 
void fingerprint2_set_gp2_status (fingerprint2_t *ctx, uint8_t status)
 Generic function for setting gp2 pin status.
 
void fingerprint2_reset (fingerprint2_t *ctx)
 Function for restarting device.
 
void fingerprint2_reg_one_fp (fingerprint2_t *ctx, uint8_t fp_index)
 Function for fingerprint registration on index.
 
void fingerprint2_delete_one_fp (fingerprint2_t *ctx, uint8_t fp_index)
 Function for deleting fingerprint on index.
 

Detailed Description

This file contains API for Fingerprint 2 Click driver.