Fix All tests ok

Add first test ok for UnderlyingSwitch

.devcontainer/configuration.yaml

@@ -8,12 +8,13 @@ recorder:
         domains:
             - input_boolean
             - input_number
+            - input_select
             - switch
             - climate
             - sensor
             - binary_sensor
             - number
-            - input_select
+            - select
             - versatile_thermostat
 
 logger:
@@ -243,6 +244,11 @@ climate:
       heater: input_boolean.fake_valve_sonoff_trvzb2
       target_sensor: input_number.fake_temperature_sensor1
       ac_mode: false
+    - platform: generic_thermostat
+      name: Underlying switch climate
+      heater: input_boolean.fake_heater_switch2
+      target_sensor: input_number.fake_temperature_sensor1
+      ac_mode: false
 
 input_datetime:
     fake_last_seen:

.devcontainer/devcontainer.json

@@ -37,7 +37,9 @@
                 "yzhang.markdown-all-in-one",
                 "github.vscode-github-actions",
                 "azuretools.vscode-docker",
-                "huizhou.githd"
+                "huizhou.githd",
+                "github.copilot",
+                "github.copilot-chat"
             ],
             "settings": {
                 "files.eol": "\n",

README-fr.md

@@ -13,15 +13,11 @@ Ce composant personnalisé pour Home Assistant est une mise à niveau et une ré
 
 # Quoi de neuf ?
 ![Nouveau](images/new-icon.png)
-> * **Release 6.8**:
+> * **Release 7.2**:
 >
-> Ajout d'une nouvelle méthode de régulation pour les Versatile Thermostat de type `over_climate`. Cette méthode nommée 'Contrôle direct de la vanne' permet de contrôler directement la vanne d'un TRV et éventuellement un décalage pour calibrer le thermomètre interne de votre TRV. Cette nouvelle méthode a été testée avec des Sonoff TRVZB et généralisée pour d'autre type de TRV pour lesquels la vanne est directement commandable via des entités de type `number`.
+> - Prise en compte native des équipements pilotable via une entité de type `select` (ou `input_select`) ou `climate` pour des _VTherm_ de type `over_switch`. Cette évolution rend obsolète, la création de switch virtuels pour l'intégration des Nodon ou Heaty ou eCosy ... etc. Plus d'informations [ici](documentation/fr/over-switch.md#la-personnalisation-des-commandes).
 >
-> Plus d'informations [ici](documentation/fr/over-climate.md) et [ici](documentation/fr/self-regulation.md).
->
-> * **Refonte de la documentation**:
->
-> Avec toutes les évolutions réalisées depuis le début de l'intégration, la documentation nécessitait une profonde re-organisation, c'est chose faite sur cette version. Tous vos retours sur cette nouvelle organisation seront les bienvenus.
+> - Lien vers la documentation : cette version 7.2 expérimente des liens vers la documentation depuis les pages de configuration. Le lien est accessible via l'icone [![?](https://img.icons8.com/color/18/help.png)](https://github.com/jmcollin78/versatile_thermostat/blob/main/documentation/fr/over-switch.md#configuration). Elle est expérimentée sur la page de configuration des sous-jacents des _VTherm_ `over_switch`.
 
 
 # 🍻 Merci pour les bières [buymecoffee](https://www.buymeacoffee.com/jmcollin78) 🍻

custom_components/versatile_thermostat/config_flow.py

@@ -4,13 +4,12 @@
 from __future__ import annotations
 
 from typing import Any
+import re
 import logging
 import copy
 from collections.abc import Mapping  # pylint: disable=import-error
 import voluptuous as vol
 
-from homeassistant.exceptions import HomeAssistantError
-
 from homeassistant.core import callback
 from homeassistant.config_entries import (
     ConfigEntry,
@@ -273,6 +272,34 @@ class VersatileThermostatBaseConfigFlow(FlowHandler):
                     CONF_MIN_OPENING_DEGREES
                 ) from exc
 
+        # Check the VSWITCH configuration. There should be the same number of vswitch_on (resp. vswitch_off) than the number of underlying entity
+        if self._infos.get(CONF_THERMOSTAT_TYPE) == CONF_THERMOSTAT_SWITCH and step_id == "type":
+            if not self.check_vswitch_configuration(data):
+                raise VirtualSwitchConfigurationIncorrect(CONF_VSWITCH_ON_CMD_LIST)
+
+    def check_vswitch_configuration(self, data) -> bool:
+        """Check the Virtual switch configuration and return True if the configuration is correct"""
+        nb_under = len(data.get(CONF_UNDERLYING_LIST, []))
+
+        # check format of each command_on
+        for command in data.get(CONF_VSWITCH_ON_CMD_LIST, []) + data.get(CONF_VSWITCH_OFF_CMD_LIST, []):
+            pattern = r"^(?P<command>[a-zA-Z0-9_]+)(?:/(?P<argument>[a-zA-Z0-9_]+)(?::(?P<value>[a-zA-Z0-9_]+))?)?$"
+            if not re.match(pattern, command):
+                return False
+
+        nb_command_on = len(data.get(CONF_VSWITCH_ON_CMD_LIST, []))
+        nb_command_off = len(data.get(CONF_VSWITCH_OFF_CMD_LIST, []))
+        if (nb_command_on == nb_under or nb_command_on == 0) and (nb_command_off == nb_under or nb_command_off == 0):
+            # There is enough command_on and off
+            # Check if one under is not a switch (which have default command).
+            if any(
+                not thermostat_type.startswith(SWITCH_DOMAIN) and not thermostat_type.startswith(INPUT_BOOLEAN_DOMAIN) for thermostat_type in data.get(CONF_UNDERLYING_LIST, [])
+            ):
+                if nb_command_on != nb_under or nb_command_off != nb_under:
+                    return False
+            return True
+        return False
+
     def check_config_complete(self, infos) -> bool:
         """True if the config is now complete (ie all mandatory attributes are set)"""
         is_central_config = (
@@ -407,6 +434,8 @@ class VersatileThermostatBaseConfigFlow(FlowHandler):
                 errors["base"] = "valve_regulation_nb_entities_incorrect"
             except ValveRegulationMinOpeningDegreesIncorrect as err:
                 errors[str(err)] = "min_opening_degrees_format"
+            except VirtualSwitchConfigurationIncorrect as err:
+                errors["base"] = "vswitch_configuration_incorrect"
             except Exception:  # pylint: disable=broad-except
                 _LOGGER.exception("Unexpected exception")
                 errors["base"] = "unknown"

custom_components/versatile_thermostat/config_schema.py

@@ -16,6 +16,14 @@ from homeassistant.components.input_number import (
     DOMAIN as INPUT_NUMBER_DOMAIN,
 )
 
+from homeassistant.components.select import (
+    DOMAIN as SELECT_DOMAIN,
+)
+
+from homeassistant.components.input_select import (
+    DOMAIN as INPUT_SELECT_DOMAIN,
+)
+
 from homeassistant.components.input_datetime import (
     DOMAIN as INPUT_DATETIME_DOMAIN,
 )
@@ -120,9 +128,7 @@ STEP_CENTRAL_BOILER_SCHEMA = vol.Schema(
 STEP_THERMOSTAT_SWITCH = vol.Schema(  # pylint: disable=invalid-name
     {
         vol.Required(CONF_UNDERLYING_LIST): selector.EntitySelector(
-            selector.EntitySelectorConfig(
-                domain=[SWITCH_DOMAIN, INPUT_BOOLEAN_DOMAIN], multiple=True
-            ),
+            selector.EntitySelectorConfig(domain=[SWITCH_DOMAIN, INPUT_BOOLEAN_DOMAIN, SELECT_DOMAIN, INPUT_SELECT_DOMAIN, CLIMATE_DOMAIN], multiple=True),
         ),
         vol.Optional(CONF_HEATER_KEEP_ALIVE): cv.positive_int,
         vol.Required(CONF_PROP_FUNCTION, default=PROPORTIONAL_FUNCTION_TPI): vol.In(
@@ -132,6 +138,10 @@ STEP_THERMOSTAT_SWITCH = vol.Schema(  # pylint: disable=invalid-name
         ),
         vol.Optional(CONF_AC_MODE, default=False): cv.boolean,
         vol.Optional(CONF_INVERSE_SWITCH, default=False): cv.boolean,
+        vol.Optional("on_command_text"): vol.In([]),
+        vol.Optional(CONF_VSWITCH_ON_CMD_LIST): selector.TextSelector(selector.TextSelectorConfig(type=selector.TextSelectorType.TEXT, multiple=True)),
+        vol.Optional("off_command_text"): vol.In([]),
+        vol.Optional(CONF_VSWITCH_OFF_CMD_LIST): selector.TextSelector(selector.TextSelectorConfig(type=selector.TextSelectorType.TEXT, multiple=True)),
     }
 )
 

custom_components/versatile_thermostat/const.py

@@ -127,6 +127,9 @@ CONF_OPENING_DEGREE_LIST = "opening_degree_entity_ids"
 CONF_CLOSING_DEGREE_LIST = "closing_degree_entity_ids"
 CONF_MIN_OPENING_DEGREES = "min_opening_degrees"
 
+CONF_VSWITCH_ON_CMD_LIST = "vswitch_on_command"
+CONF_VSWITCH_OFF_CMD_LIST = "vswitch_off_command"
+
 # Deprecated
 CONF_HEATER = "heater_entity_id"
 CONF_HEATER_2 = "heater_entity2_id"
@@ -562,6 +565,10 @@ class ValveRegulationMinOpeningDegreesIncorrect(HomeAssistantError):
     """Error to indicate that the minimal opening degrees is not a list of int separated by coma"""
 
 
+class VirtualSwitchConfigurationIncorrect(HomeAssistantError):
+    """Error when a virtual switch is not configured correctly"""
+
+
 class overrides:  # pylint: disable=invalid-name
     """An annotation to inform overrides"""
 

custom_components/versatile_thermostat/manifest.json

@@ -14,6 +14,6 @@
   "quality_scale": "silver",
   "requirements": [],
   "ssdp": [],
-  "version": "7.1.6",
+  "version": "7.2.0",
   "zeroconf": []
 }

custom_components/versatile_thermostat/strings.json

@@ -82,7 +82,9 @@
           "auto_regulation_periode_min": "Regulation minimum period",
           "auto_regulation_use_device_temp": "Use internal temperature of the underlying",
           "inverse_switch_command": "Inverse switch command",
-          "auto_fan_mode": "Auto fan mode"
+          "auto_fan_mode": "Auto fan mode",
+          "vswitch_on_command": "Optional turn on commands",
+          "vswitch_off_command": "Optional turn off commands"
         },
         "data_description": {
           "underlying_entity_ids": "The device(s) to be controlled - 1 is required",
@@ -94,7 +96,9 @@
           "auto_regulation_periode_min": "Duration in minutes between two regulation update",
           "auto_regulation_use_device_temp": "Use the eventual internal temperature sensor of the underlying to speedup the self-regulation",
           "inverse_switch_command": "For switch with pilot wire and diode you may need to inverse the command",
-          "auto_fan_mode": "Automatically activate fan when huge heating/cooling is necessary"
+          "auto_fan_mode": "Automatically activate fan when huge heating/cooling is necessary",
+          "vswitch_on_command": "A list of turn on command in the form: action:parameter. Example: select_option:comfort. See README for more examples",
+          "vswitch_off_command": "A list of turn on command in the form: action:parameter. Example: select_option:frost. See README for more examples"
         }
       },
       "tpi": {
@@ -330,7 +334,9 @@
           "auto_regulation_periode_min": "Regulation minimum period",
           "auto_regulation_use_device_temp": "Use internal temperature of the underlying",
           "inverse_switch_command": "Inverse switch command",
-          "auto_fan_mode": "Auto fan mode"
+          "auto_fan_mode": "Auto fan mode",
+          "vswitch_on_command": "Optional turn on commands",
+          "vswitch_off_command": "Optional turn off commands"
         },
         "data_description": {
           "underlying_entity_ids": "The device(s) to be controlled - 1 is required",
@@ -342,7 +348,9 @@
           "auto_regulation_periode_min": "Duration in minutes between two regulation update",
           "auto_regulation_use_device_temp": "Use the eventual internal temperature sensor of the underlying to speedup the self-regulation",
           "inverse_switch_command": "For switch with pilot wire and diode you may need to invert the command",
-          "auto_fan_mode": "Automatically activate fan when huge heating/cooling is necessary"
+          "auto_fan_mode": "Automatically activate fan when huge heating/cooling is necessary",
+          "vswitch_on_command": "A list of turn on command in the form: action:parameter. Example: select_option:comfort. See README for more examples",
+          "vswitch_off_command": "A list of turn on command in the form: action:parameter. Example: select_option:frost. See README for more examples"
         }
       },
       "tpi": {

custom_components/versatile_thermostat/thermostat_switch.py

@@ -14,6 +14,8 @@ from .const import (
     CONF_UNDERLYING_LIST,
     CONF_HEATER_KEEP_ALIVE,
     CONF_INVERSE_SWITCH,
+    CONF_VSWITCH_ON_CMD_LIST,
+    CONF_VSWITCH_OFF_CMD_LIST,
     overrides,
 )
 
@@ -40,6 +42,8 @@ class ThermostatOverSwitch(BaseThermostat[UnderlyingSwitch]):
                 "tpi_coef_ext",
                 "power_percent",
                 "calculated_on_percent",
+                "vswitch_on_commands",
+                "vswitch_off_commands",
             }
         )
     )
@@ -47,6 +51,8 @@ class ThermostatOverSwitch(BaseThermostat[UnderlyingSwitch]):
     def __init__(self, hass: HomeAssistant, unique_id, name, config_entry) -> None:
         """Initialize the thermostat over switch."""
         self._is_inversed: bool | None = None
+        self._lst_vswitch_on: list[str] = []
+        self._lst_vswitch_off: list[str] = []
         super().__init__(hass, unique_id, name, config_entry)
 
     @property
@@ -75,10 +81,16 @@ class ThermostatOverSwitch(BaseThermostat[UnderlyingSwitch]):
             max_on_percent=self._max_on_percent,
         )
 
+        self._is_inversed = config_entry.get(CONF_INVERSE_SWITCH) is True
+
         lst_switches = config_entry.get(CONF_UNDERLYING_LIST)
+        self._lst_vswitch_on = config_entry.get(CONF_VSWITCH_ON_CMD_LIST, [])
+        self._lst_vswitch_off = config_entry.get(CONF_VSWITCH_OFF_CMD_LIST, [])
 
         delta_cycle = self._cycle_min * 60 / len(lst_switches)
         for idx, switch in enumerate(lst_switches):
+            vswitch_on = self._lst_vswitch_on[idx] if idx < len(self._lst_vswitch_on) else None
+            vswitch_off = self._lst_vswitch_off[idx] if idx < len(self._lst_vswitch_off) else None
             self._underlyings.append(
                 UnderlyingSwitch(
                     hass=self._hass,
@@ -86,10 +98,11 @@ class ThermostatOverSwitch(BaseThermostat[UnderlyingSwitch]):
                     switch_entity_id=switch,
                     initial_delay_sec=idx * delta_cycle,
                     keep_alive_sec=config_entry.get(CONF_HEATER_KEEP_ALIVE, 0),
+                    vswitch_on=vswitch_on,
+                    vswitch_off=vswitch_off,
                 )
             )
 
-        self._is_inversed = config_entry.get(CONF_INVERSE_SWITCH) is True
         self._should_relaunch_control_heating = False
 
     @overrides
@@ -142,6 +155,9 @@ class ThermostatOverSwitch(BaseThermostat[UnderlyingSwitch]):
             "calculated_on_percent"
         ] = self._prop_algorithm.calculated_on_percent
 
+        self._attr_extra_state_attributes["vswitch_on_commands"] = self._lst_vswitch_on
+        self._attr_extra_state_attributes["vswitch_off_commands"] = self._lst_vswitch_off
+
         self.async_write_ha_state()
         _LOGGER.debug(
             "%s - Calling update_custom_attributes: %s",

custom_components/versatile_thermostat/translations/en.json

@@ -82,7 +82,9 @@
           "auto_regulation_periode_min": "Regulation minimum period",
           "auto_regulation_use_device_temp": "Use internal temperature of the underlying",
           "inverse_switch_command": "Inverse switch command",
-          "auto_fan_mode": "Auto fan mode"
+          "auto_fan_mode": "Auto fan mode",
+          "vswitch_on_command": "Optional turn on commands",
+          "vswitch_off_command": "Optional turn off commands"
         },
         "data_description": {
           "underlying_entity_ids": "The device(s) to be controlled - 1 is required",
@@ -94,7 +96,9 @@
           "auto_regulation_periode_min": "Duration in minutes between two regulation update",
           "auto_regulation_use_device_temp": "Use the eventual internal temperature sensor of the underlying to speedup the self-regulation",
           "inverse_switch_command": "For switch with pilot wire and diode you may need to inverse the command",
-          "auto_fan_mode": "Automatically activate fan when huge heating/cooling is necessary"
+          "auto_fan_mode": "Automatically activate fan when huge heating/cooling is necessary",
+          "vswitch_on_command": "A list of turn on command in the form: action:parameter. Example: select_option:comfort. See README for more examples",
+          "vswitch_off_command": "A list of turn on command in the form: action:parameter. Example: select_option:frost. See README for more examples"
         }
       },
       "tpi": {
@@ -234,7 +238,7 @@
           "opening_degree_entity_ids": "The list of the 'opening degree' entities. There should be one per underlying climate entities",
           "closing_degree_entity_ids": "The list of the 'closing degree' entities. Set it if your TRV has the entity for better regulation. There should be one per underlying climate entities",
           "proportional_function": "Algorithm to use (TPI is the only one for now)",
-          "min_opening_degrees": "A comma seperated list of minimal opening degrees. Default to 0. Example: 20, 25, 30"
+          "min_opening_degrees": "Opening degree minimum value for each underlying device, comma separated. Default to 0. Example: 20, 25, 30"
         }
       }
     },
@@ -330,7 +334,9 @@
           "auto_regulation_periode_min": "Regulation minimum period",
           "auto_regulation_use_device_temp": "Use internal temperature of the underlying",
           "inverse_switch_command": "Inverse switch command",
-          "auto_fan_mode": "Auto fan mode"
+          "auto_fan_mode": "Auto fan mode",
+          "vswitch_on_command": "Optional turn on commands",
+          "vswitch_off_command": "Optional turn off commands"
         },
         "data_description": {
           "underlying_entity_ids": "The device(s) to be controlled - 1 is required",
@@ -342,7 +348,9 @@
           "auto_regulation_periode_min": "Duration in minutes between two regulation update",
           "auto_regulation_use_device_temp": "Use the eventual internal temperature sensor of the underlying to speedup the self-regulation",
           "inverse_switch_command": "For switch with pilot wire and diode you may need to invert the command",
-          "auto_fan_mode": "Automatically activate fan when huge heating/cooling is necessary"
+          "auto_fan_mode": "Automatically activate fan when huge heating/cooling is necessary",
+          "vswitch_on_command": "A list of turn on command in the form: action:parameter. Example: select_option:comfort. See README for more examples",
+          "vswitch_off_command": "A list of turn on command in the form: action:parameter. Example: select_option:frost. See README for more examples"
         }
       },
       "tpi": {
@@ -481,7 +489,7 @@
           "opening_degree_entity_ids": "The list of the 'opening degree' entities. There should be one per underlying climate entities",
           "closing_degree_entity_ids": "The list of the 'closing degree' entities. Set it if your TRV has the entity for better regulation. There should be one per underlying climate entities",
           "proportional_function": "Algorithm to use (TPI is the only one for now)",
-          "min_opening_degrees": "A comma seperated list of minimal opening degrees. Default to 0. Example: 20, 25, 30"
+          "min_opening_degrees": "Opening degree minimum value for each underlying device, comma separated. Default to 0. Example: 20, 25, 30"
         }
       }
     },

custom_components/versatile_thermostat/translations/fr.json

@@ -71,7 +71,7 @@
       },
       "type": {
         "title": "Entité(s) liée(s)",
-        "description": "Attributs de(s) l'entité(s) liée(s)",
+        "description": "Attributs de(s) l'entité(s) liée(s) [![?](https://img.icons8.com/color/18/help.png)](https://github.com/jmcollin78/versatile_thermostat/blob/main/documentation/fr/over-switch.md#configuration)",
         "data": {
           "underlying_entity_ids": "Les équipements à controller",
           "heater_keep_alive": "keep-alive (sec)",
@@ -82,7 +82,11 @@
           "auto_regulation_periode_min": "Période minimale de régulation",
           "auto_regulation_use_device_temp": "Compenser la température interne du sous-jacent",
           "inverse_switch_command": "Inverser la commande",
-          "auto_fan_mode": " Auto ventilation mode"
+          "auto_fan_mode": " Auto ventilation mode",
+          "on_command_text": "Personnalisation des commandes d'allumage",
+          "vswitch_on_command": "Commande d'allumage (optionnel)",
+          "off_command_text": "Personnalisation des commandes d'extinction",
+          "vswitch_off_command": "Commande d'extinction (optionnel)"
         },
         "data_description": {
           "underlying_entity_ids": "La liste des équipements qui seront controlés par ce VTherm",
@@ -94,7 +98,8 @@
           "auto_regulation_periode_min": "La durée en minutes entre deux mise à jour faites par la régulation",
           "auto_regulation_use_device_temp": "Compenser la temperature interne du sous-jacent pour accélérer l'auto-régulation",
           "inverse_switch_command": "Inverse la commande du switch pour une installation avec fil pilote et diode",
-          "auto_fan_mode": "Active la ventilation automatiquement en cas d'écart important"
+          "auto_fan_mode": "Active la ventilation automatiquement en cas d'écart important",
+          "on_command_text": "Pour les sous-jacents de type `select` ou `climate` vous devez personnaliser les commandes."
         }
       },
       "tpi": {
@@ -319,7 +324,7 @@
       },
       "type": {
         "title": "Entité(s) liée(s) - {name}",
-        "description": "Attributs de(s) l'entité(s) liée(s)",
+        "description": "Attributs de(s) l'entité(s) liée(s) [![?](https://img.icons8.com/color/18/help.png)](https://github.com/jmcollin78/versatile_thermostat/blob/main/documentation/fr/over-switch.md#configuration)",
         "data": {
           "underlying_entity_ids": "Les équipements à controller",
           "heater_keep_alive": "keep-alive (sec)",
@@ -330,7 +335,11 @@
           "auto_regulation_periode_min": "Période minimale de régulation",
           "auto_regulation_use_device_temp": "Compenser la température interne du sous-jacent",
           "inverse_switch_command": "Inverser la commande",
-          "auto_fan_mode": " Auto ventilation mode"
+          "auto_fan_mode": " Auto ventilation mode",
+          "on_command_text": "Personnalisation des commandes d'allumage",
+          "vswitch_on_command": "Commande d'allumage (optionnel)",
+          "off_command_text": "Personnalisation des commandes d'extinction",
+          "vswitch_off_command": "Commande d'extinction (optionnel)"
         },
         "data_description": {
           "underlying_entity_ids": "La liste des équipements qui seront controlés par ce VTherm",
@@ -342,7 +351,8 @@
           "auto_regulation_periode_min": "La durée en minutes entre deux mise à jour faites par la régulation",
           "auto_regulation_use_device_temp": "Compenser la temperature interne du sous-jacent pour accélérer l'auto-régulation",
           "inverse_switch_command": "Inverse la commande du switch pour une installation avec fil pilote et diode",
-          "auto_fan_mode": "Active la ventilation automatiquement en cas d'écart important"
+          "auto_fan_mode": "Active la ventilation automatiquement en cas d'écart important",
+          "on_command_text": "Pour les sous-jacents de type `select` ou `climate`"
         }
       },
       "tpi": {
@@ -487,7 +497,8 @@
       "no_central_config": "Vous ne pouvez pas cocher 'Utiliser la configuration centrale' car aucune configuration centrale n'a été trouvée. Vous devez créer un Versatile Thermostat de type 'Central Configuration' pour pouvoir l'utiliser.",
       "service_configuration_format": "Mauvais format de la configuration du service",
       "valve_regulation_nb_entities_incorrect": "Le nombre d'entités pour la régulation par vanne doit être égal au nombre d'entité sous-jacentes",
-      "min_opening_degrees_format": "Une liste d'entiers positifs séparés par des ',' est attendu. Exemple : 20, 25, 30"
+      "min_opening_degrees_format": "Une liste d'entiers positifs séparés par des ',' est attendu. Exemple : 20, 25, 30",
+      "vswitch_configuration_incorrect": "La configuration de la personnalisation des commandes est incorrecte. Elle est obligatoire pour les sous-jacents non switch et le format doit être 'service_name[/attribut:valeur]'. Plus d'informations dans le README."
     },
     "abort": {
       "already_configured": "Le device est déjà configuré"

custom_components/versatile_thermostat/underlyings.py

@@ -2,10 +2,12 @@
 
 """ Underlying entities classes """
 import logging
-from typing import Any
+import re
+from typing import Any, Dict, Tuple
+
 from enum import StrEnum
 
-from homeassistant.const import ATTR_ENTITY_ID, STATE_ON, STATE_UNAVAILABLE
+from homeassistant.const import ATTR_ENTITY_ID, STATE_ON, STATE_OFF, STATE_UNAVAILABLE
 from homeassistant.core import State
 
 from homeassistant.exceptions import ServiceNotFound
@@ -209,17 +211,8 @@ class UnderlyingEntity:
 class UnderlyingSwitch(UnderlyingEntity):
     """Represent a underlying switch"""
 
-    _initialDelaySec: int
-    _on_time_sec: int
-    _off_time_sec: int
-
     def __init__(
-        self,
-        hass: HomeAssistant,
-        thermostat: Any,
-        switch_entity_id: str,
-        initial_delay_sec: int,
-        keep_alive_sec: float,
+        self, hass: HomeAssistant, thermostat: Any, switch_entity_id: str, initial_delay_sec: int, keep_alive_sec: float, vswitch_on: str = None, vswitch_off: str = None
     ) -> None:
         """Initialize the underlying switch"""
 
@@ -235,6 +228,14 @@ class UnderlyingSwitch(UnderlyingEntity):
         self._on_time_sec = 0
         self._off_time_sec = 0
         self._keep_alive = IntervalCaller(hass, keep_alive_sec)
+        self._vswitch_on = vswitch_on.strip() if vswitch_on else None
+        self._vswitch_off = vswitch_off.strip() if vswitch_off else None
+        self._domain = self._entity_id.split(".")[0]
+        # build command
+        command, data, state_on = self.build_command(use_on=True)
+        self._on_command = {"command": command, "data": data, "state": state_on}
+        command, data, state_off = self.build_command(use_on=False)
+        self._off_command = {"command": command, "data": data, "state": state_off}
 
     @property
     def initial_delay_sec(self):
@@ -243,7 +244,7 @@ class UnderlyingSwitch(UnderlyingEntity):
 
     @overrides
     @property
-    def is_inversed(self):
+    def is_inversed(self) -> bool:
         """Tells if the switch command should be inversed"""
         return self._thermostat.is_inversed
 
@@ -275,10 +276,15 @@ class UnderlyingSwitch(UnderlyingEntity):
     @property
     def is_device_active(self):
         """If the toggleable device is currently active."""
-        real_state = self._hass.states.is_state(self._entity_id, STATE_ON)
-        return (self.is_inversed and not real_state) or (
-            not self.is_inversed and real_state
-        )
+        # real_state = self._hass.states.is_state(self._entity_id, STATE_ON)
+        # return (self.is_inversed and not real_state) or (
+        #    not self.is_inversed and real_state
+        # )
+        is_on = self._hass.states.is_state(self._entity_id, self._on_command.get("state"))
+        if self.is_inversed:
+            return not is_on
+
+        return is_on
 
     async def _keep_alive_callback(self):
         """Keep alive: Turn on if already turned on, turn off if already turned off."""
@@ -305,18 +311,48 @@ class UnderlyingSwitch(UnderlyingEntity):
                 )
             await (self.turn_on() if self.is_device_active else self.turn_off())
 
-    # @overrides this breaks some unit tests TypeError: object MagicMock can't be used in 'await' expression
+    def build_command(self, use_on: bool) -> Tuple[str, Dict[str, str]]:
+        """Build a command and returns a command and a dict as data"""
+
+        value = None
+        data = {ATTR_ENTITY_ID: self._entity_id}
+        take_on = (use_on and not self.is_inversed) or (not use_on and self.is_inversed)
+        vswitch = self._vswitch_on if take_on else self._vswitch_off
+        if vswitch:
+            pattern = r"^(?P<command>[^\s/]+)(?:/(?P<argument>[^\s:]+)(?::(?P<value>[^\s]+))?)?$"
+            match = re.match(pattern, vswitch)
+
+            if match:
+                # Extraire les groupes nommés
+                command = match.group("command")
+                argument = match.group("argument")
+                value = match.group("value")
+                if argument is not None and value is not None:
+                    data.update({argument: value})
+            else:
+                raise ValueError(f"Invalid input format: {vswitch}. Must be conform to 'command[/argument[:value]]'")
+
+        else:
+            command = SERVICE_TURN_ON if take_on else SERVICE_TURN_OFF
+
+        if value is None:
+            value = STATE_ON if take_on else STATE_OFF
+
+        return command, data, value
+
     async def turn_off(self):
         """Turn heater toggleable device off."""
         self._keep_alive.cancel()  # Cancel early to avoid a turn_on/turn_off race condition
         _LOGGER.debug("%s - Stopping underlying entity %s", self, self._entity_id)
-        command = SERVICE_TURN_OFF if not self.is_inversed else SERVICE_TURN_ON
-        domain = self._entity_id.split(".")[0]
+
+        command = self._off_command.get("command")
+        data = self._off_command.get("data")
+
         # This may fails if called after shutdown
         try:
             try:
-                data = {ATTR_ENTITY_ID: self._entity_id}
-                await self._hass.services.async_call(domain, command, data)
+                _LOGGER.debug("%s - Sending command %s with data=%s", self, command, data)
+                await self._hass.services.async_call(self._domain, command, data)
                 self._keep_alive.set_async_action(self._keep_alive_callback)
             except Exception:
                 self._keep_alive.cancel()
@@ -332,12 +368,12 @@ class UnderlyingSwitch(UnderlyingEntity):
         if not await self.check_overpowering():
             return False
 
-        command = SERVICE_TURN_ON if not self.is_inversed else SERVICE_TURN_OFF
-        domain = self._entity_id.split(".")[0]
+        command = self._on_command.get("command")
+        data = self._on_command.get("data")
         try:
             try:
-                data = {ATTR_ENTITY_ID: self._entity_id}
-                await self._hass.services.async_call(domain, command, data)
+                _LOGGER.debug("%s - Sending command %s with data=%s", self, command, data)
+                await self._hass.services.async_call(self._domain, command, data)
                 self._keep_alive.set_async_action(self._keep_alive_callback)
                 return True
             except Exception:

documentation/fr/over-switch.md

@@ -7,6 +7,7 @@
     - [Le keep-alive](#le-keep-alive)
     - [Le mode AC](#le-mode-ac)
     - [L'inversion de la commande](#linversion-de-la-commande)
+    - [La personnalisation des commandes](#la-personnalisation-des-commandes)
 
 ## Pré-requis
 
@@ -17,8 +18,8 @@ L'installation doit ressembler à ça :
 1. L'utilisateur ou une automatisation ou le Sheduler programme une consigne (setpoint) par le biais d'un pre-réglage ou directement d'une température,
 2. régulièrement le thermomètre intérieur (2) ou extérieur (2b) envoie la température mesurée. Le thermomètre interieur doit être placé à une place pertinente pour le ressenti de l'utilisateur : idéalement au milieu du lieu de vie. Evitez de le mettre trop près d'une fenêtre ou trop proche du radiateur,
 3. avec les valeurs de consigne, les différentes températures et des paramètres de l'algorithme TPI (cf. [TPI](algorithms.md#lalgorithme-tpi)), VTherm va calculer un pourcentage de temps d'allumage,
-4. et va régulièrement commander l'allumage et l'extinction du ou des entités `switch` sous-jacentes,
-5. ces entités switchs sous-jacentes vont alors commander le switch physique
+4. et va régulièrement commander l'allumage et l'extinction du ou des entités `switch` (ou `select` ou `climate`) sous-jacentes,
+5. ces entités sous-jacentes vont alors commander l'équipement physique
 6. la commande du switch physique allumera ou éteindra le radiateur.
 
 > Le pourcentage d'allumage est recalculé à chaque cycle et c'est ce qui permet de réguler la température de la pièce.
@@ -31,7 +32,9 @@ Ensuite cliquez sur l'option de menu "Sous-jacents" et vous allez avoir cette pa
 ![image](images/config-linked-entity.png)
 
 ### les sous-jacents
-Dans la "liste des équipements à contrôler" vous mettez les switchs qui vont être controllés par le VTherm. Seuls les entités de type `switch` ou `input_boolean` sont acceptées.
+Dans la "liste des équipements à contrôler" vous mettez les switchs qui vont être controllés par le VTherm. Seuls les entités de type `switch` ou `input_boolean` ou `select` ou `input_select` ou `climate` sont acceptées.
+
+Si un des sous-jacents n'est pas un `switch` alors la personnalisation des commandes est obligatoires. Par défaut pour les `switch` les commandes sont les commandes classique d'allumage / extinction du switch (`turn_on`, `turn_off`)
 
 L'algorithme à utiliser est aujourd'hui limité à TPI est disponible. Voir [algorithme](#algorithme).
 Si plusieurs entités de type sont configurées, la thermostat décale les activations afin de minimiser le nombre de switch actif à un instant t. Ca permet une meilleure répartition de la puissance puisque chaque radiateur va s'allumer à son tour.
@@ -54,3 +57,37 @@ Il est possible de choisir un thermostat over switch qui commande une climatisat
 
 Si votre équipement est commandé par un fil pilote avec un diode, vous aurez certainement besoin de cocher la case "Inverser la case". Elle permet de mettre le switch à `On` lorsqu'on doit étiendre l'équipement et à `Off` lorsqu'on doit l'allumer. Les temps de cycle sont donc inversés avec cette option.
 
+### La personnalisation des commandes
+
+Cette section de configuration permet de personnaliser les commandes d'allumage et d'extinction envoyée à l'équipement sous-jacent,
+Ces commandes sont obligatoires si un des sous-jacents n'est pas un `switch` (pour les `switchs` les commandes d'allumage/extinction classiques sont utilisées).
+
+Pour personnaliser les commande, cliquez sur `Ajouter` en bas de page sur les commandes d'allumage et sur les commandes d'extinction :
+
+![virtual switch](images/config-vswitch1.png)
+
+et donner la commande d'allumage et d'exinction avec le format `commande[/attribut[:valeur]]`.
+Les commandes possibles dépendent du type de sous-jacents :
+
+| type de sous-jacent         | commandes d'allumage possibles        | commandes d'extinction possibles    | S'applique à                   |
+| --------------------------- | ------------------------------------- | ----------------------------------- | ------------------------------ |
+| `switch` ou `input_boolean` | `turn_on`                             | `turn_off`                          | tous les switchs               |
+| `select` ou `input_select`  | `select_option/option:comfort`        | `set_option/option:frost`           | Nodon SIN-4-FP-21 et assimilés |
+| `climate` (hvac_mode)       | `set_hvac_mode/hvac_mode:heat`        | `set_hvac_mode/hvac_mode:off`       | eCosy (via Tuya Local)         |
+| `climate` (preset)          | `set_preset_mode/preset_mode:comfort` | `set_preset_mode/preset_mode:frost` | Heatzy                         |
+
+Evidemment, tous ces exemples peuvent être adaptés à votre cas.
+
+Exemple pour un Nodon SIN-4-FP-21 :
+![virtual switch Nodon](images/config-vswitch2.png)
+
+Cliquez sur valider pour accepter les modifications.
+
+Si l'erreur suivante se produit :
+
+> La configuration de la personnalisation des commandes est incorrecte. Elle est obligatoire pour les sous-jacents non switch et le format doit être 'service_name[/attribut:valeur]'. Plus d'informations dans le README.
+
+Cela signifie que une des commandes saisies est invalide. Les règles à respecter sont les suivantes :
+1. chaque commande doit avoir le format `commande[/attribut[:valeur]]` (ex: `select_option/option:comfort` ou `turn_on`) sans blanc et sans caractères spéciaux sauf '_',
+2. il doit y avoir autant de commandes qu'il y a de sous-jacents déclarés sauf si tous les sous-jacents sont des `switchs` auquel cas il n'est pas nécessaire de paramétrer les commandes,
+3. si plusieurs sous-jacents sont configurés, les commandes doivent être dans le même ordre. Le nombre de commandes d'allumage doit être égal au nombre de commandes d'extinction et de sous-jacents (dans l'ordre donc). Il est possible de mettre des sous-jacents de type différent. À partir du moment où un sous-jacent n'est pas un `switch`, il faut paramétrer toutes les commandes de tous les sous-jacents y compris des éventuels switchs.

tests/test_safety.py

@@ -624,6 +624,7 @@ async def test_security_over_climate(
             assert entity._saved_preset_mode == "none"
 
 
+@pytest.mark.parametrize("expected_lingering_timers", [True])
 async def test_migration_security_safety(
     hass: HomeAssistant,
     skip_hass_states_is_state,

tests/test_virtual_switch.py

@@ -0,0 +1,168 @@
+""" Test of virtual switch """
+
+# pylint: disable=wildcard-import, unused-wildcard-import, protected-access, line-too-long
+
+from unittest.mock import patch, MagicMock, PropertyMock
+import pytest
+
+from homeassistant.const import STATE_ON, STATE_OFF
+
+from custom_components.versatile_thermostat.underlyings import UnderlyingSwitch
+from custom_components.versatile_thermostat.thermostat_switch import ThermostatOverSwitch
+from .commons import *
+
+
+@pytest.mark.parametrize(
+    "is_inversed, vswitch_on_command, vswitch_off_command, expected_command_on, expected_data_on, expected_state_on, expected_command_off, expected_data_off, expected_state_off, is_ok",
+    [
+        # Select (with stripping - trim)
+        (
+            False,
+            " select_option/option:comfort ",
+            "  select_option/option:frost      ",
+            "select_option",
+            {"entity_id": "switch.test", "option": "comfort"},
+            PRESET_COMFORT,
+            "select_option",
+            {"entity_id": "switch.test", "option": "frost"},
+            PRESET_FROST_PROTECTION,
+            True,
+        ),
+        # Inversed Select
+        (
+            True,
+            "select_option/option:comfort",
+            "select_option/option:eco",
+            "select_option",
+            {"entity_id": "switch.test", "option": "eco"},
+            PRESET_ECO,
+            "select_option",
+            {"entity_id": "switch.test", "option": "comfort"},
+            PRESET_COMFORT,
+            True,
+        ),
+        # switch
+        (False, "turn_on", "turn_off", "turn_on", {"entity_id": "switch.test"}, STATE_ON, "turn_off", {"entity_id": "switch.test"}, STATE_OFF, True),
+        # inversed switch
+        (True, "turn_on", "turn_off", "turn_off", {"entity_id": "switch.test"}, STATE_OFF, "turn_on", {"entity_id": "switch.test"}, STATE_ON, True),
+        # Climate
+        (
+            False,
+            "set_hvac_mode/hvac_mode:heat",
+            "set_hvac_mode/hvac_mode:off",
+            "set_hvac_mode",
+            {"entity_id": "switch.test", "hvac_mode": "heat"},
+            HVACMode.HEAT,
+            "set_hvac_mode",
+            {"entity_id": "switch.test", "hvac_mode": "off"},
+            HVACMode.OFF,
+            True,
+        ),
+        # Inversed Climate
+        (
+            True,
+            "set_hvac_mode/hvac_mode:heat",
+            "set_hvac_mode/hvac_mode:off",
+            "set_hvac_mode",
+            {"entity_id": "switch.test", "hvac_mode": "off"},
+            HVACMode.OFF,
+            "set_hvac_mode",
+            {"entity_id": "switch.test", "hvac_mode": "heat"},
+            HVACMode.HEAT,
+            True,
+        ),
+        # Error cases invalid command
+        (
+            False,
+            "select_ option/option:comfort",  # whitespace
+            "select_option/option:frost",
+            "select_option",
+            {"entity_id": "switch.test", "option": "comfort"},
+            PRESET_COMFORT,
+            "select_option",
+            {"entity_id": "switch.test", "option": "frost"},
+            PRESET_FROST_PROTECTION,
+            False,
+        ),
+        (
+            False,
+            "select_option/option comfort",  # whitespace
+            "select_option/option:frost",
+            "select_option",
+            {"entity_id": "switch.test", "option": "comfort"},
+            PRESET_COMFORT,
+            "select_option",
+            {"entity_id": "switch.test", "option": "frost"},
+            PRESET_FROST_PROTECTION,
+            False,
+        ),
+        (
+            False,
+            "select_option/option:com fort",  # whitespace
+            "select_option/option:frost",
+            "select_option",
+            {"entity_id": "switch.test", "option": "comfort"},
+            PRESET_COMFORT,
+            "select_option",
+            {"entity_id": "switch.test", "option": "frost"},
+            PRESET_FROST_PROTECTION,
+            False,
+        ),
+    ],
+)
+async def test_build_command(
+    hass,
+    is_inversed,
+    vswitch_on_command,
+    vswitch_off_command,
+    expected_command_on,
+    expected_data_on,
+    expected_state_on,
+    expected_command_off,
+    expected_data_off,
+    expected_state_off,
+    is_ok,
+):
+    """Test the initialisation of a UnderlyingSwitch with some personnalisations commands"""
+
+    vtherm = MagicMock(spec=ThermostatOverSwitch)
+    type(vtherm).is_inversed = PropertyMock(return_value=is_inversed)
+
+    assert vtherm.is_inversed == is_inversed
+
+    try:
+        under = UnderlyingSwitch(hass, vtherm, "switch.test", 0, 0, vswitch_on_command, vswitch_off_command)
+    except ValueError as e:
+        if is_ok:
+            pytest.fail(f"Initialization failed with ValueError: {e}")
+        else:
+            return
+
+    if not is_ok:
+        pytest.fail("There should be a ValueError")
+        return
+
+    assert under.is_inversed == is_inversed
+
+    assert under._on_command.get("command") == expected_command_on
+    assert under._on_command.get("data") == expected_data_on
+    assert under._on_command.get("state") == expected_state_on
+
+    assert under._off_command.get("command") == expected_command_off
+    assert under._off_command.get("data") == expected_data_off
+    assert under._off_command.get("state") == expected_state_off
+
+    # Calling turn-on
+    # fmt: off
+    with patch.object(under, "check_overpowering", return_value=True), \
+         patch("homeassistant.core.ServiceRegistry.async_call") as mock_service_call:
+    #fmt: on
+        await under.turn_on()
+        mock_service_call.assert_called_once_with("switch", expected_command_on, expected_data_on)
+
+    # Calling turn-off
+    #fmt: off
+    with patch("homeassistant.core.ServiceRegistry.async_call") as mock_service_call:
+    #fmt: on
+        await under.turn_off()
+        mock_service_call.assert_called_once_with("switch", expected_command_off, expected_data_off)