Skip to content

Commit b255205

Browse files
SullyPXavier Berger
authored andcommitted
Updated documentation
1 parent bd3cb95 commit b255205

8 files changed

Lines changed: 10 additions & 10 deletions

docs/en/engine_1dimmer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This package is implementing the engine of the solar router which determines when and how many energy has to be diverted to the load.
44

5-
**Engine 1 x dimmer** 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.
5+
**Engine 1 x dimmer** calls every the power meter everytime it's updated 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.
66

77
Engine's automatic regulation can be activated or deactivated with the activation switch.
88

docs/en/engine_1dimmer_1bypass.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This package implements the engine of the solar router which determines when and
44

55
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.
66

7-
**Engine 1 x dimmer + 1 x bypass** 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.
7+
**Engine 1 x dimmer + 1 x bypass** calls the power meter everytime it's updated 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.
88

99
Engine's automatic regulation can be activated or deactivated with the activation switch.
1010

@@ -54,4 +54,4 @@ When this package is used it is required to define `green_led_pin` and `yellow_l
5454
* `hide_leds` allow to hide or show leds values from HA and is optionnal.
5555

5656
!!! tip "Adjusting Bypass Tempo"
57-
The `Bypass Tempo` determines how many consecutive regulations at 100% are needed before activating the bypass relay. A lower value will make the bypass more reactive but might cause more frequent switching (flickering). Because there's roughly 1 regulation per second, `Bypass Tempo` can be approximated as the time in second with the regulator at 100% before which the the bypass relay is activated.
57+
The `Bypass Tempo` determines how many consecutive regulations at 100% are needed before activating the bypass relay. A lower value will make the bypass more reactive but might cause more frequent switching (flickering). If your powermeter is updated 1 time per second, `Bypass Tempo` can be approximated as the time in second with the regulator at 100% before which the the bypass relay is activated, else this correpond to the number of time that your powermeter is updated.

docs/en/engine_1switch.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
This package is implementing the engine of the solar router which determines energy can be diverted to a local load or not.
55

6-
**Engine 1 x switch** 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.
6+
**Engine 1 x switch** calls the power meter everytime it's updated 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.
77

88
Engine 1 x switch's automatic regulation can be activated or deactivated with the activation switch.
99

docs/fr/engine_1dimmer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
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.
44

5-
L'**Engine 1 x dimmer** 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.
5+
L'**Engine 1 x dimmer** appelle le compteur d'énergie à chaque mise à jour de la valeur de celui-ci 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.
66

77
La régulation automatique du moteur peut être activée ou désactivée avec l'interrupteur d'activation.
88

docs/fr/engine_1dimmer_1bypass.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Ce package implémente le moteur du routeur solaire qui détermine quand et quel
44

55
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.
66

7-
L'**Engine 1 x dimmer + 1 x 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.
7+
L'**Engine 1 x dimmer + 1 x bypass** interroge le compteur d'énergie à chaque mise à jour de la valeur de celui-ci 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.
88

99
La régulation automatique du moteur peut être activée ou désactivée avec l'interrupteur d'activation.
1010

@@ -54,4 +54,4 @@ Il est necessaire de définir `green_led_pin` et `yellow_led_pin` dans la sectio
5454
* Le paramètre `hide_leds` permet de définir si les valeurs des leds sont affichées dans HA. Ce paramètre est optionnel.
5555

5656
!!! tip "Ajustement du Bypass tempo"
57-
Le `Bypass tempo` détermine combien de régulations consécutives à 100% sont nécessaires avant d'activer le relais de bypass. Une valeur plus basse rendra le bypass plus réactif mais pourrait causer des commutations plus fréquentes (scintillement). Comme il y a environ 1 régulation par seconde, `Bypass tempo` peut être approximé comme le temps en secondes avec le régulateur à 100% avant que le relais de bypass ne soit activé.
57+
Le `Bypass tempo` détermine combien de régulations consécutives à 100% sont nécessaires avant d'activer le relais de bypass. Une valeur plus basse rendra le bypass plus réactif mais pourrait causer des commutations plus fréquentes (scintillement). Si votre capteur d'énergie se met à jour 1 fois par seconde, `Bypass tempo` peut être approximé comme le temps en secondes avec le régulateur à 100% avant que le relais de bypass ne soit activé, sinon celà correpond au nombre de mises à jours du capteur d'énergie.

docs/fr/engine_1switch.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
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.
44

5-
L'***Engine 1 x switch*** 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.
5+
L'***Engine 1 x switch*** appelle le compteur d'énergie à chaque mise à jour de la valeur de celui-ci 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.
66

77
La régulation automatique du *engine_1switch* peut être activée ou désactivée avec l'interrupteur d'activation.
88

solar_router/engine_1switch.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ packages:
66

77
switch:
88
# Define is router is active or not
9-
# When switch is ON, activate power meter (pooling timer will trigger every seconds)
9+
# When switch is ON, activate power meter (each time power meter is updated the energy regulation will run)
1010
# When switch is OFF, deactivate power meter, turn off divertion and reset counters
1111
- platform: template
1212
name: "Activate Solar Routing"

solar_router/engine_common.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ substitutions:
3333
hide_leds: "True"
3434

3535
# Component managing time.
36-
# If activate switch is ON, power measurment and energy regulation are performed every secondes
36+
# If activate switch is ON, yellow led update is performed every secondes
3737
time:
3838
- platform: sntp
3939
id: yellow_led_engine_time_trigger

0 commit comments

Comments
 (0)