doc: Review and update

XavierBerger · XavierBerger · commit 26beae5aa862 · 2025-01-24T19:16:52.000+01:00
diff --git a/docs/en/disclamer.md b/docs/en/disclamer.md
@@ -2,7 +2,7 @@
 
 !!! danger "Disclaimer"
 
-    Before implementing the **Solar Router for ESPHome** project, it is imperative that users exercise extreme caution, particularly concerning the utilization of high voltage (110V/230V) power supply. The author of this project cannot be held liable for any potential accidents or mishaps that may occur during the setup or operation of the project.
+    Before implementing the **Solar Router for ESPHome** project, it is imperative that users exercise extreme caution, particularly concerning the utilization of high voltage (110V/240V) power supply. The author of this project cannot be held liable for any potential accidents or mishaps that may occur during the setup or operation of the project.
 
     Electricity, especially at high voltages, poses significant risks, including but not limited to electrical shocks, fires, damage to equipment or death. It is essential that users have a thorough understanding of electrical safety protocols and adhere to all relevant guidelines and regulations.
 
diff --git a/docs/en/firmware.md b/docs/en/firmware.md
@@ -6,7 +6,7 @@ Firmware has been split in several packages which can be assemble to the needs o
 
 Packages are :
 
-* **Power meters** : design to measure the energy exchanged with the grid.
+* **Power meter** : design to measure the energy exchanged with the grid.
 * **Engine** : design to determine how much of energy and when surplus of energy should be diverted to the load.
 * **Regulator** : design to channel the surplus of energy to a designated load.
 * **Energy counter** : design to report the amount of energy diverted to the load.
@@ -30,7 +30,7 @@ In this proxy configuration, two ESP is doing the job. The first one (which coud
 ![hardware connection](images/with_proxy.drawio.png){width=535}
 
 !!! Note
-    A Power Meter Proxy doesn't require a lot of CPU power and could then be executed on an ESP8285 or ESP8286.
+    A Power Meter Proxy doesn't require a lot of CPU power and could then be executed on an ESP8285 or ESP8266.
 
 ### Multiple Solar Router configuration
 
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 engine and is not compatible with variable engine
+    * It has to be used with ON/OFF regulation (engine_on_off.yaml) and is not compatible with variaprogressiveble engine
     * Due to the small space of memory, it doesn't support OTA update
diff --git a/docs/en/index.md b/docs/en/index.md
@@ -2,7 +2,7 @@
 
 **Solar Router for ESPHome** is a DIY project aiming to provide specialized hardware device and software tailored for optimizing solar energy utilization. It performs real-time monitoring and intelligent surplus energy management to effectively channels excess solar energy to designated loads like water heaters or frost protection systems. 
 
-Key features include a choice of dynamic energy routing algorithms (variable, ON/OFF), power meter sources (local or remote ...), regulators (with triac or relay ... ), and a seamless integration with [HomeAssistant](http://home-assistant.io) via [ESPHome](http://esphome.io) firmware. 
+Key features include a choice of dynamic energy routing algorithms (progressive, ON/OFF), power meter sources (local or remote ...), regulators (with triac or relay ... ), and a seamless integration with [HomeAssistant](http://home-assistant.io) via [ESPHome](http://esphome.io) firmware. 
 
 This component enables users to effortlessly monitor and control the router's functionality within the HomeAssistant ecosystem, facilitating streamlined energy management and automation.
 
diff --git a/docs/en/installation.md b/docs/en/installation.md
@@ -15,7 +15,7 @@ Adopt it into [Home Assistant](https://home-assistant.io).
 
 ### Step 2: Select packages
 
-A **solar router** needs 3 packages: a **power meter**, a **regulator** and the **engine**.
+A **solar router** needs 3 packages: a **power meter**, a **regulator** and an **engine**.
 
 A **proxy** just need 1 **power meter** package
 
@@ -25,6 +25,8 @@ A **proxy** just need 1 **power meter** package
     Get power data from Fronius inverter (Tested on Gen24 Primo)
 * [Home Assistant](power_meter_home_assistant.md)  
     Get power data from Home Assistant sensor
+* [Shelly EM](power_meter_shelly_em.md)  
+    Get power data from a shelly EM
 * [Proxy client](power_meter_proxy_client.md)  
     Get power data from outside from solar router
 
diff --git a/docs/en/solar_router.md b/docs/en/solar_router.md
@@ -2,7 +2,7 @@
 
 **Solar Router for [ESPHome](http://esphome.io)** has been designed to work with [Home Assistant](http://home-assistant.io) and it requires the installation of [ESPHome integration](https://www.home-assistant.io/integrations/esphome/).  
 
-## Variable regulation
+## Progressive regulation
 
 ![HA](images/SolarRouterInHomeAssistant.png){ align=left }
 !!! note ""
diff --git a/docs/fr/disclamer.md b/docs/fr/disclamer.md
@@ -2,7 +2,7 @@
 
 !!! danger "Avertissement"
 
-    Avant de mettre en œuvre le projet **Solar Router for ESPHome**, il est impératif que les utilisateurs fassent preuve d'une extrême prudence, en particulier concernant l'utilisation d'une alimentation à haute tension (110V/230V). L'auteur de ce projet ne peut être tenu responsable des accidents ou incidents potentiels qui pourraient survenir lors de la mise en place ou de l'utilisation du projet.
+    Avant de mettre en œuvre le projet **Solar Router for ESPHome**, il est impératif que les utilisateurs fassent preuve d'une extrême prudence, en particulier concernant l'utilisation d'une alimentation à haute tension (110V/240V). L'auteur de ce projet ne peut être tenu responsable des accidents ou incidents potentiels qui pourraient survenir lors de la mise en place ou de l'utilisation du projet.
 
     L'électricité, en particulier à haute tension, présente des risques importants, incluant mais ne se limitant pas aux chocs électriques, incendies, dommages aux équipements ou décès. Il est essentiel que les utilisateurs aient une compréhension approfondie des protocoles de sécurité électrique et respectent toutes les directives et réglementations pertinentes.
 
diff --git a/docs/fr/firmware.md b/docs/fr/firmware.md
@@ -1,24 +1,24 @@
-# Micrologiciel
+# Firlware
 
-Le micrologiciel a été divisé en plusieurs paquets qui peuvent être assemblés selon les besoins de l'utilisateur.
+Le firmware a été divisé en plusieurs *packages* qui peuvent être assemblés selon les besoins de l'utilisateur.
 
-![combinaison des paquets](images/packages.drawio.png)
+![combinaison des *packages*](images/packages.drawio.png)
 
-Les paquets sont :
+Les *packages* sont :
 
-* **Compteurs d'énergie** : conçus pour mesurer l'énergie échangée avec le réseau.
-* **Moteur** : conçu pour déterminer quelle quantité d'énergie et quand le surplus d'énergie doit être détourné vers la charge.
-* **Régulateur** : conçu pour canaliser le surplus d'énergie vers une charge désignée.
-* **Compteur d'énergie** : conçu pour rapporter la quantité d'énergie détournée vers la charge.
-* **Limiteur de température** : conçu pour arrêter le système lorsqu'une limite de température est atteinte.
+* **Power meter** : conçus pour mesurer l'énergie échangée avec le réseau.
+* **Engine** : conçu pour déterminer quelle quantité d'énergie et quand le surplus d'énergie doit être détourné vers la charge.
+* **Regulator** : conçu pour canaliser le surplus d'énergie vers une charge désignée.
+* **Energy counter** : conçu pour rapporter la quantité d'énergie détournée vers la charge.
+* **Temperature limiter** : conçu pour arrêter le système lorsqu'une limite de température est atteinte.
 
-## Paquets
+## Packages
 
-Les paquets peuvent être combinés pour créer une variété de routeurs solaires comme dans les exemples suivants.
+Les *packages* peuvent être combinés pour créer une variété de routeurs solaires comme dans les exemples suivants.
 
 ### Configuration autonome
 
-Dans cette configuration autonome, un seul ESP32 effectue le travail et exécute les 3 paquets.
+Dans cette configuration autonome, un seul ESP32 effectue le travail et exécute les 3 *packages*.
 
 ![connexion matérielle](images/standalone.drawio.png){width=374}
 
@@ -29,7 +29,7 @@ Dans cette configuration avec proxy, deux ESP effectuent le travail. Le premier
 ![connexion matérielle](images/with_proxy.drawio.png){width=535}
 
 !!! Note
-    Un proxy de compteur d'énergie ne nécessite pas beaucoup de puissance CPU et pourrait donc être exécuté sur un ESP8285 ou ESP8286.
+    Un proxy de compteur d'énergie ne nécessite pas beaucoup de puissance CPU et pourrait donc être exécuté sur un ESP8285 ou ESP8266.
 
 ### Configuration avec plusieurs routeurs solaires
 
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 un moteur ON/OFF et n'est pas compatible avec un moteur à vitesse variable
+    * Il doit être utilisé avec une regulation Tout ou Rien (engine_on_off.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/index.md b/docs/fr/index.md
@@ -2,13 +2,13 @@
 
 **Solar Router for ESPHome** est un projet DIY visant à fournir un dispositif matériel spécialisé et un logiciel conçu pour optimiser l'utilisation de l'énergie solaire. Il effectue une surveillance en temps réel et une gestion intelligente de l'énergie excédentaire pour rediriger efficacement le surplus d'énergie solaire vers des charges désignées comme les chauffe-eau ou les systèmes de protection contre le gel.
 
-Les principales caractéristiques comprennent un choix d'algorithmes de routage d'énergie dynamique (variable, ON/OFF), de sources de compteurs d'énergie (locales ou distantes ...), de régulateurs (avec triac ou relais ...), et une intégration transparente avec [HomeAssistant](http://home-assistant.io) via le firmware [ESPHome](http://esphome.io).
+Les principales caractéristiques comprennent un choix d'algorithmes de routage d'énergie dynamique (progressif, tout ou rien), de sources de compteurs d'énergie (locales ou distantes ...), de régulateurs (avec gradateur ou relais ...), et une intégration transparente avec [HomeAssistant](http://home-assistant.io) via le firmware [ESPHome](http://esphome.io).
 
 Ce composant permet aux utilisateurs de surveiller et de contrôler facilement les fonctionnalités du routeur au sein de l'écosystème *Home Assistant*, facilitant ainsi la gestion et l'automatisation de l'énergie.
 
 !!! danger "Avis important"
     Ce projet implique de travailler avec de la haute tension (110 ou 230 volts), ce qui peut être dangereux.  
-    Veuillez lire la [clause de non-responsabilité](disclamer.md) avant de mettre en oeuvre le projet **Solar Router for ESPHome**.
+    Veuillez lire l'[avertissement](disclamer.md) avant de mettre en oeuvre le projet **Solar Router for ESPHome**.
 
 !!! tips "Capacités étendues avec les capteurs Home Assistant"
 
diff --git a/docs/fr/installation.md b/docs/fr/installation.md
@@ -15,47 +15,49 @@ Adoptez-le dans [Home Assistant](https://home-assistant.io).
 
 ### Étape 2 : Sélectionner les packages
 
-Un **routeur solaire** nécessite 3 packages : un **compteur de puissance**, un **régulateur** et le **moteur**.
+Un **routeur solaire** nécessite 3 packages : un **power meter**, un **regulator** et un **engine**.
 
-Un **proxy** n'a besoin que d'1 package de **compteur de puissance**
+Un **proxy** n'a besoin que d'un package **power meter**
 
-#### Étape 2.1 : Sélectionner un Compteur de Puissance
+#### Étape 2.1 : Sélectionner un power meter
 
 * [Fronius](power_meter_fronius.md)  
-    Obtenir les données de puissance de l'onduleur Fronius (Testé sur Gen24 Primo)
+    Pour obtenir les données de puissance de l'onduleur Fronius (Testé sur Gen24 Primo)
 * [Home Assistant](power_meter_home_assistant.md)  
-    Obtenir les données de puissance du capteur Home Assistant
+    Pour obtenir les données de puissance du capteur Home Assistant
+* [Shelly EM](power_meter_shelly_em.md)  
+    Pour obtenir les données de puissance d'un Shelly EM
 * [Client Proxy](power_meter_proxy_client.md)  
-    Obtenir les données de puissance de l'extérieur du routeur solaire
+    Pour obtenir les données de puissance de l'extérieur du routeur solaire
 
 !!! abstract "Contribuer"
-    Vous êtes développeur et votre compteur de puissance manque dans cette liste, référez-vous à la section [contribuer](contributing.md) pour voir comment contribuer à ce projet.
+    Vous êtes développeur et votre power meter manque dans cette liste, référez-vous à la section [contribuer](contributing.md) pour voir comment contribuer à ce projet.
 
-#### Étape 2.2 : Sélectionner un Régulateur
+#### Étape 2.2 : Sélectionner un Regulator
 
-* Pour les régulateurs pouvant être contrôlés de 0% à 100%
+* Pour les regulators pouvant être contrôlés de 0% à 100%
     * [Triac](regulator_triac.md)  
-    Réguler l'énergie avec un Triac
+    Réguler l'énergie avec un gratateur
     * [Relais Statique](regulator_solid_state_relay.md)  
-    Réguler l'énergie avec un Relais Statique
-* Pour les régulateurs qui ne peuvent être que allumés/éteints
+    Réguler l'énergie avec un relais statique
+* Pour les regulators qui ne peuvent être que allumés/éteints
     * [Relais mécanique](regulator_mecanical_relay.md)  
     Réguler l'énergie avec un relais mécanique
 
 !!! abstract "Contribuer"
-    Vous êtes développeur et votre régulateur manque dans cette liste, référez-vous à la section [contribuer](contributing.md) pour voir comment contribuer à ce projet.
+    Vous êtes développeur et votre regulator manque dans cette liste, référez-vous à la section [contribuer](contributing.md) pour voir comment contribuer à ce projet.
 
-#### Étape 2.3 : Ajouter un Moteur
+#### Étape 2.3 : Ajouter un engine
 
-* [Moteur Variable](engine.md)  
-  Lire l'échange de puissance avec le réseau, déterminer et appliquer le pourcentage d'ouverture du régulateur.
+* [Régulation progressive](engine.md)  
+  Lit l'échange de puissance avec le réseau, déterminer et appliquer le pourcentage d'ouverture du regulator.
 
-* [Moteur ON/OFF](engine_on_off.md)  
-  Lire 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.
+* [Régulation tout ou rien](engine_on_off.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*)
 
-* [Compteur d'Énergie Théorique](energy_counter_theorical.md)  
+* [Compteur d'énergie théorique](energy_counter_theorical.md)  
   Calculer l'énergie économisée basée sur l'énergie détournée et la puissance de charge.
 
 ### Étape 3 : Configurer votre routeur solaire
diff --git a/docs/fr/solar_router.md b/docs/fr/solar_router.md
@@ -2,7 +2,7 @@
 
 **Solar Router for [ESPHome](http://esphome.io)** a été conçu pour fonctionner avec [Home Assistant](http://home-assistant.io) et nécessite l'installation de l'[intégration ESPHome](https://www.home-assistant.io/integrations/esphome/).
 
-## Régulation variable
+## Régulation progressive
 
 ![HA](images/SolarRouterInHomeAssistant.png){ align=left }
 !!! note ""
@@ -11,7 +11,7 @@
     * ***Activer le routage solaire***  
       Contrôle si le routage solaire doit être activé ou non
     * ***Réactivité***  
-      Vitesse du routage solaire
+      Vitesse du routage solaire.  
       De 1 à 100. 1 est le plus lent, 100 est le plus rapide.
     * ***Ouverture du régulateur***  
       Pourcentage actuel d'ouverture de la porte pour envoyer de l'énergie à la charge 
@@ -24,16 +24,15 @@
     
     * ***Puissance réelle***  
       Énergie effectivement échangée avec le réseau. Mise à jour toutes les secondes. 
-
-<br>  
+  
 <br>  
 <br>  
 
 !!! note 
     Lorsque le routage solaire est désactivé, le curseur d'ouverture du régulateur peut être modifié "manuellement".  
     Si vous modifiez l'état d'ouverture du triac alors que le routage solaire est activé, l'algorithme de routage modifiera immédiatement la valeur pour atteindre le niveau d'échange réseau cible.
 
-## Régulation ON/OFF
+## Régulation Tout ou Rien
 
 ![HA](images/SolarRouterONOFFInHomeAssistant.png){ align=left }
 !!! note ""
@@ -56,9 +55,9 @@
     
     * ***Puissance réelle***  
       Énergie effectivement échangée avec le réseau. Mise à jour toutes les secondes.
-    * ***Tempo de démarrage***
+    * ***Tempo de démarrage***  
       Compteur définissant quand la dérivation d'énergie doit commencer 
-    * ***Tempo d'arrêt***
+    * ***Tempo d'arrêt***  
       Compteur définissant quand la dérivation d'énergie doit s'arrêter 
 
 <br>
