Skip to content

Commit

Permalink
Fix README
Browse files Browse the repository at this point in the history
  • Loading branch information
bdragon300 committed Oct 26, 2024
1 parent b2d7d92 commit dd434ae
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 24 deletions.
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,29 +9,32 @@
**PyZKAccess** is a library and command-line interface for working with ZKTeco ZKAccess
C3-100/200/400 access controllers.

This library is Windows-only, but it can be used on *nix systems with Wine. It built on top of the ZKTeco PULL SDK.
This package is Windows-only, but it can be used on *nix systems with [Wine](https://www.winehq.org/).
It built on top of the ZKTeco PULL SDK and fully supports all its features.

This package, once installed, may be used as library or command-line interface. It's also distributed as
a portable Windows executable, created by [PyInstaller](https://pyinstaller.org/en/stable/) with built-in 32-bit Python
This package, once installed, may be used as library for your project or command-line interface.
It's also distributed as a portable Windows executable, created by [PyInstaller](https://pyinstaller.org/en/stable/) with built-in 32-bit Python
interpreter.

[Read documentation](https://bdragon300.github.io/pyzkaccess)

## Features

- Command-line interface
- Read (+filters), write, delete the data in device tables
We support all the features the ZKTeco PULL SDK provides:

- Can be used as a code library or a command-line tool
- Reading and writing the device data tables
- Making queries to device data tables
- CSV format support
- On-board relays switch
- Read the events of a particular reader, aux input, door or the whole device
- Get/set the device parameters such as datetime, network settings, entry modes, backup time, etc.
- Get/set the door parameters such as smart card modes, intervals, entry modes, etc.
- Scan the local network for active C3 devices
- On-board relays control
- Read the realtime events of a particular reader, aux input, door or the whole device
- Manipulation the device parameters such as datetime, network settings, entry modes, backup time, etc.
- Manipulation the door parameters such as smart card modes, intervals, entry modes, etc.
- Restart a device
- Scan the local network for active C3 devices
- Download/upload files from PC to/from a device
- Cancel alarm function
- Reset the IP address using the broadcast method for a device available in the same local network. Useful when
device IP is unknown.
- Reset the device IP address by its MAC address

## Quick start

Expand All @@ -43,7 +46,8 @@ Download it, open up a terminal window and run it to setup the environment:
pyzkaccess setup
```

It will make a quick compatibility check of your system and suggest you to install PULL SDK from the official ZKTeco site.
This command will make a quick compatibility check of your system and suggest you to install PULL SDK from the
official ZKTeco site.

![pyzkaccess setup](docs/img/setup_screenshot.png)

Expand All @@ -70,10 +74,6 @@ $ pyzkaccess connect 192.168.1.201 table User
+----------+------------+-------+----------+-----+------------+-----------------+
```





Or print a particular one:

```console
Expand Down
15 changes: 8 additions & 7 deletions docs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,16 @@ NOTE: the default factory IP address of C3 devices is `192.168.1.201`.

## Features

- Command-line interface
- Read (+filters), write, delete the data in device tables
- Can be used as a code library or a command-line tool
- Reading and writing the device data tables
- Making queries to device data tables
- CSV format support
- On-board relays switch
- On-board relays control
- Read the realtime events of a particular reader, aux input, door or the whole device
- Get/set the device parameters such as datetime, network settings, entry modes, backup time, etc.
- Get/set the door parameters such as smart card modes, intervals, entry modes, etc.
- Scan the local network for active C3 devices
- Manipulation the device parameters such as datetime, network settings, entry modes, backup time, etc.
- Manipulation the door parameters such as smart card modes, intervals, entry modes, etc.
- Restart a device
- Scan the local network for active C3 devices
- Download/upload files from PC to/from a device
- Cancel alarm function
- Reset the IP address by MAC address.
- Reset the device IP address by its MAC address

0 comments on commit dd434ae

Please sign in to comment.