Welcome to pyzk’s documentation!

pyzk is unofficial library for zksoftware the fingerprint attendance machine. It’s easy to use and no need to understand how to communicate to device. Just create ZK instance and you will ready to use api.

Installation

https://travis-ci.org/fananimi/pyzk.svg?branch=master

You can install from two different options

  1. from pypi
$ pip install pyzk
  1. from original repository

Go to https://github.com/fananimi/pyzk and clone the latest source code by using git, and then just execute the setup.py file.

$ python setup.py install

Basic Usage

import zk
from zk import const

conn = False
zk = zk.ZK(ip='192.168.1.201', port=4370, timeout=5)
try:
    conn = zk.connect()

    # disable (lock) the device, make sure no activity when process run
    zk.disable_device()

    # Do another task here
    firmware_version = zk.get_firmware_version()
    print 'Firmware Version: : {}'.format(firmware_version)
    users = zk.get_users()
    for user in users:
        privilege = 'User'
        if user.privilege == const.USER_ADMIN:
            privilege = 'Admin'

        print '- UID #{}'.format(user.uid)
        print '  Name       : {}'.format(user.name)
        print '  Privilege  : {}'.format(privilege)
        print '  Password   : {}'.format(user.password)
        print '  Group ID   : {}'.format(user.group_id)
        print '  User  ID   : {}'.format(user.user_id)

    # don't forget to re-enable device
    zk.enable_device()
except Exception, e:
    print "Process terminate : {}".format(e)
finally:
    if conn:
        zk.disconnect()

Technical Documentation

We open to everyone for contribute in this project. Please refer Communication_protocol_manual_CMD.pdf before you starting write your code.

Indices and tables