From 27da4bf08d1a77977273a60c94ad865294386e4a Mon Sep 17 00:00:00 2001 From: Tiaan Viljoen Date: Tue, 19 Jan 2021 07:34:25 +0200 Subject: [PATCH] Update README.md Added additional sensor and config info --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8a73b7f..4626f0d 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,9 @@ [![BuyMeCoffee][buymecoffeebadge]][buymecoffee] This is a simple component to integrate with the [Eskom Loadshedding API](https://loadshedding.eskom.co.za/LoadShedding) and provide [loadshedding](https://en.wikipedia.org/wiki/South_African_energy_crisis)-related status information. +Forked from [swartjean/ha-eskom-loadshedding](swartjean/ha-eskom-loadshedding) -This integration exposes a sensor for the current stage of loadshedding. +This integration exposes a sensor for the current stage of loadshedding. It also calculates the loadshedding shedule for COCT, and can provide a sensor indicating if the selected Area is currently in loadshedding, as well as when the next loadshedding slot for the selected area will be. this depends of course on the current loadshedding stage. **This component will set up the following platforms.** @@ -18,6 +19,14 @@ Platform | Description -- | -- `sensor` | Show loadshedding status information. +**This component will create the following sensors.** + +Sensor | Description +-- | -- +`sensor.eskom_loadshedding_stage` | Show Current Loadshedding Stage from Eskom API (Numeric). +`sensor.eskom_loadshedding_load_shedding_active` | Is the configured Area currently in loadshedding (True/False). +`sensor.eskom_loadshedding_next_load_shedding` | When the next scheduled loadshedding for the area will take place (DateTime). + ## Installation 1. Using the tool of choice open the directory (folder) for your HA configuration (where you find `configuration.yaml`). @@ -30,6 +39,11 @@ Platform | Description ## Configuration is done in the UI +1. Configure the Scan Period (update frequency in seconds). Default is 900s. +2. Configure the Area as per COCT map. + +NOTE: Long refresh rates kan delay the change of the sensor, as the current implementation does not run on ZERO hour, and refresh times are dependent on startup time. This generally is not an issue in practice. It just seems erratic if you are monitoring the sensor(s). + [buymecoffee]: https://www.buymeacoffee.com/swartjean