pyzkfp 0.0.3

A Python wrapper library for ZKFinger fingerprint scanner software.

pyzkfp

A Python wrapper library for ZKFinger SDK Windows1, a biometric module SDK that supports ZKTeco fingerprint scanners, SLK20R and ZK series, including ZK9500, ZK6500, ZK8500R.

Overview

This library provides a Python interface for ZKFinger Reader devices through the ZKFinger Reader SDK in Python. You can use it to interact with ZKFinger Reader devices, capture fingerprint images, perform fingerprint comparisons 1:1 and 1:N, and more.

Installation

You can install this library via pip:

pip install pyzkfp

Usage

Here's a simple example of how to use this library:

Initialize the ZKFP2 class and open the device

from pyzkfp import ZKFP2

# Initialize the ZKFP2 class
zkfp2 = ZKFP2()
zkfp2.Init()

# Get device count and open first device
device_count = zkfp2.GetDeviceCount()
logger.info(f"{device_count} Devices found, Connecting to the first device.")
zkfp2.OpenDevice(0)

Capture a fingerprint

while True:
    capture = zkfp2.AcquireFingerprint()
    if capture:
        # Implement your logic here
        break

Perform a 1:N comparison

tmp, img = capture
finger_id, score = zkfp2.DBIdentify(tmp)

Perform a 1:1 comparison

res = zkfp2.DBMatch(template1, template2) # returns 1 if match, 0 if not

Register a fingerprint

In order to register a fingerprint, we must collect 3 templates from the same finger. And then we can merge them into one template and store it in the device's database.

templates = []
for i in range(3):
    while True:
        capture = zkfp2.AcquireFingerprint()
        if capture:
            print('fingerprint captured')
            tmp, img = capture
            templates.append(tmp)
            break
regTemp, regTempLen = zkfp2.DBMerge(*templates)

# Store the template in the device's database
finger_id = 1 # The id of the finger to be registered
zkfp2.DBAdd(finger_id, regTemp)

Store and load templates from database for later use

you can store regTemp (the result of the 3 merged templates) in your favorite database and use it later for direct identification after adding it to the device's database with the DBAdd method.

for member in members:
    fid, temp = member
    zkfp2.DBAdd(fid, temp)
    ...  

To turn on/off the light

zkfp2.Light('green') # green/red/white

Terminate the device and release resources

zkfp2.Terminate()

For more detailed usage instructions, please refer to the example folder (WIP).

Features

• Initialize and interact with ZKFinger Reader devices.
• Capture fingerprint images.
• Perform fingerprint 1:1 comparisons.
• Perform fingerprint 1:N comparisons.
• Register and identify users.
• Light & Beep control functions.