Issue #524 switch from cool to heat don't change the target temp (#529)

* Preparation tests ok

* Fixed

---------

Co-authored-by: Jean-Marc Collin <jean-marc.collin-extern@renault.com>

.vscode/settings.json

@@ -4,7 +4,6 @@
         "editor.formatOnSave": true,
         "editor.formatOnSaveMode": "modifications"
     },
-    "pylint.lintOnChange": false,
     "files.associations": {
         "*.yaml": "home-assistant"
     },

README-fr.md

@@ -1202,9 +1202,9 @@ Une carte spéciale pour le Versatile Thermostat a été développée (sur la ba
 ## Encore mieux avec le composant Scheduler !
 
 Afin de profiter de toute la puissance du Versatile Thermostat, je vous invite à l'utiliser avec https://github.com/nielsfaber/scheduler-component
-En effet, le composant scheduler propose une gestion de la base climatique sur les modes prédéfinis. Cette fonctionnalité a un intérêt limité avec le thermostat générique mais elle devient très puissante avec le thermostat Awesome :
+En effet, le composant scheduler propose une gestion de la base climatique sur les modes prédéfinis. Cette fonctionnalité a un intérêt limité avec le thermostat générique mais elle devient très puissante avec le Versatile Thermostat :
 
-À partir d'ici, je suppose que vous avez installé Awesome Thermostat et Scheduler Component.
+À partir d'ici, je suppose que vous avez installé Versatile Thermostat et Scheduler Component.
 
 Dans Scheduler, ajoutez un planning :
 

custom_components/versatile_thermostat/__init__.py

@@ -13,6 +13,7 @@ from homeassistant.const import SERVICE_RELOAD, EVENT_HOMEASSISTANT_STARTED
 
 from homeassistant.config_entries import ConfigEntry, ConfigType
 from homeassistant.core import HomeAssistant, CoreState, callback
+from homeassistant.helpers.service import async_register_admin_service
 
 from .base_thermostat import BaseThermostat
 
@@ -115,7 +116,8 @@ async def async_setup(
     else:
         hass.bus.async_listen_once(EVENT_HOMEASSISTANT_STARTED, _async_startup_internal)
 
-    hass.helpers.service.async_register_admin_service(
+    async_register_admin_service(
+        hass,
         DOMAIN,
         SERVICE_RELOAD,
         _handle_reload,

custom_components/versatile_thermostat/base_thermostat.py

@@ -13,7 +13,6 @@ from homeassistant.util import dt as dt_util
 from homeassistant.core import (
     HomeAssistant,
     callback,
-    CoreState,
     Event,
     State,
 )
@@ -22,7 +21,6 @@ from homeassistant.components.climate import ClimateEntity
 from homeassistant.helpers.restore_state import RestoreEntity
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.helpers.device_registry import DeviceInfo, DeviceEntryType
-from homeassistant.helpers.typing import EventType as HASSEventType
 
 from homeassistant.helpers.event import (
     async_track_state_change_event,
@@ -58,7 +56,6 @@ from homeassistant.const import (
     STATE_UNKNOWN,
     STATE_OFF,
     STATE_ON,
-    EVENT_HOMEASSISTANT_START,
     STATE_HOME,
     STATE_NOT_HOME,
 )
@@ -300,7 +297,7 @@ class BaseThermostat(ClimateEntity, RestoreEntity, Generic[T]):
         self._presets: dict[str, Any] = {}  # presets
         self._presets_away: dict[str, Any] = {}  # presets_away
 
-        self._attr_preset_modes: list[str] | None
+        self._attr_preset_modes: list[str] = []
 
         self._use_central_config_temperature = False
 
@@ -1238,7 +1235,7 @@ class BaseThermostat(ClimateEntity, RestoreEntity, Generic[T]):
             )
 
         # If AC is on maybe we have to change the temperature in force mode, but not in frost mode (there is no Frost protection possible in AC mode)
-        if self._hvac_mode == HVACMode.COOL and self.preset_mode != PRESET_NONE:
+        if self._hvac_mode in [HVACMode.COOL, HVACMode.HEAT, HVACMode.HEAT_COOL] and self.preset_mode != PRESET_NONE:
             if self.preset_mode != PRESET_FROST_PROTECTION:
                 await self._async_set_preset_mode_internal(self.preset_mode, True)
             else:
@@ -1790,7 +1787,7 @@ class BaseThermostat(ClimateEntity, RestoreEntity, Generic[T]):
             _LOGGER.error("Unable to update external temperature from sensor: %s", ex)
 
     @callback
-    async def _async_power_changed(self, event: HASSEventType[EventStateChangedData]):
+    async def _async_power_changed(self, event: Event[EventStateChangedData]):
         """Handle power changes."""
         _LOGGER.debug("Thermostat %s - Receive new Power event", self.name)
         _LOGGER.debug(event)
@@ -1816,9 +1813,7 @@ class BaseThermostat(ClimateEntity, RestoreEntity, Generic[T]):
             _LOGGER.error("Unable to update current_power from sensor: %s", ex)
 
     @callback
-    async def _async_max_power_changed(
+    async def _async_max_power_changed(self, event: Event[EventStateChangedData]):
-        self, event: HASSEventType[EventStateChangedData]
-    ):
         """Handle power max changes."""
         _LOGGER.debug("Thermostat %s - Receive new Power Max event", self.name)
         _LOGGER.debug(event)
@@ -1843,9 +1838,7 @@ class BaseThermostat(ClimateEntity, RestoreEntity, Generic[T]):
             _LOGGER.error("Unable to update current_power from sensor: %s", ex)
 
     @callback
-    async def _async_presence_changed(
+    async def _async_presence_changed(self, event: Event[EventStateChangedData]):
-        self, event: HASSEventType[EventStateChangedData]
-    ):
         """Handle presence changes."""
         new_state = event.data.get("new_state")
         _LOGGER.info(
@@ -2188,7 +2181,7 @@ class BaseThermostat(ClimateEntity, RestoreEntity, Generic[T]):
             new_central_mode,
         )
 
-        first_init = self._last_central_mode == None
+        first_init = self._last_central_mode is None
 
         self._last_central_mode = new_central_mode
 

custom_components/versatile_thermostat/climate.py

@@ -72,6 +72,13 @@ async def async_setup_entry(
         entity = ThermostatOverClimate(hass, unique_id, name, entry.data)
     elif vt_type == CONF_THERMOSTAT_VALVE:
         entity = ThermostatOverValve(hass, unique_id, name, entry.data)
+    else:
+        _LOGGER.error(
+            "Cannot create Versatile Thermostat name=%s of type %s which is unknown",
+            name,
+            vt_type,
+        )
+        return
 
     async_add_entities([entity], True)
 

custom_components/versatile_thermostat/config_flow.py

@@ -99,30 +99,31 @@ class VersatileThermostatBaseConfigFlow(FlowHandler):
 
     def _init_feature_flags(self, _):
         """Fix features selection depending to infos"""
-        is_empty: bool = False  # TODO remove this not bool(infos)
         is_central_config = (
             self._infos.get(CONF_THERMOSTAT_TYPE) == CONF_THERMOSTAT_CENTRAL_CONFIG
         )
 
         self._infos[CONF_USE_WINDOW_FEATURE] = (
-            is_empty
+            self._infos.get(CONF_USE_WINDOW_CENTRAL_CONFIG)
             or self._infos.get(CONF_WINDOW_SENSOR) is not None
             or self._infos.get(CONF_WINDOW_AUTO_OPEN_THRESHOLD) is not None
         )
-        self._infos[CONF_USE_MOTION_FEATURE] = (
+        self._infos[CONF_USE_MOTION_FEATURE] = self._infos.get(
-            is_empty
+            CONF_USE_MOTION_FEATURE
-            or self._infos.get(CONF_MOTION_SENSOR) is not None
+        ) and (self._infos.get(CONF_MOTION_SENSOR) is not None or is_central_config)
-            or is_central_config
+
-        )
+        self._infos[CONF_USE_POWER_FEATURE] = self._infos.get(
-        self._infos[CONF_USE_POWER_FEATURE] = is_empty or (
+            CONF_USE_POWER_CENTRAL_CONFIG
+        ) or (
             self._infos.get(CONF_POWER_SENSOR) is not None
             and self._infos.get(CONF_MAX_POWER_SENSOR) is not None
         )
         self._infos[CONF_USE_PRESENCE_FEATURE] = (
-            is_empty or self._infos.get(CONF_PRESENCE_SENSOR) is not None
+            self._infos.get(CONF_USE_PRESENCE_CENTRAL_CONFIG)
+            or self._infos.get(CONF_PRESENCE_SENSOR) is not None
         )
 
-        self._infos[CONF_USE_CENTRAL_BOILER_FEATURE] = is_empty or (
+        self._infos[CONF_USE_CENTRAL_BOILER_FEATURE] = (
             self._infos.get(CONF_CENTRAL_BOILER_ACTIVATION_SRV) is not None
             and self._infos.get(CONF_CENTRAL_BOILER_DEACTIVATION_SRV) is not None
         )

custom_components/versatile_thermostat/manifest.json

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

custom_components/versatile_thermostat/prop_algorithm.py

@@ -14,6 +14,10 @@ PROPORTIONAL_MIN_DURATION_SEC = 10
 FUNCTION_TYPE = [PROPORTIONAL_FUNCTION_ATAN, PROPORTIONAL_FUNCTION_LINEAR]
 
 
+def is_number(value):
+    return isinstance(value, (int, float))
+
+
 class PropAlgorithm:
     """This class aims to do all calculation of the Proportional alogorithm"""
 
@@ -36,6 +40,30 @@ class PropAlgorithm:
             cycle_min,
             minimal_activation_delay,
         )
+
+        # Issue 506 - check parameters
+        if (
+            vtherm_entity_id is None
+            or not is_number(tpi_coef_int)
+            or not is_number(tpi_coef_ext)
+            or not is_number(cycle_min)
+            or not is_number(minimal_activation_delay)
+            or function_type != PROPORTIONAL_FUNCTION_TPI
+        ):
+            _LOGGER.error(
+                "%s - configuration is wrong. function_type=%s, entity_id is %s, tpi_coef_int is %s, tpi_coef_ext is %s, cycle_min is %s, minimal_activation_delay is %s",
+                vtherm_entity_id,
+                function_type,
+                vtherm_entity_id,
+                tpi_coef_int,
+                tpi_coef_ext,
+                cycle_min,
+                minimal_activation_delay,
+            )
+            raise TypeError(
+                f"TPI parameters are not set correctly. VTherm will not work as expected. Please reconfigure it correctly. See previous log for values"
+            )
+
         self._vtherm_entity_id = vtherm_entity_id
         self._function = function_type
         self._tpi_coef_int = tpi_coef_int
@@ -70,9 +98,9 @@ class PropAlgorithm:
             if hvac_mode == HVACMode.COOL:
                 delta_temp = current_temp - target_temp
                 delta_ext_temp = (
-                    ext_current_temp
+                    ext_current_temp - target_temp
                     if ext_current_temp is not None
-                    else 0 - target_temp
+                    else 0
                 )
             else:
                 delta_temp = target_temp - current_temp

custom_components/versatile_thermostat/strings.json

@@ -90,7 +90,7 @@
           "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"
         },
         "data_description": {
           "heater_entity_id": "Mandatory heater entity id",
@@ -113,7 +113,7 @@
           "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"
         }
       },
       "tpi": {
@@ -325,7 +325,7 @@
           "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"
         },
         "data_description": {
           "heater_entity_id": "Mandatory heater entity id",
@@ -348,7 +348,7 @@
           "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"
         }
       },
       "tpi": {

custom_components/versatile_thermostat/thermostat_climate.py

@@ -3,13 +3,12 @@
 import logging
 from datetime import timedelta, datetime
 
-from homeassistant.core import HomeAssistant, State, callback
+from homeassistant.core import Event, HomeAssistant, State, callback
 from homeassistant.helpers.event import (
     async_track_state_change_event,
     async_track_time_interval,
     EventStateChangedData,
 )
-from homeassistant.helpers.typing import EventType as HASSEventType
 from homeassistant.components.climate import (
     HVACAction,
     HVACMode,
@@ -143,7 +142,17 @@ class ThermostatOverClimate(BaseThermostat[UnderlyingClimate]):
         """Sends the regulated temperature to all underlying"""
 
         if self.hvac_mode == HVACMode.OFF:
-            _LOGGER.debug("%s - don't send regulated temperature cause VTherm is off ")
+            _LOGGER.debug(
+                "%s - don't send regulated temperature cause VTherm is off ", self
+            )
+            return
+
+        if self.target_temperature is None:
+            _LOGGER.warning(
+                "%s - don't send regulated temperature cause VTherm target_temp (%s) is None. This should be a temporary warning message.",
+                self,
+                self.target_temperature,
+            )
             return
 
         _LOGGER.info(
@@ -170,16 +179,17 @@ class ThermostatOverClimate(BaseThermostat[UnderlyingClimate]):
 
         # use _attr_target_temperature_step to round value if _auto_regulation_dtemp is equal to 0
         regulation_step = self._auto_regulation_dtemp if self._auto_regulation_dtemp else self._attr_target_temperature_step
-        _LOGGER.debug("%s - usage of regulation_step: %.2f ",
+        _LOGGER.debug("%s - usage regulation_step: %.2f ", self, regulation_step)
-                      self,
-                      regulation_step)
 
+        if self.current_temperature is not None:
             new_regulated_temp = round_to_nearest(
                 self._regulation_algo.calculate_regulated_temperature(
                     self.current_temperature, self._cur_ext_temp
                 ),
                 regulation_step,
             )
+        else:
+            new_regulated_temp = self.target_temperature
         dtemp = new_regulated_temp - self._regulated_target_temp
 
         if not force and abs(dtemp) < self._auto_regulation_dtemp:
@@ -204,8 +214,10 @@ class ThermostatOverClimate(BaseThermostat[UnderlyingClimate]):
             offset_temp = 0
             device_temp = 0
             if (
+                # current_temperature is set
+                self.current_temperature is not None
                 # regulation can use the device_temp
-                self.auto_regulation_use_device_temp
+                and self.auto_regulation_use_device_temp
                 # and we have access to the device temp
                 and (device_temp := under.underlying_current_temperature) is not None
                 # and target is not reach (ie we need regulation)
@@ -600,7 +612,7 @@ class ThermostatOverClimate(BaseThermostat[UnderlyingClimate]):
         )
 
     @callback
-    async def _async_climate_changed(self, event: HASSEventType[EventStateChangedData]):
+    async def _async_climate_changed(self, event: Event[EventStateChangedData]):
         """Handle unerdlying climate state changes.
         This method takes the underlying values and update the VTherm with them.
         To avoid loops (issues #121 #101 #95 #99), we discard the event if it is received

custom_components/versatile_thermostat/thermostat_switch.py

@@ -2,12 +2,11 @@
 
 """ A climate over switch classe """
 import logging
-from homeassistant.core import callback
+from homeassistant.core import Event, callback
 from homeassistant.helpers.event import (
     async_track_state_change_event,
     EventStateChangedData,
 )
-from homeassistant.helpers.typing import EventType as HASSEventType
 from homeassistant.components.climate import HVACMode
 
 from .const import (
@@ -212,7 +211,7 @@ class ThermostatOverSwitch(BaseThermostat[UnderlyingSwitch]):
         )
 
     @callback
-    def _async_switch_changed(self, event: HASSEventType[EventStateChangedData]):
+    def _async_switch_changed(self, event: Event[EventStateChangedData]):
         """Handle heater switch state changes."""
         new_state = event.data.get("new_state")
         old_state = event.data.get("old_state")

custom_components/versatile_thermostat/thermostat_valve.py

@@ -8,8 +8,7 @@ from homeassistant.helpers.event import (
     async_track_time_interval,
     EventStateChangedData,
 )
-from homeassistant.helpers.typing import EventType as HASSEventType
+from homeassistant.core import Event, HomeAssistant, callback
-from homeassistant.core import HomeAssistant, callback
 from homeassistant.components.climate import HVACMode
 
 from .base_thermostat import BaseThermostat, ConfigData
@@ -149,7 +148,7 @@ class ThermostatOverValve(BaseThermostat[UnderlyingValve]):  # pylint: disable=a
         )
 
     @callback
-    async def _async_valve_changed(self, event: HASSEventType[EventStateChangedData]):
+    async def _async_valve_changed(self, event: Event[EventStateChangedData]):
         """Handle unerdlying valve state changes.
         This method just log the change. It changes nothing to avoid loops.
         """

custom_components/versatile_thermostat/translations/el.json

@@ -43,7 +43,7 @@
           "auto_regulation_dtemp": "Όριο ρύθμισης",
           "auto_regulation_periode_min": "Ελάχιστη περίοδος ρύθμισης",
           "inverse_switch_command": "Αντίστροφη εντολή διακόπτη",
-          "auto_fan_mode": " Auto fan mode"
+          "auto_fan_mode": "Auto fan mode"
         },
         "data_description": {
           "heater_entity_id": "Υποχρεωτική ταυτότητα οντότητας θερμαντήρα",
@@ -64,7 +64,7 @@
           "auto_regulation_dtemp": "Το όριο σε ° κάτω από το οποίο η αλλαγή θερμοκρασίας δεν θα αποστέλλεται",
           "auto_regulation_periode_min": "Διάρκεια σε λεπτά μεταξύ δύο ενημερώσεων ρύθμισης",
           "inverse_switch_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"
         }
       },
       "tpi": {
@@ -216,7 +216,7 @@
           "auto_regulation_dtemp": "Όριο ρύθμισης",
           "auto_regulation_periode_min": "Ελάχιστη περίοδος ρύθμισης",
           "inverse_switch_command": "Αντίστροφη εντολή διακόπτη",
-          "auto_fan_mode": " Auto fan mode"
+          "auto_fan_mode": "Auto fan mode"
         },
         "data_description": {
           "heater_entity_id": "Υποχρεωτική ταυτότητα οντότητας θερμαντήρα",
@@ -237,7 +237,7 @@
           "auto_regulation_dtemp": "Το κατώφλι σε °C κάτω από το οποίο η αλλαγή της θερμοκρασίας δεν θα αποστέλλεται",
           "auto_regulation_periode_min": "Διάρκεια σε λεπτά μεταξύ δύο ενημερώσεων ρύθμισης",
           "inverse_switch_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"
         }
       },
       "tpi": {

custom_components/versatile_thermostat/translations/en.json

@@ -90,7 +90,7 @@
           "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"
         },
         "data_description": {
           "heater_entity_id": "Mandatory heater entity id",
@@ -113,7 +113,7 @@
           "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"
         }
       },
       "tpi": {
@@ -325,7 +325,7 @@
           "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"
         },
         "data_description": {
           "heater_entity_id": "Mandatory heater entity id",
@@ -348,7 +348,7 @@
           "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"
         }
       },
       "tpi": {

custom_components/versatile_thermostat/translations/fr.json

@@ -337,7 +337,7 @@
           "auto_regulation_periode_min": "Période minimale de régulation",
           "auto_regulation_use_device_temp": "Utiliser la température interne du sous-jacent",
           "inverse_switch_command": "Inverser la commande",
-          "auto_fan_mode": " Auto fan mode"
+          "auto_fan_mode": "Auto fan mode"
         },
         "data_description": {
           "heater_entity_id": "Entity id du 1er radiateur obligatoire",

custom_components/versatile_thermostat/translations/it.json

@@ -42,7 +42,7 @@
           "valve_entity4_id": "Quarta valvola",
           "auto_regulation_mode": "Autoregolamentazione",
           "inverse_switch_command": "Comando inverso",
-          "auto_fan_mode": " Auto fan mode"
+          "auto_fan_mode": "Auto fan mode"
         },
         "data_description": {
           "heater_entity_id": "Entity id obbligatoria del primo riscaldatore",
@@ -62,7 +62,7 @@
           "valve_entity4_id": "Entity id della quarta valvola",
           "auto_regulation_mode": "Regolazione automatica della temperatura target",
           "inverse_switch_command": "Inverte il controllo dell'interruttore per un'installazione con filo pilota e diodo",
-          "auto_fan_mode": " Automatically activate fan when huge heating/cooling is necessary"
+          "auto_fan_mode": "Automatically activate fan when huge heating/cooling is necessary"
         }
       },
       "tpi": {
@@ -206,7 +206,7 @@
           "valve_entity4_id": "Quarta valvola",
           "auto_regulation_mode": "Autoregolamentazione",
           "inverse_switch_command": "Comando inverso",
-          "auto_fan_mode": " Auto fan mode"
+          "auto_fan_mode": "Auto fan mode"
         },
         "data_description": {
           "heater_entity_id": "Entity id obbligatoria del primo riscaldatore",
@@ -226,7 +226,7 @@
           "valve_entity4_id": "Entity id della quarta valvola",
           "auto_regulation_mode": "Autoregolamentazione",
           "inverse_switch_command": "Inverte il controllo dell'interruttore per un'installazione con filo pilota e diodo",
-          "auto_fan_mode": " Automatically activate fan when huge heating/cooling is necessary"
+          "auto_fan_mode": "Automatically activate fan when huge heating/cooling is necessary"
         }
       },
       "tpi": {

custom_components/versatile_thermostat/underlyings.py

@@ -612,11 +612,21 @@ class UnderlyingClimate(UnderlyingEntity):
         if not self.is_initialized:
             return
 
+        # Issue 508 we have to take care of service set_temperature or set_range
+        target_temp = self.cap_sent_value(temperature)
+        if (
+            ClimateEntityFeature.TARGET_TEMPERATURE_RANGE
+            in self._underlying_climate.supported_features
+        ):
             data = {
                 ATTR_ENTITY_ID: self._entity_id,
-            "temperature": self.cap_sent_value(temperature),
+                "target_temp_high": target_temp,
-            "target_temp_high": max_temp,
+                "target_temp_low": target_temp,
-            "target_temp_low": min_temp,
+            }
+        else:
+            data = {
+                ATTR_ENTITY_ID: self._entity_id,
+                "temperature": target_temp,
             }
 
         await self._hass.services.async_call(

hacs.json

@@ -3,5 +3,5 @@
     "content_in_root": false,
     "render_readme": true,
     "hide_default_branch": false,
-    "homeassistant": "2024.6.1"
+    "homeassistant": "2024.9.3"
 }

requirements_dev.txt

@@ -1 +1 @@
-homeassistant==2024.6.1
+homeassistant==2024.9.3

tests/commons.py

@@ -435,6 +435,86 @@ class MagicMockClimate(MagicMock):
         return 19
 
 
+class MagicMockClimateWithTemperatureRange(MagicMock):
+    """A Magic Mock class for a underlying climate entity"""
+
+    @property
+    def temperature_unit(self):  # pylint: disable=missing-function-docstring
+        return UnitOfTemperature.CELSIUS
+
+    @property
+    def hvac_mode(self):  # pylint: disable=missing-function-docstring
+        return HVACMode.HEAT
+
+    @property
+    def hvac_action(self):  # pylint: disable=missing-function-docstring
+        return HVACAction.IDLE
+
+    @property
+    def target_temperature(self):  # pylint: disable=missing-function-docstring
+        return 15
+
+    @property
+    def current_temperature(self):  # pylint: disable=missing-function-docstring
+        return 14
+
+    @property
+    def target_temperature_step(  # pylint: disable=missing-function-docstring
+        self,
+    ) -> float | None:
+        return 0.5
+
+    @property
+    def target_temperature_high(  # pylint: disable=missing-function-docstring
+        self,
+    ) -> float | None:
+        return 35
+
+    @property
+    def target_temperature_low(  # pylint: disable=missing-function-docstring
+        self,
+    ) -> float | None:
+        return 7
+
+    @property
+    def hvac_modes(  # pylint: disable=missing-function-docstring
+        self,
+    ) -> list[str] | None:
+        return [HVACMode.HEAT, HVACMode.OFF, HVACMode.COOL]
+
+    @property
+    def fan_modes(  # pylint: disable=missing-function-docstring
+        self,
+    ) -> list[str] | None:
+        return None
+
+    @property
+    def swing_modes(  # pylint: disable=missing-function-docstring
+        self,
+    ) -> list[str] | None:
+        return None
+
+    @property
+    def fan_mode(self) -> str | None:  # pylint: disable=missing-function-docstring
+        return None
+
+    @property
+    def swing_mode(self) -> str | None:  # pylint: disable=missing-function-docstring
+        return None
+
+    @property
+    def supported_features(self):  # pylint: disable=missing-function-docstring
+        return ClimateEntityFeature.TARGET_TEMPERATURE_RANGE
+
+    @property
+    def min_temp(self):  # pylint: disable=missing-function-docstring
+        return 10
+
+    @property
+    def max_temp(self):  # pylint: disable=missing-function-docstring
+        return 31
+
+
 class MockSwitch(SwitchEntity):
     """A fake switch to be used instead real switch"""
 
@@ -907,3 +987,8 @@ async def set_climate_preset_temp(
     )
     if temp_entity:
         await temp_entity.async_set_native_value(temp)
+    else:
+        _LOGGER.warning(
+            "commons tests set_cliamte_preset_temp: cannot find number entity with entity_id '%s'",
+            number_entity_id,
+        )

tests/test_auto_regulation.py

@@ -53,18 +53,6 @@ async def test_over_climate_regulation(
         return_value=fake_underlying_climate,
     ):
         entity = await create_thermostat(hass, entry, "climate.theoverclimatemockname")
-        # entry.add_to_hass(hass)
-        # await hass.config_entries.async_setup(entry.entry_id)
-        # assert entry.state is ConfigEntryState.LOADED
-        #
-        # def find_my_entity(entity_id) -> ClimateEntity:
-        #    """Find my new entity"""
-        #    component: EntityComponent[ClimateEntity] = hass.data[CLIMATE_DOMAIN]
-        #    for entity in component.entities:
-        #        if entity.entity_id == entity_id:
-        #            return entity
-        #
-        # entity: ThermostatOverClimate = find_my_entity("climate.theoverclimatemockname")
 
         assert entity
         assert isinstance(entity, ThermostatOverClimate)
@@ -163,18 +151,6 @@ async def test_over_climate_regulation_ac_mode(
         return_value=fake_underlying_climate,
     ):
         entity = await create_thermostat(hass, entry, "climate.theoverclimatemockname")
-        # entry.add_to_hass(hass)
-        # await hass.config_entries.async_setup(entry.entry_id)
-        # assert entry.state is ConfigEntryState.LOADED
-        #
-        # def find_my_entity(entity_id) -> ClimateEntity:
-        #     """Find my new entity"""
-        #     component: EntityComponent[ClimateEntity] = hass.data[CLIMATE_DOMAIN]
-        #     for entity in component.entities:
-        #         if entity.entity_id == entity_id:
-        #             return entity
-        #
-        # entity: ThermostatOverClimate = find_my_entity("climate.theoverclimatemockname")
 
         assert entity
         assert isinstance(entity, ThermostatOverClimate)
@@ -626,9 +602,7 @@ async def test_over_climate_regulation_dtemp_null(
 
             # the regulated temperature should be greater
             assert entity.regulated_target_temp > entity.target_temperature
-            assert (
+            assert entity.regulated_target_temp == 20 + 0.9
-                entity.regulated_target_temp == 20 + 0.9
-            ) 
 
             # change temperature so that the regulated temperature should slow down
         event_timestamp = now - timedelta(minutes=13)
@@ -641,9 +615,7 @@ async def test_over_climate_regulation_dtemp_null(
 
             # the regulated temperature should be greater
             assert entity.regulated_target_temp > entity.target_temperature
-            assert (
+            assert entity.regulated_target_temp == 20 + 0.5
-                entity.regulated_target_temp == 20 + 0.5
-            ) 
 
         old_regulated_temp = entity.regulated_target_temp
         # Test if a small temperature change is taken into account : change temperature so that dtemp < 0.5 and time is > period_min (+ 3min)

tests/test_bugs.py

@@ -12,6 +12,18 @@ from homeassistant.components.climate import (
     SERVICE_SET_TEMPERATURE,
 )
 
+
+from custom_components.versatile_thermostat.config_flow import (
+    VersatileThermostatBaseConfigFlow,
+)
+from custom_components.versatile_thermostat.thermostat_valve import ThermostatOverValve
+from custom_components.versatile_thermostat.thermostat_climate import (
+    ThermostatOverClimate,
+)
+from custom_components.versatile_thermostat.thermostat_switch import (
+    ThermostatOverSwitch,
+)
+
 from .commons import *
 
 logging.getLogger().setLevel(logging.DEBUG)
@@ -657,8 +669,8 @@ async def test_bug_272(
                     {
                         "entity_id": "climate.mock_climate",
                         "temperature": 17.5,
-                        "target_temp_high": 30,
+                        # "target_temp_high": 30,
-                        "target_temp_low": 15,
+                        # "target_temp_low": 15,
                     },
                 ),
             ]
@@ -687,8 +699,8 @@ async def test_bug_272(
                     {
                         "entity_id": "climate.mock_climate",
                         "temperature": 15,  # the minimum acceptable
-                        "target_temp_high": 30,
+                        # "target_temp_high": 30,
-                        "target_temp_low": 15,
+                        # "target_temp_low": 15,
                     },
                 ),
             ]
@@ -714,8 +726,8 @@ async def test_bug_272(
                     {
                         "entity_id": "climate.mock_climate",
                         "temperature": 19,  # the maximum acceptable
-                        "target_temp_high": 30,
+                        # "target_temp_high": 30,
-                        "target_temp_low": 15,
+                        # "target_temp_low": 15,
                     },
                 ),
             ]
@@ -924,3 +936,278 @@ async def test_bug_339(
     assert api.nb_active_device_for_boiler == 1
 
     entity.remove_thermostat()
+
+
+@pytest.mark.parametrize("expected_lingering_timers", [True])
+async def test_bug_508(
+    hass: HomeAssistant,
+    skip_hass_states_is_state,
+    skip_turn_on_off_heater,
+    skip_send_event,
+):
+    """Test that it not possible to set the target temperature under the min_temp setting"""
+
+    tz = get_tz(hass)  # pylint: disable=invalid-name
+    now: datetime = datetime.now(tz=tz)
+
+    entry = MockConfigEntry(
+        domain=DOMAIN,
+        title="TheOverClimateMockName",
+        unique_id="uniqueId",
+        # default value are min 15°, max 31°, step 0.1
+        data=PARTIAL_CLIMATE_CONFIG,  # 5 minutes security delay
+    )
+
+    # Min_temp is 10 and max_temp is 31 and features contains TARGET_TEMPERATURE_RANGE
+    fake_underlying_climate = MagicMockClimateWithTemperatureRange()
+
+    with patch(
+        "custom_components.versatile_thermostat.base_thermostat.BaseThermostat.send_event"
+    ), patch(
+        "custom_components.versatile_thermostat.underlyings.UnderlyingClimate.find_underlying_climate",
+        return_value=fake_underlying_climate,
+    ), patch(
+        "homeassistant.core.ServiceRegistry.async_call"
+    ) as mock_service_call:
+        entity = await create_thermostat(hass, entry, "climate.theoverclimatemockname")
+
+        assert entity
+
+        assert entity.name == "TheOverClimateMockName"
+        assert entity.is_over_climate is True
+        assert entity.hvac_mode is HVACMode.OFF
+        # The VTherm value and not the underlying value
+        assert entity.target_temperature_step == 0.1
+        assert entity.target_temperature == entity.min_temp
+        assert entity.is_regulated is True
+
+        assert mock_service_call.call_count == 0
+
+        # Set the hvac_mode to HEAT
+        await entity.async_set_hvac_mode(HVACMode.HEAT)
+
+        # Not In the accepted interval -> should be converted into 10 (the min) and send with target_temp_high and target_temp_low
+        await entity.async_set_temperature(temperature=8.5)
+
+        # MagicMock climate is already HEAT by default. So there is no SET_HAVC_MODE call
+        assert mock_service_call.call_count == 1
+        mock_service_call.assert_has_calls(
+            [
+                call.async_call(
+                    "climate",
+                    SERVICE_SET_TEMPERATURE,
+                    {
+                        "entity_id": "climate.mock_climate",
+                        # "temperature": 17.5,
+                        "target_temp_high": 10,
+                        "target_temp_low": 10,
+                    },
+                ),
+            ]
+        )
+
+    with patch("homeassistant.core.ServiceRegistry.async_call") as mock_service_call:
+        # Not In the accepted interval -> should be converted into 10 (the min) and send with target_temp_high and target_temp_low
+        await entity.async_set_temperature(temperature=32)
+
+        # MagicMock climate is already HEAT by default. So there is no SET_HAVC_MODE call
+        assert mock_service_call.call_count == 1
+        mock_service_call.assert_has_calls(
+            [
+                call.async_call(
+                    "climate",
+                    SERVICE_SET_TEMPERATURE,
+                    {
+                        "entity_id": "climate.mock_climate",
+                        "target_temp_high": 31,
+                        "target_temp_low": 31,
+                    },
+                ),
+            ]
+        )
+
+
+@pytest.mark.parametrize("expected_lingering_tasks", [True])
+@pytest.mark.parametrize("expected_lingering_timers", [True])
+async def test_bug_500_1(hass: HomeAssistant, init_vtherm_api) -> None:
+    """Test that the form is served with no input"""
+
+    config = {
+        CONF_THERMOSTAT_TYPE: CONF_THERMOSTAT_SWITCH,
+        CONF_USE_WINDOW_CENTRAL_CONFIG: True,
+        CONF_USE_POWER_CENTRAL_CONFIG: True,
+        CONF_USE_PRESENCE_CENTRAL_CONFIG: True,
+        CONF_USE_MOTION_FEATURE: True,
+        CONF_MOTION_SENSOR: "sensor.theMotionSensor",
+    }
+
+    flow = VersatileThermostatBaseConfigFlow(config)
+
+    assert flow._infos[CONF_USE_WINDOW_FEATURE] is True
+    assert flow._infos[CONF_USE_POWER_FEATURE] is True
+    assert flow._infos[CONF_USE_PRESENCE_FEATURE] is True
+    assert flow._infos[CONF_USE_MOTION_FEATURE] is True
+
+
+@pytest.mark.parametrize("expected_lingering_tasks", [True])
+@pytest.mark.parametrize("expected_lingering_timers", [True])
+async def test_bug_500_2(hass: HomeAssistant, init_vtherm_api) -> None:
+    """Test that the form is served with no input"""
+
+    config = {
+        CONF_THERMOSTAT_TYPE: CONF_THERMOSTAT_SWITCH,
+        CONF_USE_WINDOW_CENTRAL_CONFIG: False,
+        CONF_USE_POWER_CENTRAL_CONFIG: False,
+        CONF_USE_PRESENCE_CENTRAL_CONFIG: False,
+        CONF_USE_MOTION_FEATURE: False,
+    }
+
+    flow = VersatileThermostatBaseConfigFlow(config)
+
+    assert flow._infos[CONF_USE_WINDOW_FEATURE] is False
+    assert flow._infos[CONF_USE_POWER_FEATURE] is False
+    assert flow._infos[CONF_USE_PRESENCE_FEATURE] is False
+    assert flow._infos[CONF_USE_MOTION_FEATURE] is False
+
+
+@pytest.mark.parametrize("expected_lingering_tasks", [True])
+@pytest.mark.parametrize("expected_lingering_timers", [True])
+async def test_bug_500_3(hass: HomeAssistant, init_vtherm_api) -> None:
+    """Test that the form is served with no input"""
+
+    config = {
+        CONF_THERMOSTAT_TYPE: CONF_THERMOSTAT_SWITCH,
+        CONF_USE_WINDOW_CENTRAL_CONFIG: False,
+        CONF_WINDOW_SENSOR: "sensor.theWindowSensor",
+        CONF_USE_POWER_CENTRAL_CONFIG: False,
+        CONF_POWER_SENSOR: "sensor.thePowerSensor",
+        CONF_MAX_POWER_SENSOR: "sensor.theMaxPowerSensor",
+        CONF_USE_PRESENCE_CENTRAL_CONFIG: False,
+        CONF_PRESENCE_SENSOR: "sensor.thePresenceSensor",
+        CONF_USE_MOTION_FEATURE: True,  # motion sensor need to be checked AND a motion sensor set
+        CONF_MOTION_SENSOR: "sensor.theMotionSensor",
+    }
+
+    flow = VersatileThermostatBaseConfigFlow(config)
+
+    assert flow._infos[CONF_USE_WINDOW_FEATURE] is True
+    assert flow._infos[CONF_USE_POWER_FEATURE] is True
+    assert flow._infos[CONF_USE_PRESENCE_FEATURE] is True
+    assert flow._infos[CONF_USE_MOTION_FEATURE] is True
+
+
+@pytest.mark.parametrize("expected_lingering_tasks", [True])
+@pytest.mark.parametrize("expected_lingering_timers", [True])
+async def test_bug_524(hass: HomeAssistant, skip_hass_states_is_state):
+    """Test when switching from Cool to Heat the new temperature in Heat mode should be used"""
+
+    vtherm_api: VersatileThermostatAPI = VersatileThermostatAPI.get_vtherm_api(hass)
+
+    # The temperatures to set
+    temps = {
+        "frost": 7.0,
+        "eco": 17.0,
+        "comfort": 19.0,
+        "boost": 21.0,
+        "eco_ac": 27.0,
+        "comfort_ac": 25.0,
+        "boost_ac": 23.0,
+        "frost_away": 7.1,
+        "eco_away": 17.1,
+        "comfort_away": 19.1,
+        "boost_away": 21.1,
+        "eco_ac_away": 27.1,
+        "comfort_ac_away": 25.1,
+        "boost_ac_away": 23.1,
+    }
+
+    config_entry = MockConfigEntry(
+        domain=DOMAIN,
+        title="TheOverClimateMockName",
+        unique_id="overClimateUniqueId",
+        data={
+            CONF_NAME: "overClimate",
+            CONF_TEMP_SENSOR: "sensor.mock_temp_sensor",
+            CONF_THERMOSTAT_TYPE: CONF_THERMOSTAT_CLIMATE,
+            CONF_EXTERNAL_TEMP_SENSOR: "sensor.mock_ext_temp_sensor",
+            CONF_CYCLE_MIN: 5,
+            CONF_TEMP_MIN: 15,
+            CONF_TEMP_MAX: 30,
+            CONF_USE_WINDOW_FEATURE: False,
+            CONF_USE_MOTION_FEATURE: False,
+            CONF_USE_POWER_FEATURE: False,
+            CONF_USE_PRESENCE_FEATURE: True,
+            CONF_PRESENCE_SENSOR: "binary_sensor.presence_sensor",
+            CONF_CLIMATE: "climate.mock_climate",
+            CONF_MINIMAL_ACTIVATION_DELAY: 30,
+            CONF_SECURITY_DELAY_MIN: 5,
+            CONF_SECURITY_MIN_ON_PERCENT: 0.3,
+            CONF_AUTO_FAN_MODE: CONF_AUTO_FAN_TURBO,
+            CONF_AC_MODE: True,
+        },
+        # | temps,
+    )
+
+    fake_underlying_climate = MockClimate(
+        hass=hass,
+        unique_id="mock_climate",
+        name="mock_climate",
+        hvac_modes=[HVACMode.OFF, HVACMode.COOL, HVACMode.HEAT, HVACMode.FAN_ONLY],
+    )
+
+    with patch(
+        "custom_components.versatile_thermostat.underlyings.UnderlyingClimate.find_underlying_climate",
+        return_value=fake_underlying_climate,
+    ):
+        vtherm: ThermostatOverClimate = await create_thermostat(
+            hass, config_entry, "climate.overclimate"
+        )
+
+    assert vtherm is not None
+
+    # We search for NumberEntities
+    for preset_name, value in temps.items():
+
+        await set_climate_preset_temp(vtherm, preset_name, value)
+
+        temp_entity: NumberEntity = search_entity(
+            hass,
+            "number.overclimate_preset_" + preset_name + PRESET_TEMP_SUFFIX,
+            NUMBER_DOMAIN,
+        )
+        assert temp_entity
+        # Because set_value is not implemented in Number class (really don't understand why...)
+        assert temp_entity.state == value
+
+    # 1. Set mode to Heat and preset to Comfort
+    await send_presence_change_event(vtherm, True, False, datetime.now())
+    await vtherm.async_set_hvac_mode(HVACMode.HEAT)
+    await vtherm.async_set_preset_mode(PRESET_COMFORT)
+    await hass.async_block_till_done()
+
+    assert vtherm.target_temperature == 19.0
+
+    # 2. Only change the HVAC_MODE (and keep preset to comfort)
+    await vtherm.async_set_hvac_mode(HVACMode.COOL)
+    await hass.async_block_till_done()
+    assert vtherm.target_temperature == 25.0
+
+    # 3. Only change the HVAC_MODE (and keep preset to comfort)
+    await vtherm.async_set_hvac_mode(HVACMode.HEAT)
+    await hass.async_block_till_done()
+    assert vtherm.target_temperature == 19.0
+
+    # 4. Change presence to off
+    await send_presence_change_event(vtherm, False, True, datetime.now())
+    await hass.async_block_till_done()
+    assert vtherm.target_temperature == 19.1
+
+    # 5. Change hvac_mode to AC
+    await vtherm.async_set_hvac_mode(HVACMode.COOL)
+    await hass.async_block_till_done()
+    assert vtherm.target_temperature == 25.1
+
+    # 6. Change presence to on
+    await send_presence_change_event(vtherm, True, False, datetime.now())
+    await hass.async_block_till_done()
+    assert vtherm.target_temperature == 25

tests/test_central_boiler.py

@@ -731,7 +731,7 @@ async def test_update_central_boiler_state_simple_climate(
         "custom_components.versatile_thermostat.underlyings.UnderlyingClimate.find_underlying_climate",
         return_value=climate1,
     ):
-        entity: ThermostatOverValve = await create_thermostat(
+        entity: ThermostatOverClimate = await create_thermostat(
             hass, entry, "climate.theoverclimatemockname"
         )
         assert entity

tests/test_last_seen.py

@@ -5,9 +5,6 @@ from unittest.mock import patch, call
 from datetime import timedelta, datetime
 import logging
 
-from custom_components.versatile_thermostat.thermostat_climate import (
-    ThermostatOverClimate,
-)
 from custom_components.versatile_thermostat.thermostat_switch import (
     ThermostatOverSwitch,
 )

tests/test_start.py

@@ -254,6 +254,9 @@ async def test_over_switch_deactivate_preset(
             CONF_HEATER_KEEP_ALIVE: 0,
             CONF_SECURITY_DELAY_MIN: 10,
             CONF_MINIMAL_ACTIVATION_DELAY: 10,
+            CONF_PROP_FUNCTION: PROPORTIONAL_FUNCTION_TPI,
+            CONF_TPI_COEF_INT: 0.6,
+            CONF_TPI_COEF_EXT: 0.01,
         },
     )
 

tests/test_temp_number.py

@@ -79,6 +79,7 @@ async def test_add_number_for_central_config(
             CONF_SECURITY_MIN_ON_PERCENT: 0.5,
             CONF_SECURITY_DEFAULT_ON_PERCENT: 0.2,
             CONF_USE_CENTRAL_BOILER_FEATURE: False,
+            CONF_PROP_FUNCTION: PROPORTIONAL_FUNCTION_TPI,
         }
         | temps,
     )
@@ -156,6 +157,7 @@ async def test_add_number_for_central_config_without_temp(
             CONF_TEMP_MAX: 30,
             CONF_TPI_COEF_INT: 0.5,
             CONF_TPI_COEF_EXT: 0.02,
+            CONF_PROP_FUNCTION: PROPORTIONAL_FUNCTION_TPI,
             CONF_WINDOW_DELAY: 15,
             CONF_WINDOW_AUTO_OPEN_THRESHOLD: 4,
             CONF_WINDOW_AUTO_CLOSE_THRESHOLD: 1,
@@ -250,6 +252,7 @@ async def test_add_number_for_central_config_without_temp_ac_mode(
             CONF_AC_MODE: True,
             CONF_TPI_COEF_INT: 0.5,
             CONF_TPI_COEF_EXT: 0.02,
+            CONF_PROP_FUNCTION: PROPORTIONAL_FUNCTION_TPI,
             CONF_WINDOW_DELAY: 15,
             CONF_WINDOW_AUTO_OPEN_THRESHOLD: 4,
             CONF_WINDOW_AUTO_CLOSE_THRESHOLD: 1,
@@ -343,6 +346,7 @@ async def test_add_number_for_central_config_without_temp_restore(
             CONF_AC_MODE: False,
             CONF_TPI_COEF_INT: 0.5,
             CONF_TPI_COEF_EXT: 0.02,
+            CONF_PROP_FUNCTION: PROPORTIONAL_FUNCTION_TPI,
             CONF_WINDOW_DELAY: 15,
             CONF_WINDOW_AUTO_OPEN_THRESHOLD: 4,
             CONF_WINDOW_AUTO_CLOSE_THRESHOLD: 1,
@@ -441,6 +445,7 @@ async def test_add_number_for_over_switch_use_central(
             CONF_AC_MODE: False,
             CONF_TPI_COEF_INT: 0.5,
             CONF_TPI_COEF_EXT: 0.02,
+            CONF_PROP_FUNCTION: PROPORTIONAL_FUNCTION_TPI,
             CONF_USE_PRESENCE_CENTRAL_CONFIG: True,
             CONF_USE_ADVANCED_CENTRAL_CONFIG: True,
             CONF_USE_MAIN_CENTRAL_CONFIG: True,
@@ -666,6 +671,7 @@ async def test_add_number_for_over_switch_use_central_presets_and_restore(
             CONF_AC_MODE: False,
             CONF_TPI_COEF_INT: 0.5,
             CONF_TPI_COEF_EXT: 0.02,
+            CONF_PROP_FUNCTION: PROPORTIONAL_FUNCTION_TPI,
             CONF_CYCLE_MIN: 5,
             CONF_HEATER: "switch.mock_switch1",
             CONF_USE_PRESENCE_FEATURE: True,
@@ -788,6 +794,7 @@ async def test_change_central_config_temperature(
             CONF_TEMP_MAX: 30,
             CONF_TPI_COEF_INT: 0.5,
             CONF_TPI_COEF_EXT: 0.02,
+            CONF_PROP_FUNCTION: PROPORTIONAL_FUNCTION_TPI,
             CONF_CYCLE_MIN: 5,
             CONF_VALVE: "switch.mock_valve",
             CONF_USE_PRESENCE_FEATURE: True,
@@ -823,6 +830,7 @@ async def test_change_central_config_temperature(
             CONF_TPI_COEF_INT: 0.5,
             CONF_TPI_COEF_EXT: 0.02,
             CONF_CYCLE_MIN: 5,
+            CONF_PROP_FUNCTION: PROPORTIONAL_FUNCTION_TPI,
             CONF_VALVE: "switch.mock_valve",
             CONF_USE_PRESENCE_FEATURE: True,
             CONF_USE_PRESENCE_CENTRAL_CONFIG: False,
@@ -905,6 +913,7 @@ async def test_change_vtherm_temperature(
             CONF_TPI_COEF_INT: 0.5,
             CONF_TPI_COEF_EXT: 0.02,
             CONF_CYCLE_MIN: 5,
+            CONF_PROP_FUNCTION: PROPORTIONAL_FUNCTION_TPI,
             CONF_VALVE: "switch.mock_valve",
             CONF_USE_PRESENCE_FEATURE: True,
             CONF_USE_PRESENCE_CENTRAL_CONFIG: True,
@@ -939,6 +948,7 @@ async def test_change_vtherm_temperature(
             CONF_TPI_COEF_INT: 0.5,
             CONF_TPI_COEF_EXT: 0.02,
             CONF_CYCLE_MIN: 5,
+            CONF_PROP_FUNCTION: PROPORTIONAL_FUNCTION_TPI,
             CONF_VALVE: "switch.mock_valve",
             CONF_USE_PRESENCE_FEATURE: True,
             CONF_USE_PRESENCE_CENTRAL_CONFIG: False,
@@ -1022,6 +1032,7 @@ async def test_change_vtherm_temperature_with_presence(
             CONF_TEMP_MAX: 30,
             CONF_TPI_COEF_INT: 0.5,
             CONF_TPI_COEF_EXT: 0.02,
+            CONF_PROP_FUNCTION: PROPORTIONAL_FUNCTION_TPI,
             CONF_CYCLE_MIN: 5,
             CONF_AC_MODE: True,
             CONF_VALVE: "switch.mock_valve",
@@ -1063,6 +1074,7 @@ async def test_change_vtherm_temperature_with_presence(
             CONF_TEMP_MAX: 30,
             CONF_TPI_COEF_INT: 0.5,
             CONF_TPI_COEF_EXT: 0.02,
+            CONF_PROP_FUNCTION: PROPORTIONAL_FUNCTION_TPI,
             CONF_CYCLE_MIN: 5,
             CONF_VALVE: "switch.mock_valve",
             CONF_USE_PRESENCE_FEATURE: True,

tests/test_tpi.py

@@ -3,7 +3,10 @@
 from homeassistant.components.climate import HVACMode
 
 from custom_components.versatile_thermostat.base_thermostat import BaseThermostat
-from custom_components.versatile_thermostat.prop_algorithm import PropAlgorithm
+from custom_components.versatile_thermostat.prop_algorithm import (
+    PropAlgorithm,
+    PROPORTIONAL_FUNCTION_TPI,
+)
 from .commons import *  # pylint: disable=wildcard-import, unused-wildcard-import
 
 
@@ -121,3 +124,123 @@ async def test_tpi_calculation(
     assert tpi_algo.calculated_on_percent == 0
     assert tpi_algo.on_time_sec == 0
     assert tpi_algo.off_time_sec == 300
+
+
+@pytest.mark.parametrize("expected_lingering_tasks", [True])
+@pytest.mark.parametrize("expected_lingering_timers", [True])
+async def test_wrong_tpi_parameters(
+    hass: HomeAssistant, skip_hass_states_is_state: None
+):  # pylint: disable=unused-argument
+    """Test the wrong TPI parameters"""
+
+    # Nominal case
+    try:
+        algo = PropAlgorithm(
+            PROPORTIONAL_FUNCTION_TPI,
+            0.6,
+            0.01,
+            5,
+            1,
+            "entity_id",
+        )
+        # We should not be there
+        assert True
+    except TypeError as e:
+        # the normal case
+        assert False
+
+    # Test TPI function
+    try:
+        algo = PropAlgorithm(
+            "WRONG",
+            1,
+            0,
+            2,
+            3,
+            "entity_id",
+        )
+        # We should not be there
+        assert False
+    except TypeError as e:
+        # the normal case
+        pass
+
+    # Test coef_int
+    try:
+        algo = PropAlgorithm(
+            PROPORTIONAL_FUNCTION_TPI,
+            None,
+            0,
+            2,
+            3,
+            "entity_id",
+        )
+        # We should not be there
+        assert False
+    except TypeError as e:
+        # the normal case
+        pass
+
+    # Test coef_ext
+    try:
+        algo = PropAlgorithm(
+            PROPORTIONAL_FUNCTION_TPI,
+            0.6,
+            None,
+            2,
+            3,
+            "entity_id",
+        )
+        # We should not be there
+        assert False
+    except TypeError as e:
+        # the normal case
+        pass
+
+    # Test cycle_min
+    try:
+        algo = PropAlgorithm(
+            PROPORTIONAL_FUNCTION_TPI,
+            0.6,
+            0.00001,
+            None,
+            3,
+            "entity_id",
+        )
+        # We should not be there
+        assert False
+    except TypeError as e:
+        # the normal case
+        pass
+
+    # Test minimal_activation_delay
+    try:
+        algo = PropAlgorithm(
+            PROPORTIONAL_FUNCTION_TPI,
+            0.6,
+            0.00001,
+            0,
+            None,
+            "entity_id",
+        )
+        # We should not be there
+        assert False
+    except TypeError as e:
+        # the normal case
+        pass
+
+    # Test vtherm_entity_id
+    try:
+        algo = PropAlgorithm(
+            PROPORTIONAL_FUNCTION_TPI,
+            0.6,
+            0.00001,
+            0,
+            12,
+            None,
+        )
+        # We should not be there
+        assert False
+    except TypeError as e:
+        # the normal case
+        pass