upm  0.5.1
Sensor/Actuator repository for libmraa (v0.9.1)
 All Data Structures Files Functions Variables Enumerations Enumerator Macros Groups Pages
zfm20.h
1 /*
2  * Author: Jon Trulson <jtrulson@ics.com>
3  * Copyright (c) 2015 Intel Corporation.
4  *
5  * Thanks to Adafruit for supplying a google translated version of the
6  * Chinese datasheet and some clues in their code.
7  *
8  * Permission is hereby granted, free of charge, to any person obtaining
9  * a copy of this software and associated documentation files (the
10  * "Software"), to deal in the Software without restriction, including
11  * without limitation the rights to use, copy, modify, merge, publish,
12  * distribute, sublicense, and/or sell copies of the Software, and to
13  * permit persons to whom the Software is furnished to do so, subject to
14  * the following conditions:
15  *
16  * The above copyright notice and this permission notice shall be
17  * included in all copies or substantial portions of the Software.
18  *
19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
20  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
21  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
22  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
23  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
24  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
25  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
26  */
27 #pragma once
28 
29 #include <string>
30 #include <iostream>
31 
32 #include <stdint.h>
33 #include <stdlib.h>
34 #include <unistd.h>
35 #include <string.h>
36 #include <fcntl.h>
37 #include <errno.h>
38 #include <termios.h>
39 #include <sys/time.h>
40 #include <sys/select.h>
41 #include <sys/types.h>
42 #include <sys/stat.h>
43 
44 #include <mraa/uart.h>
45 
46 #define ZFM20_DEFAULT_UART 0
47 
48 // protocol start codes
49 #define ZFM20_START1 0xef
50 #define ZFM20_START2 0x01
51 
52 #define ZFM20_MAX_PKT_LEN 256
53 
54 #define ZFM20_TIMEOUT 5000 // in ms
55 
56 #define ZFM20_DEFAULT_PASSWORD 0x00000000
57 #define ZFM20_DEFAULT_ADDRESS 0xffffffff
58 
59 
60 namespace upm {
89  class ZFM20 {
90  public:
91 
92  // commands
93  typedef enum {
94  CMD_GEN_IMAGE = 0x01,
95  CMD_IMG2TZ = 0x02,
96  CMD_MATCH = 0x03,
97  CMD_SEARCH = 0x04,
98  CMD_REGMODEL = 0x05,
99  CMD_STORE = 0x06,
100  CMD_LOAD_TMPL = 0x07,
101  CMD_UPLOAD_TMPL = 0x08,
102  CMD_DOWNLOAD_TMPL = 0x09,
103  CMD_UPLOAD_IMAGE = 0x0a,
104  CMD_DOWNLOAD_IMAGE = 0x0b,
105  CMD_DELETE_TMPL = 0x0c,
106  CMD_EMPTYDB = 0x0d,
107  CMD_SET_SYSPARAMS = 0x0e,
108  CMD_GET_SYSPARAMS = 0x0f,
109  CMD_SET_PASSWORD = 0x12,
110  CMD_VERIFY_PASSWORD = 0x13,
111  CMD_GET_RANDOM_NUMBER = 0x14,
112  CMD_SET_ADDRESS = 0x15,
113  CMD_GET_TMPL_COUNT = 0x1d,
114  CMD_GET_INDEX_TABLE = 0x1f
115  } ZFM20_COMMAND_T;
116 
117  // Error response codes
118  typedef enum {
119  ERR_OK = 0x00,
120  ERR_PACKET_RX_ERROR = 0x01,
121  ERR_NO_FINGER = 0x02,
122  ERR_FP_IMAGE_FAILED = 0x03,
123  ERR_FP_TOO_MESSY = 0x06,
124  ERR_FP_IMAGE_FEW_FEATURES = 0x07,
125  ERR_FP_NOMATCH = 0x08,
126  ERR_FP_NOTFOUND = 0x09,
127  ERR_FP_ENROLLMISMATCH = 0x0a,
128  ERR_BAD_LOCATION = 0x0b,
129  ERR_DB_ERROR = 0x0c,
130  ERR_UPLOAD_FEAT_FAILED = 0x0d,
131  ERR_NO_MORE_PACKETS = 0x0e,
132  ERR_UPLOAD_IMG_FAILED = 0x0f,
133  ERR_RM_TMPL_FAILED = 0x10,
134  ERR_EMPTY_DB_FAILED = 0x11,
135  ERR_INVALID_PWD = 0x13,
136  ERR_INVALID_IMAGE = 0x15,
137  ERR_RW_FLASH_ERROR = 0x18,
138  ERR_INVALID_REG = 0x1a,
139  ERR_INVALID_ADDR = 0x20,
140  ERR_NEEDS_PWD = 0x21,
141  // end of module-specific errors
142  ERR_INTERNAL_ERR = 0xff // API internal error
143  } ZFM20_ERRORS_T;
144 
145  typedef enum {
146  PKT_COMMAND = 0x01,
147  PKT_DATA = 0x02,
148  PKT_ACK = 0x07,
149  PKT_END_DATA = 0x08
150  } ZFM20_PKTCODES_T;
151 
157  ZFM20(int uart);
158 
162  ~ZFM20();
163 
170  bool dataAvailable(unsigned int millis);
171 
182  int readData(char *buffer, int len);
183 
191  int writeData(char *buffer, int len);
192 
200  bool setupTty(speed_t baud=B57600);
201 
209  int writeCmdPacket(uint8_t *pkt, int len);
210 
218  bool verifyPacket(uint8_t *pkt, int len);
219 
226  uint32_t getMillis();
227 
232  void initClock();
233 
239  void setAddress(uint32_t addr) { m_address = addr; };
240 
246  void setPassword(uint32_t pw) { m_password = pw; };
247 
256  bool getResponse(uint8_t *pkt, int len);
257 
264  bool verifyPassword();
265 
272  int getNumTemplates();
273 
282  bool setNewPassword(uint32_t pwd);
283 
292  bool setNewAddress(uint32_t addr);
293 
299  uint8_t generateImage();
300 
309  uint8_t image2Tz(int slot);
310 
318  uint8_t createModel();
319 
329  uint8_t storeModel(int slot, uint16_t id);
330 
337  uint8_t deleteModel(uint16_t id);
338 
344  uint8_t deleteDB();
345 
355  uint8_t search(int slot, uint16_t *id, uint16_t *score);
356 
364  uint8_t match(uint16_t *score);
365 
366 
367  protected:
368  int ttyFd() { return m_ttyFd; };
369 
370  private:
371  mraa_uart_context m_uart;
372  int m_ttyFd;
373  uint32_t m_password;
374  uint32_t m_address;
375  struct timeval m_startTime;
376  };
377 }
378 
379 
uint8_t search(int slot, uint16_t *id, uint16_t *score)
Definition: zfm20.cxx:545
uint8_t match(uint16_t *score)
Definition: zfm20.cxx:584
bool getResponse(uint8_t *pkt, int len)
Definition: zfm20.cxx:275
int writeData(char *buffer, int len)
Definition: zfm20.cxx:127
uint8_t storeModel(int slot, uint16_t id)
Definition: zfm20.cxx:483
bool setNewPassword(uint32_t pwd)
Definition: zfm20.cxx:367
API for the ZFM-20 Fingerprint Sensor Module.
Definition: zfm20.h:89
void setPassword(uint32_t pw)
Definition: zfm20.h:246
uint8_t deleteDB()
Definition: zfm20.cxx:529
uint8_t generateImage()
Definition: zfm20.cxx:427
bool verifyPassword()
Definition: zfm20.cxx:322
ZFM20(int uart)
Definition: zfm20.cxx:36
bool verifyPacket(uint8_t *pkt, int len)
Definition: zfm20.cxx:254
uint8_t createModel()
Definition: zfm20.cxx:467
void setAddress(uint32_t addr)
Definition: zfm20.h:239
~ZFM20()
Definition: zfm20.cxx:74
uint32_t getMillis()
Definition: zfm20.cxx:226
int readData(char *buffer, int len)
Definition: zfm20.cxx:106
bool setupTty(speed_t baud=B57600)
Definition: zfm20.cxx:157
int getNumTemplates()
Definition: zfm20.cxx:343
uint8_t image2Tz(int slot)
Definition: zfm20.cxx:443
uint8_t deleteModel(uint16_t id)
Definition: zfm20.cxx:509
int writeCmdPacket(uint8_t *pkt, int len)
Definition: zfm20.cxx:187
bool setNewAddress(uint32_t addr)
Definition: zfm20.cxx:397
void initClock()
Definition: zfm20.cxx:221
bool dataAvailable(unsigned int millis)
Definition: zfm20.cxx:82