doc: Update temperature limiter documentation

XavierBerger · Dec 19, 2024 · f9e905b · f9e905b
1 parent c1fbddb
commit f9e905b
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 4 deletions.
diff --git a/docs/temperature_limiter_DS18B20.md b/docs/temperature_limiter_DS18B20.md
@@ -2,6 +2,8 @@
 
 This package is designed to monitor a temperature coming from a DS18B20 sensor connected on ESP32 and determines if a temperature threshold as been reached or not.
 
+When safety limit is reached, it is possible to turn on a LED. LED configuration has to be added in `substitutions` section as explained bellow.
+
 !!! danger "WARNING: Conduct some tests before letting the system regulate alone"
     This temperature limit monitoring and safety limit may have some bug. It is strongly advised to validate the behaviour of your system carefully before letting the system working by its own.
 
@@ -22,9 +24,12 @@ This package needs to know the GPIO used by the temperature to get the temperatu
 
 ```yaml linenums="1"
 substitutions:
-  # Power meter source -----------------------------------------------------------
-  # Sensor in home assistant gathering the hot water temperature
+  # Sensor in home assistant gathering the temperature
   DS18B20_pin: GPIO13
+  # Safety limit LED configuration
+  red_led_inverted: "False"
+  red_led_pin: GPIO4
+
 ```
 
 Additionnal optional parameters can be set into `substitutions` section such as `DS18B20_address` (which is optional) and `temperature_update_interval` (which is set by default to `5s`).
diff --git a/docs/temperature_limiter_home_assistant.md b/docs/temperature_limiter_home_assistant.md
@@ -2,6 +2,8 @@
 
 This package is designed to monitor a temperature coming from a sensor in Home Assistant and determines if a temperature threshold as been reached or not.
 
+When safety limit is reached, it is possible to turn on a LED. LED configuration has to be added in `substitutions` section as explained bellow.
+
 !!! danger "WARNING: Conduct some tests before letting the system regulate alone"
     This temperature limit monitoring and safety limit may have some bug. It is strongly advised to validate the behaviour of your system carefully before letting the system working by its own.
 
@@ -18,9 +20,11 @@ This package needs to know the sensor to use to get the temperature to monitor.
 
 ```yaml linenums="1"
 substitutions:
-  # Power meter source -----------------------------------------------------------
-  # Sensor in home assistant gathering the hot water temperature
+  # Sensor in home assistant gathering the temperature
   temperature_sensor: sensor.hot_water_temperature
+ # Safety limit LED configuration
+  red_led_inverted: "False"
+  red_led_pin: GPIO4
 ```
 !!! warning "Data availability and refresh rate"
     This temperature limiter rely on Home Assistant to gather the temperature. It also depends on the rate of sensor update. If a sensor is updated too slowly, the regulation may not work as expected.