RPI System Sensors

WARNING !!! This fork has been modified, probably in a very poor way. I have added additional sensors for my needs.

I’ve created a simple python script that runs every 60 seconds and sends several system data over MQTT. It uses the MQTT Discovery for Home Assistant so you don’t need to configure anything in Home Assistant if you have discovery enabled for MQTT

It currently logs the following data:

• CPU usage
• CPU temperature
• CPU Clock Speed
• Fan Speed
• Disk usage
• Memory usage
• Power status of the RPI
• Last boot
• Last message received timestamp
• Swap usage
• Wifi signal strength
• Wifi connected SSID
• Amount of upgrades pending
• Disk usage of external drives
• Hostname
• Host local IP
• Host OS distro and version
• CPU Load (1min, 5min and 15min)
• Network Download & Upload throughput

Added Sensors

• Disk Available & Used
• Disk Available & Used Percentage
• Memory Available & Used
• Memory Available & Used Percentage
• Network Bytes Sent and Received
• Network Packets Sent and Received
• Host Kernel Version
• Host Platform
• Uptime in Days, Hours and Minutes

Added UPS Sensors

• UPS AC State
• UPS Voltage
• UPS Capacity
• UPS Status

Dependancies

• You need to have at least python 3.6 installed to use System Sensors.
• You need to have Git and Pip to install System Sensors.

sudo apt install git
sudo apt-get install python3-pip

Installation

1. Clone the following repo

git clone https://github.com/leelooauto/system_sensors.git

FOR DOCKER INSTALL SEE DOKCER STEPS BELOW !!!

2. Install Python3 if not already

sudo apt-get install python3-apt

3. To install and run system_sensors

cd system_sensors
pip3 install -r requirements.txt

3a. If 'Externally Managed Environment'

pip3 install -r requirements.txt --break-system-packages

4. Copy and edit settings.yaml to reflect your system settings

cp src/settings_example.yaml src/settings.yaml
sudo nano src/settings.yaml

Value	Required	Default	Description
mqtt	true	\	Details of the MQTT broker
mqtt:hostname	true	\	Hostname of the MQTT broker
mqtt:port	false	1883	Port of the MQTT broker
mqtt:user	false	\	The userlogin( if defined) for the MQTT broker
mqtt:password	false	\	the password ( if defined) for the MQTT broker
tls	false	\	Details of TLS settings broker
tls:ca_certs	false	\	TLS settings ( if defined) for the MQTT broker
tls:certfile	false	\	TLS settings ( if defined) for the MQTT broker
tls:keyfile	false	\	TLS settings ( if defined) for the MQTT broker
client_id	true	\	client id to connect to the MQTT broker
ha_status	false	hass	Status topic for homeassistant, defaults to hass if not set
timezone	true	\	Your local timezone (you can find the list of timezones here: time zones)
power_integer_state(Deprecated)	false	false	Deprecated
update_interval	false	60	The update interval to send new values to the MQTT broker
sensors	false	\	Enable/disable individual sensors (see example settings.yaml for how-to). Default is true for all sensors.

5. Run to confirm working as expected

python3 src/system_sensors.py src/settings.yaml

6. (optional, but not really) create service to autostart the script at boot
   • Edit the path to your script path and settings.yaml. Also make sure you replace pi in "User=pi" with the account from which this script will be run. This is typically 'pi' on default raspbian system.

sudo cp system_sensors.service /etc/systemd/system/system_sensors.service
sudo systemctl enable system_sensors.service
sudo systemctl start system_sensors.service

Docker

Preparations

Before running this application in a docker container you'll need to add the following to the crontab

@reboot <git clone location>/src/bin/ip_pipe.sh

This little script will create a pipe and fetch the Host OS IP address and put it in the pipe.
The container will have the pipe mounted /tmp/system_sensor_pipe:/app/host/system_sensor_pipe:ro so it can read the ip.
this is required since docker container can't and shouldn't access the host OS

Build & Start Container

2. Running in docker container is very symplistic:

docker-compose up -d