friso/rpi-mqtt-monitor
Public Access
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated Readme to define the new discovery_messages setting.

Browse Source
This commit is contained in:
leaskovski
2021-04-09 10:42:24 +01:00
committed by GitHub
parent 0c1ab54048
commit 4e4f4bc7c2
1 changed files with 4 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@@ -51,6 +51,7 @@ This is the default configuration:
``` ```
random_delay = randrange(30) random_delay = randrange(30)
discovery_messages = False
group_messages = True group_messages = True
sleep_time = 0.5 sleep_time = 0.5
cpu_load = True cpu_load = True
@@ -63,6 +64,8 @@ memory = False
uptime = True uptime = True
``` ```
If the ```discovery_messages``` is set to true, the script will send MQTT Discovery config messages which allows Home Assistant to automatically add the sensors without having to define them in configuration. Note, this setting is only available for when ```group_messages``` is set to False.
If the ```group_messages``` is set to true the script will send just one message containing all values in CSV format. If the ```group_messages``` is set to true the script will send just one message containing all values in CSV format.
The group message looks like this: The group message looks like this:
``` ```
@@ -85,7 +88,7 @@ Create a cron entry like this (you might need to update the path in the cron ent
Once you installed the script on your raspberry you need to create some sensors in home assistant. Once you installed the script on your raspberry you need to create some sensors in home assistant.
If you are using ```discovery_messages```, then this step is not required as the sensors are auto discovered by Home Assistant and added.
This is the sensors configuration if ```group_messages = True``` assuming your sensors are separated in ```sensors.yaml``` file. This is the sensors configuration if ```group_messages = True``` assuming your sensors are separated in ```sensors.yaml``` file.
```yaml ```yaml