Giter VIP home page Giter VIP logo

pyzatt's Introduction

PyZatt

Documentation Status Updates

Python lib to access ZKTeco's standalone devices

  • Supports TFT and iFace(partial) devices, B&W devices are not supported yet.
  • Documentation: https://pyzatt.readthedocs.io.
  • Free software: MIT license

Introduction

This project is part of an effort to make an alternative to ZKTeco's software, to manage attendance devices, it was made using the protocol spec shown in zk-protocol repo.

Project overview

Functions in this module follow a similar grouping used on zk-protocol repo.

ZK Modules

  • Access: Includes functions to get/set access parameters (permissions, groups, timezones).
  • Data Record: Includes functions to manage the attendance records and operation records.
  • Data User: Includes functions to manage users info, including passwords, fingerprints, names, verification styles, etc).
  • Realtime: Includes functions to receive and parse realtime events (e.g. user auth at door).
  • Terminal: Includes functions to get/set device parameters.
  • Other: Misc operations (enable/disable device, restart, power off, etc).

For more info about these operations take a look at zk-protocol.

Tests

A series of tests scrips are included to test the library and to show how the lib may be used. Some of the actions that can be done with these scripts include:

  • Creating/modifying users.
  • Creating groups.
  • Enrolling users.
  • Downloading/uploading fingerprint info.
  • Monitor realtime events.

and more ...

For more details about running tests see docs/tests.rst

Check also docs/usage.rst to understand how to use the lib

Installation

For more details see docs/installation.rst

Develop

Currently this lib is intended for devices of the TFT series, but there's no reason to keep it that way.

Capture files of network traffic of documented tests are welcomed, to expand the protocol spec and then add support in the lib.

For more details see ./CONTRIBUTING.rst

Contact

Author: Alexander Marin <[email protected]>

pyzatt's People

Contributors

adrobinoga avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.