system_sensors
system_sensors copied to clipboard
Logging of system sensor specific for the RPI and sending them to a MQTT broker
RPI System sensors
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
- 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
System Requirements
You need to have at least python 3.6 installed to use System Sensors.
Installation:
- Clone this repo >> git clone https://github.com/Sennevds/system_sensors.git
- cd system_sensors
- pip3 install -r requirements.txt
- sudo apt-get install python3-apt
- Edit settings_example.yaml in "~/system_sensors/src" to reflect your setup and save as 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 |
deviceName | true | \ | device name is sent with topic |
client_id | true | \ | client id to connect to the MQTT broker |
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. |
- python3 src/system_sensors.py src/settings.yaml
- (optional) create service to autostart the script at boot:
- sudo cp example_system_sensors.service /etc/systemd/system/system_sensors.service
- 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 systemctl enable system_sensors.service
- sudo systemctl start system_sensors.service
Home Assistant configuration:
Configuration:
The only config you need in Home Assistant is the following:
mqtt:
discovery: true
discovery_prefix: homeassistant
Lovelace UI example:
I have used following custom plugins for lovelace:
- vertical-stack-in-card
- mini-graph-card
- bar-card
Config:
- type: 'custom:vertical-stack-in-card'
title: Deconz System Monitor
cards:
- type: horizontal-stack
cards:
- type: custom:mini-graph-card
entities:
- sensor.deconz_cpu_usage
name: CPU
line_color: '#2980b9'
line_width: 2
hours_to_show: 24
- type: custom:mini-graph-card
entities:
- sensor.deconz_temperature
name: Temp
line_color: '#2980b9'
line_width: 2
hours_to_show: 24
- type: custom:bar-card
entity: sensor.deconz_disk_use
name: HDD
positions:
icon: outside
name: inside
color: '#00ba6a'
- type: custom:bar-card
entity: sensor.deconz_memory_use
name: RAM
positions:
icon: outside
name: inside
- type: entities
entities:
- sensor.deconz_last_boot
- sensor.deconz_under_voltage
Example: