fingerprint.h

Go to the documentation of this file.

#include "simpletools.h"                      // Include simple tools
#include "fdserial.h"

#ifndef FINGERPRINT_H
#define FINGERPRINT_H


#define ACK_SUCCESS                       0x00 // Operation successfully
#define ACK_FAIL                          0x01 // Operation failed
#define ACK_FULL                          0x04 // Fingerprint database is full
#define ACK_NOUSER                        0x05 // No such user
#define ACK_USER_EXISTS                   0x07 // already exists
#define ACK_TIMEOUT                       0x08 // Acquisition timeout

#define CMD_SLEEP                         0x2C // Sleeps the device
#define CMD_SET_MODE                      0x2D
#define CMD_ADD_FINGERPRINT_1             0x01
#define CMD_ADD_FINGERPRINT_2             0x02
#define CMD_ADD_FINGERPRINT_3             0x03
#define CMD_DELETE_USER                   0x04
#define CMD_DELETE_ALL_USERS              0x05
#define CMD_GET_USERS_COUNT               0x09
#define CMD_SCAN_COMPARE_1_TO_1           0x0B
#define CMD_SCAN_COMPARE_1_TO_N           0x0C
#define CMD_READ_USER_PRIVLAGE            0x0A
#define CMD_SENSITIVITY                   0x28
#define CMD_SCAN_GET_IMAGE                0x24
#define CMD_SCAN_GET_EIGENVALS            0x23
#define CMD_SCAN_PUT_EIGENVALS            0x44
#define CMD_PUT_EIGENVALS_COMPARE_1_TO_1  0x42
#define CMD_PUT_EIGENVALS_COMPARE_1_TO_N  0x43
#define CMD_GET_USER_EIGENVALS            0x31
#define CMD_PUT_USER_EIGENVALS            0x41
#define CMD_GET_USERS_INFO                0x2B
#define CMD_SET_SCAN_TIMEOUT              0x2E // How long to try scanning - multiples of ~0.25s


#if defined(__cplusplus)
extern "C" {
#endif


typedef struct fpScanner_st
{
    int  rx_head;   /* receive queue head */
    int  rx_tail;   /* receive queue tail */
    int  tx_head;   /* transmit queue head */
    int  tx_tail;   /* transmit queue tail */
    int  rx_pin;    /* recieve pin */
    int  tx_pin;    /* transmit pin */
    int  mode;      /* interface mode */
    int  ticks;     /* clkfreq / baud */
    char *buffptr;  /* pointer to rx buffer */
    //char *idstr;
    //int  en;
} fpScanner_t;


typedef text_t fpScanner;


fpScanner *fingerprint_open(int pin_rx, int pin_tx);

void fingerprint_close(fpScanner *device);


void fingerprint_sendCommand(fpScanner *device, char __fpCmd, char __fpParam1, char __fpParam2, char __fpParam3);


void fingerprint_readResponse(fpScanner *device, char *__fpResponse);


//ACK_SUCCESS, ACK_FAIL, ACK_FULL, ACK_NOUSER, ACK_FIN_EXIST, or ACK_TIMEOUT


int fingerprint_allowOverwrite(fpScanner *device, char b);


int fingerprint_add(fpScanner *device, int userId, char userLevel, int scanNumber);


int fingerprint_deleteUser(fpScanner *device, int userId);


int fingerprint_countUsers(fpScanner *device);


int fingerprint_scan(fpScanner *device, int userId, int *uid);


int fingerprint_lookupUserPrivlage(fpScanner *device, int userId); 

int fingerprint_setTimeout(fpScanner *device, int timeout);

int fingerprint_setStrictness(fpScanner *device, char s_level);



#if defined(__cplusplus)
}
#endif
/* __cplusplus */ 
#endif
/* FINGERPRINT_H */