Skip to content

Template upload/download fixes, misc improvements #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Mar 4, 2021
Merged

Template upload/download fixes, misc improvements #28

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
fdcaf76
additional support for template comparasion
Feb 15, 2021
d0279ee
bugfix for LED behaviour
Feb 15, 2021
8f89c07
bugfix for LED calls
Feb 16, 2021
64a78d2
added license info to example
Feb 16, 2021
90706fc
Ran pylint and black
Feb 17, 2021
820d9b7
Pylint LF restore
Feb 17, 2021
a5897ea
More Pylint corrections... :(
Feb 17, 2021
4a934a9
More Black corrections...
Feb 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
159 changes: 103 additions & 56 deletions adafruit_fingerprint.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,12 @@
https://github.com/adafruit/circuitpython/releases
"""

from micropython import const
try:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm curious why this was added.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm running these on Windows PC so needed a way to get around the micropython requirements. Any suggestion on how to get around it?

Copy link
Contributor

@jerryneedell jerryneedell Feb 16, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure I understand - I thought the micropython modue was satisfied buy the Blinka interface -- at least, it is on a Raspberry Pi.
Does the example work an a Windows system?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah -- I see -- the import of board is also commented out in the example so it is not using any CircuitPython specific modules. I have no objection to the try/except -- just curious about it.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I looked into this further, the issue was that my venv was missing Blinka. I thought setup had installed but apparently not. I removed the pseudo code. The examples work on both Linux (Ubuntu) and Windows 10.

from micropython import const
except:
def const(x):
"Emulate making a constant"
return x

try:
import struct
Expand All @@ -43,6 +48,7 @@

_GETIMAGE = const(0x01)
_IMAGE2TZ = const(0x02)
_COMPARE = const(0x03)
_FINGERPRINTSEARCH = const(0x04)
_REGMODEL = const(0x05)
_STORE = const(0x06)
Expand All @@ -53,11 +59,13 @@
_DOWNLOADIMAGE = const(0x0B)
_DELETE = const(0x0C)
_EMPTY = const(0x0D)
_SETSYSPARA = const(0x0E)
_READSYSPARA = const(0x0F)
_HISPEEDSEARCH = const(0x1B)
_VERIFYPASSWORD = const(0x13)
_TEMPLATECOUNT = const(0x1D)
_TEMPLATEREAD = const(0x1F)
_SOFTRESET = const(0x3D)
_GETECHO = const(0x53)
_SETAURA = const(0x35)

Expand Down Expand Up @@ -90,6 +98,7 @@
class Adafruit_Fingerprint:
"""UART based fingerprint sensor."""

_debug = False
_uart = None

password = None
Expand All @@ -112,6 +121,8 @@ def __init__(self, uart, passwd=(0, 0, 0, 0)):
self._uart = uart
if self.verify_password() != OK:
raise RuntimeError("Failed to find sensor, check wiring!")
if self.read_sysparam() != OK:
raise RuntimeError("Failed to read system parameters!")

def check_module(self):
"""Checks the state of the fingerprint scanner module.
Expand Down Expand Up @@ -149,6 +160,20 @@ def read_sysparam(self):
self.baudrate = struct.unpack(">H", bytes(r[15:17]))[0]
return r[0]

def set_sysparam(self, param_num, param_val):
"""Set the system parameters (param_num)"""
self._send_packet([_SETSYSPARA, param_num, param_val])
r = self._get_packet(12)
if r[0] != OK:
raise RuntimeError("Command failed.")
if param_num == 4:
self.baudrate = param_val
elif param_num == 5:
self.security_level = param_val
elif param_num == 6:
self.data_packet_size = param_val
return r[0]

def get_image(self):
"""Requests the sensor to take an image and store it memory, returns
the packet error code or OK success"""
Expand Down Expand Up @@ -188,7 +213,7 @@ def load_model(self, location, slot=1):
def get_fpdata(self, sensorbuffer="char", slot=1):
"""Requests the sensor to transfer the fingerprint image or
template. Returns the data payload only."""
if slot != 1 or slot != 2:
if slot != 1 and slot != 2:
# raise error or use default value?
slot = 2
if sensorbuffer == "image":
Expand All @@ -199,14 +224,14 @@ def get_fpdata(self, sensorbuffer="char", slot=1):
raise RuntimeError("Uknown sensor buffer type")
if self._get_packet(12)[0] == 0:
res = self._get_data(9)
# print('datasize: ' + str(len(res)))
# print(res)
self._print_debug("get_fpdata data size:", str(len(res)))
self._print_debug("get_fdata res:", res, data_type="hex")
return res

def send_fpdata(self, data, sensorbuffer="char", slot=1):
"""Requests the sensor to receive data, either a fingerprint image or
a character/template data. Data is the payload only."""
if slot != 1 or slot != 2:
if slot != 1 and slot != 2:
# raise error or use default value?
slot = 2
if sensorbuffer == "image":
Expand All @@ -217,8 +242,8 @@ def send_fpdata(self, data, sensorbuffer="char", slot=1):
raise RuntimeError("Uknown sensor buffer type")
if self._get_packet(12)[0] == 0:
self._send_data(data)
# print('datasize: ' + str(len(res)))
# print(res)
self._print_debug("send_fpdata data size:", str(len(data)))
self._print_debug("sent_fdata data:", data, data_type="hex")
return True

def empty_library(self):
Expand Down Expand Up @@ -268,9 +293,14 @@ def finger_fast_search(self):
)
r = self._get_packet(16)
self.finger_id, self.confidence = struct.unpack(">HH", bytes(r[1:5]))
# print(r)
self._print_debug("finger_fast_search packet:", r, data_type="hex")
return r[0]

def close_uart(self):
"""close serial port"""
self._uart.close()
return

def finger_search(self):
"""Asks the sensor to search for a matching fingerprint starting at
slot 1. Stores the location and confidence in self.finger_id
Expand All @@ -282,7 +312,17 @@ def finger_search(self):
)
r = self._get_packet(16)
self.finger_id, self.confidence = struct.unpack(">HH", bytes(r[1:5]))
# print(r)
self._print_debug("finger_search packet:", r, data_type="hex")
return r[0]

def compare_templates(self):
"""Compares two fingerprint templates in char buffers 1 and 2. Stores the confidence score
in self.finger_id and self.confidence. Returns the packet error code or
OK success"""
self._send_packet( [_COMPARE] )
r = self._get_packet(14)
self.confidence = struct.unpack(">H", bytes(r[1:3]))
self._print_debug("compare_templates confidence:", self.confidence)
return r[0]

def set_led(self, color=1, mode=3, speed=0x80, cycles=0):
Expand All @@ -302,7 +342,7 @@ def _get_packet(self, expected):
"""Helper to parse out a packet from the UART and check structure.
Returns just the data payload from the packet"""
res = self._uart.read(expected)
# print("Got", res)
self._print_debug("_get_packet received data:", res, data_type="hex")
if (not res) or (len(res) != expected):
raise RuntimeError("Failed to read data from sensor")

Expand All @@ -328,30 +368,32 @@ def _get_packet(self, expected):
# print(packet_type + length + struct.unpack('>HHHH', res[9:9+(length-2)]))

reply = list(i for i in res[9 : 9 + (length - 2)])
# print(reply)
self._print_debug("_get_packet reply:", reply, data_type="hex")
return reply

def _get_data(self, expected):
"""Gets packet from serial and checks structure for _DATAPACKET
and _ENDDATAPACKET. Alternate method for getting data such
as fingerprint image, etc. Returns the data payload."""
res = self._uart.read(expected)
self._print_debug("_get_data received data:", res, data_type="hex")
if (not res) or (len(res) != expected):
raise RuntimeError("Failed to read data from sensor")

# first two bytes are start code
start = struct.unpack(">H", res[0:2])[0]
# print(start)
self._print_debug("_get_data received start pos:", start)
if start != _STARTCODE:
raise RuntimeError("Incorrect packet data")
# next 4 bytes are address
addr = list(i for i in res[2:6])
# print(addr)
self._print_debug("_get_data received address:", addr)
if addr != self.address:
raise RuntimeError("Incorrect address")

packet_type, length = struct.unpack(">BH", res[6:9])
# print(str(packet_type) + ' ' + str(length))
self._print_debug("_get_data received packet_type:", packet_type)
self._print_debug("_get_data received length:", length)

# todo: check checksum

Expand All @@ -363,15 +405,19 @@ def _get_data(self, expected):
res = self._uart.read(length - 2)
# todo: we should really inspect the headers and checksum
reply = list(i for i in res[0:length])
self._uart.read(2) # disregard checksum but we really shouldn't
received_checksum = struct.unpack(">H", self._uart.read(2))
self._print_debug("_get_data received checksum:", received_checksum)

reply += self._get_data(9)
elif packet_type == _ENDDATAPACKET:
res = self._uart.read(length - 2)
# todo: we should really inspect the headers and checksum
reply = list(i for i in res[0:length])
self._uart.read(2) # disregard checksum but we really shouldn't
# print(len(reply))
# print(reply)
received_checksum = struct.unpack(">H", self._uart.read(2))
self._print_debug("_get_data received checksum:", received_checksum)

self._print_debug("_get_data reply length:", len(reply))
self._print_debug("_get_data reply:", reply, data_type="hex")
return reply

def _send_packet(self, data):
Expand All @@ -389,12 +435,14 @@ def _send_packet(self, data):
packet.append(checksum >> 8)
packet.append(checksum & 0xFF)

# print("Sending: ", [hex(i) for i in packet])
self._print_debug("_send_packet length:", len(packet))
self._print_debug("_send_packet data:", packet, data_type="hex")
self._uart.write(bytearray(packet))

def _send_data(self, data):
print(len(data))
self.read_sysparam()
self._print_debug("_send_data length:", len(data))
self._print_debug("_send_data data:", data, data_type="hex")
#self.read_sysparam() #moved this to init
if self.data_packet_size == 0:
data_length = 32
elif self.data_packet_size == 1:
Expand All @@ -403,58 +451,57 @@ def _send_data(self, data):
data_length = 128
elif self.data_packet_size == 3:
data_length = 256

self._print_debug("_send_data sensor data length:", data_length)
i = 0
for i in range(int(len(data) / (data_length - 2))):
start = i * (data_length - 2)
end = (i + 1) * (data_length - 2)
# print(start)
# print(end)
# print(i)
left = len(data)
for i in range(int(len(data) / data_length)):
start = i * data_length
end = (i + 1) * data_length
left = left - data_length
self._print_debug("_send_data data start:", start)
self._print_debug("_send_data data end:", end)
self._print_debug("_send_data i:", i)

packet = [_STARTCODE >> 8, _STARTCODE & 0xFF]
packet = packet + self.address
packet.append(_DATAPACKET)

if left <= 0:
packet.append(_ENDDATAPACKET)
else:
packet.append(_DATAPACKET)

length = len(data[start:end]) + 2
# print(length)
self._print_debug("_send_data length:", length)
packet.append(length >> 8)
packet.append(length & 0xFF)
checksum = _DATAPACKET + (length >> 8) + (length & 0xFF)

for j in range(len(data[start:end])):
#for j in range(len(data[start:end])):
for j in range(start, end):
packet.append(data[j])
checksum += data[j]

packet.append(checksum >> 8)
packet.append(checksum & 0xFF)

# print("Sending: ", [hex(i) for i in packet])
self._print_debug("_send_data sending packet:", packet, data_type="hex")
self._uart.write(packet)
# print(i)

i += 1
start = i * (data_length - 2)
end = (i + 1) * (data_length - 2)
# print(start)
# print(end)
# print(i)

packet = [_STARTCODE >> 8, _STARTCODE & 0xFF]
packet = packet + self.address
packet.append(_ENDDATAPACKET)
length = len(data[start:end]) + 2
# print(length)
packet.append(length >> 8)
packet.append(length & 0xFF)
checksum = _ENDDATAPACKET + (length >> 8) + (length & 0xFF)
def soft_reset(self):
"""Performs a soft reset of the sensor"""
self._send_packet([_SOFTRESET])
if self._get_packet(12)[0] == OK:
if self._uart.read(1)[0] != MODULEOK:
raise RuntimeError("Sensor did not send a handshake signal!")

for j in range(len(data[start:end])):
packet.append(data[j])
checksum += data[j]
def _print_debug(self, info, data, data_type="str"):
"""Prints debugging information. This is activated
by flag __debug"""
if not self._debug:
return

packet.append(checksum >> 8)
packet.append(checksum & 0xFF)
if data_type == "hex":
print("*** DEBUG ==>", info, ["{:02x}".format(i) for i in data])
elif data_type == "str":
print("*** DEBUG ==>", info, data)

# print("Sending: ", [hex(i) for i in packet])
self._uart.write(packet)
# print(i)
Loading