diff --git a/README.md b/README.md index 72588b0..f60178c 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,6 @@ # fw-anwesenheit -# Setup +![PXL_20251004_141110955 MP (1)](https://github.com/user-attachments/assets/afffd664-507d-439a-a428-2477b2fe4de2) -In order to use the LED we need to enable the SPI interface on the Rpi. -You can enable it by running `sudo raspi-config`, or by manually adding `dtparam=spi=on` to `/boot/firmware/config.txt`. -Enable PWM -> add dtoverlay=pwm to /boot/config.txt -I²C fpr RTC `sudo raspi-config` -> interface -> enable I²C +![PXL_20251001_103957322 MP~2](https://github.com/user-attachments/assets/8bc182df-a93d-4923-b8d8-88b56d1aa441) -# Config - -Flags: - -`--error` or `-e`: Enters error state. The LED turns red and the hotspot is activated. This state gets called from systemd if the service is in a failure state. - -Environment variables: - -- `PM3_BIN`: Path to the pm3 binary. Seach in path if not set. Can also be set to the `pm3_mock.sh` for testing. -- `LOG_LEVEL`: Can be set to either "debug","warn","error","trace" or "info". Defaults to "warn" in production. -- `HTTP_PORT`: What port to listen on. Defaults to 80. -- `HOTSPOT_IDS`: A semicolon seperated list of ids to activate the hotspot with e.g. `578B5DF2;c1532b57`. -- `HOTSPOT_SSID`: Set the hotspot ssid. Defaults to "fwa". -- `HOTSPOT_PW`: Set the hotspot password. Default to "a9LG2kUVrsRRVUo1". Recommended to change. - -Systemd: - -The service is run as a systemd service. There are two service `fwa.service` and `fwa-fail.service`. They read their config -from a env file located at `/etc/fwa.env`. See example [env file](service/fwa.env). - -# Building - -Run `make package` to create `.deb` file. [Cross](https://github.com/cross-rs/cross) is used for building the rust code.