zfm20: Initial implementation

This driver implements support for the ZFM20 fingerprint module.  It
was tested on a Grove Fingerprint Sensor.

Signed-off-by: Jon Trulson <jtrulson@ics.com>
Signed-off-by: Zion Orent <zorent@ics.com>
Signed-off-by: John Van Drasek <john.r.van.drasek@intel.com>
This commit is contained in:
Jon Trulson
2015-03-30 18:02:08 -06:00
committed by John Van Drasek
parent bdaf952e91
commit 8bf92be1ab
12 changed files with 1818 additions and 0 deletions

View File

@ -109,6 +109,8 @@ add_executable (mhz16-example mhz16.cxx)
add_executable (apds9002-example apds9002.cxx)
add_executable (waterlevel-example waterlevel.cxx)
add_executable (tm1637-example tm1637.cxx)
add_executable (zfm20-example zfm20.cxx)
add_executable (zfm20-register-example zfm20-register.cxx)
include_directories (${PROJECT_SOURCE_DIR}/src/hmc5883l)
include_directories (${PROJECT_SOURCE_DIR}/src/grove)
@ -197,6 +199,7 @@ include_directories (${PROJECT_SOURCE_DIR}/src/mhz16)
include_directories (${PROJECT_SOURCE_DIR}/src/apds9002)
include_directories (${PROJECT_SOURCE_DIR}/src/waterlevel)
include_directories (${PROJECT_SOURCE_DIR}/src/tm1637)
include_directories (${PROJECT_SOURCE_DIR}/src/zfm20)
target_link_libraries (hmc5883l-example hmc5883l ${CMAKE_THREAD_LIBS_INIT})
target_link_libraries (groveled-example grove ${CMAKE_THREAD_LIBS_INIT})
@ -307,3 +310,5 @@ target_link_libraries (mhz16-example mhz16 ${CMAKE_THREAD_LIBS_INIT})
target_link_libraries (apds9002-example apds9002 ${CMAKE_THREAD_LIBS_INIT})
target_link_libraries (waterlevel-example waterlevel ${CMAKE_THREAD_LIBS_INIT})
target_link_libraries (tm1637-example tm1637 ${CMAKE_THREAD_LIBS_INIT})
target_link_libraries (zfm20-example zfm20 ${CMAKE_THREAD_LIBS_INIT})
target_link_libraries (zfm20-register-example zfm20 ${CMAKE_THREAD_LIBS_INIT})

View File

@ -0,0 +1,140 @@
/*
* Author: Jon Trulson <jtrulson@ics.com>
* Copyright (c) 2015 Intel Corporation.
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
#include <unistd.h>
#include <iostream>
#include <signal.h>
#include "zfm20.h"
using namespace std;
using namespace upm;
int main (int argc, char **argv)
{
//! [Interesting]
// Instantiate a ZFM20 Fingerprint reader on UART 0
upm::ZFM20* fp = new upm::ZFM20(0);
// make sure port is initialized properly. 57600 baud is the default.
if (!fp->setupTty(B57600))
{
cerr << "Failed to setup tty port parameters" << endl;
return 1;
}
// This example demonstrates registering a fingerprint on the zfm20
// module. The procedure is as follows:
//
// 1. get an image, store it in characteristics buffer 1
// 2. get another image, store it in characteristics buffer 2
// 3. store the image, assuming the two fingerprints match
// first, we need to register our address and password
fp->setPassword(ZFM20_DEFAULT_PASSWORD);
fp->setAddress(ZFM20_DEFAULT_ADDRESS);
// now verify the password. If this fails, any other commands
// will be ignored, so we just bail.
if (fp->verifyPassword())
{
cout << "Password verified." << endl;
}
else
{
cerr << "Password verification failed." << endl;
return 1;
}
cout << endl;
uint8_t rv;
// get the first image
cout << "Place a finger on the sensor." << endl;
while (fp->generateImage() != ZFM20::ERR_OK)
;
// in theory, we have an image
cout << "Image captured, converting..." << endl;
if ((rv = fp->image2Tz(1)) != ZFM20::ERR_OK)
{
cerr << "Image conversion failed with error code " << int(rv) <<endl;
return 1;
}
cout << "Image conversion succeeded, remove finger." << endl;
sleep(1);
while (fp->generateImage() != ZFM20::ERR_NO_FINGER)
;
cout << endl;
cout << "Now place the same finger on the sensor." << endl;
while (fp->generateImage() != ZFM20::ERR_OK)
;
cout << "Image captured, converting..." << endl;
// save this one in slot 2
if ((rv = fp->image2Tz(2)) != ZFM20::ERR_OK)
{
cerr << "Image conversion failed with error code " << int(rv) <<endl;
return 1;
}
cout << "Image conversion succeeded, remove finger." << endl;
cout << endl;
cout << "Storing fingerprint at id 1" << endl;
// create the model
if ((rv = fp->createModel()) != ZFM20::ERR_OK)
{
if (rv == ZFM20::ERR_FP_ENROLLMISMATCH)
cerr << "Fingerprints did not match." << endl;
else
cerr << "createModel failed with error code " << int(rv) <<endl;
return 1;
}
// now store it, we hard code the id (second arg) to 1 here
if ((rv = fp->storeModel(1, 1)) != ZFM20::ERR_OK)
{
cerr << "storeModel failed with error code " << int(rv) <<endl;
return 1;
}
cout << endl;
cout << "Fingerprint stored at id 1." << endl;
//! [Interesting]
delete fp;
return 0;
}

112
examples/c++/zfm20.cxx Normal file
View File

@ -0,0 +1,112 @@
/*
* Author: Jon Trulson <jtrulson@ics.com>
* Copyright (c) 2015 Intel Corporation.
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
#include <unistd.h>
#include <iostream>
#include <signal.h>
#include "zfm20.h"
using namespace std;
using namespace upm;
int main (int argc, char **argv)
{
//! [Interesting]
// Instantiate a ZFM20 Fingerprint reader on UART 0
upm::ZFM20* fp = new upm::ZFM20(0);
// make sure port is initialized properly. 57600 baud is the default.
if (!fp->setupTty(B57600))
{
cerr << "Failed to setup tty port parameters" << endl;
return 1;
}
// first, set the default password and address
fp->setPassword(ZFM20_DEFAULT_PASSWORD);
fp->setAddress(ZFM20_DEFAULT_ADDRESS);
// now verify the password. If this fails, any other commands
// will be ignored, so we just bail.
if (fp->verifyPassword())
{
cout << "Password verified." << endl;
}
else
{
cerr << "Password verification failed." << endl;
return 1;
}
// how many valid stored templates (fingerprints) do we have?
cout << "Total stored templates: " << fp->getNumTemplates() << endl;
cout << endl;
// now spin waiting for a fingerprint to successfully image
cout << "Waiting for finger print..." << endl;
while (fp->generateImage() == ZFM20::ERR_NO_FINGER)
;
// in theory, we have an image
cout << "Image captured, converting..." << endl;
uint8_t rv;
if ((rv = fp->image2Tz(1)) != ZFM20::ERR_OK)
{
cerr << "Image conversion failed with error code " << int(rv) <<endl;
return 1;
}
cout << "Image conversion succeeded." << endl;
cout << "Searching database..." << endl;
uint16_t id = 0;
uint16_t score = 0;
// we search for a print matching slot 1, where we shored our last
// converted fingerprint
if ((rv = fp->search(1, &id, &score)) != ZFM20::ERR_OK)
{
if (rv == ZFM20::ERR_FP_NOTFOUND)
{
cout << "Finger Print not found" << endl;
return 0;
}
else
{
cerr << "Search failed with error code " << int(rv) <<endl;
return 1;
}
}
cout << "Fingerprint found!" << endl;
cout << "ID: " << int(id) << ", Score: " << int(score) << endl;
//! [Interesting]
delete fp;
return 0;
}