plugwise 1.6.1__tar.gz → 1.6.3__tar.gz

{plugwise-1.6.1 → plugwise-1.6.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: plugwise
-Version: 1.6.1
+Version: 1.6.3
 Summary: Plugwise Smile (Adam/Anna/P1) and Stretch module for Python 3.
 Home-page: https://github.com/plugwise/python-plugwise
 Author: Plugwise device owners

{plugwise-1.6.1 → plugwise-1.6.3}/plugwise/__init__.py

@@ -147,6 +147,7 @@ class Smile(SmileComm):
             self.smile_model_id,
             self.smile_name,
             self.smile_type,
+            self.smile_version,
             self._port,
             self._username,
          ) if not self.smile_legacy else SmileLegacyAPI(

{plugwise-1.6.1 → plugwise-1.6.3}/plugwise/constants.py

@@ -196,6 +196,7 @@ ZONE_MEASUREMENTS: Final[dict[str, DATA | UOM]] = {
     "electricity_produced": UOM(POWER_WATT),
     "relay": UOM(NONE),
     "temperature": UOM(TEMP_CELSIUS),  # HA Core thermostat current_temperature
+    "thermostat": DATA("setpoint", TEMP_CELSIUS),  # HA Core thermostat setpoint
 }
 
 # Literals
@@ -566,7 +567,7 @@ class GwEntityData(TypedDict, total=False):
 
     climate_mode: str
     # Extra for Adam Master Thermostats
-    control_state: str | bool
+    control_state: str
 
     # Dict-types
     binary_sensors: SmileBinarySensors

{plugwise-1.6.1 → plugwise-1.6.3}/plugwise/data.py

@@ -160,9 +160,16 @@ class SmileData(SmileHelper):
         """
         zone = self._zones[loc_id]
         data = self._get_zone_data(loc_id)
-        if ctrl_state := self._control_state(loc_id):
-            data["control_state"] = ctrl_state
-            self._count += 1
+        if ctrl_state := self._control_state(data, loc_id):
+            if str(ctrl_state) in ("cooling", "heating", "preheating"):
+                data["control_state"] = str(ctrl_state)
+                self._count += 1
+            if str(ctrl_state) == "off":
+                data["control_state"] = "idle"
+                self._count += 1
+
+        data["sensors"].pop("setpoint")  # remove, only used in _control_state()
+        self._count -= 1
 
         # Thermostat data (presets, temperatures etc)
         self._climate_data(loc_id, zone, data)
@@ -191,7 +198,8 @@ class SmileData(SmileHelper):
         # Switching groups data
         self._entity_switching_group(entity, data)
         # Adam data
-        self._get_adam_data(entity, data)
+        if self.smile(ADAM):
+            self._get_adam_data(entity, data)
 
         # Thermostat data for Anna (presets, temperatures etc)
         if self.smile(ANNA) and entity["dev_class"] == "thermostat":
@@ -218,26 +226,26 @@ class SmileData(SmileHelper):
         """Helper-function for _get_entity_data().
 
         Determine Adam heating-status for on-off heating via valves,
-        available regulations_modes and thermostat control_states.
+        available regulations_modes and thermostat control_states,
+        and add missing cooling_enabled when required.
         """
-        if self.smile(ADAM):
+        if entity["dev_class"] == "heater_central":
             # Indicate heating_state based on valves being open in case of city-provided heating
-            if (
-                entity["dev_class"] == "heater_central"
-                and self._on_off_device
-                and isinstance(self._heating_valves(), int)
-            ):
+            if self._on_off_device and isinstance(self._heating_valves(), int):
                 data["binary_sensors"]["heating_state"] = self._heating_valves() != 0
-
-            # Show the allowed regulation_modes and gateway_modes
-            if entity["dev_class"] == "gateway":
-                if self._reg_allowed_modes:
-                    data["regulation_modes"] = self._reg_allowed_modes
-                    self._count += 1
-                if self._gw_allowed_modes:
-                    data["gateway_modes"] = self._gw_allowed_modes
-                    self._count += 1
-
+            # Add cooling_enabled binary_sensor
+            if "binary_sensors" in data:
+                if "cooling_enabled" not in data["binary_sensors"] and self._cooling_present:
+                    data["binary_sensors"]["cooling_enabled"] = self._cooling_enabled
+
+        # Show the allowed regulation_modes and gateway_modes
+        if entity["dev_class"] == "gateway":
+            if self._reg_allowed_modes:
+                data["regulation_modes"] = self._reg_allowed_modes
+                self._count += 1
+            if self._gw_allowed_modes:
+                data["gateway_modes"] = self._gw_allowed_modes
+                self._count += 1
 
     def _climate_data(
         self,

{plugwise-1.6.1 → plugwise-1.6.3}/plugwise/helper.py

@@ -64,7 +64,7 @@ from dateutil import tz
 from dateutil.parser import parse
 from defusedxml import ElementTree as etree
 from munch import Munch
-from packaging.version import Version
+from packaging import version
 
 
 class SmileComm:
@@ -252,13 +252,14 @@ class SmileHelper(SmileCommon):
         self.gateway_id: str
         self.gw_data: GatewayData = {}
         self.gw_entities: dict[str, GwEntityData] = {}
-        self.smile_fw_version: Version | None
+        self.smile_fw_version: version.Version | None
         self.smile_hw_version: str | None
         self.smile_mac_address: str | None
         self.smile_model: str
         self.smile_model_id: str | None
         self.smile_name: str
         self.smile_type: str
+        self.smile_version: version.Version | None
         self.smile_zigbee_mac_address: str | None
         self.therms_with_offset_func: list[str] = []
         self._zones: dict[str, GwEntityData] = {}
@@ -797,7 +798,9 @@ class SmileHelper(SmileCommon):
             # Techneco Elga has cooling-capability
             self._cooling_present = True
             data["model"] = "Generic heater/cooler"
-            self._cooling_enabled = data["elga_status_code"] in (8, 9)
+            # Cooling_enabled in xml does NOT show the correct status!
+            # Setting it specifically:
+            self._cooling_enabled = data["binary_sensors"]["cooling_enabled"] = data["elga_status_code"] in (8, 9)
             data["binary_sensors"]["cooling_state"] = self._cooling_active = (
                 data["elga_status_code"] == 8
             )
@@ -811,11 +814,13 @@ class SmileHelper(SmileCommon):
 
     def _update_loria_cooling(self, data: GwEntityData) -> None:
         """Loria/Thermastage: base cooling-related on cooling_state and modulation_level."""
-        self._cooling_enabled = data["binary_sensors"]["cooling_state"]
+        # For Loria/Thermastage it's not clear if cooling_enabled in xml shows the correct status,
+        # setting it specifically:
+        self._cooling_enabled = data["binary_sensors"]["cooling_enabled"] = data["binary_sensors"]["cooling_state"]
         self._cooling_active = data["sensors"]["modulation_level"] == 100
         # For Loria the above does not work (pw-beta issue #301)
         if "cooling_ena_switch" in data["switches"]:
-            self._cooling_enabled = data["switches"]["cooling_ena_switch"]
+            self._cooling_enabled = data["binary_sensors"]["cooling_enabled"] = data["switches"]["cooling_ena_switch"]
             self._cooling_active = data["binary_sensors"]["cooling_state"]
 
     def _cleanup_data(self, data: GwEntityData) -> None:
@@ -917,7 +922,7 @@ class SmileHelper(SmileCommon):
             else:
                 thermo_loc["secondary"].append(appliance_id)
 
-    def _control_state(self, loc_id: str) -> str | bool:
+    def _control_state(self, data: GwEntityData, loc_id: str) -> str | bool:
         """Helper-function for _get_adam_data().
 
         Adam: find the thermostat control_state of a location, from DOMAIN_OBJECTS.
@@ -930,7 +935,20 @@ class SmileHelper(SmileCommon):
             if (ctrl_state := location.find(locator)) is not None:
                 return str(ctrl_state.text)
 
-        return False
+        # Handle missing control_state in regulation_mode off for firmware >= 3.2.0 (issue #776)
+        # In newer firmware versions, default to "off" when control_state is not present
+        if self.smile_version is not None:
+            if self.smile_version >= version.parse("3.2.0"):
+                return "off"
+
+            # Older Adam firmware does not have the control_state xml-key
+            # Work around this by comparing the reported temperature and setpoint for a location
+            setpoint = data["sensors"]["setpoint"]
+            temperature = data["sensors"]["temperature"]
+            # No cooling available in older firmware
+            return "heating" if temperature < setpoint else "off"
+
+        return False  # pragma: no cover
 
     def _heating_valves(self) -> int | bool:
         """Helper-function for smile.py: _get_adam_data().

{plugwise-1.6.1 → plugwise-1.6.3}/plugwise/smile.py

@@ -66,6 +66,7 @@ class SmileAPI(SmileData):
         smile_model_id: str | None,
         smile_name: str,
         smile_type: str,
+        smile_version: Version | None,
         port: int = DEFAULT_PORT,
         username: str = DEFAULT_USERNAME,
     ) -> None:
@@ -90,6 +91,7 @@ class SmileAPI(SmileData):
         self.smile_model_id = smile_model_id
         self.smile_name = smile_name
         self.smile_type = smile_type
+        self.smile_version = smile_version
         SmileData.__init__(self)
 
 
@@ -129,6 +131,8 @@ class SmileAPI(SmileData):
         try:
             await self.full_xml_update()
             self.get_all_gateway_entities()
+            # Set self._cooling_enabled -required for set_temperature,
+            #also, check for a failed data-retrieval
             if "heater_id" in self.gw_data:
                 heat_cooler = self.gw_entities[self.gw_data["heater_id"]]
                 if (

{plugwise-1.6.1 → plugwise-1.6.3}/plugwise.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: plugwise
-Version: 1.6.1
+Version: 1.6.3
 Summary: Plugwise Smile (Adam/Anna/P1) and Stretch module for Python 3.
 Home-page: https://github.com/plugwise/python-plugwise
 Author: Plugwise device owners

{plugwise-1.6.1 → plugwise-1.6.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name            = "plugwise"
-version         = "1.6.1"
+version         = "1.6.3"
 license         = {file = "LICENSE"}
 description     = "Plugwise Smile (Adam/Anna/P1) and Stretch module for Python 3."
 readme          = "README.md"

{plugwise-1.6.1 → plugwise-1.6.3}/tests/test_adam.py

@@ -18,7 +18,7 @@ class TestPlugwiseAdam(TestPlugwise):  # pylint: disable=attribute-defined-outsi
 
     @pytest.mark.asyncio
     async def test_connect_adam_plus_anna_new(self):
-        """Test extended Adam (firmware 3.8) with Anna and a switch-group setup."""
+        """Test extended Adam (firmware 3.7) with Anna and a switch-group setup."""
         self.smile_setup = "adam_plus_anna_new"
 
         testdata = self.load_testdata(SMILE_TYPE, self.smile_setup)
@@ -167,6 +167,20 @@ class TestPlugwiseAdam(TestPlugwise):  # pylint: disable=attribute-defined-outsi
         await smile.close_connection()
         await self.disconnect(server, client)
 
+    @pytest.mark.asyncio
+    async def test_connect_adam_plus_anna_new_regulation_off(self):
+        """Test regultaion_mode off with control_state key missing for Adam."""
+        self.smile_setup = "adam_plus_anna_new_regulation_off"
+
+        testdata = self.load_testdata(SMILE_TYPE, self.smile_setup)
+        server, smile, client = await self.connect_wrapper()
+        assert smile.smile_hostname == "smile000000"
+
+        await self.device_test(smile, "2023-12-17 00:00:01", testdata)
+
+        await smile.close_connection()
+        await self.disconnect(server, client)
+
     @pytest.mark.asyncio
     async def test_connect_adam_zone_per_device(self):
         """Test an extensive setup of Adam with a zone per device."""
@@ -189,7 +203,7 @@ class TestPlugwiseAdam(TestPlugwise):  # pylint: disable=attribute-defined-outsi
         assert smile._last_active["82fa13f017d240daa0d0ea1775420f24"] == CV_JESSIE
         assert smile._last_active["08963fec7c53423ca5680aa4cb502c63"] == BADKAMER_SCHEMA
         assert smile._last_active["446ac08dd04d4eff8ac57489757b7314"] == BADKAMER_SCHEMA
-        assert self.entity_items == 364
+        assert self.entity_items == 369
 
         assert "af82e4ccf9c548528166d38e560662a4" in self.notifications
         await smile.delete_notification()
@@ -267,7 +281,7 @@ class TestPlugwiseAdam(TestPlugwise):  # pylint: disable=attribute-defined-outsi
         assert smile._last_active["82fa13f017d240daa0d0ea1775420f24"] == CV_JESSIE
         assert smile._last_active["08963fec7c53423ca5680aa4cb502c63"] == BADKAMER_SCHEMA
         assert smile._last_active["446ac08dd04d4eff8ac57489757b7314"] == BADKAMER_SCHEMA
-        assert self.entity_items == 364
+        assert self.entity_items == 369
 
         assert "af82e4ccf9c548528166d38e560662a4" in self.notifications
 
@@ -306,6 +320,8 @@ class TestPlugwiseAdam(TestPlugwise):  # pylint: disable=attribute-defined-outsi
         assert smile._last_active["8cf650a4c10c44819e426bed406aec34"] == WERKDAG_SCHEMA
         assert smile._last_active["5cc21042f87f4b4c94ccb5537c47a53f"] == WERKDAG_SCHEMA
         assert self.entity_items == 497
+        assert self.cooling_present
+        assert self._cooling_enabled
 
         await smile.close_connection()
         await self.disconnect(server, client)
@@ -351,7 +367,7 @@ class TestPlugwiseAdam(TestPlugwise):  # pylint: disable=attribute-defined-outsi
         await self.device_test(smile, "2020-03-22 00:00:01", testdata)
         assert smile.gateway_id == "b128b4bbbd1f47e9bf4d756e8fb5ee94"
         assert smile._last_active["009490cc2f674ce6b576863fbb64f867"] == "Weekschema"
-        assert self.entity_items == 79
+        assert self.entity_items == 80
         assert "6fb89e35caeb4b1cb275184895202d84" in self.notifications
 
         result = await self.tinker_thermostat(

{plugwise-1.6.1 → plugwise-1.6.3}/tests/test_anna.py

@@ -205,6 +205,7 @@ class TestPlugwiseAnna(TestPlugwise):  # pylint: disable=attribute-defined-outsi
                 good_schedules=[
                     "standaard",
                 ],
+                fail_cooling=True,
             )
             _LOGGER.debug(
                 "ERROR raised setting good schedule standaard: %s", exc.value
@@ -261,6 +262,7 @@ class TestPlugwiseAnna(TestPlugwise):  # pylint: disable=attribute-defined-outsi
                 good_schedules=[
                     "standaard",
                 ],
+                fail_cooling=True,
             )
             _LOGGER.debug(
                 "ERROR raised good schedule to standaard: %s", exc.value
@@ -407,6 +409,33 @@ class TestPlugwiseAnna(TestPlugwise):  # pylint: disable=attribute-defined-outsi
         assert self._cooling_enabled
         assert self._cooling_active
 
+        result = await self.tinker_thermostat(
+            smile,
+            "d3ce834534114348be628b61b26d9220",
+            good_schedules=["Thermostat schedule"],
+        )
+        assert result
+
+        # Simulate a change of season: from cooling to heating after an update_interval
+        testdata_updated = self.load_testdata(
+            SMILE_TYPE, f"{self.smile_setup}_UPDATED_DATA"
+        )
+
+        self.smile_setup = "updated/anna_elga_2_switch_heating"
+        await self.device_test(
+            smile, "2020-04-05 00:00:01", testdata_updated, initialize=False
+        )
+        assert self.cooling_present
+        assert not self._cooling_enabled
+        assert not self._cooling_active
+
+        result = await self.tinker_thermostat(
+            smile,
+            "d3ce834534114348be628b61b26d9220",
+            good_schedules=["Thermostat schedule"],
+        )
+        assert result
+
         await smile.close_connection()
         await self.disconnect(server, client)
 
@@ -445,6 +474,7 @@ class TestPlugwiseAnna(TestPlugwise):  # pylint: disable=attribute-defined-outsi
                 good_schedules=[
                     "Winter",
                 ],
+                fail_cooling=True,
             )
             _LOGGER.debug(
                 "ERROR raised setting to schedule Winter: %s", exc.value

{plugwise-1.6.1 → plugwise-1.6.3}/tests/test_init.py

@@ -704,14 +704,20 @@ class TestPlugwise:  # pylint: disable=attribute-defined-outside-init
 
     @pytest.mark.asyncio
     async def tinker_thermostat_temp(
-        self, smile, loc_id, block_cooling=False, unhappy=False
+        self, smile, loc_id, block_cooling=False, fail_cooling=False, unhappy=False
     ):
         """Toggle temperature to test functionality."""
         _LOGGER.info("Asserting modifying settings in location (%s):", loc_id)
         tinker_temp_passed = False
         test_temp = {"setpoint": 22.9}
         if self.cooling_present and not block_cooling:
-            test_temp = {"setpoint_low": 19.5, "setpoint_high": 23.5}
+            if smile.smile_name == "Smile Anna":
+                if self._cooling_enabled:
+                    test_temp = {"setpoint_low": 4.0, "setpoint_high": 23.0}
+                else:
+                    test_temp = {"setpoint_low": 19.0, "setpoint_high": 30.0}
+                if fail_cooling:
+                    test_temp = {"setpoint_low": 19.0, "setpoint_high": 23.0}
         _LOGGER.info("- Adjusting temperature to %s", test_temp)
         try:
             await smile.set_temperature(loc_id, test_temp)
@@ -826,6 +832,7 @@ class TestPlugwise:  # pylint: disable=attribute-defined-outside-init
         good_schedules=None,
         single=False,
         block_cooling=False,
+        fail_cooling=False,
         unhappy=False,
     ):
         """Toggle various climate settings to test functionality."""
@@ -833,7 +840,7 @@ class TestPlugwise:  # pylint: disable=attribute-defined-outside-init
             good_schedules = ["Weekschema"]
 
         result_1 = await self.tinker_thermostat_temp(
-            smile, loc_id, block_cooling, unhappy
+            smile, loc_id, block_cooling, fail_cooling, unhappy
         )
         result_2 = await self.tinker_thermostat_preset(smile, loc_id, unhappy)
         if smile._schedule_old_states != {}:
@@ -858,11 +865,12 @@ class TestPlugwise:  # pylint: disable=attribute-defined-outside-init
         smile,
         schedule_on=True,
         block_cooling=False,
+        fail_cooling=False,
         unhappy=False,
     ):
         """Toggle various climate settings to test functionality."""
         result_1 = await self.tinker_thermostat_temp(
-            smile, "dummy", block_cooling, unhappy
+            smile, "dummy", block_cooling, fail_cooling, unhappy
         )
         result_2 = await self.tinker_thermostat_preset(smile, None, unhappy)
         result_3 = await self.tinker_legacy_thermostat_schedule(smile, unhappy)