refactor: BREAKING CHANGE rename engines for better understanding

XavierBerger · XavierBerger · commit 0830f2369858 · 2025-02-06T18:46:40.000+01:00
diff --git a/docs/en/compile_coverage.md b/docs/en/compile_coverage.md
@@ -4,7 +4,7 @@
 * common.yaml
 * power_meter_fronius.yaml
 * regulator_triac.yaml
-* engine_progressive.yaml
+* engine_1dimmer.yaml
 * energy_counter_theorical.yaml
 * temperature_limiter_DS18B20.yaml
 
@@ -13,11 +13,11 @@
 
 ## esp8266-standalone_on_off
 * power_meter_home_assistant.yaml
-* engine_on_off.yaml
+* engine_1switch.yaml
 * regulator_mecanical_relay.yaml
 * temperature_limiter_home_assistant.yaml
 
 ## esp8266-proxy-client
 * power_meter_proxy_client.yaml
-* engine_progressive_with_bypass.yaml
+* engine_1dimmer_1bypass.yaml
 * regulator_solid_state_relay.yaml
diff --git a/docs/en/engine.md b/docs/en/engine.md
@@ -1,8 +1,12 @@
-# Solar router engine
+# Solar router engines
 
 An engine is designed to define how many and when energy has to be diverted.
 
-Different kind of engine exists whach can progressively divert energy to a load and manage an ON/OFF switch.
+Different kind of engine exists whach can progressively divert energy to a load and manage an ON/OFF switch. See details into engine's dedicated pages.
+
+!!! note "Engine naming"
+    The name of engine is reflecting how energy divertion is performed:  
+    **Example** : `engine_1dimmer_1bypass` will manage 1 dimmer managing a progressive regulation associated with a bypass relay. 
 
 
 ### User feedback LEDS
diff --git a/docs/en/engine_1dimmer.md b/docs/en/engine_1dimmer.md
@@ -1,9 +1,9 @@
 
-# Progressive Engine
+# engine_1dimmer
 
 This package is implementing the engine of the solar router which determines when and how many energy has to be diverted to the load.
 
-**Progressive engine** calls every second the power meter to get the actual energy exchanged with the grid. If energy produce is greater than energy consummed and exceed the define echange target, the engine will determine the **percentage of the regulator "opening"** and adjusts it dynamically to reach the target.
+**engine_1dimmer** calls every second the power meter to get the actual energy exchanged with the grid. If energy produce is greater than energy consummed and exceed the define echange target, the engine will determine the **percentage of the regulator "opening"** and adjusts it dynamically to reach the target.
 
 Engine's automatic regulation can be activated or deactivated with the activation switch.
 
@@ -27,6 +27,6 @@ To use this package, add the following lines to your configuration file:
 packages:
   engine:
     url: https://github.com/XavierBerger/Solar-Router-for-ESPHome/
-    file: solar_router/engine_progressive.yaml
+    file: solar_router/engine_1dimmer.yaml
 ```
 
diff --git a/docs/en/engine_1dimmer_1bypass.md b/docs/en/engine_1dimmer_1bypass.md
@@ -1,10 +1,10 @@
-# Regulator with Bypass Engine
+# engine_1dimmer_1bypass
 
 This package implements the engine of the solar router which determines when and how much energy has to be diverted to the load, with a bypass function for maximum efficiency.
 
 When the regulator is intensively used for an extended period, the regulator will tends to overheat. This engine is designed to avoid this issue by activating a bypass relay and turning off the regulator when the regulator is opened at 100% for an extended period. To avoid flickering, the bypass relay is activated only when the regulator is opened at 100% for a number of consecutive regulation.
 
-**Regulator with Bypass engine** calls every second the power meter to get the actual energy exchanged with the grid. If energy produced is greater than energy consumed and exceeds the defined exchange target, the engine will determine the **percentage of regulator opening** and adjusts it dynamically to reach the target. When the regulator reaches 100% for an extended period, the bypass relay is activated for maximum efficiency.
+**engine_1dimmer_1bypass** calls every second the power meter to get the actual energy exchanged with the grid. If energy produced is greater than energy consumed and exceeds the defined exchange target, the engine will determine the **percentage of regulator opening** and adjusts it dynamically to reach the target. When the regulator reaches 100% for an extended period, the bypass relay is activated for maximum efficiency.
 
 Engine's automatic regulation can be activated or deactivated with the activation switch.
 
@@ -34,9 +34,9 @@ To use this package, add the following lines to your configuration file:
 
 ```yaml linenums="1"
 packages:
-  engine_regulator_with_bypass:
+  engine_regulator_1bypass:
     url: https://github.com/XavierBerger/Solar-Router-for-ESPHome/
-    file: solar_router/engine_regulator_with_bypass.yaml
+    file: solar_router/engine_regulator_1bypass.yaml
 ```
 
 !!! tip "Adjusting Bypass Tempo"
diff --git a/docs/en/engine_1switch.md b/docs/en/engine_1switch.md
@@ -1,15 +1,15 @@
 
-# ON/OFF Engine
+# engine_1switch
 
 This package is implementing the engine of the solar router which determines energy can be diverted to a local load or not.
 
-**ON/OFF engine** calls every second the power meter to get the actual power consumed. If energy sent to the grid is greater than the divertion start level (in W) during start tempo (in s), the relay is closed to use the energy locally. When the energy sent to the grid reach the level (in W) defined to stop the divertion during stop tempo (in s), the relay is openned and local consomption is stopped.
+**engine_1switch** calls every second the power meter to get the actual power consumed. If energy sent to the grid is greater than the divertion start level (in W) during start tempo (in s), the relay is closed to use the energy locally. When the energy sent to the grid reach the level (in W) defined to stop the divertion during stop tempo (in s), the relay is openned and local consomption is stopped.
 
-ON/OFF engine's automatic regulation can be activated or deactivated with the activation switch.
+engine_1switch's automatic regulation can be activated or deactivated with the activation switch.
 
 The following schema is representing the consumption with this engine activated:
 
-![engine_on_off](images/engine_on_off.png)
+![engine_1switch](images/engine_1switch.png)
 
 **Legend:**
 
@@ -36,7 +36,7 @@ To use this package, add the following lines to your configuration file:
 packages:
   engine:
     url: https://github.com/XavierBerger/Solar-Router-for-ESPHome/
-    file: solar_router/engine_on_off.yaml
+    file: solar_router/engine_1switch.yaml
 ```
 
 When this package is used it is required to define the following paramater is `substitution` section as show in the example bellow:
diff --git a/docs/en/example_proxy.md b/docs/en/example_proxy.md
@@ -6,7 +6,7 @@ The configuration of the **Proxy client** is only using a [Home Assistant power
 --8<-- "esp8285-power-meter-proxy.yaml"
 ```
 
-This configuration the **Solar Router** is using [Proxy client power meter](power_meter_proxy_client.md), [Triac regulator](regulator_triac.md) and [Solar router engine](engine_progressive.md).
+This configuration the **Solar Router** is using [Proxy client power meter](power_meter_proxy_client.md), [Triac regulator](regulator_triac.md) and [Solar router engine](engine_1dimmer.md).
 
 GPIO pins have been defined to match hardware configuration described [here](hardware.md)
 
diff --git a/docs/en/example_standalone.md b/docs/en/example_standalone.md
@@ -1,6 +1,6 @@
 # Standalone Solar Router
 
-This configuration implements a **Solar Router** with a progressive regulation. It uses [Fronuis power meter](power_meter_fronius.md), [Triac regulator](regulator_triac.md), [Progressive engine](engine_progressive.md).
+This configuration implements a **Solar Router** with a progressive regulation. It uses [Fronuis power meter](power_meter_fronius.md), [Triac regulator](regulator_triac.md), [Progressive engine](engine_1dimmer.md).
 
 GPIO pins have been defined to match hardware configuration described [here](hardware.md)
 
diff --git a/docs/en/hardware.md b/docs/en/hardware.md
@@ -45,5 +45,5 @@ Bill of material:
 * 1 x ESP8266 (or equivalent)
 
 !!! Note "This router has some limitation"
-    * It has to be used with ON/OFF regulation (engine_on_off.yaml) and is not compatible with variable engine
+    * It has to be used with ON/OFF regulation (engine_1switch.yaml) and is not compatible with variable engine
     * Due to the small space of memory, it doesn't support OTA update
diff --git a/docs/en/installation.md b/docs/en/installation.md
@@ -51,10 +51,10 @@ A **proxy** just need 1 **power meter** package
 
 #### Step 2.3: Add an Engine
 
-* [Progressive Engine](engine_progressive.md)  
+* [Progressive Engine](engine_1dimmer.md)  
   Read power exchange with the grid, determine and apply the percentage of router level.
 
-* [ON/OFF Engine](engine_on_off.md)  
+* [ON/OFF Engine](engine_1switch.md)  
   Read power exchange with the grid, and start to divert energy if a threshold is reached and stop if another threshold is reached.
 
 #### Step 2.4: Add an Energy Counter (*Optional*)
diff --git a/docs/en/regulator_mecanical_relay.md b/docs/en/regulator_mecanical_relay.md
@@ -12,7 +12,7 @@ The following schematic is representing the wiring of the relay:
 
 !!! Warning "Be carefull during wiring and use the Normally Open (NO) pin."
 
-!!! Danger "WARNING : This kind of relay is not compatible with progressive engine. Only use it [engine ON/OFF](engine_on_off.md)"
+!!! Danger "WARNING : This kind of relay is not compatible with progressive engine. Only use it [engine ON/OFF](engine_1switch.md)"
 
 To use this package, add the following lines to your configuration file:
 
diff --git a/docs/fr/engine.md b/docs/fr/engine.md
@@ -2,7 +2,13 @@
 
 Un moteur est conçu pour définir la quantité et le moment où l'énergie doit être détournée.
 
-Différents types de moteurs existent, qui peuvent progressivement détourner l'énergie vers une charge et gérer un interrupteur ON/OFF.
+Différents types de moteurs existent, qui peuvent progressivement détourner l'énergie vers une charge et gérer un interrupteur ON/OFF.  
+Pour plus de détails, référez vous aux pages dédiées des moteurs.
+
+!!! note "Nommage des moteurs"
+    Le nom du moteur reflète la façon dont le détournement d'énergie est effectué :  
+    **Exemple** : `engine_1dimmer_1bypass` gérera 1 gradateur assurant une régulation progressive associée à un relais de dérivation.
+
 
 ### LEDs de retour utilisateur
 
diff --git a/docs/fr/engine_1dimmer.md b/docs/fr/engine_1dimmer.md
@@ -1,8 +1,8 @@
-# Progressive Engine
+# engine_1dimmer
 
 Ce package implémente le moteur du routeur solaire qui détermine quand et quelle quantité d'énergie doit être déviée vers la charge.
 
-Le **progressive engine** appelle toutes les secondes le compteur d'énergie pour obtenir l'énergie réelle échangée avec le réseau. Si l'énergie produite est supérieure à l'énergie consommée et dépasse la cible d'échange définie, le moteur déterminera le **pourcentage d'ouverture du régulateur** et l'ajustera dynamiquement pour atteindre la cible.
+Le **engine_1dimmer** appelle toutes les secondes le compteur d'énergie pour obtenir l'énergie réelle échangée avec le réseau. Si l'énergie produite est supérieure à l'énergie consommée et dépasse la cible d'échange définie, le moteur déterminera le **pourcentage d'ouverture du régulateur** et l'ajustera dynamiquement pour atteindre la cible.
 
 La régulation automatique du moteur peut être activée ou désactivée avec l'interrupteur d'activation.
 
diff --git a/docs/fr/engine_1dimmer_1bypass.md b/docs/fr/engine_1dimmer_1bypass.md
@@ -1,10 +1,10 @@
-# Régulation progressive avec Bypass
+# engine_1dimmer_1bypass
 
 Ce package implémente le moteur du routeur solaire qui détermine quand et quelle quantité d'énergie doit être déviée vers la charge, avec une fonction de bypass pour une efficacité maximale.
 
 Lorsque le régulateur est utilisé intensivement pendant une période prolongée, il aura tendance à surchauffer. Ce moteur est conçu pour éviter ce problème en activant un relais de bypass et en éteignant le régulateur lorsque celui-ci est ouvert à 100% pendant une période prolongée. Pour éviter le scintillement, le relais de bypass n'est activé que lorsque le régulateur est ouvert à 100% pendant un nombre consécutif de régulations.
 
-Le **régulateur avec bypass** interroge chaque seconde le compteur d'énergie pour obtenir l'énergie réelle échangée avec le réseau. Si l'énergie produite est supérieure à l'énergie consommée et dépasse l'objectif d'échange défini, le moteur déterminera le **pourcentage d'ouverture du régulateur** et l'ajustera dynamiquement pour atteindre l'objectif. Lorsque le régulateur atteint 100% pendant une période prolongée, le relais de bypass est activé pour une efficacité maximale.
+Le **engine_1dimmer_1bypass** interroge chaque seconde le compteur d'énergie pour obtenir l'énergie réelle échangée avec le réseau. Si l'énergie produite est supérieure à l'énergie consommée et dépasse l'objectif d'échange défini, le moteur déterminera le **pourcentage d'ouverture du régulateur** et l'ajustera dynamiquement pour atteindre l'objectif. Lorsque le régulateur atteint 100% pendant une période prolongée, le relais de bypass est activé pour une efficacité maximale.
 
 La régulation automatique du moteur peut être activée ou désactivée avec l'interrupteur d'activation.
 
@@ -35,9 +35,9 @@ Pour utiliser ce package, ajoutez les lignes suivantes à votre fichier de confi
 
 ```yaml linenums="1"
 packages:
-  engine_regulator_with_bypass:
+  engine_regulator_1bypass:
     url: https://github.com/XavierBerger/Solar-Router-for-ESPHome/
-    file: solar_router/engine_regulator_with_bypass.yaml
+    file: solar_router/engine_regulator_1bypass.yaml
 ```
 
 !!! tip "Ajustement du Bypass tempo"
diff --git a/docs/fr/engine_1switch.md b/docs/fr/engine_1switch.md
@@ -1,14 +1,14 @@
-# ON/OFF Engine
+# engine_1switch
 
 Ce package implémente le moteur du routeur solaire qui détermine si l'énergie peut être détournée vers une charge locale ou non.
 
-Le ***ON/OFF engine*** appelle chaque seconde le compteur d'énergie pour obtenir la puissance réelle consommée. Si l'énergie envoyée au réseau est supérieure au niveau de démarrage du détournement (en W) pendant le temps de démarrage (en s), le relais est fermé pour utiliser l'énergie localement. Lorsque l'énergie envoyée au réseau atteint le niveau défini (en W) pour arrêter le détournement pendant le temps d'arrêt (en s), le relais est ouvert et la consommation locale est arrêtée.
+Le ***engine_1switch*** appelle chaque seconde le compteur d'énergie pour obtenir la puissance réelle consommée. Si l'énergie envoyée au réseau est supérieure au niveau de démarrage du détournement (en W) pendant le temps de démarrage (en s), le relais est fermé pour utiliser l'énergie localement. Lorsque l'énergie envoyée au réseau atteint le niveau défini (en W) pour arrêter le détournement pendant le temps d'arrêt (en s), le relais est ouvert et la consommation locale est arrêtée.
 
-La régulation automatique du *ON/OFF engine* peut être activée ou désactivée avec l'interrupteur d'activation.
+La régulation automatique du *engine_1switch* peut être activée ou désactivée avec l'interrupteur d'activation.
 
 Le schéma suivant représente la consommation avec ce moteur activé :
 
-![engine_on_off](images/engine_on_off.png)
+![engine_1switch](images/engine_1switch.png)
 
 **Légende :**
 
@@ -35,6 +35,6 @@ Pour utiliser ce package, ajoutez les lignes suivantes à votre fichier de confi
 packages:
   engine:
     url: https://github.com/XavierBerger/Solar-Router-for-ESPHome/
-    file: solar_router/engine_on_off.yaml
+    file: solar_router/engine_1switch.yaml
 ```
 
diff --git a/docs/fr/example_proxy.md b/docs/fr/example_proxy.md
@@ -7,7 +7,7 @@ La configuration du **client Proxy** utilise uniquement un [compteur de puissanc
 --8<-- "esp8285-power-meter-proxy.yaml"
 ```
 
-Cette configuration du **Routeur Solaire** utilise un [compteur de puissance client Proxy](power_meter_proxy_client.md), un [régulateur Triac](regulator_triac.md) et un [moteur de routeur solaire](engine_progressive.md).
+Cette configuration du **Routeur Solaire** utilise un [compteur de puissance client Proxy](power_meter_proxy_client.md), un [régulateur Triac](regulator_triac.md) et un [moteur de routeur solaire](engine_1dimmer.md).
 
 Les broches GPIO ont été définies pour correspondre à la configuration matérielle décrite [ici](hardware.md)
 
diff --git a/docs/fr/example_standalone.md b/docs/fr/example_standalone.md
@@ -1,6 +1,6 @@
 # Routeur Solaire Autonome
 
-Cette configuration  implement un **Routeur Solaire** avec une régulation profressive. Il utilise le [powermeter Fronius](power_meter_fronius.md), le [regulator Triac](regulator_triac.md), et le [progressive engine](engine_progressive.md).
+Cette configuration  implement un **Routeur Solaire** avec une régulation profressive. Il utilise le [powermeter Fronius](power_meter_fronius.md), le [regulator Triac](regulator_triac.md), et le [progressive engine](engine_1dimmer.md).
 
 Les broches GPIO ont été définies pour correspondre à la configuration matérielle décrite [ici](hardware.md)
 
diff --git a/docs/fr/hardware.md b/docs/fr/hardware.md
@@ -45,5 +45,5 @@ Liste des composants :
 * 1 x ESP8266 (ou équivalent)
 
 !!! Note "Ce routeur a quelques limitations"
-    * Il doit être utilisé avec une regulation Tout ou Rien (engine_on_off.yaml) et n'est pas compatible avec une régulation progressive
+    * Il doit être utilisé avec une regulation Tout ou Rien (engine_1switch.yaml) et n'est pas compatible avec une régulation progressive
     * En raison de l'espace mémoire limité, il ne prend pas en charge la mise à jour OTA
diff --git a/docs/fr/installation.md b/docs/fr/installation.md
@@ -49,10 +49,10 @@ Un **proxy** n'a besoin que d'un package **power meter**
 
 #### Étape 2.3 : Ajouter un engine
 
-* [Régulation progressive](engine_progressive.md)  
+* [Régulation progressive](engine_1dimmer.md)  
   Lit l'échange de puissance avec le réseau, déterminer et appliquer le pourcentage d'ouverture du regulator.
 
-* [Régulation tout ou rien](engine_on_off.md)  
+* [Régulation tout ou rien](engine_1switch.md)  
   Lit l'échange de puissance avec le réseau, et commencer à détourner l'énergie si un seuil est atteint et arrêter si un autre seuil est atteint.
 
 #### Étape 2.4 : Ajouter un Compteur d'Énergie (*Optionnel*)
diff --git a/docs/fr/regulator_mecanical_relay.md b/docs/fr/regulator_mecanical_relay.md
@@ -12,7 +12,7 @@ Le schéma suivant représente le câblage du relais :
 
 !!! Attention "Soyez prudent lors du câblage et utilisez la broche Normalement Ouverte (NO)."
 
-!!! Danger "AVERTISSEMENT : Ce type de relais n'est pas compatible avec les moteurs à vitesse progressive. Utilisez-le uniquement pour [moteur ON/OFF](engine_on_off.md)"
+!!! Danger "AVERTISSEMENT : Ce type de relais n'est pas compatible avec les moteurs à vitesse progressive. Utilisez-le uniquement pour [moteur ON/OFF](engine_1switch.md)"
 
 Pour utiliser ce package, ajoutez les lignes suivantes à votre fichier de configuration :
 
diff --git a/docs/images/engine_1switch.png b/docs/images/engine_1switch.png
diff --git a/esp32-standalone.yaml b/esp32-standalone.yaml
@@ -91,6 +91,6 @@ packages:
     refresh: 1d
   engine:
     url: https://github.com/XavierBerger/Solar-Router-for-ESPHome/
-    file: solar_router/engine_progressive.yaml
+    file: solar_router/engine_1dimmer.yaml
     refresh: 1d
 
diff --git a/esp32-standalone_DS18B20.yaml b/esp32-standalone_DS18B20.yaml
@@ -60,10 +60,6 @@ substitutions:
   # Define ip address of Power Meter (Fronius Inverter)
   power_meter_ip_address: "192.168.1.21"
 
-
-  # Regulator --------------------------------------------------------------------
-  regulator: "ac_dimmer"
-
   # Regulator configuration 
   # Define GPIO pin connected to AC Dimmer for gate and zero crossing detection.
   regulator_gate_pin: GPIO22
@@ -93,15 +89,15 @@ packages:
     url: https://github.com/XavierBerger/Solar-Router-for-ESPHome/
     file: solar_router/regulator_triac.yaml
     refresh: 1d
-  solar_router:
+  engine:
     url: https://github.com/XavierBerger/Solar-Router-for-ESPHome/
-    file: solar_router/engine_progressive.yaml
+    file: solar_router/engine_1dimmer.yaml
     refresh: 1d
   energy_counter:
     url: https://github.com/XavierBerger/Solar-Router-for-ESPHome/
     file: solar_router/energy_counter_theorical.yaml
     refresh: 1d
-  temperature_limmiter:
+  temperature_limiter:
     url: https://github.com/XavierBerger/Solar-Router-for-ESPHome/
     file: solar_router/temperature_limiter_DS18B20.yaml
     refresh: 1d
diff --git a/esp8266-proxy-client.yaml b/esp8266-proxy-client.yaml
@@ -60,7 +60,7 @@ packages:
     refresh: 1d
   engine:
     url: https://github.com/XavierBerger/Solar-Router-for-ESPHome/
-    file: solar_router/engine_progressive_with_bypass.yaml
+    file: solar_router/engine_1dimmer_1bypass.yaml
     refresh: 1d
   regulator:
     url: https://github.com/XavierBerger/Solar-Router-for-ESPHome/
diff --git a/esp8266-standalone_on_off.yaml b/esp8266-standalone_on_off.yaml
@@ -66,7 +66,7 @@ packages:
     refresh: 1d
   engine:
     url: https://github.com/XavierBerger/Solar-Router-for-ESPHome/
-    file: solar_router/engine_on_off.yaml
+    file: solar_router/engine_1switch.yaml
     refresh: 1d
   temperature_limiter:
     url: https://github.com/XavierBerger/Solar-Router-for-ESPHome/
diff --git a/mkdocs.yml b/mkdocs.yml
diff --git a/solar_router/engine_1dimmer.yaml b/solar_router/engine_1dimmer.yaml
diff --git a/solar_router/engine_1dimmer_1bypass.yaml b/solar_router/engine_1dimmer_1bypass.yaml
diff --git a/solar_router/engine_1switch.yaml b/solar_router/engine_1switch.yaml
diff --git a/wt32-eth01-solar-water-heater.yaml b/wt32-eth01-solar-water-heater.yaml
diff --git a/wt32-eth01-standalone_on_off.yaml b/wt32-eth01-standalone_on_off.yaml
