update documentation

This commit is contained in:
Fanani M. Ihsan 2018-12-29 08:52:00 +07:00
parent ac5e543ee6
commit 8d41a427d1

View File

@ -69,70 +69,6 @@ Basic Usage
if conn:
conn.disconnect()
API Ussage
##########
**Connect/Disconnect**
.. code-block:: python
conn = zk.connect()
conn.disconnect()
**Disable/Enable Connected Device**
.. code-block:: python
conn.disable_device()
conn.enable_device()
**Ger Firmware Version**
.. code-block:: python
conn.get_firmware_version()
**User Operation**
.. code-block:: python
# Create user
conn.set_user(uid=1, name='Fanani M. Ihsan', privilege=const.USER_ADMIN, password='12345678', group_id='', user_id='123')
# Get all users (will return list of User object)
users = conn.get_users()
# Delete User
conn.delete_user(uid=1)
**Attendance Record**
.. code-block:: python
# Get attendances (will return list of Attendance object)
attendances = conn.get_attendance()
# Clear attendances record
conn.clear_attendance()
**Test voice**
.. code-block:: python
conn.test_voice()
**Device Maintenance**
.. code-block:: python
# shutdown connected device
conn.power_off()
# restart connected device
conn.restart()
Technical Documentation
#######################