refactor: rename sysinfo tool to aster-sysinfo (#16)

The sysinfo name was too generic and misleading. This tool provides
sensor values from the system for `asterctl` and is not a generic system
information tool.
This commit is contained in:
Markus Zehnder
2025-08-31 20:58:43 +02:00
committed by GitHub
parent cfe178893f
commit 54f34def2c
18 changed files with 144 additions and 64 deletions
+1 -1
View File
@@ -21,7 +21,7 @@
- [Sensor Value Provider](sensor/provider/README.md)
- [Text File Data Source](sensor/provider/text_file.md)
- [Shell Scripts](sensor/provider/shell_scripts.md)
- [Sysinfo Tool](sensor/provider/sysinfo.md)
- [aster-sysinfo Tool](sensor/provider/sysinfo.md)
<!--
- [For developers](for_developers/panel.md)
-->
+2 -2
View File
@@ -8,11 +8,11 @@ Please note that only Linux has been tested so far.
Executable binaries are available for download on the [GitHub Releases page](https://github.com/zehnm/aoostar-rs/releases).
Download the binary for your platform (only Linux available at the moment) and extract the archive.
The archive contains the `asterctl` and `sysinfo` executables which you can run.
The archive contains the `asterctl` and `aster-sysinfo` executables which you can run.
## Build from source using Rust
To build the `asterctl` and `sysinfo` executables from source, you will first need to install Rust and Cargo.
To build the `asterctl` and `aster-sysinfo` executables from source, you will first need to install Rust and Cargo.
Follow the instructions on the [Rust installation page](https://www.rust-lang.org/tools/install).
At least Rust version 1.88 is required.
+28 -6
View File
@@ -1,26 +1,27 @@
# Linux systemd Service
# Linux systemd Services
## Switch Off LCD on Boot
The systemd unit [lcd-off.service](https://github.com/zehnm/aoostar-rs/blob/main/linux/lcd-off.service)
can be installed to automatically switch off the embedded LCD on boot.
The unit file has been tailored to Debian based Linux distros and has been tested on Proxmox 8.4 and Ubuntu 25.04.
The unit file has been tailored to Debian-based Linux distros and has been tested on Proxmox 8.4 and Ubuntu 25.04.
Requirements:
- `/dev/ttyACM0`: `dialout` group with rw permissions.
- To run as root: remove `DynamicUser` and `Group` settings.
## Install
### Install
As root user, otherwise `sudo` is required:
```shell
cp asterctl /usr/bin/
cp asterctl /usr/local/bin/
cp lcd-off.service /etc/systemd/system/
systemctl daemon-reload
systemctl enable lcd-off
```
## Security
### Security
The systemd unit file uses strong security settings to only allow operations required for `asterctl`:
@@ -120,3 +121,24 @@ systemd-analyze security lcd-off.service
```
→ Overall exposure level for lcd-off.service: 0.8 SAFE 😀
```
## asterctl Daemon
_TODO_
## aster-sysinfo Daemon
‼️ Work in progress. This also requires the `asterctl` daemon running.
The systemd unit [aster-sysinfo.service](https://github.com/zehnm/aoostar-rs/blob/main/linux/aster-sysinfo.service)
can be installed to automatically collect system sensor information for `asterctl`.
### Install
As root user, otherwise `sudo` is required:
```shell
cp aster-sysinfo /usr/local/bin/
cp aster-sysinfo.service /etc/systemd/system/
systemctl daemon-reload
systemctl enable aster-sysinfo
```
+1 -1
View File
@@ -25,4 +25,4 @@ Only the file data source is supported at the moment, other sources like pipes,
### Sensor Data Providers
- Proof of concept [Linux shell scripts](provider/shell_scripts.md)
- [sysinfo tool](provider/sysinfo.md)
- [aster-sysinfo tool](provider/sysinfo.md)
+5 -5
View File
@@ -1,6 +1,6 @@
# sysinfo Tool
# aster-sysinfo Tool
The Rust based [sysinfo](https://github.com/zehnm/aoostar-rs/blob/main/crates/sysinfo) tool gathers many more system sensor values with the help of
The Rust based [aster-sysinfo](https://github.com/zehnm/aoostar-rs/blob/main/crates/sysinfo) tool gathers many more system sensor values with the help of
the [sysinfo](https://github.com/GuillaumeGomez/sysinfo) crate.
It supports FreeBSD, Linux, macOS, Windows and other OSes, but it has only been tested on Linux so far.
@@ -8,7 +8,7 @@ It supports FreeBSD, Linux, macOS, Windows and other OSes, but it has only been
```
Proof of concept sensor value collection for the asterctl screen control tool
Usage: sysinfo [OPTIONS]
Usage: aster-sysinfo [OPTIONS]
Options:
-o, --out <OUT>
@@ -39,13 +39,13 @@ Options:
Single test run with printing all sensors in the console:
```shell
sysinfo --console
aster-sysinfo --console
```
Normal mode providing sensor values for `asterctl` in `/tmp/sensors/sysinfo.txt` every 3 seconds:
```shell
sysinfo --refresh 3 --out /tmp/sensors/sysinfo.txt
aster-sysinfo --refresh 3 --out /tmp/sensors/aster-sysinfo.txt
```
Note: the lower the refresh rate, the more resources are used!