Update README.md
This commit is contained in:
parent
6e6e35021b
commit
e90f1e0ebb
1 changed files with 13 additions and 2 deletions
15
README.md
15
README.md
|
@ -2,6 +2,7 @@
|
|||
|
||||
> Integrates any Linux machine into your Home Assistant ecosystem.
|
||||
|
||||
|
||||
## Features
|
||||
|
||||
- [x] Command buttons
|
||||
|
@ -10,7 +11,8 @@
|
|||
- [x] System information reporting (CPU usage, RAM usage, battery status)
|
||||
- [ ] Media control (MPRIS)
|
||||
- [ ] PipeWire control
|
||||
- [ ] File watcher
|
||||
- [ ] Exposing file contents as sensors
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
|
@ -25,6 +27,7 @@
|
|||
systemctl enable hassliebe && systemctl start hassliebe
|
||||
```
|
||||
|
||||
|
||||
### As a systemd _user_ service
|
||||
|
||||
- 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
|
||||
```
|
||||
|
||||
|
||||
## Configuration
|
||||
|
||||
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`.
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
|
@ -72,6 +77,7 @@ battery = 60
|
|||
enabled = true
|
||||
```
|
||||
|
||||
|
||||
### Machine identification
|
||||
|
||||
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`.
|
||||
The latter always takes precedence.
|
||||
|
||||
|
||||
## Modules
|
||||
|
||||
### 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`.
|
||||
|
||||
|
||||
### Info
|
||||
|
||||
Hassliebe currently supports reporting the following system stats:
|
||||
|
@ -115,6 +123,7 @@ ram_usage = 0 # disabled
|
|||
battery = 60 # updates every 60 seconds
|
||||
```
|
||||
|
||||
|
||||
### Notifications
|
||||
|
||||
**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.
|
||||
- `actions` (optional) — Object with the keys being IDs and the values being labels.
|
||||
|
||||
|
||||
#### Actions
|
||||
|
||||
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.
|
||||
|
||||
|
||||
## 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).
|
||||
|
|
Loading…
Add table
Reference in a new issue