fingerprint3  2.0.0.0
fingerprint3.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef FINGERPRINT3_H
36 #define FINGERPRINT3_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_uart.h"
41 
42 
43 // -------------------------------------------------------------- PUBLIC MACROS
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 );
58 
64 #define FINGERPRINT3_RETVAL uint8_t
65 
66 #define FINGERPRINT3_OK 0x00
67 #define FINGERPRINT3_INIT_ERROR 0xFF
68 
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
109 
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
139 
145 #define FINGERPRINT3_HEADER 0xEF01
146 #define FINGERPRINT3_HEADER_MSB 0xEF
147 #define FINGERPRINT3_HEADER_LSB 0x01
148 
154 #define FINGERPRINT3_DEFAULT_ADDRESS 0xFFFFFFFF
155 #define FINGERPRINT3_DEFAULT_PASSWORD 0x00000000
156 
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
166 
172 #define FINGERPRINT3_DETECT_FINGER 0x00
173 #define FINGERPRINT3_DETECT_NO_FINGER 0x01
174 
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
185 
191 #define FINGERPRINT3_AURA_LED_RED 0x01
192 #define FINGERPRINT3_AURA_LED_BLUE 0x02
193 #define FINGERPRINT3_AURA_LED_PURPLE 0x03
194 
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
201 
202 #define FINGERPRINT3_AURA_TIME_INFINITE 0x00
203 
209 #define FINGERPRINT3_MAX_PACKAGE_LENGTH 256
210 
216 #define DRV_RX_BUFFER_SIZE 500
217 
223 #define FINGERPRINT3_TIMEOUT 500
224  // End group macro
228 // --------------------------------------------------------------- PUBLIC TYPES
238 typedef struct
239 {
240  uint16_t header;
241  uint32_t addr;
242  uint8_t pkg_id;
243  uint16_t pkg_len;
244  uint8_t pkg_content[ FINGERPRINT3_MAX_PACKAGE_LENGTH ];
245  uint16_t checksum;
247 
251 typedef struct
252 {
253  uint8_t module_type[ 16 ];
254  uint8_t module_batch_number[ 4 ];
255  uint8_t module_serial_number[ 8 ];
256  uint8_t hardware_version[ 2 ];
257  uint8_t sensor_type[ 8 ];
258  uint16_t sensor_width;
259  uint16_t sensor_height;
260  uint16_t template_size;
261  uint16_t database_size;
263 
267 typedef struct
268 {
269  uint16_t status_register;
272  uint16_t security_level;
273  uint32_t device_address;
275  uint32_t baudrate;
277 
281 typedef struct
282 {
283  // Output pins
284 
285  digital_out_t rst;
286 
287  // Input pins
288 
289  digital_in_t int_pin;
290 
291  // Modules
292 
293  uart_t uart;
294 
295  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
296  char uart_tx_buffer[ DRV_RX_BUFFER_SIZE ];
297 
301  uint32_t address;
302  uint32_t password;
303 
305 
309 typedef struct
310 {
311  // Communication gpio pins
312 
313  pin_name_t rx_pin;
314  pin_name_t tx_pin;
315 
316  // Additional gpio pins
317 
318  pin_name_t rst;
319  pin_name_t int_pin;
320 
321  // static variable
322 
323  uint32_t baud_rate; // Clock speed.
325  uart_data_bits_t data_bit; // Data bits.
326  uart_parity_t parity_bit; // Parity bit.
327  uart_stop_bits_t stop_bit; // Stop bits.
328 
330  // End types group
336 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
337 
343 #ifdef __cplusplus
344 extern "C"{
345 #endif
346 
356 
365 
378 uint8_t fingerprint3_set_config ( fingerprint3_t *ctx, uint32_t addr, uint32_t pass );
379 
391 void fingerprint3_set_rst_pin ( fingerprint3_t *ctx, uint8_t rst_pin );
392 
400 void fingerprint3_generic_write ( fingerprint3_t *ctx, char *data_buf, uint16_t len );
401 
411 int32_t fingerprint3_generic_read ( fingerprint3_t *ctx, char *data_buf, uint16_t max_len );
412 
426 uint8_t fingerprint3_send_package ( fingerprint3_t *ctx, uint8_t pkg_id, uint8_t *pkg_content, uint16_t pkg_len );
427 
436 
455 uint8_t fingerprint3_aura_control ( fingerprint3_t *ctx, uint8_t control, uint8_t speed,
456  uint8_t color, uint8_t times );
457 
468 uint8_t fingerprint3_verify_password ( fingerprint3_t *ctx, uint32_t pass );
469 
480 
491 
504 uint8_t fingerprint3_set_security_level ( fingerprint3_t *ctx, uint8_t lvl );
505 
515 uint8_t fingerprint3_hand_shake ( fingerprint3_t *ctx );
516 
527 
537 uint8_t fingerprint3_soft_reset ( fingerprint3_t *ctx );
538 
560 uint8_t fingerprint3_read_index_table ( fingerprint3_t *ctx, uint8_t *table, uint8_t page );
561 
571 uint8_t fingerprint3_take_image ( fingerprint3_t *ctx );
572 
584 uint8_t fingerprint3_extract_features ( fingerprint3_t *ctx, uint8_t char_buffer );
585 
598 
610 uint8_t fingerprint3_store_template ( fingerprint3_t *ctx, uint8_t char_buffer, uint16_t location );
611 
622 uint8_t fingerprint3_delete_template ( fingerprint3_t *ctx, uint16_t location );
623 
634 
646 uint8_t fingerprint3_load_template ( fingerprint3_t *ctx, uint8_t char_buffer, uint16_t location );
647 
658 uint8_t fingerprint3_match_finger ( fingerprint3_t *ctx, uint16_t *score );
659 
672 uint8_t fingerprint3_search_finger ( fingerprint3_t *ctx, uint8_t char_buffer, uint16_t *location, uint16_t *score );
673 
674 #ifdef __cplusplus
675 }
676 #endif
677 #endif // _FINGERPRINT3_H_
678  // End public_function group
681 
682 // ------------------------------------------------------------------------- END
fingerprint3_take_image
uint8_t fingerprint3_take_image(fingerprint3_t *ctx)
Take image function.
fingerprint3_load_template
uint8_t fingerprint3_load_template(fingerprint3_t *ctx, uint8_t char_buffer, uint16_t location)
Create template function.
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: fingerprint3.h:216
fingerprint3_read_product_info
uint8_t fingerprint3_read_product_info(fingerprint3_t *ctx)
Read product info function.
fingerprint3_read_index_table
uint8_t fingerprint3_read_index_table(fingerprint3_t *ctx, uint8_t *table, uint8_t page)
Read index table function.
fingerprint3_sys_parameter_t::status_register
uint16_t status_register
Definition: fingerprint3.h:269
fingerprint3_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: fingerprint3.h:327
fingerprint3_sys_parameter_t::system_identifier_code
uint16_t system_identifier_code
Definition: fingerprint3.h:270
fingerprint3_cfg_t::uart_blocking
bool uart_blocking
Definition: fingerprint3.h:324
fingerprint3_cfg_t::int_pin
pin_name_t int_pin
Definition: fingerprint3.h:319
fingerprint3_generic_write
void fingerprint3_generic_write(fingerprint3_t *ctx, char *data_buf, uint16_t len)
Generic write function.
fingerprint3_sys_parameter_t::device_address
uint32_t device_address
Definition: fingerprint3.h:273
fingerprint3_finger_indicator
uint8_t fingerprint3_finger_indicator(fingerprint3_t *ctx)
Finger indicator function.
fingerprint3_extract_features
uint8_t fingerprint3_extract_features(fingerprint3_t *ctx, uint8_t char_buffer)
Extract features function.
fingerprint3_soft_reset
uint8_t fingerprint3_soft_reset(fingerprint3_t *ctx)
Soft reset function.
fingerprint3_search_finger
uint8_t fingerprint3_search_finger(fingerprint3_t *ctx, uint8_t char_buffer, uint16_t *location, uint16_t *score)
Empty the library function.
fingerprint3_read_system_parameter
uint8_t fingerprint3_read_system_parameter(fingerprint3_t *ctx)
Read system parameter function.
fingerprint3_t::product_info
fingerprint3_product_info_t product_info
Definition: fingerprint3.h:299
fingerprint3_store_template
uint8_t fingerprint3_store_template(fingerprint3_t *ctx, uint8_t char_buffer, uint16_t location)
Create template function.
fingerprint3_pkg_t::addr
uint32_t addr
Definition: fingerprint3.h:241
fingerprint3_cfg_t::rx_pin
pin_name_t rx_pin
Definition: fingerprint3.h:313
fingerprint3_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: fingerprint3.h:326
fingerprint3_sys_parameter_t::security_level
uint16_t security_level
Definition: fingerprint3.h:272
fingerprint3_t::rsp
fingerprint3_pkg_t rsp
Definition: fingerprint3.h:298
fingerprint3_product_info_t::template_size
uint16_t template_size
Definition: fingerprint3.h:260
fingerprint3_t::password
uint32_t password
Definition: fingerprint3.h:302
fingerprint3_cfg_t::rst
pin_name_t rst
Definition: fingerprint3.h:318
fingerprint3_t::int_pin
digital_in_t int_pin
Definition: fingerprint3.h:289
fingerprint3_set_security_level
uint8_t fingerprint3_set_security_level(fingerprint3_t *ctx, uint8_t lvl)
Set security level function.
fingerprint3_product_info_t::sensor_height
uint16_t sensor_height
Definition: fingerprint3.h:259
FINGERPRINT3_RETVAL
#define FINGERPRINT3_RETVAL
Definition: fingerprint3.h:64
fingerprint3_t::rst
digital_out_t rst
Definition: fingerprint3.h:285
fingerprint3_t::address
uint32_t address
Definition: fingerprint3.h:301
fingerprint3_t::uart
uart_t uart
Definition: fingerprint3.h:293
fingerprint3_pkg_t
Package structure.
Definition: fingerprint3.h:238
fingerprint3_send_package
uint8_t fingerprint3_send_package(fingerprint3_t *ctx, uint8_t pkg_id, uint8_t *pkg_content, uint16_t pkg_len)
Send package function.
fingerprint3_generic_read
int32_t fingerprint3_generic_read(fingerprint3_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
fingerprint3_sys_parameter_t::baudrate
uint32_t baudrate
Definition: fingerprint3.h:275
fingerprint3_sys_parameter_t
System Parameters structure.
Definition: fingerprint3.h:267
fingerprint3_delete_template
uint8_t fingerprint3_delete_template(fingerprint3_t *ctx, uint16_t location)
Delete template function.
fingerprint3_t
Click ctx object definition.
Definition: fingerprint3.h:281
fingerprint3_pkg_t::pkg_id
uint8_t pkg_id
Definition: fingerprint3.h:242
fingerprint3_t::system_parameters
fingerprint3_sys_parameter_t system_parameters
Definition: fingerprint3.h:300
fingerprint3_check_sensor
uint8_t fingerprint3_check_sensor(fingerprint3_t *ctx)
Check sensor function.
fingerprint3_product_info_t::sensor_width
uint16_t sensor_width
Definition: fingerprint3.h:258
fingerprint3_set_rst_pin
void fingerprint3_set_rst_pin(fingerprint3_t *ctx, uint8_t rst_pin)
Set RST pin state function.
fingerprint3_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: fingerprint3.h:325
fingerprint3_empty_library
uint8_t fingerprint3_empty_library(fingerprint3_t *ctx)
Empty the library function.
fingerprint3_hand_shake
uint8_t fingerprint3_hand_shake(fingerprint3_t *ctx)
Hand shake function.
fingerprint3_product_info_t
Product Info structure.
Definition: fingerprint3.h:251
fingerprint3_pkg_t::header
uint16_t header
Definition: fingerprint3.h:240
fingerprint3_init
FINGERPRINT3_RETVAL fingerprint3_init(fingerprint3_t *ctx, fingerprint3_cfg_t *cfg)
Initialization function.
FINGERPRINT3_MAX_PACKAGE_LENGTH
#define FINGERPRINT3_MAX_PACKAGE_LENGTH
Definition: fingerprint3.h:209
fingerprint3_create_template
uint8_t fingerprint3_create_template(fingerprint3_t *ctx)
Create template function.
fingerprint3_match_finger
uint8_t fingerprint3_match_finger(fingerprint3_t *ctx, uint16_t *score)
Empty the library function.
fingerprint3_pkg_t::pkg_len
uint16_t pkg_len
Definition: fingerprint3.h:243
fingerprint3_set_config
uint8_t fingerprint3_set_config(fingerprint3_t *ctx, uint32_t addr, uint32_t pass)
Set config function.
fingerprint3_cfg_t::baud_rate
uint32_t baud_rate
Definition: fingerprint3.h:323
fingerprint3_pkg_t::checksum
uint16_t checksum
Definition: fingerprint3.h:245
fingerprint3_cfg_t::tx_pin
pin_name_t tx_pin
Definition: fingerprint3.h:314
fingerprint3_sys_parameter_t::finger_library_size
uint16_t finger_library_size
Definition: fingerprint3.h:271
fingerprint3_sys_parameter_t::data_package_size
uint16_t data_package_size
Definition: fingerprint3.h:274
fingerprint3_aura_control
uint8_t fingerprint3_aura_control(fingerprint3_t *ctx, uint8_t control, uint8_t speed, uint8_t color, uint8_t times)
Aura LED control function.
fingerprint3_verify_password
uint8_t fingerprint3_verify_password(fingerprint3_t *ctx, uint32_t pass)
Verify password function.
fingerprint3_cfg_setup
void fingerprint3_cfg_setup(fingerprint3_cfg_t *cfg)
Config Object Initialization function.
fingerprint3_product_info_t::database_size
uint16_t database_size
Definition: fingerprint3.h:261
fingerprint3_cfg_t
Click configuration structure definition.
Definition: fingerprint3.h:309