fingerprint2  2.0.0.0
fingerprint2.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 FINGERPRINT2_H
36 #define FINGERPRINT2_H
37 
38 #include "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_uart.h"
51 
52 
53 // -------------------------------------------------------------- PUBLIC MACROS
63 #define FINGERPRINT2_MAP_MIKROBUS( cfg, mikrobus ) \
64  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
65  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
66  cfg.ld1 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
67  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
68  cfg.gp1 = MIKROBUS( mikrobus, MIKROBUS_CS ); \
69  cfg.gp2 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
70  cfg.ld2 = MIKROBUS( mikrobus, MIKROBUS_INT )
71 
77 #define FINGERPRINT2_RETVAL uint8_t
78 
79 #define FINGERPRINT2_OK 0x00
80 #define FINGERPRINT2_INIT_ERROR 0xFF
81 
88 #define FINGERPRINT2_CMD_GET_FW_VER "<C>GetFWVer</C>"
89 #define FINGERPRINT2_CMD_GET_DS "<C>GetDS</C>"
90 #define FINGERPRINT2_CMD_FP_CMP "<C>CompareFingerprint</C>"
91 #define FINGERPRINT2_CMD_FP_REG "<C>RegisterFingerprint</C>"
92 #define FINGERPRINT2_CMD_FP_CLR "<C>ClearRegisteredFp</C>"
93 #define FINGERPRINT2_CMD_FP_IMG_INFO "<C>FpImageInformation</C>"
94 #define FINGERPRINT2_CMD_FP_IMG_SCAN "<C>ScanFpImage</C>"
95 #define FINGERPRINT2_CMD_FP_REG_NO "<C>CheckRegisteredNo</C>"
96 #define FINGERPRINT2_CMD_LOCK_DEV "<C>LockDevice</C>"
97 #define FINGERPRINT2_CMD_UNLOCK_DEV "<C>UnlockCompareFp</C>"
98 
104 #define MOD_NUM 10
105 #define VAL_CHAR 48
106 
112 #define DRV_RX_BUFFER_SIZE 800
113 #define DRV_TX_BUFFER_SIZE 100
114  // End group macro
118 // --------------------------------------------------------------- PUBLIC TYPES
126 typedef struct
127 {
128  // Output pins
129 
130  digital_out_t rst;
131  digital_out_t gp1;
132  digital_out_t gp2;
133 
134  // Input pins
135 
136  digital_in_t ld1;
137  digital_in_t ld2;
138 
139  // Modules
140 
141  uart_t uart;
142 
143  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
144  char uart_tx_buffer[ DRV_TX_BUFFER_SIZE ];
145 
147 
151 typedef struct
152 {
153  // Communication gpio pins
154 
155  pin_name_t rx_pin;
156  pin_name_t tx_pin;
157 
158  // Additional gpio pins
159 
160  pin_name_t ld1;
161  pin_name_t rst;
162  pin_name_t gp1;
163  pin_name_t gp2;
164  pin_name_t ld2;
165 
166  // static variable
167 
168  uint32_t baud_rate; // Clock speed.
170  uart_data_bits_t data_bit; // Data bits.
171  uart_parity_t parity_bit; // Parity bit.
172  uart_stop_bits_t stop_bit; // Stop bits.
173 
175  // End types group
177 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
178 
184 #ifdef __cplusplus
185 extern "C"{
186 #endif
187 
197 
207 
217 void fingerprint2_generic_write ( fingerprint2_t *ctx, char *data_buf, uint16_t len );
218 
230 int32_t fingerprint2_generic_read ( fingerprint2_t *ctx, char *data_buf, uint16_t max_len );
231 
242 
253 
262 void fingerprint2_set_rst_status ( fingerprint2_t *ctx, uint8_t status );
263 
272 void fingerprint2_set_gp1_status ( fingerprint2_t *ctx, uint8_t status );
273 
282 void fingerprint2_set_gp2_status ( fingerprint2_t *ctx, uint8_t status );
283 
292 
301 void fingerprint2_reg_one_fp ( fingerprint2_t *ctx, uint8_t fp_index );
302 
311 void fingerprint2_delete_one_fp ( fingerprint2_t *ctx, uint8_t fp_index );
312 
313 #ifdef __cplusplus
314 }
315 #endif
316 #endif // _FINGERPRINT2_H_
317  // End public_function group
320 
321 // ------------------------------------------------------------------------- END
fingerprint2_reset
void fingerprint2_reset(fingerprint2_t *ctx)
Function for restarting device.
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: fingerprint2.h:112
fingerprint2_cfg_setup
void fingerprint2_cfg_setup(fingerprint2_cfg_t *cfg)
Config Object Initialization function.
fingerprint2_init
FINGERPRINT2_RETVAL fingerprint2_init(fingerprint2_t *ctx, fingerprint2_cfg_t *cfg)
Initialization function.
fingerprint2_get_ld2_status
uint8_t fingerprint2_get_ld2_status(fingerprint2_t *ctx)
Generic function for reading ld2 pin status.
fingerprint2_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: fingerprint2.h:170
fingerprint2_cfg_t::ld1
pin_name_t ld1
Definition: fingerprint2.h:160
fingerprint2_cfg_t::uart_blocking
bool uart_blocking
Definition: fingerprint2.h:169
fingerprint2_cfg_t::gp2
pin_name_t gp2
Definition: fingerprint2.h:163
fingerprint2_t::gp1
digital_out_t gp1
Definition: fingerprint2.h:131
fingerprint2_generic_write
void fingerprint2_generic_write(fingerprint2_t *ctx, char *data_buf, uint16_t len)
Generic write function.
fingerprint2_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: fingerprint2.h:171
fingerprint2_cfg_t::tx_pin
pin_name_t tx_pin
Definition: fingerprint2.h:156
fingerprint2_get_ld1_status
uint8_t fingerprint2_get_ld1_status(fingerprint2_t *ctx)
Generic function for reading ld1 pin status.
fingerprint2_t
Click ctx object definition.
Definition: fingerprint2.h:127
fingerprint2_cfg_t::rst
pin_name_t rst
Definition: fingerprint2.h:161
fingerprint2_set_rst_status
void fingerprint2_set_rst_status(fingerprint2_t *ctx, uint8_t status)
Generic function for setting rst pin status.
FINGERPRINT2_RETVAL
#define FINGERPRINT2_RETVAL
Definition: fingerprint2.h:77
fingerprint2_reg_one_fp
void fingerprint2_reg_one_fp(fingerprint2_t *ctx, uint8_t fp_index)
Function for fingerprint registration on index.
fingerprint2_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: fingerprint2.h:172
fingerprint2_t::gp2
digital_out_t gp2
Definition: fingerprint2.h:132
fingerprint2_set_gp2_status
void fingerprint2_set_gp2_status(fingerprint2_t *ctx, uint8_t status)
Generic function for setting gp2 pin status.
fingerprint2_generic_read
int32_t fingerprint2_generic_read(fingerprint2_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
fingerprint2_t::rst
digital_out_t rst
Definition: fingerprint2.h:130
fingerprint2_cfg_t::ld2
pin_name_t ld2
Definition: fingerprint2.h:164
fingerprint2_cfg_t::gp1
pin_name_t gp1
Definition: fingerprint2.h:162
fingerprint2_cfg_t::rx_pin
pin_name_t rx_pin
Definition: fingerprint2.h:155
fingerprint2_t::uart
uart_t uart
Definition: fingerprint2.h:141
DRV_TX_BUFFER_SIZE
#define DRV_TX_BUFFER_SIZE
Definition: fingerprint2.h:113
fingerprint2_cfg_t::baud_rate
uint32_t baud_rate
Definition: fingerprint2.h:168
fingerprint2_t::ld1
digital_in_t ld1
Definition: fingerprint2.h:136
fingerprint2_t::ld2
digital_in_t ld2
Definition: fingerprint2.h:137
fingerprint2_set_gp1_status
void fingerprint2_set_gp1_status(fingerprint2_t *ctx, uint8_t status)
Generic function for setting gp1 pin status.
fingerprint2_delete_one_fp
void fingerprint2_delete_one_fp(fingerprint2_t *ctx, uint8_t fp_index)
Function for deleting fingerprint on index.
fingerprint2_cfg_t
Click configuration structure definition.
Definition: fingerprint2.h:152