tm24fan8/monitor-py
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Better explanations for config example

Browse Source
This commit is contained in:
Tony Stork
2026-05-04 20:44:23 -04:00
parent 64bdcc7409
commit f68040daec
2 changed files with 22 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+8 -8
View File
@@ -66,10 +66,10 @@ Open `config.yaml` and at minimum set your broker address and credentials:
mqtt: mqtt:
host: "192.168.1.x" # your MQTT broker IP or hostname host: "192.168.1.x" # your MQTT broker IP or hostname
port: 1883 port: 1883
username: "your_user" username: "your_user" # leave empty if broker has no auth
password: "your_password" password: "your_password" # leave empty if broker has no auth
topic_prefix: "monitor-py" topic_prefix: "monitor-py" # base topic: {topic_prefix}/{node_id}/...
client_id: "" # auto-generated if left empty client_id: "" # auto-generated from hostname if left empty
monitor: monitor:
interval: 30 # seconds between publishes interval: 30 # seconds between publishes
@@ -78,17 +78,17 @@ monitor:
sensors: sensors:
cpu: true cpu: true
gpu: true gpu: true # NVIDIA via nvidia-smi; skipped gracefully if unavailable
ram: true ram: true
disk: disk:
enabled: true enabled: true
partitions: [] # empty = auto-detect; or list specific mounts: ["/", "/home"] partitions: [] # empty = auto-detect; or list specific mounts: ["/", "/home"]
io_stats: true io_stats: true # enable read/write speed sensors
network: network:
enabled: true enabled: true
interfaces: [] # empty = all non-loopback; or list specific: ["enp6s0"] interfaces: [] # empty = all non-loopback; or list specific: ["enp6s0"]
system: true system: true # uptime, logged-in users
idle_time: true idle_time: true # session idle via xprintidle (requires X11 + xprintidle in PATH)
``` ```
#### `device_name` vs `node_id` #### `device_name` vs `node_id`
config.yaml.example
+14 -14
View File
@@ -1,26 +1,26 @@
mqtt: mqtt:
host: "" # MQTT broker address host: "192.168.1.x" # your MQTT broker IP or hostname
port: 1883 port: 1883
username: "" # leave empty if broker has no auth username: "your_user" # leave empty if broker has no auth
password: "" password: "your_password" # leave empty if broker has no auth
topic_prefix: "monitor-py" # base topic: {topic_prefix}/{hostname}/... topic_prefix: "monitor-py" # base topic: {topic_prefix}/{node_id}/...
client_id: "" # leave empty to auto-generate from hostname client_id: "" # auto-generated from hostname if left empty
monitor: monitor:
interval: 15 # seconds between stat publishes interval: 30 # seconds between publishes
device_name: "" # display name in HA; defaults to hostname device_name: "" # human-readable HA device name; defaults to hostname
node_id: "" # MQTT topic slug and unique_id prefix; defaults to hostname if empty node_id: "" # MQTT topic slug; defaults to hostname if empty
sensors: sensors:
cpu: true cpu: true
gpu: true # NVIDIA via nvidia-smi; skipped gracefully if unavailable gpu: true # NVIDIA via nvidia-smi; skipped gracefully if unavailable
ram: true ram: true
disk: disk:
enabled: true enabled: true
partitions: ["/","/boot"] # empty = auto-detect all physical, non-loop mounts partitions: [] # empty = auto-detect; or list specific mounts: ["/", "/home"]
io_stats: true # enable read/write speed sensors io_stats: true # enable read/write speed sensors
network: network:
enabled: true enabled: true
interfaces: ["enp6s0","wlan0"] # empty = all non-loopback interfaces interfaces: [] # empty = all non-loopback; or list specific: ["enp6s0"]
system: true # uptime, logged-in users system: true # uptime, logged-in users
idle_time: true # session idle via xprintidle (requires X11 + xprintidle in PATH) idle_time: true # session idle via xprintidle (requires X11 + xprintidle in PATH)