43 lines
1.1 KiB
Markdown
43 lines
1.1 KiB
Markdown
# matrix-lolopener
|
|
|
|
A simple matrix bot which posts to a list of matrix rooms everytime the front door is opened or closed.
|
|
The door state is retrieved by subscribing to an MQTT topic, and a matrix event is sent every time that state changes.
|
|
|
|
## building
|
|
|
|
```sh
|
|
cargo build --release
|
|
```
|
|
|
|
## installing
|
|
|
|
```sh
|
|
useradd -r -M -s /usr/sbin/nologin matrix-lolopener
|
|
install -o matrix-lolopener -g nogroup target/release/matrix-lolopener /opt/matrix-lolopener/bin/
|
|
install -o matrix-lolopener -g nogroup -m 600 -T config.yml.example /opt/matrix-lolopener/etc/config.yml
|
|
cp matrix-lolopener.service /etc/systemd/system/
|
|
$EDITOR /opt/matrix-lolopener/etc/config.yml
|
|
systemctl daemon-reload && systemctl enable --now matrix-lolopener.service
|
|
```
|
|
|
|
## usage
|
|
|
|
```
|
|
Matrix bot posting when the front door is opened or closed
|
|
|
|
Usage: matrix-lolopener [OPTIONS]
|
|
|
|
Options:
|
|
-c, --config <CONFIG> Configuration file path [default: config.yml]
|
|
-h, --help Print help
|
|
-V, --version Print version
|
|
```
|
|
|
|
## contributing
|
|
|
|
Send PRs to https://git.labolyon.fr/mirsal/matrix-lolopener
|
|
|
|
## license
|
|
|
|
GPL v3 or later
|