moritzruth/Hassliebe
1
0
Fork 0
Code Issues Pull requests Releases 4 Activity

Update README.md

Browse source
This commit is contained in:
Moritz Ruth 2024-07-09 23:02:57 +02:00 • committed by git.moritzruth.de
parent 6e6e35021b
commit e90f1e0ebb
Signed by: git.moritzruth.de
GPG key ID: AF72C6EBB4B578A7
1 changed files with 13 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -2,6 +2,7 @@
> Integrates any Linux machine into your Home Assistant ecosystem. > Integrates any Linux machine into your Home Assistant ecosystem.
## Features ## Features
- [x] Command buttons - [x] Command buttons
@ -10,7 +11,8 @@
- [x] System information reporting (CPU usage, RAM usage, battery status) - [x] System information reporting (CPU usage, RAM usage, battery status)
- [ ] Media control (MPRIS) - [ ] Media control (MPRIS)
- [ ] PipeWire control - [ ] PipeWire control
- [ ] File watcher - [ ] Exposing file contents as sensors
## Installation ## Installation
@ -25,6 +27,7 @@
systemctl enable hassliebe && systemctl start hassliebe systemctl enable hassliebe && systemctl start hassliebe
``` ```
### As a systemd _user_ service ### As a systemd _user_ service
- Download [the latest binary](https://git.moritzruth.de/moritzruth/Hassliebe/releases) and put it into `~/.local/bin`. - Download [the latest binary](https://git.moritzruth.de/moritzruth/Hassliebe/releases) and put it into `~/.local/bin`.
@ -36,11 +39,13 @@ systemctl enable hassliebe && systemctl start hassliebe
systemctl --user enable hassliebe && systemctl --user start hassliebe systemctl --user enable hassliebe && systemctl --user start hassliebe
``` ```
## Configuration ## Configuration
Depending on whether Hassliebe is run as root or as a regular user, the configuration is read from Depending on whether Hassliebe is run as root or as a regular user, the configuration is read from
`/etc/hassliebe/config.toml` or `$XDG_CONFIG_HOME/hassliebe/config.toml`. `/etc/hassliebe/config.toml` or `$XDG_CONFIG_HOME/hassliebe/config.toml`.
### Example ### Example
```toml ```toml
@ -72,6 +77,7 @@ battery = 60
enabled = true enabled = true
``` ```
### Machine identification ### Machine identification
Hassliebe needs a way to uniquely identify a machine. Hassliebe needs a way to uniquely identify a machine.
@ -81,6 +87,7 @@ If `/etc/machine-id` exists (as is the case with systemd-based systems), it will
Otherwise, a random ID will be generated on the first run and stored in `[data]/machine_id`. Otherwise, a random ID will be generated on the first run and stored in `[data]/machine_id`.
The latter always takes precedence. The latter always takes precedence.
## Modules ## Modules
### Buttons ### Buttons
@ -97,6 +104,7 @@ run_in_shell = true # defaults to false
When `run_in_shell` is set to `true`, the command will be run with `/bin/sh`. When `run_in_shell` is set to `true`, the command will be run with `/bin/sh`.
### Info ### Info
Hassliebe currently supports reporting the following system stats: Hassliebe currently supports reporting the following system stats:
@ -115,6 +123,7 @@ ram_usage = 0 # disabled
battery = 60 # updates every 60 seconds battery = 60 # updates every 60 seconds
``` ```
### Notifications ### Notifications
**Not available when running as a system service.** **Not available when running as a system service.**
@ -150,6 +159,7 @@ Complex messages have these properties:
- `encoded_image` (optional) — Padded Base64-encoded image attached to the notification. - `encoded_image` (optional) — Padded Base64-encoded image attached to the notification.
- `actions` (optional) — Object with the keys being IDs and the values being labels. - `actions` (optional) — Object with the keys being IDs and the values being labels.
#### Actions #### Actions
When a notification action is invoked, the ID of the action is sent to the MQTT topic with the following name: When a notification action is invoked, the ID of the action is sent to the MQTT topic with the following name:
@ -157,6 +167,7 @@ When a notification action is invoked, the ID of the action is sent to the MQTT
When a notification is dismissed, `closed` is sent into the topic. When a notification is dismissed, `closed` is sent into the topic.
## License ## License
Hassliebe is licensed under the [Blue Oak Model License 1.0.0](./LICENSE.md). This project is available under the permissive [Blue Oak Model License 1.0.0](https://blueoakcouncil.org/license/1.0.0).