pyztk/README.md

# pyzk

pyzk is unofficial library of zksoftware the fingerprint attendance machine. 

# Installation

[![Build Status](https://travis-ci.org/fananimi/pyzk.svg?branch=master)](https://travis-ci.org/fananimi/pyzk)

`pip install pyzk`

# Documentation

Complete documentation can be found at [Readthedocs](http://pyzk.readthedocs.io/en/latest/ "pyzk's readthedocs") .

# Api Usage

Create ZK object and you will ready to call api.

* Basic Usage
```
import zk
from zk import const

zk = zk.ZK(ip='192.168.1.201', port=4370, timeout=5)
try:
    response = zk.connect()
    if response.get('status') is False:
        raise Exception(response.get('message'))

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

    # Do another task here
    firmware = zk.get_firmware_version()
    print 'Firmware Version: : {}'.format(firmware.get('data'))
    users = zk.get_users()
    if users.get('status'):
        for user in users.get('data'):
            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 zk.is_connect:
        zk.disconnect()

```

* Ger Firmware Version

```
zk.get_firmware_version()
```

* Create User

```
zk.set_user(uid=1, name='Fanani M. Ihsan', privilege=const.USER_ADMIN, password='12345678', group_id='', user_id='123')
```

* Get User

```
users = zk.get_users()
```

* Test voice

```
zk.test_voice()
```

* Shutdown Device

```
zk.power_off()
```

* Restart

```
zk.restart()
```

# Todo

* Create better documentation
* Clear user
* Finger template downloader & uploader
* Get attendance record
* Clear attendance record
* HTTP Rest api
* Create real time api (if possible)
* and much more ...