Add documentation (readme) and translations for the keep-alive feature

pdcastro · pdcastro · commit d8243f8493b5 · 2024-01-28T16:59:38.000Z
diff --git a/README-fr.md b/README-fr.md
@@ -245,6 +245,9 @@ En fonction de votre choix sur le type de thermostat, vous devrez choisir une ou
 
 ### Pour un thermostat de type ```thermostat_over_switch```
 ![image](images/config-linked-entity.png)
+
+Certains équipements nécessitent d'être périodiquement sollicités pour empêcher un arrêt de sécurité. Connu sous le nom de "keep-alive" cette fonction est activable en entrant un nombre de secondes non nul dans le champ d'intervalle keep-alive du thermostat. Pour désactiver la fonction ou en cas de doute, laissez-le vide ou entrez zéro (valeur par défaut).
+
 L'algorithme à utiliser est aujourd'hui limité à TPI est disponible. Voir [algorithme](#algorithme).
 Si plusieurs entités de type sont configurées, la thermostat décale les activations afin de minimiser le nombre de switch actif à un instant t. Ca permet une meilleure répartition de la puissance puisque chaque radiateur va s'allumer à son tour.
 Exemple de déclenchement synchronisé :
@@ -689,6 +692,7 @@ context:
 | ``heater_entity2_id``                     | 2ème radiateur                                                                    | X             | -                   | -            | -                        |
 | ``heater_entity3_id``                     | 3ème radiateur                                                                    | X             | -                   | -            | -                        |
 | ``heater_entity4_id``                     | 4ème radiateur                                                                    | X             | -                   | -            | -                        |
+| ``heater_keep_alive``                     | Intervalle de rafraichissement du switch                                          | X             | -                   | -            | -                        |
 | ``proportional_function``                 | Algorithme                                                                        | X             | -                   | -            | -                        |
 | ``climate_entity1_id``                    | Thermostat sous-jacent                                                            | -             | X                   | -            | -                        |
 | ``climate_entity2_id``                    | 2ème thermostat sous-jacent                                                       | -             | X                   | -            | -                        |
diff --git a/README.md b/README.md
@@ -41,7 +41,7 @@
     - [How to find the right service?](#how-to-find-the-right-service)
     - [The events](#the-events)
     - [Warning](#warning)
-  - [Parameters synthesis](#parameters-synthesis)
+  - [Parameter summary](#parameter-summary)
 - [Examples tuning](#examples-tuning)
   - [Electrical heater](#electrical-heater)
   - [Central heating (gaz or fuel heating system)](#central-heating-gaz-or-fuel-heating-system)
@@ -244,7 +244,10 @@ Depending on your choice of thermostat type, you will need to choose one or more
 It is possible to choose an over switch thermostat which controls air conditioning by checking the "AC Mode" box. In this case, only the cooling mode will be visible.
 
 ### For a ```thermostat_over_switch``` type thermostat
-![image](images/config-linked-entity.png)
+![image](images/en/config-linked-entity.png)
+
+Some heater switches require regular "keep-alive messages" to prevent them from triggering a failsafe switch off. This feature can be enabled through the switch keep-alive interval configuration field.
+
 The algorithm to use is currently limited to TPI is available. See [algorithm](#algorithm).
 If several type entities are configured, the thermostat shifts the activations in order to minimize the number of switches active at a time t. This allows for better power distribution since each radiator will turn on in turn.
 Example of synchronized triggering:
@@ -654,9 +657,9 @@ context:
 > ![Tip](images/tips.png) _*Notes*_
 > Controlling a central boiler using software or hardware such as home automation can pose risks to its proper functioning. Before using these functions, make sure that your boiler has safety functions and that they are working. Turning on a boiler if all the taps are closed can generate excess pressure, for example.
 
-## Parameters synthesis
+## Parameter summary
 
-| Paramètre                                 | Libellé                                                                       | "over switch" | "over climate"      | "over valve" | "central configuration" |
+| Parameter                                 | Description                                                                   | "over switch" | "over climate"      | "over valve" | "central configuration" |
 | ----------------------------------------- | ----------------------------------------------------------------------------- | ------------- | ------------------- | ------------ | ----------------------- |
 | ``name``                                  | Name                                                                          | X             | X                   | X            | -                       |
 | ``thermostat_type``                       | Thermostat type                                                               | X             | X                   | X            | -                       |
@@ -675,6 +678,7 @@ context:
 | ``heater_entity2_id``                     | 2nd heater switch                                                             | X             | -                   | -            | -                       |
 | ``heater_entity3_id``                     | 3rd heater switch                                                             | X             | -                   | -            | -                       |
 | ``heater_entity4_id``                     | 4th heater switch                                                             | X             | -                   | -            | -                       |
+| ``heater_keep_alive``                     | Switch keep-alive interval                                                    | X             | -                   | -            | -                       |
 | ``proportional_function``                 | Algorithm                                                                     | X             | -                   | X            | -                       |
 | ``climate_entity1_id``                    | 1rst underlying climate                                                       | -             | X                   | -            | -                       |
 | ``climate_entity2_id``                    | 2nd underlying climate                                                        | -             | X                   | -            | -                       |
diff --git a/custom_components/versatile_thermostat/translations/fr.json b/custom_components/versatile_thermostat/translations/fr.json
@@ -46,6 +46,7 @@
           "heater_entity2_id": "2ème radiateur",
           "heater_entity3_id": "3ème radiateur",
           "heater_entity4_id": "4ème radiateur",
+          "heater_keep_alive": "Intervalle keep-alive du switch en secondes",
           "proportional_function": "Algorithme",
           "climate_entity_id": "Thermostat sous-jacent",
           "climate_entity2_id": "2ème thermostat sous-jacent",
@@ -67,6 +68,7 @@
           "heater_entity2_id": "Optionnel entity id du 2ème radiateur",
           "heater_entity3_id": "Optionnel entity id du 3ème radiateur",
           "heater_entity4_id": "Optionnel entity id du 4ème radiateur",
+          "heater_keep_alive": "Intervalle de rafraichissement du switch en secondes. Laisser vide pour désactiver. À n'utiliser que pour les switchs qui le nécessite.",
           "proportional_function": "Algorithme à utiliser (Seul TPI est disponible pour l'instant)",
           "climate_entity_id": "Entity id du thermostat sous-jacent",
           "climate_entity2_id": "Entity id du 2ème thermostat sous-jacent",
@@ -293,6 +295,7 @@
           "heater_entity2_id": "2ème radiateur",
           "heater_entity3_id": "3ème radiateur",
           "heater_entity4_id": "4ème radiateur",
+          "heater_keep_alive": "Intervalle keep-alive du switch en secondes",
           "proportional_function": "Algorithme",
           "climate_entity_id": "Thermostat sous-jacent",
           "climate_entity2_id": "2ème thermostat sous-jacent",
@@ -314,6 +317,7 @@
           "heater_entity2_id": "Optionnel entity id du 2ème radiateur",
           "heater_entity3_id": "Optionnel entity id du 3ème radiateur",
           "heater_entity4_id": "Optionnel entity id du 4ème radiateur",
+          "heater_keep_alive": "Intervalle de rafraichissement du switch en secondes. Laisser vide pour désactiver. À n'utiliser que pour les switchs qui le nécessite.",
           "proportional_function": "Algorithme à utiliser (Seul TPI est disponible pour l'instant)",
           "climate_entity_id": "Entity id du thermostat sous-jacent",
           "climate_entity2_id": "Entity id du 2ème thermostat sous-jacent",
diff --git a/custom_components/versatile_thermostat/translations/it.json b/custom_components/versatile_thermostat/translations/it.json
@@ -29,6 +29,7 @@
           "heater_entity2_id": "Secondo riscaldatore",
           "heater_entity3_id": "Terzo riscaldatore",
           "heater_entity4_id": "Quarto riscaldatore",
+          "heater_keep_alive": "Intervallo keep-alive dell'interruttore in secondi",
           "proportional_function": "Algoritmo",
           "climate_entity_id": "Primo termostato",
           "climate_entity2_id": "Secondo termostato",
@@ -48,6 +49,7 @@
           "heater_entity2_id": "Entity id del secondo riscaldatore facoltativo. Lasciare vuoto se non utilizzato",
           "heater_entity3_id": "Entity id del terzo riscaldatore facoltativo. Lasciare vuoto se non utilizzato",
           "heater_entity4_id": "Entity id del quarto riscaldatore facoltativo. Lasciare vuoto se non utilizzato",
+          "heater_keep_alive": "Frequenza di aggiornamento dell'interruttore (facoltativo). Lasciare vuoto se non richiesto.",
           "proportional_function": "Algoritmo da utilizzare (il TPI per adesso è l'unico)",
           "climate_entity_id": "Entity id del primo termostato",
           "climate_entity2_id": "Entity id del secondo termostato",
@@ -191,6 +193,7 @@
           "heater_entity2_id": "Secondo riscaldatore",
           "heater_entity3_id": "Terzo riscaldatore",
           "heater_entity4_id": "Quarto riscaldatore",
+          "heater_keep_alive": "Intervallo keep-alive dell'interruttore in secondi",
           "proportional_function": "Algoritmo",
           "climate_entity_id": "Primo termostato",
           "climate_entity2_id": "Secondo termostato",
@@ -210,6 +213,7 @@
           "heater_entity2_id": "Entity id del secondo riscaldatore facoltativo. Lasciare vuoto se non utilizzato",
           "heater_entity3_id": "Entity id del terzo riscaldatore facoltativo. Lasciare vuoto se non utilizzato",
           "heater_entity4_id": "Entity id del quarto riscaldatore facoltativo. Lasciare vuoto se non utilizzato",
+          "heater_keep_alive": "Frequenza di aggiornamento dell'interruttore (facoltativo). Lasciare vuoto se non richiesto.",
           "proportional_function": "Algoritmo da utilizzare (il TPI per adesso è l'unico)",
           "climate_entity_id": "Entity id del primo termostato",
           "climate_entity2_id": "Entity id del secondo termostato",
diff --git a/images/config-linked-entity.png b/images/config-linked-entity.png
diff --git a/images/en/config-linked-entity.png b/images/en/config-linked-entity.png
