Window ByPass (#143)

* Add Window ByPass

custom_components/versatile_thermostat/base_thermostat.py

@@ -130,6 +130,8 @@ class BaseThermostat(ClimateEntity, RestoreEntity):
     _motion_state: bool
     _presence_state: bool
     _window_auto_state: bool
+    #PR - Adding Window ByPass
+    _window_bypass_state: bool
     _underlyings: list[UnderlyingEntity]
     _last_change_time: datetime
 
@@ -229,6 +231,8 @@ class BaseThermostat(ClimateEntity, RestoreEntity):
         self._window_auto_state = False
         self._window_auto_on = False
         self._window_auto_algo = None
+        # PR - Adding Window ByPass
+        self._window_bypass_state = False
 
         self._current_tz = dt_util.get_time_zone(self._hass.config.time_zone)
 
@@ -961,6 +965,12 @@ class BaseThermostat(ClimateEntity, RestoreEntity):
         """Get the window_auto_state"""
         return STATE_ON if self._window_auto_state else STATE_OFF
 
+    #PR - Adding Window ByPass
+    @property
+    def window_bypass_state(self) -> bool | None:
+        """Get the Window Bypass"""
+        return self._window_bypass_state
+
     @property
     def security_state(self) -> bool | None:
         """Get the security_state"""
@@ -1308,7 +1318,16 @@ class BaseThermostat(ClimateEntity, RestoreEntity):
                 _LOGGER.debug("%s - no change in window state. Forget the event")
                 return
 
+
             self._window_state = new_state.state
+
+            #PR - Adding Window ByPass
+            _LOGGER.debug("%s - Window ByPass is : %s", self, self._window_bypass_state)
+            if self._window_bypass_state:
+                _LOGGER.info("Window ByPass is activated. Ignore window event")
+                self.update_custom_attributes()
+                return
+
             if self._window_state == STATE_OFF:
                 _LOGGER.info(
                     "%s - Window is closed. Restoring hvac_mode '%s'",
@@ -2107,6 +2126,8 @@ class BaseThermostat(ClimateEntity, RestoreEntity):
             "overpowering_state": self._overpowering_state,
             "presence_state": self._presence_state,
             "window_auto_state": self._window_auto_state,
+            #PR - Adding Window ByPass
+            "window_bypass_state": self._window_bypass_state,
             "security_delay_min": self._security_delay_min,
             "security_min_on_percent": self._security_min_on_percent,
             "security_default_on_percent": self._security_default_on_percent,
@@ -2224,6 +2245,26 @@ class BaseThermostat(ClimateEntity, RestoreEntity):
         await self.async_control_heating()
         self.update_custom_attributes()
 
+    #PR - Adding Window ByPass
+    async def service_set_window_bypass_state(self, window_bypass):
+        """Called by a service call:
+        service: versatile_thermostat.set_window_bypass
+        data:
+            window_bypass: True
+        target:
+            entity_id: climate.thermostat_1
+        """
+        _LOGGER.info("%s - Calling service_set_window_bypass, window_bypass: %s", self, window_bypass)
+        self._window_bypass_state = window_bypass
+        if not self._window_bypass_state and self._window_state == STATE_ON:
+            _LOGGER.info("%s - Last window state was open & ByPass is now off. Set hvac_mode to '%s'", self, HVACMode.OFF)
+            self.save_hvac_mode()
+            await self.async_set_hvac_mode(HVACMode.OFF)
+        if self._window_bypass_state and self._window_state == STATE_ON:
+            _LOGGER.info("%s - Last window state was open & ByPass is now on. Set hvac_mode to last available mode", self)
+            await self.restore_hvac_mode(True)
+        self.update_custom_attributes()
+
     def send_event(self, event_type: EventType, data: dict):
         """Send an event"""
         _LOGGER.info("%s - Sending event %s with data: %s", self, event_type, data)

custom_components/versatile_thermostat/binary_sensor.py

@@ -38,7 +38,7 @@ async def async_setup_entry(
     unique_id = entry.entry_id
     name = entry.data.get(CONF_NAME)
 
-    entities = [SecurityBinarySensor(hass, unique_id, name, entry.data)]
+    entities = [SecurityBinarySensor(hass, unique_id, name, entry.data),WindowByPassBinarySensor(hass, unique_id, name, entry.data)]
     if entry.data.get(CONF_USE_MOTION_FEATURE):
         entities.append(MotionBinarySensor(hass, unique_id, name, entry.data))
     if entry.data.get(CONF_USE_WINDOW_FEATURE):
@@ -238,3 +238,38 @@ class PresenceBinarySensor(VersatileThermostatBaseEntity, BinarySensorEntity):
             return "mdi:home-account"
         else:
             return "mdi:nature-people"
+
+#PR - Adding Window ByPass
+class WindowByPassBinarySensor(VersatileThermostatBaseEntity, BinarySensorEntity):
+    """Representation of a BinarySensor which exposes the Window ByPass state"""
+
+    def __init__(
+        self, hass: HomeAssistant, unique_id, name, entry_infos
+    ) -> None:  # pylint: disable=unused-argument
+        """Initialize the WindowByPass Binary sensor"""
+        super().__init__(hass, unique_id, entry_infos.get(CONF_NAME))
+        self._attr_name = "Window bypass"
+        self._attr_unique_id = f"{self._device_name}_window_bypass_state"
+        self._attr_is_on = False
+
+    @callback
+    async def async_my_climate_changed(self, event: Event = None):
+        """Called when my climate have change"""
+        _LOGGER.debug("%s - climate state change", self._attr_unique_id)
+        old_state = self._attr_is_on
+        if self.my_climate.window_bypass_state in [True, False]:
+            self._attr_is_on = self.my_climate.window_bypass_state
+            if old_state != self._attr_is_on:
+                self.async_write_ha_state()
+        return
+
+    @property
+    def device_class(self) -> BinarySensorDeviceClass | None:
+        return BinarySensorDeviceClass.RUNNING
+
+    @property
+    def icon(self) -> str | None:
+        if self._attr_is_on:
+            return "mdi:window-shutter-cog"
+        else:
+            return "mdi:window-shutter-auto"

custom_components/versatile_thermostat/climate.py

@@ -24,6 +24,8 @@ from .const import (
     SERVICE_SET_PRESENCE,
     SERVICE_SET_PRESET_TEMPERATURE,
     SERVICE_SET_SECURITY,
+    #PR - Adding Window ByPass
+    SERVICE_SET_WINDOW_BYPASS,
     CONF_THERMOSTAT_TYPE,
     CONF_THERMOSTAT_SWITCH,
     CONF_THERMOSTAT_CLIMATE,
@@ -98,3 +100,13 @@ async def async_setup_entry(
         },
         "service_set_security",
     )
+
+    #PR - Adding Window ByPass
+    platform.async_register_entity_service(
+        SERVICE_SET_WINDOW_BYPASS,
+        {
+            vol.Required("window_bypass"): vol.In([True, False]
+            ),
+        },
+        "service_set_window_bypass_state",
+    )

custom_components/versatile_thermostat/const.py

@@ -202,6 +202,8 @@ SUPPORT_FLAGS = ClimateEntityFeature.TARGET_TEMPERATURE
 SERVICE_SET_PRESENCE = "set_presence"
 SERVICE_SET_PRESET_TEMPERATURE = "set_preset_temperature"
 SERVICE_SET_SECURITY = "set_security"
+#PR - Adding Window ByPass
+SERVICE_SET_WINDOW_BYPASS = "set_window_bypass"
 
 DEFAULT_SECURITY_MIN_ON_PERCENT = 0.5
 DEFAULT_SECURITY_DEFAULT_ON_PERCENT = 0.1

custom_components/versatile_thermostat/services.yaml

@@ -122,3 +122,19 @@ set_security:
                     step: 0.05
                     unit_of_measurement: "%"
                     mode: slider
+
+set_window_bypass:
+    name: Set Window ByPass
+    description: Bypass the window state to enable heating with window open.
+    target:
+        entity:
+            integration: versatile_thermostat
+    fields:
+        window_bypass:
+            name: Window ByPass
+            description: ByPass value
+            required: true
+            advanced: false
+            default: true
+            selector:
+                boolean: