From 68c1707f62433c6b5ae06c3c66f2c44835d766c9 Mon Sep 17 00:00:00 2001 From: "Fanani M. Ihsan" Date: Thu, 26 May 2016 12:51:04 +0700 Subject: [PATCH] update readme --- README.md | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 59 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2dd4c78..3d370e8 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,61 @@ # pyzk -Unofficial library of zksoftware the fingerprint attendance machine. +pyzk is unofficial library of zksoftware the fingerprint attendance machine. + +# Ussage + +The usage is very simple, just Create new ZK instance and you will ready to call api. + +* Basic Ussage +``` +import zk + +zk = zk.ZK(ip='192.168.1.201', port=4370, timeout=5) +try: + zk.connect() + # disable (lock) the device, make sure not activity when process run + zk.disable_device() + + # Do another task here + firmware = zk.get_firmware_version() + print 'Firmware Version: : {}'.format(firmware.get('data')) + + # 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') +``` + +* Test voice + +``` +zk.test_voice() +``` + +* Shutdown Device + +``` +zk.power_off() +``` + +* Restart + +``` +zk.restart() +``` \ No newline at end of file