From 803e993f06c1ad609fc2c9107d6c4988c36eb912 Mon Sep 17 00:00:00 2001 From: Mario Voigt Date: Wed, 12 Mar 2025 00:31:00 +0100 Subject: [PATCH] Adjust readme to point to docs.fab-access.org --- README.md | 41 +++++++---------------------------------- 1 file changed, 7 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 15ab552..21ea117 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,8 @@ -# FabLock -Python Process Actor for FabAccess -The Hardware and Software supports only non-permanent locks. -It can trigger locks, identify them via an LED and return the state of the deadbolt. +# FabLock Actor +Python Process Actor for FabAccess controlling FabLock hardware. With FabLock we can build up controllable lockers or door systems. At the moment there are two different hardware implemententations with custom firmware: +* [FabLock for ESP8266 +FabLock for ESP8266](https://gitlab.com/fabinfra/fabhardware/fablock) +* [FabLock for Ants Make AM-022](https://gitlab.com/fabinfra/fabhardware/fablock-kallax) -To communicate with the FabLock-Hardware MQTT is used. -Every FabLock Module must have an unique ID. The ID is 5 digits long and has leading zeros. -To distinguish the individual locks in the FabLock module, each has a 5-digit ID with leading zeros. - - -Since different locks have different trigger times and these must be adhered to in order to maintain the functionality of the lock, these can only be set on the hardware. - -The LED flashes every 500ms seconds, when identifying. And lights permanent up when the lock is unlocked. -The state of the deadbolt is reported every 30 seconds. - -## Paramters -### MQTT Configuration -* `--host` MQTT Server Address -* `--port` MQTT Server Port -* `--user` MQTT User (optional) -* `--password` MQTT Password (optional) - -### FabLock Configuration -* `--fablock` FabLock ID -* `--lock` Lock ID - -## MQTT Commands -`/fablock/[FabLock-ID]/[Lock-ID]/[event]` - -### Examples -* `/fablock/00001/00001/trigger` -* `/fablock/00001/00001/identify` - -The state of the deadbolt is reported on: -* `/fablock/00001/00001/feedback` \ No newline at end of file +## Installation +Details for setup and usage can be found at [docs.fab-access.org](https://docs.fab-access.org/books/plugins-aktoren-initiatoren/page/aktor-fablock) \ No newline at end of file