adafruit_fingerprint
¶
This library will let you use an Adafruit Fingerprint sensor on any UART to get, store, retreive and query fingerprints! Great for adding bio-sensing security to your next build.
- Author(s): ladyada
Implementation Notes¶
Hardware:
- Fingerprint sensor (Product ID: 751)
Software and Dependencies:
- Adafruit CircuitPython firmware (2.2.0+) for the ESP8622 and M0-based boards: https://github.com/adafruit/circuitpython/releases
-
class
adafruit_fingerprint.
Adafruit_Fingerprint
(uart, passwd=(0, 0, 0, 0))[source]¶ UART based fingerprint sensor.
-
count_templates
()[source]¶ Requests the sensor to count the number of templates and stores it in
self.template_count
. Returns the packet error code or OK success
-
create_model
()[source]¶ Requests the sensor take the template data and turn it into a model returns the packet error code or OK success
-
delete_model
(location)[source]¶ Requests the sensor delete a model from flash memory given by the argument location. Returns the packet error code or OK success
-
empty_library
()[source]¶ Requests the sensor to delete all models from flash memory. Returns the packet error code or OK success
-
finger_fast_search
()[source]¶ Asks the sensor to search for a matching fingerprint template to the last model generated. Stores the location and confidence in self.finger_id and self.confidence. Returns the packet error code or OK success
-
get_fpdata
(sensorbuffer='char', slot=1)[source]¶ Requests the sensor to transfer the fingerprint image or template. Returns the data payload only.
-
get_image
()[source]¶ Requests the sensor to take an image and store it memory, returns the packet error code or OK success
-
image_2_tz
(slot=1)[source]¶ Requests the sensor convert the image to a template, returns the packet error code or OK success
-
load_model
(location, slot=1)[source]¶ Requests the sensor to load a model from the given memory location to the given slot. Returns the packet error code or success
-
read_templates
()[source]¶ Requests the sensor to list of all template locations in use and stores them in self.templates. Returns the packet error code or OK success
-
send_fpdata
(data, sensorbuffer='char', slot=1)[source]¶ Requests the sensor to receive data, either a fingerprint image or a character/template data. Data is the payload only.
-