Red Reactor Battery Monitoring service with MQTT, and Home Assistant support
Project description
Red Reactor MQTT Client for Home Automation
This is a Red Reactor MQTT Client service that is designed to run as a background application to monitor battery status, and to publish that data to a MQTT broker.
Functionality includes:
- Background application that continuously monitors the battery status, and will safely shutdown if required
- The configuration file can be used to override specific topics and entities
- Connects to a MQTT broker, and publishes the service status, data and enables command topics
- Published data includes:
- Voltage
- Current
- Battery Level
- External Power Status
- CPU Temperature
- CPU Status
- Battery Warning Threshold
- Battery Voltage Minimum and Maximum
- Report Interval
- Commands:
- Immediate Shutdown
- Immediate Restart
- Change the Battery Warning Threshold
- Change the Battery Voltage Minimum and Maximum
- Change the Report Interval
- Provides
systemd
service example, so it can be started as a service on system boot
Home Assistant
Connecting your Home Assistant instance to the same MQTT Broker as your Red Reactor will allow your Red Reactor to be auto discovered by your Home Assistant instance. It will give you access to all the readings available from the Red Reactor sensors, and allows full configuration of the Red Reactor on the fly - it even adds the ability to reboot and shutdown your device at the push of a button.
There is also a Home Assistant Add-on available for Supervisor users.
MQTT
State
Topic redreactor/your-configured-hostname/state
{
"voltage": 4.164,
"current": 2.1799,
"battery_level": 100,
"external_power": "ON",
"cpu_temperature": 49.1,
"cpu_stat": 0,
"battery_warning_threshold": 10,
"battery_voltage_minimum": 2.6,
"battery_voltage_maximum": 4.2,
"report_interval": 30
}
State Description
voltage
is the Voltage of the connected batteriescurrent
is the Current draw from the batteriesbattery_level
is the percentage value of charge left in the batteriesexternal_power
is whether the batteries are connected to an external power source or notcpu_temperature
read viacat /sys/class/thermal/thermal_zone0/temp
gets the CPU Temperaturecpu_stat
read viacat /sys/devices/platform/soc/soc:firmware/get_throttled
gets the CPU Statbattery_warning_threshold
is a percentage value below 100% that once crossed will initiate a safe shutdown of the devicebattery_voltage_minimum
is the voltage at which is to be considered the lowest allowable before initiating a safe shutdownbattery_voltage_maximum
is the voltage at which is to be considered the maximum at which the battery can be (this is used in the calculation of thebattery_level
)report_interval
is the reporting interval at which the data will be published onto the state topic
Status
Topic redreactor/hostname/status
Data online
or offline
Command
Topic redreactor/your-configured-hostname/set/chosen-command
Command topic | value:
battery_warning_threshold
| value (int)battery_voltage_minimum
| value (float)battery_voltage_maximum
| value (float)report_interval
| value (int)restart
| no value requiredshutdown
| no value required
If there are more features that you would like to see supported, let me know!
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for redreactor-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8a81874a3104b697c732fc136eda4339cc13c52ac39d0e80f9a1193482a90350 |
|
MD5 | cbc3cbdd791eef6f418a7297b16b51b0 |
|
BLAKE2b-256 | b448a68a3afc69ea236a785e7d9db858302144d05d3ff6c7be07eb5d9cda80de |