Update documentation

README-fr.md

@@ -30,6 +30,7 @@
   - [Mes presets](#mes-presets)
 - [Algorithme](#algorithme)
   - [Algorithme TPI](#algorithme-tpi)
+- [Capteurs](#capteurs)
 - [Services](#services)
   - [Forcer la présence/occupation](#forcer-la-présenceoccupation)
   - [Modifier la température des préréglages](#modifier-la-température-des-préréglages)
@@ -73,9 +74,10 @@ Ce composant nommé __Versatile thermostat__ gère les cas d'utilisation suivant
 - Éteindre/allumer un thermostat lorsqu'une **porte ou des fenêtres sont ouvertes/fermées** après un certain délai,
 - Changer de preset lorsqu'une **activité est détectée** ou non dans une pièce pendant un temps défini,
 - Utiliser un algorithme **TPI (Time Proportional Interval)** grâce à l'algorithme [[Argonaute](https://forum.hacf.fr/u/argonaute/summary)] ,
-- Ajoutez une **gestion de délestage** ou une régulation pour ne pas dépasser une puissance totale définie. Lorsque la puissance maximale est dépassée, un préréglage caché de « puissance » est défini sur l'entité climatique. Lorsque la puissance passe en dessous du maximum, le préréglage précédent est restauré.
-- Ajouter la **gestion de la présence à domicile**. Cette fonctionnalité vous permet de modifier dynamiquement la température du préréglage en tenant compte d'un capteur de présence de votre maison.
-- Ajoutez des **services pour interagir avec le thermostat** à partir d'autres intégrations : vous pouvez forcer la présence / la non-présence à l'aide d'un service, et vous pouvez modifier dynamiquement la température des préréglages et changer les paramètres de sécurité.
+- Ajouter une **gestion de délestage** ou une régulation pour ne pas dépasser une puissance totale définie. Lorsque la puissance maximale est dépassée, un préréglage caché de « puissance » est défini sur l'entité climatique. Lorsque la puissance passe en dessous du maximum, le préréglage précédent est restauré.
+- La **gestion de la présence à domicile**. Cette fonctionnalité vous permet de modifier dynamiquement la température du préréglage en tenant compte d'un capteur de présence de votre maison.
+- Des **services pour interagir avec le thermostat** à partir d'autres intégrations : vous pouvez forcer la présence / la non-présence à l'aide d'un service, et vous pouvez modifier dynamiquement la température des préréglages et changer les paramètres de sécurité.
+- Ajouter des capteurs pour voir les états internes du thermostat.
 
 # Comment installer cet incroyable Thermostat Versatile ?
 
@@ -121,7 +123,8 @@ Donnez les principaux attributs obligatoires :
 5. une entité capteur de température donnant la température extérieure. Si vous n'avez pas de capteur externe, vous pouvez utiliser l'intégration météo locale
 6. une durée de cycle en minutes. A chaque cycle, le radiateur s'allumera puis s'éteindra pendant une durée calculée afin d'atteindre la température ciblée (voir [preset](#configure-the-preset-temperature) ci-dessous),
 7. les températures minimales et maximales du thermostat,
-8. la liste des fonctionnalités qui seront utilisées pour ce thermostat. En fonction de vos choix, les écrans de configuration suivants s'afficheront ou pas.
+8. une puissance de l'équipement ce qui va activer les capteurs de puissance et énergie consommée par l'appareil,
+9. la liste des fonctionnalités qui seront utilisées pour ce thermostat. En fonction de vos choix, les écrans de configuration suivants s'afficheront ou pas.
 
 > ![Astuce](https://github.com/jmcollin78/versatile_thermostat/blob/main/images/tips.png?raw=true) _*Notes*_
       1. avec le type ```thermostat_over_swutch```, les calculs sont effectués à chaque cycle. Donc en cas de changement de conditions, il faudra attendre le prochain cycle pour voir un changement. Pour cette raison, le cycle ne doit pas être trop long. **5 min est une bonne valeur**,
@@ -213,7 +216,7 @@ Si vous avez choisi la fonctionnalité ```Avec détection de la puissance```, cl
 
 ![image](https://github.com/jmcollin78/versatile_thermostat/blob/main/images/config-power.png?raw=true)
 
-Cette fonction vous permet de réguler la consommation électrique de vos radiateurs. Connue sous le nom de délestage, cette fonction vous permet de limiter la consommation électrique de votre appareil de chauffage si des conditions de surpuissance sont détectées. Donnez un **capteur à la consommation électrique actuelle de votre maison**, un **capteur à la puissance max** qu'il ne faut pas dépasser, la **consommation électrique de votre chauffage** et l'algorithme ne démarrera pas un radiateur si la puissance maximale sera dépassée après le démarrage du radiateur.
+Cette fonction vous permet de réguler la consommation électrique de vos radiateurs. Connue sous le nom de délestage, cette fonction vous permet de limiter la consommation électrique de votre appareil de chauffage si des conditions de surpuissance sont détectées. Donnez un **capteur à la consommation électrique actuelle de votre maison**, un **capteur à la puissance max** qu'il ne faut pas dépasser, la **consommation électrique de votre chauffage** (en étape 1 de la configuration) et l'algorithme ne démarrera pas un radiateur si la puissance maximale sera dépassée après le démarrage du radiateur.
 
 Notez que toutes les valeurs de puissance doivent avoir les mêmes unités (kW ou W par exemple).
 Cela vous permet de modifier la puissance maximale au fil du temps à l'aide d'un planificateur ou de ce que vous voulez.
@@ -330,6 +333,27 @@ Pour régler ces coefficients, gardez à l'esprit que :
 
 Voir quelques situations à [examples](#some-results).
 
+# Capteurs
+
+Avec le thermostat sont disponibles des capteurs qui permettent de visualiser les alertes et l'état interne du thermostat. Ils sont disponibles dans les entités de l'appareil associé au thermostat :
+
+![image](https://github.com/jmcollin78/versatile_thermostat/blob/main/images/thermostat-sensors.png?raw=true)
+
+Dans l'ordre, il y a :
+1. l'entité principale climate de commande du thermostat,
+2. l'énergie consommée par le thermostat (valeur qui s'incrémente en permanence),
+3. l'heure de réception de la dernière température extérieure,
+4. l'heure de réception de la dernière température intérieure,
+5. la puissance moyenne de l'appareil sur le cycle (pour les TPI seulement),
+6. le temps passé à l'état éteint dans le cycle (TPI seulement),
+7. le temps passé à l'état allumé dans le cycle (TPI seulement),
+8. l'état de délestage,
+9. le pourcentage de puissance sur le cycle (TPI seulement),
+10. l'état de présence (si la gestion de la présence est configurée),
+11. l'état de sécurité,
+12. l'état de l'ouverture (si la gestion des ouvertures est configurée),
+13. l'état du mouvement (si la gestion du mouvements est configurée)
+
 # Services
 
 Cette implémentation personnalisée offre des services spécifiques pour faciliter l'intégration avec d'autres composants Home Assistant.
@@ -420,25 +444,25 @@ Les attributs personnalisés sont les suivants :
 | ``[eco/confort/boost]_temp`` | La température configurée pour le préréglage xxx |
 | ``[eco/confort/boost]_away_temp`` | La température configurée pour le préréglage xxx lorsque la présence est désactivée ou not_home |
 | ``temp_power`` | La température utilisée lors de la détection de la perte |
-| ``on_percent`` | Le pourcentage sur calculé par l'algorithme TPI |
-| ``on_time_sec`` | La période On en sec. Doit être ```on_percent * cycle_min``` |
-| ``off_time_sec`` | La période d'arrêt en sec. Doit être ```(1 - on_percent) * cycle_min``` |
+| ``on_percent`` | (déprécié) Le pourcentage sur calculé par l'algorithme TPI |
+| ``on_time_sec`` | (déprécié) La période On en sec. Doit être ```on_percent * cycle_min``` |
+| ``off_time_sec`` | (déprécié) La période d'arrêt en sec. Doit être ```(1 - on_percent) * cycle_min``` |
 | ``cycle_min`` | Le cycle de calcul en minutes |
 | ``function`` | L'algorithme utilisé pour le calcul du cycle |
 | ``tpi_coef_int`` | Le ``coef_int`` de l'algorithme TPI |
 | ``tpi_coef_ext`` | Le ``coef_ext`` de l'algorithme TPI |
 | ``saved_preset_mode`` | Le dernier preset utilisé avant le basculement automatique du preset |
 | ``saved_target_temp`` | La dernière température utilisée avant la commutation automatique |
-| ``window_state`` | Le dernier état connu du capteur de fenêtre. Aucun si la fenêtre n'est pas configurée |
-| ``motion_state`` | Le dernier état connu du capteur de mouvement. Aucun si le mouvement n'est pas configuré |
-| ``overpowering_state`` | Le dernier état connu du capteur surpuissant. Aucun si la gestion de l'alimentation n'est pas configurée |
-| ``presence_state`` | Le dernier état connu du capteur de présence. Aucun si la gestion de présence n'est pas configurée |
+| ``window_state`` | (déprécié) Le dernier état connu du capteur de fenêtre. Aucun si la fenêtre n'est pas configurée |
+| ``motion_state`` | (déprécié) Le dernier état connu du capteur de mouvement. Aucun si le mouvement n'est pas configuré |
+| ``overpowering_state`` | (déprécié) Le dernier état connu du capteur surpuissant. Aucun si la gestion de l'alimentation n'est pas configurée |
+| ``presence_state`` | (déprécié) Le dernier état connu du capteur de présence. Aucun si la gestion de présence n'est pas configurée |
 | ``security_delay_min`` | Le délai avant de régler le mode de sécurité lorsque le capteur de température est éteint |
 | ``security_min_on_percent`` | Pourcentage de chauffe en dessous duquel le thermostat ne passera pas en sécurité |
 | ``security_default_on_percent`` | Pourcentage de chauffe utilisé lorsque le thermostat est en sécurité |
-| ``last_temperature_datetime`` | La date et l'heure au format ISO8866 de la dernière réception de température interne |
-| ``last_ext_temperature_datetime`` | La date et l'heure au format ISO8866 de la dernière réception de température extérieure |
-| ``security_state`` | L'état de sécurité. vrai ou faux |
+| ``last_temperature_datetime`` | (déprécié) La date et l'heure au format ISO8866 de la dernière réception de température interne |
+| ``last_ext_temperature_datetime`` | (déprécié) La date et l'heure au format ISO8866 de la dernière réception de température extérieure |
+| ``security_state`` | (déprécié) L'état de sécurité. vrai ou faux |
 | ``minimal_activation_delay_sec`` | Le délai d'activation minimal en secondes |
 | ``last_update_datetime`` | La date et l'heure au format ISO8866 de cet état |
 | ``friendly_name`` | Le nom du thermostat |
@@ -524,6 +548,24 @@ Exemple de configuration :
           name: Porte sam
 ```
 
+Vous pouvez personnaliser ce composant à l'aide du composant HACS card-mod pour ajuster les couleurs des alertes. Exemple pour afficher en rouge les alertes sécurité et délestage :
+
+```
+          card_mod:
+            style: |
+              {% if is_state('binary_sensor.thermostat_chambre_security_state', 'on') %}
+              ha-card .body .sensor-heading ha-icon[icon="mdi:alert-outline"] {
+                color: red;
+              }
+              {% endif %}
+              {% if is_state('binary_sensor.thermostat_chambre_overpowering_state', 'on') %}
+              ha-card .body .sensor-heading ha-icon[icon="mdi:flash"] {
+                color: red;
+              }
+              {% endif %}
+```
+![image](https://github.com/jmcollin78/versatile_thermostat/blob/main/images/custom-css-thermostat.png?raw=true)
+
 ## Toujours mieux avec Apex-chart pour régler votre thermostat
 Vous pouvez obtenir une courbe comme celle présentée dans [some results](#some-results) avec une sorte de configuration de graphique Apex uniquement en utilisant les attributs personnalisés du thermostat décrits [ici](#custom-attributes) :
 

README.md

@@ -30,6 +30,7 @@
   - [My preset configuration](#my-preset-configuration)
 - [Algorithm](#algorithm)
   - [TPI algorithm](#tpi-algorithm)
+- [Sensors](#sensors)
 - [Services](#services)
   - [Force the presence / occupancy](#force-the-presence--occupancy)
   - [Change the temperature of presets](#change-the-temperature-of-presets)
@@ -74,6 +75,7 @@ This component named __Versatile thermostat__ manage the following use cases :
 - Add **power shedding management** or regulation to avoid exceeding a defined total power. When max power is exceeded, a hidden 'power' preset is set on the climate entity. When power goes below the max, the previous preset is restored.
 - Add **home presence management**. This feature allows you to dynamically change the temperature of preset considering a occupancy sensor of your home.
 - Add **services to interact with the thermostat** from others integration: you can force the presence / un-presence using a service, and you can dynamically change the temperature of the presets and change dynamically the security parameters.
+- Add sensors to see the internal states of the thermostat
 
 # How to install this incredible Versatile Thermostat ?
 
@@ -117,7 +119,8 @@ Give the main mandatory attributes:
 5. a temperature sensor entity giving the outside temperature. If you don't have an external sensor, you can use local weather integration
 6. a cycle duration in minutes. On each cycle, the heater will cycle on and then off for a calculated time to reach the target temperature (see [preset](#configure-the-preset-temperature) below),
 7. minimum and maximum thermostat temperatures,
-8. the list of features that will be used for this thermostat. Depending on your choices, the following configuration screens will appear or not.
+8. the power of the l'équipement which will activate the power and energy sensors of the device,
+9. the list of features that will be used for this thermostat. Depending on your choices, the following configuration screens will appear or not.
 
 > ![Tip](https://github.com/jmcollin78/versatile_thermostat/blob/main/images/tips.png?raw=true) _*Notes*_
       1. With the ```thermostat_over_switch``` type, calculation are done at each cycle. So in case of conditions change, you will have to wait for the next cycle to see a change. For this reason, the cycle should not be too long. **5 min is a good value**,
@@ -198,7 +201,7 @@ For this to work, the climate thermostat should be in ``Activity`` preset mode.
 If you choose the ```Power management``` feature, click on 'Validate' on the previous page and you will get there:
 ![image](https://github.com/jmcollin78/versatile_thermostat/blob/main/images/config-power.png?raw=true)
 
-This feature allows you to regulate the power consumption of your radiators. Known as shedding, this feature allows you to limit the electrical power consumption of your heater if overpowering conditions are detected. Give a **sensor to the current power consumption of your house**, a **sensor to the max power** that should not be exceeded, the **power consumption of your heater** and the algorithm will not start a radiator if the max power will be exceeded after radiator starts.
+This feature allows you to regulate the power consumption of your radiators. Known as shedding, this feature allows you to limit the electrical power consumption of your heater if overpowering conditions are detected. Give a **sensor to the current power consumption of your house**, a **sensor to the max power** that should not be exceeded, the **power consumption of your heater** (in the first step of the configuration) and the algorithm will not start a radiator if the max power will be exceeded after radiator starts.
 
 
 Note that all power values should have the same units (kW or W for example).
@@ -316,6 +319,27 @@ To tune those coefficients keep in mind that:
 
 See some situations at [examples](#some-results).
 
+# Sensors
+
+With the thermostat are available sensors that allow you to view the alerts and the internal status of the thermostat. They are available in the entities of the device associated with the thermostat:
+
+![image](https://github.com/jmcollin78/versatile_thermostat/blob/main/images/thermostat-sensors.png?raw=true)
+
+In order, there are:
+1. the main climate thermostat command entity,
+2. the energy consumed by the thermostat (value which continuously increases),
+3. the time of receipt of the last outside temperature,
+4. the time of receipt of the last indoor temperature,
+5. the average power of the device over the cycle (for TPIs only),
+6. the time spent in the off state in the cycle (TPI only),
+7. the time spent in the on state in the cycle (TPI only),
+8. load shedding status,
+9. cycle power percentage (TPI only),
+10. presence status (if presence management is configured),
+11. security status,
+12. opening status (if opening management is configured),
+13. motion status (if motion management is configured)
+
 # Services
 
 This custom implementation offers some specific services to facilitate integration with others Home Assisstant components.
@@ -406,25 +430,25 @@ Custom attributes are the following:
 | ``[eco/comfort/boost]_temp`` | The temperature configured for the preset xxx |
 | ``[eco/comfort/boost]_away_temp`` | The temperature configured for the preset xxx when presence is off or not_home |
 | ``power_temp`` | The temperature used when shedding is detected |
-| ``on_percent`` | The percentage on calculated by the TPI algorithm |
-| ``on_time_sec`` | The On period in sec. Should be ```on_percent * cycle_min``` |
-| ``off_time_sec`` | The Off period in sec. Should be ```(1 - on_percent) * cycle_min``` |
+| ``on_percent`` | (deprecated) The percentage on calculated by the TPI algorithm |
+| ``on_time_sec`` | (deprecated) The On period in sec. Should be ```on_percent * cycle_min``` |
+| ``off_time_sec`` | (deprecated) The Off period in sec. Should be ```(1 - on_percent) * cycle_min``` |
 | ``cycle_min`` | The calculation cycle in minutes |
 | ``function`` | The algorithm used for cycle calculation |
 | ``tpi_coef_int`` | The ``coef_int`` of the TPI algorithm |
 | ``tpi_coef_ext`` | The ``coef_ext`` of the TPI algorithm |
 | ``saved_preset_mode`` | The last preset used before automatic switch of the preset |
 | ``saved_target_temp`` | The last temperature used before automatic switching |
-| ``window_state`` | The last known state of the window sensor. None if window is not configured |
-| ``motion_state`` | The last known state of the motion sensor. None if motion is not configured |
-| ``overpowering_state`` | The last known state of the overpowering sensor. None if power management is not configured |
-| ``presence_state`` | The last known state of the presence sensor. None if presence management is not configured |
+| ``window_state`` | (deprecated) The last known state of the window sensor. None if window is not configured |
+| ``motion_state`` | (deprecated) The last known state of the motion sensor. None if motion is not configured |
+| ``overpowering_state`` | (deprecated) The last known state of the overpowering sensor. None if power management is not configured |
+| ``presence_state`` | (deprecated) The last known state of the presence sensor. None if presence management is not configured |
 | ``security_delay_min`` | The delay before setting the security mode when temperature sensor are off |
 | ``security_min_on_percent`` | The minimal on_percent below which security preset won't be trigger |
 | ``security_default_on_percent`` | The on_percent used when thermostat is in ``security`` |
-| ``last_temperature_datetime`` | The date and time in ISO8866 format of the last internal temperature reception |
-| ``last_ext_temperature_datetime`` | The date and time in ISO8866 format of the last external temperature reception |
-| ``security_state`` | The security state. true or false |
+| ``last_temperature_datetime`` | (deprecated) The date and time in ISO8866 format of the last internal temperature reception |
+| ``last_ext_temperature_datetime`` | (deprecated) The date and time in ISO8866 format of the last external temperature reception |
+| ``security_state`` | (deprecated) The security state. true or false |
 | ``minimal_activation_delay_sec`` | The minimal activation delay in seconds |
 | ``last_update_datetime`` | The date and time in ISO8866 format of this state |
 | ``friendly_name`` | The name of the thermostat |
@@ -509,6 +533,23 @@ Example configuration:
           entity: input_boolean.etat_ouverture_porte_sam
           name: Porte sam
 ```
+You can customize this component using the HACS card-mod component to adjust the alert colors. Example for displaying safety and load shedding alerts in red:
+
+```
+          card_mod:
+            style: |
+              {% if is_state('binary_sensor.thermostat_chambre_security_state', 'on') %}
+              ha-card .body .sensor-heading ha-icon[icon="mdi:alert-outline"] {
+                color: red;
+              }
+              {% endif %}
+              {% if is_state('binary_sensor.thermostat_chambre_overpowering_state', 'on') %}
+              ha-card .body .sensor-heading ha-icon[icon="mdi:flash"] {
+                color: red;
+              }
+              {% endif %}
+```
+![image](https://github.com/jmcollin78/versatile_thermostat/blob/main/images/custom-css-thermostat.png?raw=true)
 
 ## Even better with Apex-chart to tune your Thermostat
 You can get curve like presented in [some results](#some-results) with kind of Apex-chart configuration only using the custom attributes of the thermostat described [here](#custom-attributes):