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
@@ -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!