Update Readme

This commit is contained in:
T
2025-09-05 23:50:48 +02:00
parent b6544af569
commit d485491f22

View File

@@ -1,30 +1,28 @@
# ButtonCtl # ButtonCtl
<div style="text-align:center"><img src="./buttons-platzierung.png" /></div> ![](./buttons-platzierung.png)
### dependencies ### Dependencies
- RPi python3-rpi.gpio - RPi python3-rpi.gpio
```bash ```sh
sudo apt install python3-rpi-gpio sudo apt install python3-rpi-gpio
``` ```
- OpenSSH client - OpenSSH client
```bash ```sh
sudo apt install openssh sudo apt install openssh
``` ```
- circuitpython libraries for neopixel - circuitpython libraries for neopixel
```bash ```sh
pip3 install adafruit-circuitpython-neopixel pip3 install adafruit-circuitpython-neopixel
``` ```
### install ### Install
```bash ```sh
git clone https://github.com/dylangoepel/buttonctl.git cd buttonctl/1og
cd buttonctl
./service.sh # create systemd .service file ./service.sh # create systemd .service file
sudo systemctl enable buttond # autostart at boot sudo systemctl enable --now buttond # start and autostart at boot
sudo systemctl start buttond # start as daemon
``` ```
### wiring ### Wiring
- pin 23: left button input (pull-down) - pin 23: left button input (pull-down)
- pin 24: center button input (pull-down) - pin 24: center button input (pull-down)
- pin 22: right button input (pull-down) - pin 22: right button input (pull-down)
@@ -41,49 +39,49 @@ sudo systemctl start buttond # start as daemon
(counter-clockwise) (counter-clockwise)
``` ```
### usage ## Usage
![Rot](https://placehold.it/15/ff0000/000000?text=+)
![Schwarz](https://placehold.it/15/000000/000000?text=+)
![Rot](https://placehold.it/15/ff0000/000000?text=+)
→ Linker Button
![Schwarz](https://placehold.it/15/000000/000000?text=+) ### Open Door
![Grün](https://placehold.it/15/00ff00/000000?text=+) <span style="color:red">&#9724;</span>
![Rot](https://placehold.it/15/ff0000/000000?text=+) <span style="color:black">&#9724;</span>
→ Mittlerer Button <span style="color:red">&#9724;</span>
→ Left Button
![Rot](https://placehold.it/15/ff0000/000000?text=+) <span style="color:black">&#9724;</span>
![Schwarz](https://placehold.it/15/000000/000000?text=+) <span style="color:green">&#9724;</span>
![Rot](https://placehold.it/15/ff0000/000000?text=+) <span style="color:red">&#9724;</span>
Kurze Wartezeit Middle Button
![Grün](https://placehold.it/15/00ff00/000000?text=+) <span style="color:red">&#9724;</span>
![Schwarz](https://placehold.it/15/000000j/000000?text=+) <span style="color:black">&#9724;</span>
![Rot](https://placehold.it/15/ff0000/000000?text=+) <span style="color:red">&#9724;</span>
→ Short Delay
---------- <span style="color:green">&#9724;</span>
<span style="color:black">&#9724;</span>
<span style="color:red">&#9724;</span>
![Rot](https://placehold.it/15/ff0000/000000?text=+) ### Abort
![Schwarz](https://placehold.it/15/000000/000000?text=+) <span style="color:red">&#9724;</span>
![Rot](https://placehold.it/15/ff0000/000000?text=+) <span style="color:black">&#9724;</span>
→ Linker Button <span style="color:red">&#9724;</span>
→ Left Button
![Schwarz](https://placehold.it/15/000000/000000?text=+) <span style="color:black">&#9724;</span>
![Grün](https://placehold.it/15/00ff00/000000?text=+) <span style="color:green">&#9724;</span>
![Rot](https://placehold.it/15/ff0000/000000?text=+) <span style="color:red">&#9724;</span>
→ Linker Button → Left Button
![Rot](https://placehold.it/15/ff0000/000000?text=+) <span style="color:red">&#9724;</span>
![Schwarz](https://placehold.it/15/000000/000000?text=+) <span style="color:black">&#9724;</span>
![Rot](https://placehold.it/15/ff0000/000000?text=+) <span style="color:red">&#9724;</span>
----------- ### No-Op
<span style="color:red">&#9724;</span>
<span style="color:black">&#9724;</span>
<span style="color:red">&#9724;</span>
→ Middle Button
![Rot](https://placehold.it/15/ff0000/000000?text=+) <span style="color:red">&#9724;</span>
![Schwarz](https://placehold.it/15/000000/000000?text=+) <span style="color:black">&#9724;</span>
![Rot](https://placehold.it/15/ff0000/000000?text=+) <span style="color:red">&#9724;</span>
→ Mittlerer Button
![Rot](https://placehold.it/15/ff0000/000000?text=+)
![Schwarz](https://placehold.it/15/000000/000000?text=+)
![Rot](https://placehold.it/15/ff0000/000000?text=+)