pyzk Documentation

pyzk is an unofficial library of zksoftware (zkzteco family) a biometric attendance machine. It’s easy to use and no need to understand how to communicate to device.

Installation

You can install from two different options

1. from pypi

$ pip install pyzk

2. from original repository

Go to repository then clone the latest source code by using git, and then just execute the setup.py file.

$ python setup.py install

Basic Usage

from zk import ZK, const

conn = None
zk = ZK('192.168.1.201', port=4370, timeout=5)
try:
    print 'Connecting to device ...'
    conn = zk.connect()
    print 'Disabling device ...'
    conn.disable_device()
    print 'Firmware Version: : {}'.format(conn.get_firmware_version())
    # print '--- Get User ---'
    users = conn.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)

    print "Voice Test ..."
    conn.test_voice()
    print 'Enabling device ...'
    conn.enable_device()
except Exception, e:
    print "Process terminate : {}".format(e)
finally:
    if conn:
        conn.disconnect()

Technical Documentation

We open to everyone to contribute on this project. Please refer Communication_protocol_manual_CMD.pdf before you start writing the code.

Indices and tables

• Index
• Module Index
• Search Page