Skip to content

Commit 3a46c48

Browse files
authored
Revise README for improved CLI and InfluxDB instructions
Updated README to enhance clarity and detail on CLI usage, arguments, and InfluxDB integration.
1 parent 720349e commit 3a46c48

File tree

1 file changed

+27
-12
lines changed

1 file changed

+27
-12
lines changed

README.MD

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,24 @@
11
# LibreHardwareMonitorReporter
22

3-
This is a Python project that wraps around the LibreHardwareMonitor.dll files in order to allow CLI usecases. There are a few purposes of this program:
4-
- Allow users to get sensor data from their hardware in a simple way
5-
- Allow users to integrate the sensor data into their own python projects
3+
![CLI Image](https://i.imgur.com/cFmRKtx.png)
64

7-
# For EXE Users
8-
You can download the latest release from the releases page : https://github.com/LibreHardwareMonitor/LibreHardwareMonitor/releases
9-
# Arguements
5+
This is a Python CLI project that wraps around the LibreHardwareMonitor.dll files in order to allow CLI use cases.
6+
- Allow users to get sensor data from their hardware on Windows with a simple terminal, with optional Rich Table support
7+
- Allow users to integrate the sensor data into their own projects, has support for sending to InfluxDB!
8+
- This solution is available as an all-in-one executable, just hit run!
9+
10+
# Setup
11+
12+
You can download the latest release from the releases page: https://github.com/LibreHardwareMonitor/LibreHardwareMonitor/releases
13+
14+
## Arguements :
15+
By design, you will not need to enter in any arguements in order to use the cli. However if you want to make some specific customisations before runtime or add influx support. Please read on :
16+
17+
### General :
1018
- `--no-table` : If this is set, the output will be a simple console output, otherwise it will use Rich to display a table of the sensor data
1119
- `--time <seconds>` : This is the time interval between each data
1220

21+
### Libre-Config :
1322
The following options can be used to filter the sensors displayed. If none are set, all sensors will be shown. This is useful as certain CPUs may have hundreads of sensors (eg. a high end server CPU).
1423
- `--CPU` : If this is set, only CPU related sensors will be shown
1524
- `--GPU` : If this is set, only GPU related sensors will be shown
@@ -19,22 +28,28 @@ The following options can be used to filter the sensors displayed. If none are s
1928
- `--NETWORK` : If this is set, only Network related sensors will be shown
2029
- `--STORAGE` : If this is set, only Storage related sensors will be shown
2130

22-
# For Python Users/Devs :
23-
If you are not interested with any of the table stuff and just want to grab specifc things from the Library in other projects and be done. Simply use the `libre_hardware_monitor_reporter.py` file in the `libre_cli` folder and initialize the class like so :
31+
### Influx Config :
32+
Tested on a InfluxDB2 container but the following solution should work in most environments, enter in the following :
33+
- `--influx-url "<YOUR-ADDRESS"` : URL for the influx address, port number also needed
34+
- `--token "<YOUR-TOKEN>"` : Token for the setup, can be an admin token but works with normal tokens fine
35+
- `--org "<org>"` : Organisation for the setup
36+
- `--bucket "<bucket>"` : Bucket for the setup
37+
38+
# For Devs/Advanced Users :
39+
If you are not interested in any of the table stuff and just want to grab specific things from the Library in other projects and be done. Simply use the `libre_hardware_monitor_reporter.py` file in the `libre_cli` folder and initialize the class like so :
2440
```python
2541
from libre_cli.libre_hardware_monitor_reporter import LibreHardwareMonitorReporter
26-
# Intialize the reporter, note that you can optionaly pass in filter parameters here as well, but I would leave it at the default
42+
# Initialise the reporter, note that you can optionally pass in filter parameters here as well, but I would leave it at the default
2743
LibreHardwareMonitorReport = LibreHardwareMonitorReporter()
2844
sensor_data = LibreHardwareMonitorReport.get_sensor_data()
2945
```
3046

31-
# Building your own EXE
32-
In order to build your own executable, you will need to have PyInstaller and the libremonitorlib dll files and run the following command :
47+
# Building your own executable (not required)
48+
If you want to build your own executable from scratch. You will need to have PyInstaller and the libremonitorlib dll files and run the following command :
3349
`python -m PyInstaller --onefile --name "LibreMonitor" .\main.py --add-binary ".\libre_cli\LibreHardwareMonitorLib.dll;libre_cli" --add-binary ".\libre_cli\Aga.Controls.dll;libre_cli" --add-binary ".\libre_cli\HidSharp.dll;libre_cli"`
3450

3551
Please note the following :
3652
- When running this, please make sure you run this with Admin permissions as certain things will not be shown, I've often found Intel CPU Temps are not shown when running without admin privs
37-
3853
- Add better examples of putting the data into an Influx Database
3954

4055
Many thanks to the LibreHardwareMonitor team : https://github.com/LibreHardwareMonitor/LibreHardwareMonitor

0 commit comments

Comments
 (0)