Issue #619 - manual hvac_off should be prioritized over window and auto-start/stop hvac_off (#622)

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

.devcontainer/configuration.yaml

@@ -152,6 +152,7 @@ climate:
       name: Underlying thermostat2
       heater: input_boolean.fake_heater_switch3
       target_sensor: input_number.fake_temperature_sensor1
+      ac_mode: false
     - platform: generic_thermostat
       name: Underlying thermostat3
       heater: input_boolean.fake_heater_switch3

custom_components/versatile_thermostat/base_thermostat.py

@@ -1206,6 +1206,24 @@ class BaseThermostat(ClimateEntity, RestoreEntity, Generic[T]):
         if hvac_mode is None:
             return
 
+        def save_state():
+            self.reset_last_change_time()
+            self.update_custom_attributes()
+            self.async_write_ha_state()
+            self.send_event(EventType.HVAC_MODE_EVENT, {"hvac_mode": self._hvac_mode})
+
+        # If we already are in OFF, the manual OFF should just overwrite the reason and saved_hvac_mode
+        if self._hvac_mode == HVACMode.OFF and hvac_mode == HVACMode.OFF:
+            _LOGGER.info(
+                "%s - already in OFF. Change the reason to MANUAL and erase the saved_havc_mode"
+            )
+            self._hvac_off_reason = HVAC_OFF_REASON_MANUAL
+            self._saved_hvac_mode = HVACMode.OFF
+
+            save_state()
+
+            return
+
         self._hvac_mode = hvac_mode
 
         # Delegate to all underlying
@@ -1227,14 +1245,11 @@ class BaseThermostat(ClimateEntity, RestoreEntity, Generic[T]):
 
         # Ensure we update the current operation after changing the mode
         self.reset_last_temperature_time()
-        self.reset_last_change_time()
 
         if self._hvac_mode != HVACMode.OFF:
             self.set_hvac_off_reason(None)
 
-        self.update_custom_attributes()
+        save_state()
-        self.async_write_ha_state()
-        self.send_event(EventType.HVAC_MODE_EVENT, {"hvac_mode": self._hvac_mode})
 
     @overrides
     async def async_set_preset_mode(
@@ -2227,8 +2242,9 @@ class BaseThermostat(ClimateEntity, RestoreEntity, Generic[T]):
             save_all()
 
         if new_central_mode == CENTRAL_MODE_STOPPED:
-            self.set_hvac_off_reason(HVAC_OFF_REASON_MANUAL)
+            if self.hvac_mode != HVACMode.OFF:
-            await self.async_set_hvac_mode(HVACMode.OFF)
+                self.set_hvac_off_reason(HVAC_OFF_REASON_MANUAL)
+                await self.async_set_hvac_mode(HVACMode.OFF)
             return
 
         if new_central_mode == CENTRAL_MODE_COOL_ONLY:
@@ -2242,7 +2258,8 @@ class BaseThermostat(ClimateEntity, RestoreEntity, Generic[T]):
         if new_central_mode == CENTRAL_MODE_HEAT_ONLY:
             if HVACMode.HEAT in self.hvac_modes:
                 await self.async_set_hvac_mode(HVACMode.HEAT)
-            else:
+            # if not already off
+            elif self.hvac_mode != HVACMode.OFF:
                 self.set_hvac_off_reason(HVAC_OFF_REASON_MANUAL)
                 await self.async_set_hvac_mode(HVACMode.OFF)
             return

custom_components/versatile_thermostat/thermostat_climate.py

@@ -852,7 +852,8 @@ class ThermostatOverClimate(BaseThermostat[UnderlyingClimate]):
             changes = True
 
         # try to manage new target temperature set if state if no other changes have been found
-        if not changes:
+        # and if a target temperature have already been sent
+        if not changes and under.last_sent_temperature is not None:
             _LOGGER.debug(
                 "Do temperature check. under.last_sent_temperature is %s, new_target_temp is %s",
                 under.last_sent_temperature,

tests/test_central_mode.py

@@ -630,6 +630,7 @@ async def test_climate_ac_only_change_central_mode_true(
         },
     )
 
+    # 1. set hvac_mode to COOL and preet ECO
     with patch("homeassistant.core.ServiceRegistry.async_call"), patch(
         "custom_components.versatile_thermostat.underlyings.UnderlyingClimate.find_underlying_climate",
         return_value=fake_underlying_climate,

tests/test_overclimate.py

@@ -11,6 +11,8 @@ from homeassistant.components.climate import (
     SERVICE_SET_TEMPERATURE,
 )
 
+from homeassistant.components.switch import DOMAIN as SWITCH_DOMAIN
+
 from custom_components.versatile_thermostat.thermostat_climate import (
     ThermostatOverClimate,
 )
@@ -320,6 +322,78 @@ async def test_bug_101(
         assert entity.preset_mode is PRESET_NONE
 
 
+@pytest.mark.parametrize("expected_lingering_tasks", [True])
+@pytest.mark.parametrize("expected_lingering_timers", [True])
+async def test_bug_615(
+    hass: HomeAssistant,
+    skip_hass_states_is_state,
+    skip_turn_on_off_heater,
+    skip_send_event,
+):
+    """Test that when a underlying climate target temp is changed, the VTherm don't change its own temperature target if no
+    target_temperature have already been sent"""
+
+    tz = get_tz(hass)  # pylint: disable=invalid-name
+    now: datetime = datetime.now(tz=tz)
+
+    entry = MockConfigEntry(
+        domain=DOMAIN,
+        title="TheOverClimateMockName",
+        unique_id="uniqueId",
+        data=PARTIAL_CLIMATE_NOT_REGULATED_CONFIG,  # 5 minutes security delay
+    )
+
+    # Underlying is in HEAT mode but should be shutdown at startup
+    fake_underlying_climate = MockClimate(
+        hass, "mockUniqueId", "MockClimateName", {}, HVACMode.HEAT, HVACAction.HEATING
+    )
+
+    # 1. create the thermostat
+    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,
+    ):
+        vtherm = await create_thermostat(hass, entry, "climate.theoverclimatemockname")
+
+        assert vtherm
+
+        assert vtherm.name == "TheOverClimateMockName"
+        assert vtherm.is_over_climate is True
+        assert vtherm.hvac_mode is HVACMode.OFF
+        # because in MockClimate HVACAction is HEATING if hvac_mode is not set
+        assert vtherm.hvac_action is HVACAction.HEATING
+
+        # Force a preset_mode without sending a temperature (as it was restored with a preset)
+        vtherm._attr_preset_mode = PRESET_BOOST
+
+        assert vtherm.target_temperature == vtherm.min_temp
+        assert vtherm.preset_mode is PRESET_BOOST
+
+    with patch(
+        "custom_components.versatile_thermostat.underlyings.UnderlyingClimate.set_hvac_mode"
+    ) as mock_underlying_set_hvac_mode:
+        # 2. Change the target temp of underlying thermostat at now + 1 min
+        now = now + timedelta(minutes=1)
+        await send_climate_change_event_with_temperature(
+            vtherm,
+            HVACMode.OFF,
+            HVACMode.OFF,
+            HVACAction.OFF,
+            HVACAction.OFF,
+            now,
+            25,
+            True,
+            "climate.mock_climate",  # the underlying climate entity id
+        )
+        # Should NOT have been taken the new target temp nor have change the preset
+        assert vtherm.target_temperature == vtherm.min_temp
+        assert vtherm.preset_mode is PRESET_BOOST
+
+        mock_underlying_set_hvac_mode.assert_not_called()
+
+
 @pytest.mark.parametrize("expected_lingering_timers", [True])
 async def test_bug_508(
     hass: HomeAssistant,
@@ -631,3 +705,356 @@ async def test_ignore_temp_outside_minmax_range(
             "climate.mock_climate",  # the underlying climate entity id
         )
         assert entity.target_temperature == 17
+
+
+@pytest.mark.parametrize("expected_lingering_tasks", [True])
+@pytest.mark.parametrize("expected_lingering_timers", [True])
+async def test_manual_hvac_off_should_take_the_lead_over_window(
+    hass: HomeAssistant, skip_hass_states_is_state
+):
+    """Test than a manual hvac_off is taken into account over a window hvac_off"""
+
+    # 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: True,
+            CONF_WINDOW_SENSOR: "binary_sensor.window_sensor",
+            CONF_WINDOW_DELAY: 10,
+            CONF_USE_MOTION_FEATURE: False,
+            CONF_USE_POWER_FEATURE: False,
+            CONF_USE_AUTO_START_STOP_FEATURE: True,
+            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,
+            CONF_AUTO_START_STOP_LEVEL: AUTO_START_STOP_LEVEL_FAST,
+        },
+    )
+
+    fake_underlying_climate = MockClimate(
+        hass=hass,
+        unique_id="mock_climate",
+        name="mock_climate",
+        hvac_modes=[HVACMode.OFF, HVACMode.COOL, HVACMode.HEAT],
+    )
+
+    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
+
+        # Initialize all temps
+        await set_all_climate_preset_temp(hass, vtherm, temps, "overclimate")
+
+        # Check correct initialization of auto_start_stop attributes
+        assert (
+            vtherm._attr_extra_state_attributes["auto_start_stop_level"]
+            == AUTO_START_STOP_LEVEL_FAST
+        )
+
+        assert vtherm.auto_start_stop_level == AUTO_START_STOP_LEVEL_FAST
+        enable_entity = search_entity(
+            hass, "switch.overclimate_enable_auto_start_stop", SWITCH_DOMAIN
+        )
+        assert enable_entity is not None
+        assert enable_entity.state == STATE_ON
+
+    tz = get_tz(hass)  # pylint: disable=invalid-name
+    now: datetime = datetime.now(tz=tz)
+
+    # 1. Set mode to Heat and preset to Comfort and close the window
+    send_window_change_event(vtherm, False, False, now, False)
+    await send_presence_change_event(vtherm, True, False, now)
+    await send_temperature_change_event(vtherm, 18, now, True)
+    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
+    # VTherm should be heating
+    assert vtherm.hvac_mode == HVACMode.HEAT
+    # VTherm window_state should be off
+    assert vtherm.window_state == STATE_OFF
+
+    # 2. Open the window and wait for the delay
+    now = now + timedelta(minutes=2)
+    with patch(
+        "custom_components.versatile_thermostat.base_thermostat.BaseThermostat.send_event"
+    ) as mock_send_event, patch(
+        "homeassistant.helpers.condition.state", return_value=True
+    ):
+        vtherm._set_now(now)
+        try_function = await send_window_change_event(
+            vtherm, True, False, now, sleep=False
+        )
+
+        await try_function(None)
+
+        # Nothing should have change (window event is ignoed as we are already OFF)
+        assert vtherm.hvac_mode == HVACMode.OFF
+        assert vtherm.hvac_off_reason == HVAC_OFF_REASON_WINDOW_DETECTION
+        assert vtherm._saved_hvac_mode == HVACMode.HEAT
+
+        assert mock_send_event.call_count == 2
+
+        assert vtherm.window_state == STATE_ON
+
+    # 3. Turn off manually the VTherm. This should be taken into account
+    now = now + timedelta(minutes=1)
+    vtherm._set_now(now)
+    with patch(
+        "custom_components.versatile_thermostat.base_thermostat.BaseThermostat.send_event"
+    ) as mock_send_event:
+        await vtherm.async_set_hvac_mode(HVACMode.OFF)
+        await hass.async_block_till_done()
+
+        # Should be off with reason MANUAL
+        assert vtherm.hvac_mode == HVACMode.OFF
+        assert vtherm.hvac_off_reason == HVAC_OFF_REASON_MANUAL
+        assert vtherm._saved_hvac_mode == HVACMode.OFF
+        # Window state should not change
+        assert vtherm.window_state == STATE_ON
+
+        assert mock_send_event.call_count == 1
+        mock_send_event.assert_has_calls(
+            [
+                call(EventType.HVAC_MODE_EVENT, {"hvac_mode": HVACMode.OFF}),
+            ]
+        )
+
+    # 4. close the window -> we should stay off reason manual
+    now = now + timedelta(minutes=1)
+    vtherm._set_now(now)
+    with patch(
+        "custom_components.versatile_thermostat.base_thermostat.BaseThermostat.send_event"
+    ) as mock_send_event, patch(
+        "homeassistant.helpers.condition.state", return_value=True
+    ):
+        try_function = await send_window_change_event(
+            vtherm, False, True, now, sleep=False
+        )
+
+        await try_function(None)
+
+        # The VTherm should turn on and off again due to auto-start-stop
+        assert vtherm.hvac_mode == HVACMode.OFF
+        assert vtherm.hvac_off_reason is HVAC_OFF_REASON_MANUAL
+        assert vtherm._saved_hvac_mode == HVACMode.OFF
+
+        assert vtherm.window_state == STATE_OFF
+        assert mock_send_event.call_count == 0
+
+
+@pytest.mark.parametrize("expected_lingering_tasks", [True])
+@pytest.mark.parametrize("expected_lingering_timers", [True])
+async def test_manual_hvac_off_should_take_the_lead_over_auto_start_stop(
+    hass: HomeAssistant, skip_hass_states_is_state
+):
+    """Test than a manual hvac_off is taken into account over a auto-start/stop hvac_off"""
+
+    # 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: True,
+            CONF_WINDOW_SENSOR: "binary_sensor.window_sensor",
+            CONF_WINDOW_DELAY: 10,
+            CONF_USE_MOTION_FEATURE: False,
+            CONF_USE_POWER_FEATURE: False,
+            CONF_USE_AUTO_START_STOP_FEATURE: True,
+            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,
+            CONF_AUTO_START_STOP_LEVEL: AUTO_START_STOP_LEVEL_FAST,
+        },
+    )
+
+    fake_underlying_climate = MockClimate(
+        hass=hass,
+        unique_id="mock_climate",
+        name="mock_climate",
+        hvac_modes=[HVACMode.OFF, HVACMode.COOL, HVACMode.HEAT],
+    )
+
+    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
+
+        # Initialize all temps
+        await set_all_climate_preset_temp(hass, vtherm, temps, "overclimate")
+
+        # Check correct initialization of auto_start_stop attributes
+        assert (
+            vtherm._attr_extra_state_attributes["auto_start_stop_level"]
+            == AUTO_START_STOP_LEVEL_FAST
+        )
+
+        assert vtherm.auto_start_stop_level == AUTO_START_STOP_LEVEL_FAST
+        enable_entity = search_entity(
+            hass, "switch.overclimate_enable_auto_start_stop", SWITCH_DOMAIN
+        )
+        assert enable_entity is not None
+        assert enable_entity.state == STATE_ON
+
+    tz = get_tz(hass)  # pylint: disable=invalid-name
+    now: datetime = datetime.now(tz=tz)
+
+    # 1. Set mode to Heat and preset to Comfort
+    send_window_change_event(vtherm, False, False, now, False)
+    await send_presence_change_event(vtherm, True, False, now)
+    await send_temperature_change_event(vtherm, 18, now, True)
+    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
+    # VTherm should be heating
+    assert vtherm.hvac_mode == HVACMode.HEAT
+
+    # 2. Set current temperature to 21 5 min later -> should turn off VTherm
+    now = now + timedelta(minutes=5)
+    vtherm._set_now(now)
+    # reset accumulated error (only for testing)
+    vtherm._auto_start_stop_algo._accumulated_error = 0
+    with patch(
+        "custom_components.versatile_thermostat.base_thermostat.BaseThermostat.send_event"
+    ) as mock_send_event:
+        await send_temperature_change_event(vtherm, 21, now, True)
+        await hass.async_block_till_done()
+
+        # VTherm should no more be heating
+        assert vtherm.hvac_mode == HVACMode.OFF
+        assert vtherm.hvac_off_reason == HVAC_OFF_REASON_AUTO_START_STOP
+        assert vtherm._saved_hvac_mode == HVACMode.HEAT
+        assert mock_send_event.call_count == 2  # turned to off
+
+        mock_send_event.assert_has_calls(
+            [
+                call(EventType.HVAC_MODE_EVENT, {"hvac_mode": HVACMode.OFF}),
+                call(
+                    event_type=EventType.AUTO_START_STOP_EVENT,
+                    data={
+                        "type": "stop",
+                        "name": "overClimate",
+                        "cause": "Auto stop conditions reached",
+                        "hvac_mode": HVACMode.OFF,
+                        "saved_hvac_mode": HVACMode.HEAT,
+                        "target_temperature": 19.0,
+                        "current_temperature": 21.0,
+                        "temperature_slope": 0.3,
+                        "accumulated_error": -2,
+                        "accumulated_error_threshold": 2,
+                    },
+                ),
+            ]
+        )
+
+    # 3. Turn off manually the VTherm. This should be taken into account
+    now = now + timedelta(minutes=1)
+    with patch(
+        "custom_components.versatile_thermostat.base_thermostat.BaseThermostat.send_event"
+    ) as mock_send_event:
+        await vtherm.async_set_hvac_mode(HVACMode.OFF)
+        await hass.async_block_till_done()
+
+        # Should be off with reason MANUAL
+        assert vtherm.hvac_mode == HVACMode.OFF
+        assert vtherm.hvac_off_reason == HVAC_OFF_REASON_MANUAL
+        assert vtherm._saved_hvac_mode == HVACMode.OFF
+
+        assert mock_send_event.call_count == 1
+        mock_send_event.assert_has_calls(
+            [
+                call(EventType.HVAC_MODE_EVENT, {"hvac_mode": HVACMode.OFF}),
+            ]
+        )
+
+    # 4. removes the auto-start/stop detection
+    now = now + timedelta(minutes=5)
+    vtherm._set_now(now)
+    with patch(
+        "custom_components.versatile_thermostat.base_thermostat.BaseThermostat.send_event"
+    ) as mock_send_event, patch(
+        "homeassistant.helpers.condition.state", return_value=True
+    ):
+        await send_temperature_change_event(vtherm, 15, now, True)
+        await hass.async_block_till_done()
+
+        # VTherm should no more be heating
+        assert vtherm.hvac_mode == HVACMode.OFF
+        assert vtherm.hvac_off_reason == HVAC_OFF_REASON_MANUAL
+        assert vtherm._saved_hvac_mode == HVACMode.OFF
+        assert mock_send_event.call_count == 0  # nothing have change