Go to the documentation of this file.
35 #ifndef FINGERPRINT3_H
36 #define FINGERPRINT3_H
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
53 #define FINGERPRINT3_MAP_MIKROBUS( cfg, mikrobus ) \
54 cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
55 cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
56 cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
57 cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
64 #define FINGERPRINT3_RETVAL uint8_t
66 #define FINGERPRINT3_OK 0x00
67 #define FINGERPRINT3_INIT_ERROR 0xFF
75 #define FINGERPRINT3_CMD_GET_IMAGE 0x01
76 #define FINGERPRINT3_CMD_IMAGE_2_TZ 0x02
77 #define FINGERPRINT3_CMD_MATCH 0x03
78 #define FINGERPRINT3_CMD_SEARCH 0x04
79 #define FINGERPRINT3_CMD_REG_MODEL 0x05
80 #define FINGERPRINT3_CMD_STORE 0x06
81 #define FINGERPRINT3_CMD_LOAD_CHAR 0x07
82 #define FINGERPRINT3_CMD_UPLOAD_CHAR 0x08
83 #define FINGERPRINT3_CMD_DOWNLOAD_CHAR 0x09
84 #define FINGERPRINT3_CMD_UPLOAD_IMAGE 0x0A
85 #define FINGERPRINT3_CMD_DOWNLOAD_IMAGE 0x0B
86 #define FINGERPRINT3_CMD_DELETE_CHAR 0x0C
87 #define FINGERPRINT3_CMD_EMPTY 0x0D
88 #define FINGERPRINT3_CMD_SET_SYS_PARAM 0x0E
89 #define FINGERPRINT3_CMD_READ_SYS_PARAM 0x0F
90 #define FINGERPRINT3_CMD_SET_PASSWORD 0x12
91 #define FINGERPRINT3_CMD_VERIFY_PASSWORD 0x13
92 #define FINGERPRINT3_CMD_GET_RANDOM_CODE 0x14
93 #define FINGERPRINT3_CMD_SET_ADDRESS 0x15
94 #define FINGERPRINT3_CMD_READ_INFO_PAGE 0x16
95 #define FINGERPRINT3_CMD_PORT_CONTROL 0x17
96 #define FINGERPRINT3_CMD_WRITE_NOTEPAD 0x18
97 #define FINGERPRINT3_CMD_READ_NOTEPAD 0x19
98 #define FINGERPRINT3_CMD_TEMPLATE_NUM 0x1D
99 #define FINGERPRINT3_CMD_READ_INDEX_TEMPLATE 0x1F
100 #define FINGERPRINT3_CMD_GET_IMAGE_EXT 0x28
101 #define FINGERPRINT3_CMD_CANCEL 0x30
102 #define FINGERPRINT3_CMD_AURA_CONTROL 0x35
103 #define FINGERPRINT3_CMD_CHECK_SENSOR 0x36
104 #define FINGERPRINT3_CMD_GET_ALG_VERSION 0x39
105 #define FINGERPRINT3_CMD_GET_FW_VERSION 0x3A
106 #define FINGERPRINT3_CMD_READ_PRODUCT_INFO 0x3C
107 #define FINGERPRINT3_CMD_SOFT_RESET 0x3D
108 #define FINGERPRINT3_CMD_HAND_SHAKE 0x40
115 #define FINGERPRINT3_CONF_CMD_OK 0x00
116 #define FINGERPRINT3_CONF_PACKET_RECEIVE_ERROR 0x01
117 #define FINGERPRINT3_CONF_NO_FINGER 0x02
118 #define FINGERPRINT3_CONF_ENROLL_FAIL 0x03
119 #define FINGERPRINT3_CONF_OVER_DISORDERLY_FAIL 0x06
120 #define FINGERPRINT3_CONF_OVER_SMALLNESS_FAIL 0x07
121 #define FINGERPRINT3_CONF_NO_MATCH 0x08
122 #define FINGERPRINT3_CONF_NOT_FOUND 0x09
123 #define FINGERPRINT3_CONF_FAIL_TO_COMBINE 0x0A
124 #define FINGERPRINT3_CONF_BAD_LOCATION 0x0B
125 #define FINGERPRINT3_CONF_READ_TEMPLATE_FAIL 0x0C
126 #define FINGERPRINT3_CONF_UPLOAD_TEMPLATE_FAIL 0x0D
127 #define FINGERPRINT3_CONF_PACKET_RECEIVE_FAIL 0x0E
128 #define FINGERPRINT3_CONF_UPLOAD_IMAGE_FAIL 0x0F
129 #define FINGERPRINT3_CONF_DELETE_TEMPLATE_FAIL 0x10
130 #define FINGERPRINT3_CONF_LIBRARY_CLEAR_FAIL 0x11
131 #define FINGERPRINT3_CONF_WRONG_PASSWORD 0x13
132 #define FINGERPRINT3_CONF_GENERATE_IMAGE_FAIL 0x15
133 #define FINGERPRINT3_CONF_FLASH_WRITE_ERROR 0x18
134 #define FINGERPRINT3_CONF_NO_DEFINITION_ERROR 0x19
135 #define FINGERPRINT3_CONF_INVALID_REG_NUM 0x1A
136 #define FINGERPRINT3_CONF_INCORRECT_REG_CONFIG 0x1B
137 #define FINGERPRINT3_CONF_WRONG_PAGE_NUM 0x1C
138 #define FINGERPRINT3_CONF_COM_PORT_FAIL 0x1D
145 #define FINGERPRINT3_HEADER 0xEF01
146 #define FINGERPRINT3_HEADER_MSB 0xEF
147 #define FINGERPRINT3_HEADER_LSB 0x01
154 #define FINGERPRINT3_DEFAULT_ADDRESS 0xFFFFFFFFul
155 #define FINGERPRINT3_DEFAULT_PASSWORD 0x00000000ul
162 #define FINGERPRINT3_COMMAND_PACKET 0x01
163 #define FINGERPRINT3_DATA_PACKET 0x02
164 #define FINGERPRINT3_ACK_PACKET 0x07
165 #define FINGERPRINT3_END_DATA_PACKET 0x08
172 #define FINGERPRINT3_DETECT_FINGER 0x00
173 #define FINGERPRINT3_DETECT_NO_FINGER 0x01
180 #define FINGERPRINT3_ERR_TIMEOUT 0xFB
181 #define FINGERPRINT3_ERR_PACKAGE_LEN 0xFC
182 #define FINGERPRINT3_ERR_CHKSUM 0xFD
183 #define FINGERPRINT3_ERR_RESPONSE 0xFE
184 #define FINGERPRINT3_ERR_HEADER 0xFF
191 #define FINGERPRINT3_AURA_LED_RED 0x01
192 #define FINGERPRINT3_AURA_LED_BLUE 0x02
193 #define FINGERPRINT3_AURA_LED_PURPLE 0x03
195 #define FINGERPRINT3_AURA_CTRL_BREATH 0x01
196 #define FINGERPRINT3_AURA_CTRL_FLASH 0x02
197 #define FINGERPRINT3_AURA_CTRL_ON 0x03
198 #define FINGERPRINT3_AURA_CTRL_OFF 0x04
199 #define FINGERPRINT3_AURA_CTRL_GRADUAL_ON 0x05
200 #define FINGERPRINT3_AURA_CTRL_GRADUAL_OFF 0x06
202 #define FINGERPRINT3_AURA_TIME_INFINITE 0x00
209 #define FINGERPRINT3_MAX_PACKAGE_LENGTH 256
216 #define FINGERPRINT3_DRV_TX_BUFFER_SIZE 500
217 #define FINGERPRINT3_DRV_RX_BUFFER_SIZE 500
224 #define FINGERPRINT3_TIMEOUT 500
255 uint8_t module_type[ 16 ];
256 uint8_t module_batch_number[ 4 ];
257 uint8_t module_serial_number[ 8 ];
258 uint8_t hardware_version[ 2 ];
259 uint8_t sensor_type[ 8 ];
454 uint8_t color, uint8_t times );
675 #endif // _FINGERPRINT3_H_
uint8_t fingerprint3_take_image(fingerprint3_t *ctx)
Take image function.
uint8_t fingerprint3_load_template(fingerprint3_t *ctx, uint8_t char_buffer, uint16_t location)
Create template function.
void fingerprint3_generic_write(fingerprint3_t *ctx, uint8_t *data_buf, uint16_t len)
Generic write function.
uint8_t fingerprint3_read_product_info(fingerprint3_t *ctx)
Read product info function.
uint8_t fingerprint3_read_index_table(fingerprint3_t *ctx, uint8_t *table, uint8_t page)
Read index table function.
uint16_t status_register
Definition: fingerprint3.h:272
uart_stop_bits_t stop_bit
Definition: fingerprint3.h:325
uint16_t system_identifier_code
Definition: fingerprint3.h:273
bool uart_blocking
Definition: fingerprint3.h:322
pin_name_t int_pin
Definition: fingerprint3.h:318
uint32_t device_address
Definition: fingerprint3.h:276
uint8_t fingerprint3_finger_indicator(fingerprint3_t *ctx)
Finger indicator function.
uint8_t fingerprint3_extract_features(fingerprint3_t *ctx, uint8_t char_buffer)
Extract features function.
#define FINGERPRINT3_DRV_TX_BUFFER_SIZE
Definition: fingerprint3.h:216
uint8_t fingerprint3_soft_reset(fingerprint3_t *ctx)
Soft reset function.
uint8_t fingerprint3_search_finger(fingerprint3_t *ctx, uint8_t char_buffer, uint16_t *location, uint16_t *score)
Empty the library function.
fingerprint3_product_info_t product_info
Definition: fingerprint3.h:300
uint8_t fingerprint3_store_template(fingerprint3_t *ctx, uint8_t char_buffer, uint16_t location)
Create template function.
uint32_t addr
Definition: fingerprint3.h:242
pin_name_t rx_pin
Definition: fingerprint3.h:313
uart_parity_t parity_bit
Definition: fingerprint3.h:324
uint16_t security_level
Definition: fingerprint3.h:275
fingerprint3_pkg_t rsp
Definition: fingerprint3.h:299
uint16_t template_size
Definition: fingerprint3.h:262
uint32_t password
Definition: fingerprint3.h:303
pin_name_t rst
Definition: fingerprint3.h:317
digital_in_t int_pin
Definition: fingerprint3.h:291
uint16_t sensor_height
Definition: fingerprint3.h:261
#define FINGERPRINT3_DRV_RX_BUFFER_SIZE
Definition: fingerprint3.h:217
digital_out_t rst
Definition: fingerprint3.h:288
uint32_t address
Definition: fingerprint3.h:302
uart_t uart
Definition: fingerprint3.h:294
Package structure.
Definition: fingerprint3.h:240
uint8_t fingerprint3_send_package(fingerprint3_t *ctx, uint8_t pkg_id, uint8_t *pkg_content, uint16_t pkg_len)
Send package function.
uint8_t fingerprint3_read_sys_param(fingerprint3_t *ctx)
Read system parameter function.
uint32_t baudrate
Definition: fingerprint3.h:278
System Parameters structure.
Definition: fingerprint3.h:271
uint8_t fingerprint3_delete_template(fingerprint3_t *ctx, uint16_t location)
Delete template function.
Click ctx object definition.
Definition: fingerprint3.h:286
uint8_t pkg_id
Definition: fingerprint3.h:243
fingerprint3_sys_parameter_t system_parameters
Definition: fingerprint3.h:301
uint8_t fingerprint3_check_sensor(fingerprint3_t *ctx)
Check sensor function.
uint8_t fingerprint3_set_security_lvl(fingerprint3_t *ctx, uint8_t lvl)
Set security level function.
uint16_t sensor_width
Definition: fingerprint3.h:260
void fingerprint3_set_rst_pin(fingerprint3_t *ctx, uint8_t rst_pin)
Set RST pin state function.
uart_data_bits_t data_bit
Definition: fingerprint3.h:323
uint8_t fingerprint3_empty_library(fingerprint3_t *ctx)
Empty the library function.
uint8_t fingerprint3_hand_shake(fingerprint3_t *ctx)
Hand shake function.
Product Info structure.
Definition: fingerprint3.h:254
uint16_t header
Definition: fingerprint3.h:241
#define FINGERPRINT3_MAX_PACKAGE_LENGTH
Definition: fingerprint3.h:209
uint8_t fingerprint3_create_template(fingerprint3_t *ctx)
Create template function.
uint8_t fingerprint3_match_finger(fingerprint3_t *ctx, uint16_t *score)
Empty the library function.
uint16_t pkg_len
Definition: fingerprint3.h:244
uint8_t fingerprint3_set_config(fingerprint3_t *ctx, uint32_t addr, uint32_t pass)
Set config function.
uint32_t baud_rate
Definition: fingerprint3.h:321
uint16_t checksum
Definition: fingerprint3.h:246
pin_name_t tx_pin
Definition: fingerprint3.h:314
uint16_t finger_library_size
Definition: fingerprint3.h:274
err_t fingerprint3_init(fingerprint3_t *ctx, fingerprint3_cfg_t *cfg)
Initialization function.
int32_t fingerprint3_generic_read(fingerprint3_t *ctx, uint8_t *data_buf, uint16_t max_len)
Generic read function.
uint16_t data_package_size
Definition: fingerprint3.h:277
uint8_t fingerprint3_aura_control(fingerprint3_t *ctx, uint8_t control, uint8_t speed, uint8_t color, uint8_t times)
Aura LED control function.
uint8_t fingerprint3_verify_password(fingerprint3_t *ctx, uint32_t pass)
Verify password function.
void fingerprint3_cfg_setup(fingerprint3_cfg_t *cfg)
Config Object Initialization function.
uint16_t database_size
Definition: fingerprint3.h:263
Click configuration structure definition.
Definition: fingerprint3.h:311