refactor: BREAKING CHANGE rename 'variable engine' 'progressive engine'

docs/en/compile_coverage.md

@@ -4,7 +4,7 @@
 * common.yaml
 * power_meter_fronius.yaml
 * regulator_triac.yaml
-* engine.yaml
+* engine_progressive.yaml
 * energy_counter_theorical.yaml
 * temperature_limiter_DS18B20.yaml
 
@@ -17,7 +17,7 @@
 * regulator_mecanical_relay.yaml
 * temperature_limiter_home_assistant.yaml
 
-## esp32-proxy-client
+## esp8266-proxy-client
 * power_meter_proxy_client.yaml
-* engine.yaml
+* engine_progressive_with_bypass.yaml
 * regulator_solid_state_relay.yaml

esp32-proxy-client.yaml

@@ -53,9 +53,6 @@ substitutions:
   # Define ip address of Proxy Power Meter
   power_meter_ip_address: "192.168.1.30"
 
-  # Regulator --------------------------------------------------------------------
-  regulator: "ac_dimmer"
-
   # Regulator configuration 
   # Define GPIO pin connected to AC Dimmer for gate and zero crossing detection.
   regulator_gate_pin: GPIO22
@@ -72,11 +69,15 @@ packages:
     url: https://github.com/XavierBerger/Solar-Router-for-ESPHome/
     file: solar_router/power_meter_proxy_client.yaml
     refresh: 1d
+  engine:
+    url: https://github.com/XavierBerger/Solar-Router-for-ESPHome/
+    file: solar_router/engine_progressive_with_bypass.yaml
+    refresh: 1d
   regulator:
     url: https://github.com/XavierBerger/Solar-Router-for-ESPHome/
     file: solar_router/regulator_solid_state_relay.yaml
     refresh: 1d
-  solar_router:
+  bypass:
     url: https://github.com/XavierBerger/Solar-Router-for-ESPHome/
-    file: solar_router/engine.yaml
+    file: solar_router/regulator_mecanical_relay.yaml
     refresh: 1d

esp32-standalone.yaml

@@ -91,6 +91,6 @@ packages:
     refresh: 1d
   engine:
     url: https://github.com/XavierBerger/Solar-Router-for-ESPHome/
-    file: solar_router/engine.yaml
+    file: solar_router/engine_progressive.yaml
     refresh: 1d
 

esp32-standalone_DS18B20.yaml

@@ -95,7 +95,7 @@ packages:
     refresh: 1d
   solar_router:
     url: https://github.com/XavierBerger/Solar-Router-for-ESPHome/
-    file: solar_router/engine.yaml
+    file: solar_router/engine_progressive.yaml
     refresh: 1d
   energy_counter:
     url: https://github.com/XavierBerger/Solar-Router-for-ESPHome/

esp8266-proxy-client.yaml

@@ -0,0 +1,73 @@
+# ----------------------------------------------------------------------------------------------------
+# ESPHome configuration - This part depends on your hardware target
+# ----------------------------------------------------------------------------------------------------
+
+esphome:
+  name: "esp8266"
+  friendly_name: ESP8266
+
+esp8266:
+  board: esp01_1m
+  restore_from_flash: true
+
+# Enable logging
+logger:
+  baud_rate: 115200
+  level: INFO
+  logs:
+    component: ERROR
+    http_request.arduino: ERROR
+
+# Enable Home Assistant API
+api:
+  encryption:
+    key: !secret proxy_api_encryption_key
+
+# WiFi connection
+wifi:
+  ssid: !secret wifi_ssid
+  password: !secret wifi_password
+  # If you have a WiFi activity plannification, you may have to update the reboot timeout (Default: 15min)
+  reboot_timeout: 24h
+
+# ----------------------------------------------------------------------------------------------------
+# Customisation
+# ----------------------------------------------------------------------------------------------------
+
+# This part of the script is designed to be use for customisation. It shouldn't be necessary to
+# edit other part of the script to perform configuration.
+substitutions:
+  # Power meter source -----------------------------------------------------------
+  # Define ip address of Proxy Power Meter
+  power_meter_ip_address: "192.168.1.28"
+
+  # Regulator configuration 
+  # Define GPIO pin connected to AC Dimmer for gate and zero crossing detection.
+  regulator_gate_pin: GPIO4
+
+  # LEDs -------------------------------------------------------------------------
+  # Green LED is reflecting regulation status
+  # Yellow LED is reflecting power meter status
+  green_led_pin: GPIO1
+  yellow_led_pin: GPIO2
+
+  relay_regulator_gate_pin: GPIO0 
+  bypass_timer_threshold: "30"
+
+packages:
+  power_meter:
+    url: https://github.com/XavierBerger/Solar-Router-for-ESPHome/
+    file: solar_router/power_meter_proxy_client.yaml
+    refresh: 1d
+  engine:
+    url: https://github.com/XavierBerger/Solar-Router-for-ESPHome/
+    file: solar_router/engine_progressive_with_bypass.yaml
+    refresh: 1d
+  regulator:
+    url: https://github.com/XavierBerger/Solar-Router-for-ESPHome/
+    file: solar_router/regulator_solid_state_relay.yaml
+    refresh: 1d
+  bypass:
+    url: https://github.com/XavierBerger/Solar-Router-for-ESPHome/
+    file: solar_router/regulator_mecanical_relay.yaml
+    refresh: 1d

esp8266-standalone_on_off.yaml

@@ -56,10 +56,6 @@ substitutions:
   red_led_pin: GPIO4
 
 packages:
-  common:
-    url: https://github.com/XavierBerger/Solar-Router-for-ESPHome/
-    file: solar_router/common.yaml
-    refresh: 1d
   power_meter:
     url: https://github.com/XavierBerger/Solar-Router-for-ESPHome/
     file: solar_router/power_meter_home_assistant.yaml
@@ -68,7 +64,7 @@ packages:
     url: https://github.com/XavierBerger/Solar-Router-for-ESPHome/
     file: solar_router/regulator_mecanical_relay.yaml
     refresh: 1d
-  solar_router:
+  engine:
     url: https://github.com/XavierBerger/Solar-Router-for-ESPHome/
     file: solar_router/engine_on_off.yaml
     refresh: 1d

mkdocs.yml

@@ -26,7 +26,8 @@ nav:
       - Solid State Relay: regulator_solid_state_relay.md
       - Mecanical relay: regulator_mecanical_relay.md
   - Engine: 
-      - Progressive regulation: engine.md
+      - Progressive regulation: engine_progressive.md
+      - Progressive with bypass: engine_progressive_with_bypass.md
       - ON/OFF regulation: engine_on_off.md
   - Energy Counter: 
       - Theorical: energy_counter_theorical.md

solar_router/regulator_solid_state_relay.yaml

@@ -8,9 +8,9 @@ script:
     mode: single
     then:
       # Apply opening level on relay ldec output
-      - output.turn_on: relay_output
+      - output.turn_on: ssr_output
       - output.set_level:
-          id: relay_output
+          id: ssr_output
           level: !lambda return id(regulator_opening).state/100.0;
 
 # ----------------------------------------------------------------------------------------------------
@@ -20,6 +20,6 @@ script:
 # Control the relay through GPIO
 output:
   - platform: slow_pwm
-    id: relay_output
+    id: ssr_output
     pin: ${regulator_gate_pin}
     period: 330ms

wt32-eth01-solar-water-heater.yaml

@@ -99,9 +99,9 @@ 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.yaml
+    file: solar_router/engine_progressive.yaml
     refresh: 1d
   energy_counter:
     url: https://github.com/XavierBerger/Solar-Router-for-ESPHome/