From 0878ce3e9270c8095a98f132162a3c2b0ee93920 Mon Sep 17 00:00:00 2001 From: Toast Date: Fri, 12 Apr 2019 12:18:29 +0200 Subject: [PATCH] Update README.md --- README.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index d38c069..f187dd1 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,18 @@ Place the component at this location on your setup: * Hass.io: `/custom_components/rpi_power/sensor.py` * Hassbian / Other: `/custom_components/rpi_power/sensor.py` +Here is a list of the current values the component checks for + +| Value | Description | +| ------------- | ------------- | +| 0 | Everything is working as intended | +| 1000* | Under-voltage was detected, consider getting a uninterruptible power supply for your Raspberry Pi. | +| 2000* | Your Raspberry Pi is limited due to a bad powersupply, replace the power supply. | +| 3000* | Your Raspberry Pi is limited due to a bad powersupply, replace the power supply. | +| 4000* | The Raspberry Pi is throttled due to a bad power supply this can lead to corruption and instability, please replace your changer and cables. | +| 5000* | The Raspberry Pi is throttled due to a bad power supply this can lead to corruption and instability, please replace your changer and cables. | +| 8000* | Your Raspberry Pi is overheating, consider getting a fan or heat sinks. | + ***Example configuration.yaml*** ```yaml @@ -54,16 +66,6 @@ and then this as an automation that sets off a notification in homeassistant. Due to how `custom_components` are loaded, it is normal to see a `ModuleNotFoundError` error on first boot after adding this, to resolve it, restart Home-Assistant. -| Value | Description | -| ------------- | ------------- | -| 0 | Everything is working as intended | -| 1000* | Under-voltage was detected, consider getting a uninterruptible power supply for your Raspberry Pi. | -| 2000* | Your Raspberry Pi is limited due to a bad powersupply, replace the power supply. | -| 3000* | Your Raspberry Pi is limited due to a bad powersupply, replace the power supply. | -| 4000* | The Raspberry Pi is throttled due to a bad power supply this can lead to corruption and instability, please replace your changer and cables. | -| 5000* | The Raspberry Pi is throttled due to a bad power supply this can lead to corruption and instability, please replace your changer and cables. | -| 8000* | Your Raspberry Pi is overheating, consider getting a fan or heat sinks. | - ## Issues Use the bugtracker for your issues if a value is missing please use the following command to get the value