Merge pull request #159 from plugwise/check_for_adam

Anna: add check for connected to Adam

Author: bouwew

CHANGELOG.md

@@ -1,31 +1,33 @@
 # Changelog
 
-# v0.xy.z - Smile: more changes and improvements
+# v0.16.7 - Smile: Bugfixes, more changes and improvements
+- Fix for #158: error setting up for systems with an Anna and and Elga (heatpump).
+- Block connecting to the Anna when an Adam is present (fixes pw-beta #231).
 - Combine helper-functions, possible after removing code related to the device_state sensor.
 - Remove single_master_thermostat() function and the related self's, no longer needed.
 - Use .get() where possible.
 - Implement walrus constructs ( := ) where possible.
 - Improve and simplify.
 
 # v0.16.6 - Smile: various changes/improvements
-- Provide cooling_state and heating_state as `binary_sensors`, show cooling_state only when cooling is present
-- Clean up gw_data, e.g. remove `single_master_thermostat` key
+- Provide cooling_state and heating_state as `binary_sensors`, show cooling_state only when cooling is present.
+- Clean up gw_data, e.g. remove `single_master_thermostat` key.
 
 # v0.16.5 - Smile: small improvements
-- Move schedule debug-message to the correct position
-- Code quality fixes
+- Move schedule debug-message to the correct position.
+- Code quality fixes.
 
 # v0.16.4 - Adding measurements
-- Expose mac-addresses for network and zigbee devices
-- Expose min/max thermostat (and heater) values and resolution (step in HA)
-- Changed mac-addresses in userdata/fixtures to be obfuscated but unique 
+- Expose mac-addresses for network and zigbee devices.
+- Expose min/max thermostat (and heater) values and resolution (step in HA).
+- Changed mac-addresses in userdata/fixtures to be obfuscated but unique. 
 
 # v0.16.3 - Typing
-- Code quality improvements
+- Code quality improvements.
 
 # v0.16.2 - Generic and Stretch
-- As per Core deprecation of python 3.8, removed CI/CD testing and bumped pypi to 3.9 and production
-- Add support for Stretch with fw 2.7.18
+- As per Core deprecation of python 3.8, removed CI/CD testing and bumped pypi to 3.9 and production.
+- Add support for Stretch with fw 2.7.18.
 
 # v0.16.1 - Smile - various updates:
 - BREAKING: Change active device detection, detect both OpenTherm (replace Auxiliary) and OnOff (new) heating and cooling devices.

plugwise/__init__.py

@@ -1,6 +1,6 @@
 """Plugwise module."""
 
-__version__ = "0.16.7a6"
+__version__ = "0.16.7"
 
 from plugwise.smile import Smile
 from plugwise.stick import Stick

plugwise/constants.py

@@ -203,11 +203,12 @@
     "120006": "Sense Legrand",
     "070051": "Switch",
     "080029": "Switch",
-    "168-01": "Jip",
-    "160-01": "Plug",
+    "143.1": "Anna",
+    "159.2": "Adam",
     "106-03": "Tom/Floor",
     "158-01": "Lisa",
-    "143.1": "Anna",
+    "160-01": "Plug",
+    "168-01": "Jip",
 }
 
 # Defaults for SED's (Sleeping End Devices)

plugwise/exceptions.py

@@ -55,6 +55,10 @@ class InvalidAuthentication(PlugwiseException):
     """Raised when unable to authenticate."""
 
 
+class InvalidSetupError(PlugwiseException):
+    """Raised when adding an Anna while an Adam exists."""
+
+
 class UnsupportedDeviceError(PlugwiseException):
     """Raised when device is not supported."""
 

plugwise/helper.py

@@ -418,6 +418,7 @@ def _get_module_data(
         if (appl_search := appliance.find(locator)) is not None:
             link_id = appl_search.attrib["id"]
             locator = f".//{mod_type}[@id='{link_id}']...."
+            # Not possible to walrus...
             module = self._modules.find(locator)
             if module is not None:
                 model_data["contents"] = True
@@ -507,20 +508,19 @@ def _appliance_info_finder(self, appliance: etree, appl: Munch) -> Munch:
             return appl
 
         if appl.pwclass == "heater_central":
-            # Provide info for On-Off device
+            # Remove heater_central when no active device present
+            if not self._opentherm_device and not self._on_off_device:
+                return None
+
+            self._heater_id = appliance.attrib["id"]
+            #  info for On-Off device
             if self._on_off_device:
-                self._heater_id = appliance.attrib["id"]
                 appl.name = "OnOff"
                 appl.v_name = None
                 appl.model = "Unknown"
-
                 return appl
 
-            # Remove heater_central when no active device present
-            if not self._opentherm_device and not self._on_off_device:
-                return None
-
-            self._heater_id = appliance.attrib["id"]
+            # Obtain info for OpenTherm device
             appl.name = "OpenTherm"
             locator1 = "./logs/point_log[type='flame_state']/boiler_state"
             locator2 = "./services/boiler_state"
@@ -873,19 +873,6 @@ def _get_appliance_data(self, d_id: str) -> dict[str, Any]:
         if "temperature" in data:
             data.pop("heating_state", None)
 
-        # Anna: indicate possible active heating/cooling operation-mode
-        # Actual ongoing heating/cooling is shown via heating_state/cooling_state
-        if "cooling_activation_outdoor_temperature" in data:
-            self._cooling_present = True
-            if not self.cooling_active and self._outdoor_temp > data.get(
-                "cooling_activation_outdoor_temperature"
-            ):
-                self.cooling_active = True
-            if self.cooling_active and self._outdoor_temp < data.get(
-                "cooling_deactivation_threshold"
-            ):
-                self.cooling_active = False
-
         return data
 
     def _rank_thermostat(

plugwise/smile.py

@@ -31,7 +31,12 @@
     SYSTEM,
     THERMOSTAT_CLASSES,
 )
-from .exceptions import ConnectionFailedError, InvalidXMLError, UnsupportedDeviceError
+from .exceptions import (
+    ConnectionFailedError,
+    InvalidSetupError,
+    InvalidXMLError,
+    UnsupportedDeviceError,
+)
 from .helper import SmileComm, SmileHelper, update_helper
 
 
@@ -108,9 +113,7 @@ def _device_data_switching_group(
                 if member_data.get("relay"):
                     counter += 1
 
-            device_data["relay"] = True
-            if counter == 0:
-                device_data["relay"] = False
+            device_data["relay"] = counter != 0
 
         return device_data
 
@@ -124,9 +127,7 @@ def _device_data_adam(
             # Indicate heating_state based on valves being open in case of city-provided heating
             if details.get("class") == "heater_central":
                 if self._on_off_device and self._heating_valves() is not None:
-                    device_data["heating_state"] = True
-                    if self._heating_valves() == 0:
-                        device_data["heating_state"] = False
+                    device_data["heating_state"] = self._heating_valves() != 0
 
         return device_data
 
@@ -156,21 +157,30 @@ def _device_data_climate(
             device_data["last_used"] = last_active
             device_data["schedule_temperature"] = sched_setpoint
 
-        # Operation mode: auto, heat, cool
-        device_data["mode"] = "auto"
-        schedule_status = False
-        if sel_schema != "None":
-            schedule_status = True
-        if not schedule_status:
-            device_data["mode"] = "heat"
-            if self._heater_id is not None:
-                if self.cooling_active:
-                    device_data["mode"] = "cool"
-
         # Control_state, only for Adam master thermostats
         if ctrl_state := self._control_state(loc_id):
             device_data["control_state"] = ctrl_state
 
+        # Anna: indicate possible active heating/cooling operation-mode
+        # Actual ongoing heating/cooling is shown via heating_state/cooling_state
+        if "cooling_activation_outdoor_temperature" in device_data:
+            self._cooling_present = True
+            if not self.cooling_active and self._outdoor_temp > device_data.get(
+                "cooling_activation_outdoor_temperature"
+            ):
+                self.cooling_active = True
+            if self.cooling_active and self._outdoor_temp < device_data.get(
+                "cooling_deactivation_threshold"
+            ):
+                self.cooling_active = False
+
+        # Operation mode: auto, heat, cool
+        device_data["mode"] = "auto"
+        if sel_schema == "None":
+            device_data["mode"] = "heat"
+            if self._heater_id is not None and self.cooling_active:
+                device_data["mode"] = "cool"
+
         return device_data
 
     def _get_device_data(self, dev_id: str) -> dict[str, Any]:
@@ -242,14 +252,18 @@ async def connect(self) -> bool:
         """Connect to Plugwise device and determine its name, type and version."""
         result = await self._request(DOMAIN_OBJECTS)
         vendor_names: list[etree] = result.findall("./module/vendor_name")
+        vendor_models: list[etree] = result.findall("./module/vendor_model")
+        # Work-around for Stretch fv 2.7.18
         if not vendor_names:
-            # Work-around for Stretch fv 2.7.18
             result = await self._request(MODULES)
             vendor_names = result.findall("./module/vendor_name")
 
         names: list[str] = []
+        models: list[str] = []
         for name in vendor_names:
             names.append(name.text)
+        for model in vendor_models:
+            models.append(model.text)
 
         dsmrmain = result.find("./module/protocols/dsmrmain")
         if "Plugwise" not in names:
@@ -262,6 +276,14 @@ async def connect(self) -> bool:
                 )
                 raise ConnectionFailedError
 
+        # Check if Anna is connected to an Adam
+        if "159.2" in models:
+            LOGGER.error(
+                "Your Anna is connected to an Adam, make \
+                sure to only add the Adam as integration.",
+            )
+            raise InvalidSetupError
+
         # Determine smile specifics
         await self._smile_detect(result, dsmrmain)
 
@@ -372,8 +394,7 @@ async def _smile_detect(self, result: etree, dsmrmain: etree) -> None:
             self._stretch_v2 = self.smile_version[1].major == 2
             self._stretch_v3 = self.smile_version[1].major == 3
 
-        if self.smile_type == "thermostat":
-            self._is_thermostat = True
+        self._is_thermostat = self.smile_type == "thermostat"
 
     async def _full_update_device(self) -> None:
         """Perform a first fetch of all XML data, needed for initialization."""

tests/test_smile.py

@@ -2773,6 +2773,16 @@ async def test_fail_legacy_system(self):
         except pw_exceptions.ConnectionFailedError:
             assert True
 
+    @pytest.mark.asyncio
+    async def test_fail_anna_connected_to_adam(self):
+        """Test erroneous legacy stretch system."""
+        self.smile_setup = "anna_connected_to_adam"
+        try:
+            _server, _smile, _client = await self.connect_wrapper()
+            assert False  # pragma: no cover
+        except pw_exceptions.InvalidSetupError:
+            assert True
+
     @pytest.mark.asyncio
     async def test_invalid_credentials(self):
         """Test P1 with invalid credentials setup."""