Skip to content

Commit 4cc703e

Browse files
committed
2 parents 3cdbf92 + b918ffd commit 4cc703e

12 files changed

Lines changed: 67 additions & 14 deletions

docs/en/engine.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,12 @@ The green LED is reflecting the actual configuration of regulation:
2424
- ***ON*** : automatic regulation is active and is not diverting energy to the load.
2525
- ***blink*** : solar router is currently sending energy to the load.
2626

27-
LEDs configuraton are done in engine configuration.
27+
LEDs configuraton are done in engine configuration.
28+
29+
### Hide or show sensors
30+
31+
An optionnal `hide_regulators` variable allow to change regulators sensors visibility in HA (hidden by default).
32+
33+
An optionnal `hide_leds` variable allow to change leds values visibility in HA (hidden by default).
34+
35+
This configuraton is done in engine configuration.

docs/en/engine_1dimmer.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,12 @@ packages:
3333
green_led_inverted: 'False'
3434
yellow_led_pin: GPIO14
3535
yellow_led_inverted: 'False'
36+
hide_regulators: 'True'
37+
hide_leds: 'True'
3638
```
3739
38-
When this package is used it is required to define `green_led_pin` and `yellow_led_pin` in `vars` section as show in the upper example. `xxx_led_inverted` can define is led is active on high or low signal and is optional.
40+
When this package is used it is required to define `green_led_pin` and `yellow_led_pin` in `vars` section as show in the upper example.
41+
* `xxx_led_inverted` can define is led is active on high or low signal and is optional.
42+
* `hide_regulators` allow to hide or show regulators sensors from HA and is optionnal.
43+
* `hide_leds` allow to hide or show leds values from HA and is optionnal.
3944

docs/en/engine_1dimmer_1bypass.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,14 @@ packages:
4343
green_led_inverted: 'False'
4444
yellow_led_pin: GPIO2
4545
yellow_led_inverted: 'False'
46+
hide_regulators: 'True'
47+
hide_leds: 'True'
4648
```
47-
When this package is used it is required to define `green_led_pin` and `yellow_led_pin` in `vars` section as show in the upper example. `xxx_led_inverted` can define is led is active on high or low signal and is optional.
49+
50+
When this package is used it is required to define `green_led_pin` and `yellow_led_pin` in `vars` section as show in the upper example.
51+
* `xxx_led_inverted` can define is led is active on high or low signal and is optional.
52+
* `hide_regulators` allow to hide or show regulators sensors from HA and is optionnal.
53+
* `hide_leds` allow to hide or show leds values from HA and is optionnal.
4854

4955
!!! tip "Adjusting Bypass Tempo"
5056
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.

docs/en/engine_1switch.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,12 @@ packages:
4343
green_led_inverted: 'False'
4444
yellow_led_pin: GPIO2
4545
yellow_led_inverted: 'False'
46+
hide_regulators: 'True'
47+
hide_leds: 'True'
4648
```
4749
48-
When this package is used it is required to define `green_led_pin` and `yellow_led_pin` in `vars` section as show in the upper example. `xxx_led_inverted` can define is led is active on high or low signal and is optional.
50+
When this package is used it is required to define `green_led_pin` and `yellow_led_pin` in `vars` section as show in the upper example.
51+
* `xxx_led_inverted` can define is led is active on high or low signal and is optional.
52+
* `hide_regulators` allow to hide or show regulators sensors from HA and is optionnal.
53+
* `hide_leds` allow to hide or show leds values from HA and is optionnal.
4954

docs/en/regulator_mecanical_relay.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ packages:
2323
files:
2424
- path: solar_router/regulator_mecanical_relay.yaml
2525
vars:
26-
regulator_gate_pin: GPIO22
26+
relay_regulator_gate_pin: GPIO22
2727
```
2828
29-
This package require the definition of pin connected to the gate of the relay. Set `regulator_gate_pin` into `vars` according to your hardware
29+
This package require the definition of pin connected to the gate of the relay. Set `relay_regulator_gate_pin` into `vars` according to your hardware

docs/fr/engine.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,11 @@ La LED verte reflète la configuration actuelle de la régulation :
2626
- ***CLIGNOTANTE*** : le routeur solaire envoie actuellement de l'énergie à la charge.
2727

2828
La configuration des LED est effectuée dans la configuration de l'`engine`.
29+
30+
### Afficher ou masquer des capteurs
31+
32+
Une variable optionnelle `hide_regulators` permet de changer la visibilité des capteurs de régulateurs dans HA (cachés par défaut).
33+
34+
Une variable optionnelle `hide_leds` permet de changer la visibilité des valeurs de leds dans HA (cachés par défaut).
35+
36+
Cette configuration est effectuée dans la configuration de l'`engine`.

docs/fr/engine_1dimmer.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,13 @@ packages:
2121
green_led_inverted: 'False'
2222
yellow_led_pin: GPIO14
2323
yellow_led_inverted: 'False'
24+
hide_regulators: 'True'
25+
hide_leds: 'True'
2426
```
2527
26-
Il est necessaire de définir `green_led_pin` et `yellow_led_pin` dans la section `vars` comme mo,ntré dans l'exemple ci-dessus. Le paramètre `xxx_led_inverted` permet de définir si la LED est active sur niveau haut ou bas. Ce paramètre est optionnel.
28+
Il est necessaire de définir `green_led_pin` et `yellow_led_pin` dans la section `vars` comme montré dans l'exemple ci-dessus.
29+
* Le paramètre `xxx_led_inverted` permet de définir si la LED est active sur niveau haut ou bas. Ce paramètre est optionnel.
30+
* Le paramètre `hide_regulators` permet de définir si le capteur de régulateur est affiché dans HA. Ce paramètre est optionnel.
31+
* Le paramètre `hide_leds` permet de définir si les valeurs des leds sont affichées dans HA. Ce paramètre est optionnel.
32+
2733

docs/fr/engine_1dimmer_1bypass.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,13 @@ packages:
4444
green_led_inverted: 'False'
4545
yellow_led_pin: GPIO2
4646
yellow_led_inverted: 'False'
47+
hide_regulators: 'True'
48+
hide_leds: 'True'
4749
```
48-
Il est necessaire de définir `green_led_pin` et `yellow_led_pin` dans la section `vars` comme mo,ntré dans l'exemple ci-dessus. Le paramètre `xxx_led_inverted` permet de définir si la LED est active sur niveau haut ou bas. Ce paramètre est optionnel.
50+
Il est necessaire de définir `green_led_pin` et `yellow_led_pin` dans la section `vars` comme montré dans l'exemple ci-dessus.
51+
* Le paramètre `xxx_led_inverted` permet de définir si la LED est active sur niveau haut ou bas. Ce paramètre est optionnel.
52+
* Le paramètre `hide_regulators` permet de définir si le capteur de régulateur est affiché dans HA. Ce paramètre est optionnel.
53+
* Le paramètre `hide_leds` permet de définir si les valeurs des leds sont affichées dans HA. Ce paramètre est optionnel.
4954

5055
!!! tip "Ajustement du Bypass tempo"
5156
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é.

docs/fr/engine_1switch.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,11 @@ packages:
4242
green_led_inverted: 'False'
4343
yellow_led_pin: GPIO2
4444
yellow_led_inverted: 'False'
45+
hide_regulators: 'True'
46+
hide_leds: 'True'
4547
```
4648
47-
Il est necessaire de définir `green_led_pin` et `yellow_led_pin` dans la section `vars` comme mo,ntré dans l'exemple ci-dessus. Le paramètre `xxx_led_inverted` permet de définir si la LED est active sur niveau haut ou bas. Ce paramètre est optionnel.
48-
49+
Il est necessaire de définir `green_led_pin` et `yellow_led_pin` dans la section `vars` comme montré dans l'exemple ci-dessus.
50+
* Le paramètre `xxx_led_inverted` permet de définir si la LED est active sur niveau haut ou bas. Ce paramètre est optionnel.
51+
* Le paramètre `hide_regulators` permet de définir si le capteur de régulateur est affiché dans HA. Ce paramètre est optionnel.
52+
* Le paramètre `hide_leds` permet de définir si les valeurs des leds sont affichées dans HA. Ce paramètre est optionnel.

docs/fr/regulator_mecanical_relay.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ packages:
2323
files:
2424
- path: solar_router/regulator_mecanical_relay.yaml
2525
vars:
26-
regulator_gate_pin: GPIO22
26+
relay_regulator_gate_pin: GPIO22
2727
```
2828
2929
Ce package nécessite la définition de la broche connectée à la porte du relais : `relay_regulator_gate_pin`

0 commit comments

Comments
 (0)