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

cleanup

Browse Source
This commit is contained in:
Hristo Jelev
2021-11-17 00:07:28 +02:00
parent 083521e69c
commit ae5397356b
2 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@@ -1,11 +1,11 @@
# Rapsberry Pi MQTT monitor # Raspberry Pi MQTT monitor
Python script to check the cpu load, cpu temperature, free space, used memory, swap usage, voltage and system clock speed Python script to check the cpu load, cpu temperature, free space, used memory, swap usage, voltage and system clock speed
on a Raspberry Pi computer and publish the data to a MQTT broker. on a Raspberry Pi or any computer running Ubuntu and publish this data to a MQTT broker.
I wrote this so I can monitor my raspberries at home with [home assistant](https://www.home-assistant.io/). The script was written and tested on Python 2 but it should work fine on Python 3. I wrote this to monitor my raspberries at home with [home assistant](https://www.home-assistant.io/). The script works fine both on Python 2 and 3
The script if very light, it takes 3 seconds as there are 5 half second sleeps in the code - due to mqtt having problems if I shoot the messages with no delay, this is only if you choose to send the messages separately, now the script support a group CSV message that don't have this delay. and is if very light, it takes 3 seconds as there are 5 half second sleeps in the code - due to mqtt having problems if I shoot the messages with no delay, this is only if you choose to send the messages separately, now the script support a group CSV message that don't have this delay.
Each value measured by the script is send via a separate message for easier craetion of home assistant sensors. Each value measured by the script is sent via a separate message for easier creation of home assistant sensors.
Example message topic if ```group_messages = False ```: Example message topic if ```group_messages = False ```:
``` ```
@@ -37,16 +37,17 @@ $ sudo apt install python-pip
Then install this module needed for the script: Then install this module needed for the script:
```bash ```bash
$ pip install paho-mqtt $ pip install paho-mqtt
```
Copy ```/src/rpi-cpu2mqtt.py``` and ```/src/config.py.example``` to a folder of your choise (I am using ```/home/pi/scripts/``` ) and rename ```config.py.example``` to ```config.py``` $ git clone https://github.com/hjelev/rpi-mqtt-monitor.git
```
Copy ```/src/rpi-cpu2mqtt.py``` and ```/src/config.py.example``` to a folder of your choice (I am using ```/home/pi/scripts/``` ) and rename ```config.py.example``` to ```config.py```
# Configuration # Configuration
Populate the variables for MQTT host, user, password and main topic in ```config.py```. Populate the variables for MQTT host, user, password and main topic in ```config.py```.
You can also choose what messages are send and what is the delay (sleep_time is only used for multiple messages) between them. You can also choose what messages are sent and what is the delay (sleep_time is only used for multiple messages) between them.
If you are sending a grouped message and you want to delay the execution of the script you need to use the ```random_delay``` variable which is set to 30 by default. If you are sending a grouped message, and you want to delay the execution of the script you need to use the ```random_delay``` variable which is set to 30 by default.
This is the default configuration: This is the default configuration:
``` ```
@@ -76,7 +77,7 @@ Test the script.
```bash ```bash
$ /usr/bin/python /home/pi/rpi-mqtt-monitor/rpi-cpu2mqtt.py $ /usr/bin/python /home/pi/rpi-mqtt-monitor/rpi-cpu2mqtt.py
``` ```
Once you test the script there will be no output if it run OK but you should get 5 messages via the configured MQTT server (the messages count depends on your configuration). Once you test the script there will be no output if it run OK, but you should get 5 messages via the configured MQTT server (the messages count depends on your configuration).
Create a cron entry like this (you might need to update the path in the cron entry below, depending on where you put the script files): Create a cron entry like this (you might need to update the path in the cron entry below, depending on where you put the script files):
``` ```
@@ -223,4 +224,3 @@ entities:
``` ```
# To Do # To Do
- maybe add network traffic monitoring via some third party software (for now I can't find a way to do it without additional software) - maybe add network traffic monitoring via some third party software (for now I can't find a way to do it without additional software)
- make it work for Ubuntu

0
null
View File