power monitor changed to latest version

Author: Senne Vande Sompele

README.md

@@ -34,7 +34,7 @@ You need to have at least __python 3.6__ installed to use System Sensors.
 | 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](https://gist.github.com/heyalexej/8bf688fd67d7199be4a1682b3eec7568))
-| power_integer_state | false | false | Return the power state in text or integer form
+| power_integer_state(Deprecated) | false | false | Deprecated
 | update_interval | false | 60 | The update interval to send new values to the MQTT broker 
 | check_available_updates | false | false | Check the # of avaiblable updates 
 | check_wifi_strength | false | false | Check the wifi strength 

requirements.txt

@@ -1,4 +1,5 @@
 paho-mqtt==1.5.0
 psutil==5.6.6
 pytz==2019.2
-PyYAML==5.2
+PyYAML==5.2
+rpi_bad_power==0.0.3

src/settings_example.yaml

@@ -6,7 +6,6 @@ mqtt:
 deviceName: test
 client_id: test
 timezone: Europe/Brussels
-power_integer_state: false #defaults to false
 update_interval: 60 #Defaults to 60
 check_wifi_strength: true
 check_available_updates: true

src/system_sensors.py

@@ -8,7 +8,7 @@
 from datetime import timedelta
 from re import findall
 from subprocess import check_output
-
+from rpi_bad_power import new_under_voltage
 import paho.mqtt.client as mqtt
 import psutil
 import pytz
@@ -18,7 +18,6 @@
 
 try:
     import apt
-
     apt_disabled = False
 except ImportError:
     apt_disabled = True
@@ -34,9 +33,9 @@
             OS_DATA[row[0]] = row[1]
 
 mqttClient = None
-SYSFILE = "/sys/devices/platform/soc/soc:firmware/get_throttled"
 WAIT_TIME_SECONDS = 60
 deviceName = None
+_underVoltage = None
 
 class ProgramKilled(Exception):
     pass
@@ -65,6 +64,11 @@ def run(self):
             self.execute(*self.args, **self.kwargs)
 
 
+def write_message_to_console(message):
+    print(message)
+    sys.stdout.flush()
+    
+
 def utc_from_timestamp(timestamp: float) -> dt.datetime:
     """Return a UTC time from a timestamp."""
     return UTC.localize(dt.datetime.utcfromtimestamp(timestamp))
@@ -95,40 +99,28 @@ def on_message(client, userdata, message):
 
 def updateSensors():
     payload_str = (
-        '{"temperature": '
-        + get_temp()
-        + ', "disk_use": '
-        + get_disk_usage("/")
-        + ', "memory_use": '
-        + get_memory_usage()
-        + ', "cpu_usage": '
-        + get_cpu_usage()
-        + ', "swap_usage": '
-        + get_swap_usage()
-        + ', "power_status": "'
-        + get_rpi_power_status()
-        + '", "last_boot": "'
-        + get_last_boot()
-        + '", "last_message": "'
-        + get_last_message()
-        + '"'
+        '{'
+        + f'"temperature": {get_temp()},'
+        + f'"disk_use": {get_disk_usage("/")},'
+        + f'"memory_use": {get_memory_usage()},'
+        + f'"cpu_usage": {get_cpu_usage()},'
+        + f'"swap_usage": {get_swap_usage()},'
+        + f'"power_status": "{get_rpi_power_status()}",'
+        + f'"last_boot": "{get_last_boot()}",'
+        + f'"last_message": "{get_last_message()}"'
     )
     if "check_available_updates" in settings and settings["check_available_updates"] and not apt_disabled:
-        payload_str = payload_str + ', "updates": ' + get_updates()
+        payload_str = payload_str + f', "updates": {get_updates()}' 
     if "check_wifi_strength" in settings and settings["check_wifi_strength"]:
-        payload_str = payload_str + ', "wifi_strength": ' + get_wifi_strength()
+        payload_str = payload_str + f', "wifi_strength": {get_wifi_strength()}'
     if "external_drives" in settings:
         for drive in settings["external_drives"]:
             payload_str = (
-                payload_str
-                + ', "disk_use_'
-                + drive.lower()
-                + '": '
-                + get_disk_usage(settings["external_drives"][drive])
+                payload_str + f', "disk_use_{drive.lower()}": {get_disk_usage(settings["external_drives"][drive])}'
             )
     payload_str = payload_str + "}"
     mqttClient.publish(
-        topic="system-sensors/sensor/" + deviceName + "/state",
+        topic=f"system-sensors/sensor/{deviceName}/state",
         payload=payload_str,
         qos=1,
         retain=False,
@@ -183,55 +175,31 @@ def get_wifi_strength():  # check_output(["/proc/net/wireless", "grep wlan0"])
 
 
 def get_rpi_power_status():
-    _throttled = open(SYSFILE, "r").read()[:-1]
-    _throttled = _throttled[:4]
-
-    if "power_integer_state" in settings and settings["power_integer_state"]:
-        return _throttled
-    else:
-        if _throttled == "0":
-            return "Everything is working as intended"
-        elif _throttled == "1000":
-            return "Under-voltage was detected, consider getting a uninterruptible power supply for your Raspberry Pi."
-        elif _throttled == "2000":
-            return "Your Raspberry Pi is limited due to a bad powersupply, replace the power supply cable or power supply itself."
-        elif _throttled == "3000":
-            return "Your Raspberry Pi is limited due to a bad powersupply, replace the power supply cable or power supply itself."
-        elif _throttled == "4000":
-            return "The Raspberry Pi is throttled due to a bad power supply this can lead to corruption and instability, please replace your changer and cables."
-        elif _throttled == "5000":
-            return "The Raspberry Pi is throttled due to a bad power supply this can lead to corruption and instability, please replace your changer and cables."
-        elif _throttled == "8000":
-            return "Your Raspberry Pi is overheating, consider getting a fan or heat sinks."
-        else:
-            return "There is a problem with your power supply or system."
+    return _underVoltage.get()
 
 
 def check_settings(settings):
     if "mqtt" not in settings:
-        print("Mqtt not defined in settings.yaml! Please check the documentation")
-        sys.stdout.flush()
+        write_message_to_console("Mqtt not defined in settings.yaml! Please check the documentation")
         sys.exit()
     if "hostname" not in settings["mqtt"]:
-        print("Hostname not defined in settings.yaml! Please check the documentation")
-        sys.stdout.flush()
+        write_message_to_console("Hostname not defined in settings.yaml! Please check the documentation")
         sys.exit()
     if "timezone" not in settings:
-        print("Timezone not defined in settings.yaml! Please check the documentation")
-        sys.stdout.flush()
+        write_message_to_console("Timezone not defined in settings.yaml! Please check the documentation")
         sys.exit()
     if "deviceName" not in settings:
-        print("deviceName not defined in settings.yaml! Please check the documentation")
-        sys.stdout.flush()
+        write_message_to_console("deviceName not defined in settings.yaml! Please check the documentation")
         sys.exit()
     if "client_id" not in settings:
-        print("client_id not defined in settings.yaml! Please check the documentation")
-        sys.stdout.flush()
+        write_message_to_console("client_id not defined in settings.yaml! Please check the documentation")
         sys.exit()
+    if "power_integer_state" in settings:
+        write_message_to_console("power_integer_state is deprecated please remove this option power state is now a binary_sensor!")
 
 
 def send_config_message(mqttClient):
-    print("send config message")
+    write_message_to_console("send config message")
     mqttClient.publish(
         topic=f"homeassistant/sensor/{deviceName}/{deviceName}Temp/config",
         payload='{"device_class":"temperature",'
@@ -304,15 +272,22 @@ def send_config_message(mqttClient):
         retain=True,
     )
     mqttClient.publish(
-        topic=f"homeassistant/sensor/{deviceName}/{deviceName}PowerStatus/config",
-        payload=f"{{\"name\":\"{deviceName} PowerStatus\","
+        topic=f"homeassistant/binary_sensor/{deviceName}/{deviceName}PowerStatus/config",
+        payload='{"device_class":"problem",'
+                + f"\"name\":\"{deviceName} UnderVoltage\","
                 + f"\"state_topic\":\"system-sensors/sensor/{deviceName}/state\","
                 + '"value_template":"{{value_json.power_status}}",'
                 + f"\"unique_id\":\"{deviceName.lower()}_sensor_power_status\","
                 + f"\"availability_topic\":\"system-sensors/sensor/{deviceName}/availability\","
                 + f"\"device\":{{\"identifiers\":[\"{deviceName.lower()}_sensor\"],"
-                + f"\"name\":\"{deviceName} Sensors\",\"model\":\"RPI {deviceName}\", \"manufacturer\":\"RPI\"}},"
-                + f"\"icon\":\"mdi:power-plug\"}}",
+                + f"\"name\":\"{deviceName} Sensors\",\"model\":\"RPI {deviceName}\", \"manufacturer\":\"RPI\"}}"
+                + f"}}",
+        qos=1,
+        retain=True,
+    )
+    mqttClient.publish(
+        topic=f"homeassistant/sensor/{deviceName}/{deviceName}PowerStatus/config",
+        payload='',
         qos=1,
         retain=True,
     )
@@ -349,7 +324,7 @@ def send_config_message(mqttClient):
     if "check_available_updates" in settings and settings["check_available_updates"]:
         # import apt
         if(apt_disabled):
-            print("import of apt failed!")
+            write_message_to_console("import of apt failed!")
         else:
             mqttClient.publish(
                 topic=f"homeassistant/sensor/{deviceName}/{deviceName}Updates/config",
@@ -410,10 +385,10 @@ def _parser():
 
 def on_connect(client, userdata, flags, rc):
     if rc == 0:
-        print("Connected to broker")
+        write_message_to_console("Connected to broker")
         client.subscribe("hass/status")
     else:
-        print("Connection failed")
+        write_message_to_console("Connection failed")
 
 
 if __name__ == "__main__":
@@ -443,7 +418,8 @@ def on_connect(client, userdata, flags, rc):
     try:
         send_config_message(mqttClient)
     except:
-        print("something whent wrong")
+        write_message_to_console("something whent wrong")
+    _underVoltage = new_under_voltage()
     job = Job(interval=timedelta(seconds=WAIT_TIME_SECONDS), execute=updateSensors)
     job.start()
 
@@ -454,11 +430,10 @@ def on_connect(client, userdata, flags, rc):
             sys.stdout.flush()
             time.sleep(1)
         except ProgramKilled:
-            print("Program killed: running cleanup code")
+            write_message_to_console("Program killed: running cleanup code")
             mqttClient.publish(f"system-sensors/sensor/{deviceName}/availability", "offline", retain=True)
             mqttClient.disconnect()
             mqttClient.loop_stop()
             sys.stdout.flush()
             job.stop()
             break
-