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