fingerprint2  2.0.0.0
Functions

Functions

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

Detailed Description

Function Documentation

◆ fingerprint2_cfg_setup()

void fingerprint2_cfg_setup ( fingerprint2_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.

◆ fingerprint2_delete_one_fp()

void fingerprint2_delete_one_fp ( fingerprint2_t ctx,
uint8_t  fp_index 
)

Function for deleting fingerprint on index.

Parameters
ctxClick object.
fp_indexFingerprint index

@description This function deletes fingerprint on index

◆ fingerprint2_generic_read()

int32_t fingerprint2_generic_read ( fingerprint2_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.

@description This function read maximum length of data.

◆ fingerprint2_generic_write()

void fingerprint2_generic_write ( fingerprint2_t ctx,
char *  data_buf,
uint16_t  len 
)

Generic write function.

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

@description This function write specific number of bytes

◆ fingerprint2_get_ld1_status()

uint8_t fingerprint2_get_ld1_status ( fingerprint2_t ctx)

Generic function for reading ld1 pin status.

Parameters
ctxClick object.
Returns
Pin status.

@description This function read ld1 pin status.

◆ fingerprint2_get_ld2_status()

uint8_t fingerprint2_get_ld2_status ( fingerprint2_t ctx)

Generic function for reading ld2 pin status.

Parameters
ctxClick object.
Returns
Pin status

@description This function read ld2 pin status

◆ fingerprint2_init()

FINGERPRINT2_RETVAL fingerprint2_init ( fingerprint2_t ctx,
fingerprint2_cfg_t cfg 
)

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

@description This function initializes all necessary pins and peripherals used for this click.

◆ fingerprint2_reg_one_fp()

void fingerprint2_reg_one_fp ( fingerprint2_t ctx,
uint8_t  fp_index 
)

Function for fingerprint registration on index.

Parameters
ctxClick object.
fp_indexFingerprint index

@description This function registrates fingerprint on index.

◆ fingerprint2_reset()

void fingerprint2_reset ( fingerprint2_t ctx)

Function for restarting device.

Parameters
ctxClick object.

@description This function restarts device.

◆ fingerprint2_set_gp1_status()

void fingerprint2_set_gp1_status ( fingerprint2_t ctx,
uint8_t  status 
)

Generic function for setting gp1 pin status.

Parameters
ctxClick object.
statusState of the pin.

@description This function sets gp1 pin status.

◆ fingerprint2_set_gp2_status()

void fingerprint2_set_gp2_status ( fingerprint2_t ctx,
uint8_t  status 
)

Generic function for setting gp2 pin status.

Parameters
ctxClick object.
statusstate of the pin

@description This function sets gp2 pin status.

◆ fingerprint2_set_rst_status()

void fingerprint2_set_rst_status ( fingerprint2_t ctx,
uint8_t  status 
)

Generic function for setting rst pin status.

Parameters
ctxClick object.
statusState of the pin

@description This function sets rst pin status.