pyztk/README.md

128 lines
2.7 KiB
Markdown
Raw Normal View History

2016-05-24 08:11:36 +07:00
# pyzk
2016-06-24 19:00:55 +07:00
pyzk is an unofficial library of zksoftware the fingerprint attendance machine.
2016-05-26 12:51:04 +07:00
2016-05-26 23:27:05 +07:00
# Installation
2016-05-27 02:10:53 +07:00
[![Build Status](https://travis-ci.org/fananimi/pyzk.svg?branch=master)](https://travis-ci.org/fananimi/pyzk)
2016-05-26 23:27:05 +07:00
`pip install pyzk`
2016-05-27 01:33:51 +07:00
# Documentation
Complete documentation can be found at [Readthedocs](http://pyzk.readthedocs.io/en/latest/ "pyzk's readthedocs") .
2016-05-26 23:27:05 +07:00
# Api Usage
2016-05-26 12:51:04 +07:00
2016-07-04 16:29:01 +07:00
Just create a ZK object and you will ready to call api.
2016-05-26 12:51:04 +07:00
2016-05-26 22:15:03 +07:00
* Basic Usage
2016-05-26 12:51:04 +07:00
```
2016-06-24 19:00:55 +07:00
from zk import ZK, const
2016-05-26 12:51:04 +07:00
2016-06-24 19:00:55 +07:00
conn = None
zk = ZK('192.168.1.10', port=4370, timeout=5)
2016-05-26 12:51:04 +07:00
try:
2016-06-24 19:00:55 +07:00
print 'Connecting to device ...'
2016-05-30 09:49:54 +07:00
conn = zk.connect()
2016-06-24 19:00:55 +07:00
print 'Disabling device ...'
conn.disable_device()
print 'Firmware Version: : {}'.format(conn.get_firmware_version())
# print '--- Get User ---'
users = conn.get_users()
2016-05-30 09:49:54 +07:00
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)
2016-06-17 14:00:13 +07:00
2016-06-24 19:00:55 +07:00
print "Voice Test ..."
conn.test_voice()
print 'Enabling device ...'
conn.enable_device()
2016-05-26 12:51:04 +07:00
except Exception, e:
print "Process terminate : {}".format(e)
finally:
2016-05-30 09:49:54 +07:00
if conn:
2016-06-24 19:00:55 +07:00
conn.disconnect()
2016-05-26 12:51:04 +07:00
```
2016-06-17 13:54:05 +07:00
* Connect/Disconnect
```
2016-06-24 19:00:55 +07:00
conn = zk.connect()
conn.disconnect()
2016-06-17 13:54:05 +07:00
```
* Disable/Enable Connected Device
```
2016-06-24 19:00:55 +07:00
conn.disable_device()
conn.enable_device()
2016-06-17 13:54:05 +07:00
```
2016-05-26 12:51:04 +07:00
* Ger Firmware Version
```
2016-06-24 19:00:55 +07:00
conn.get_firmware_version()
2016-05-26 12:51:04 +07:00
```
2016-06-17 13:54:05 +07:00
* User Operation
2016-05-26 12:51:04 +07:00
```
2016-06-17 13:54:05 +07:00
# Create user
2016-06-24 19:00:55 +07:00
conn.set_user(uid=1, name='Fanani M. Ihsan', privilege=const.USER_ADMIN, password='12345678', group_id='', user_id='123')
2016-06-17 13:54:05 +07:00
# Get all users (will return list of User object)
2016-06-24 19:00:55 +07:00
users = conn.get_users()
2016-06-17 13:54:05 +07:00
# Delete User
2016-06-24 19:00:55 +07:00
conn.delete_user(uid=1)
2016-05-26 12:51:04 +07:00
```
2018-03-01 16:56:09 +07:00
* Remote Fingerprint Enrollment
```
zk.enroll_user('23')
```
2016-06-17 13:54:05 +07:00
* Attendance Record
2016-05-26 13:05:17 +07:00
```
2016-06-17 13:54:05 +07:00
# Get attendances (will return list of Attendance object)
2016-06-24 19:00:55 +07:00
attendances = conn.get_attendance()
2016-06-17 13:54:05 +07:00
# Clear attendances record
2016-06-24 19:00:55 +07:00
conn.clear_attendance()
2016-05-26 13:05:17 +07:00
```
2016-05-26 12:51:04 +07:00
* Test voice
```
2016-06-24 19:00:55 +07:00
conn.test_voice()
2016-05-26 12:51:04 +07:00
```
2016-06-17 13:54:05 +07:00
* Device Maintenance
2016-05-26 12:51:04 +07:00
```
2016-06-17 13:54:05 +07:00
# shutdown connected device
2016-06-24 19:00:55 +07:00
conn.power_off()
2016-06-17 13:54:05 +07:00
# restart connected device
2016-06-24 19:00:55 +07:00
conn.restart()
2016-05-26 12:55:18 +07:00
```
2016-06-17 15:02:01 +07:00
# Related Project
2016-06-23 16:22:13 +07:00
* [zkcluster](https://github.com/fananimi/zkcluster/ "zkcluster project") is a django apps to manage multiple fingerprint devices.
* [Driji](https://github.com/fananimi/driji/ "Driji project") is an attendance apps based fingerprint for school
2016-06-17 15:02:01 +07:00
2016-05-26 12:55:18 +07:00
# Todo
2016-05-26 22:15:03 +07:00
* Create better documentation
2016-05-26 12:55:18 +07:00
* Finger template downloader & uploader
* HTTP Rest api
2016-05-26 22:15:03 +07:00
* Create real time api (if possible)
2016-06-17 13:54:05 +07:00
* and much more ...