Skip to content

Latest commit

 

History

History
53 lines (32 loc) · 1.64 KB

README.md

File metadata and controls

53 lines (32 loc) · 1.64 KB

rszurro

rszurro is a multi-purpose IoT-focused daemon written in Rust that monitors sensors from various sources and distributes data to different endpoints.

It is formerly designed to integrate raw sensors that are physically unreachable from an Home Assistant server.

Building

To build rszurro, ensure Rust is installed, also the lm_sensors monitor requires sensors.h provided on debian by the libsensors-dev package.

Clone the repository, navigate to the project directory, and run:

cargo build --release

This will produce a single executable file in the target/release directory.

Configuration

rszurro load settings from a yaml file, an example configuration can be found on config.yaml from this repository.

Usage

To use rszurro, you need to provide the path of your configuration file, as follows:

target/release/rszurro /path/to/config.yaml

Once operational, rszurro will consistently monitor the designated sensors data for any alterations, promptly transmitting their updated information to the configured endpoints.

You can see all available command line options with:

rszurro --help

Debian packaging

It is possible to build and install a debian package of rszurro, including a systemd service, using cargo-deb as follows:

cargo deb
sudo dpkg -i target/debian/rszurro_0.1.0_armhf.deb

Once installed the systemd service should be automatically started and can be checked via systemctl as shown below:

systemctl status rszurro