pyztk/docs/index.rst
2016-05-27 02:09:40 +07:00

91 lines
2.6 KiB
ReStructuredText

.. pyzk documentation master file, created by
sphinx-quickstart on Fri May 27 00:09:19 2016.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
********************************
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
############
.. image:: https://travis-ci.org/fananimi/pyzk.svg?branch=master
:target: https://travis-ci.org/fananimi/pyzk
You can install from two different options
1. from pypi
``$ pip install pyzk``
2. 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
###########
.. code-block:: python
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()
Technical Documentation
#######################
We open to everyone for contribute in this project. Please refer `Communication_protocol_manual_CMD.pdf <https://github.com/fananimi/pyzk/blob/master/docs/_static/Communication_protocol_manual_CMD.pdf>`_ before you starting write your code.
.. toctree::
:maxdepth: 2
Indices and tables
##################
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`