Merge pull request #180 from plugwise/various-fixes

Corrections, fixes, etc.

Author: bouwew

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+# v0.17.7: Smile: Corrections, fixes, clean up
+- Move compressor_state into binary_sensors
+- Adam: add missing zigbee_mac to wireless thermostats
+- Stretch & Adam: don't show devices without a zigbee_mac, should be orphaned devices
+- Harmonize appliance dicts for legacy devices
+- Typing improvements
+- Fix related test asserts
+
 # v0.17.6: Smile: revert removing LOGGER.error messages
 
 # v0.17.5: Smile: rework to raise instead of return

plugwise/__init__.py

@@ -1,6 +1,6 @@
 """Plugwise module."""
 
-__version__ = "0.17.6"
+__version__ = "0.17.7a0"
 
 from plugwise.smile import Smile
 from plugwise.stick import Stick

plugwise/constants.py

@@ -1,4 +1,6 @@
 """Plugwise Stick and Smile constants."""
+from __future__ import annotations
+
 import logging
 from typing import Any, Final
 
@@ -402,7 +404,7 @@
 STATUS: Final = "/system/status.xml"
 
 # P1 related measurements:
-HOME_MEASUREMENTS: Final[dict[str, Any]] = {
+HOME_MEASUREMENTS: Final[dict[str, dict[str, str]]] = {
     "electricity_consumed": {
         ATTR_TYPE: "power",
         ATTR_UNIT_OF_MEASUREMENT: POWER_WATT,
@@ -421,7 +423,7 @@
 # Excluded:
 # zone_thermosstat: 'temperature_offset'
 # radiator_valve: 'uncorrected_temperature', 'temperature_offset'
-DEVICE_MEASUREMENTS: Final[dict[str, Any]] = {
+DEVICE_MEASUREMENTS: Final[dict[str, dict[str, str | None]]] = {
     # HA Core thermostat current_temperature
     "temperature": {ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS},
     # HA Core thermostat setpoint
@@ -452,7 +454,7 @@
 }
 
 # Heater Central related measurements
-HEATER_CENTRAL_MEASUREMENTS: Final[dict[str, Any]] = {
+HEATER_CENTRAL_MEASUREMENTS: Final[dict[str, dict[str, str | None]]] = {
     "boiler_temperature": {
         ATTR_NAME: "water_temperature",
         ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS,
@@ -508,7 +510,7 @@
 }
 
 # Known types of Smiles and Stretches
-SMILES: Final[dict[str, Any]] = {
+SMILES: Final[dict[str, dict[str, Any]]] = {
     "smile_open_therm_v3": {
         "type": "thermostat",
         "friendly_name": "Adam",
@@ -551,6 +553,7 @@
 # All available Binary Sensor, Sensor, and Switch Types
 
 BINARY_SENSORS: Final[list[str]] = [
+    "compressor_state",
     "cooling_state",
     "dhw_state",
     "flame_state",

plugwise/helper.py

@@ -125,7 +125,7 @@ def schedules_schedule_temp(schedules: dict[str, Any], name: str) -> Any:
     return None
 
 
-def types_finder(data: etree) -> set[str]:
+def types_finder(data: etree) -> set[str | None]:
     """Detect types within locations from logs."""
     types = set()
     for measure, attrs in HOME_MEASUREMENTS.items():
@@ -449,42 +449,50 @@ def _get_module_data(
 
         return model_data
 
-    def _energy_device_info_finder(self, appliance: etree, appl: Munch) -> Munch:
+    def _energy_device_info_finder(self, appliance: etree, appl: Munch) -> Munch | None:
         """Helper-function for _appliance_info_finder().
         Collect energy device info (Circle, Plug, Stealth): firmware, model and vendor name.
         """
         if self._stretch_v2 or self._stretch_v3:
             locator = "./services/electricity_point_meter"
             mod_type = "electricity_point_meter"
+
             module_data = self._get_module_data(appliance, locator, mod_type)
-            if not module_data["contents"]:
+            # Filter appliance without zigbee_mac, it's an orphaned device
+            appl.zigbee_mac = module_data["zigbee_mac_address"]
+            if appl.zigbee_mac is None:
                 return None
 
             appl.v_name = module_data["vendor_name"]
-            if appl.model != "Switchgroup":
-                appl.model = None
             appl.hw = module_data["hardware_version"]
             if appl.hw:
                 hw_version = module_data["hardware_version"].replace("-", "")
                 appl.model = version_to_model(hw_version)
             appl.fw = module_data["firmware_version"]
-            appl.zigbee_mac = module_data["zigbee_mac_address"]
+
             return appl
 
         if self.smile_type != "stretch" and "plug" in appl.types:
             locator = "./logs/point_log/electricity_point_meter"
             mod_type = "electricity_point_meter"
             module_data = self._get_module_data(appliance, locator, mod_type)
+            # Filter appliance without zigbee_mac, it's an orphaned device
+            appl.zigbee_mac = module_data["zigbee_mac_address"]
+            if appl.zigbee_mac is None:
+                return None
+
             appl.v_name = module_data["vendor_name"]
             appl.model = version_to_model(module_data["vendor_model"])
             appl.hw = module_data["hardware_version"]
             appl.fw = module_data["firmware_version"]
-            appl.zigbee_mac = module_data["zigbee_mac_address"]
+
             return appl
 
+        return appl  # pragma: no cover
+
     def _appliance_info_finder(self, appliance: etree, appl: Munch) -> Munch:
         """Collect device info (Smile/Stretch, Thermostats, OpenTherm/On-Off): firmware, model and vendor name."""
-        # Find gateway and heater_central devices
+        # Collect gateway device info
         if appl.pwclass == "gateway":
             self.gateway_id = appliance.attrib["id"]
             appl.fw = self.smile_fw_version
@@ -511,6 +519,7 @@ def _appliance_info_finder(self, appliance: etree, appl: Munch) -> Munch:
 
             return appl
 
+        # Collect thermostat device info
         if appl.pwclass in THERMOSTAT_CLASSES:
             locator = "./logs/point_log[type='thermostat']/thermostat"
             mod_type = "thermostat"
@@ -519,23 +528,25 @@ def _appliance_info_finder(self, appliance: etree, appl: Munch) -> Munch:
             appl.model = check_model(module_data["vendor_model"], appl.v_name)
             appl.hw = module_data["hardware_version"]
             appl.fw = module_data["firmware_version"]
+            appl.zigbee_mac = module_data["zigbee_mac_address"]
 
             return appl
 
+        # Collect heater_central device info
         if appl.pwclass == "heater_central":
             # 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
+            #  Info for On-Off device
             if self._on_off_device:
                 appl.name = "OnOff"
                 appl.v_name = None
                 appl.model = "Unknown"
                 return appl
 
-            # Obtain info for OpenTherm device
+            # Info for OpenTherm device
             appl.name = "OpenTherm"
             locator1 = "./logs/point_log[type='flame_state']/boiler_state"
             locator2 = "./services/boiler_state"
@@ -554,13 +565,10 @@ def _appliance_info_finder(self, appliance: etree, appl: Munch) -> Munch:
                 )
             return appl
 
-        # Handle stretches
+        # Collect info from Stretches
         appl = self._energy_device_info_finder(appliance, appl)
-        if not appl:
-            return None
 
-        # Cornercase just return existing dict-object
-        return appl  # pragma: no cover
+        return appl
 
     def _appliance_types_finder(self, appliance: etree, appl: Munch) -> Munch:
         """Helper-function for _all_appliances() - determine type(s) per appliance."""
@@ -600,29 +608,29 @@ def _all_appliances(self) -> None:
                 "class": "gateway",
                 "fw": self.smile_fw_version,
                 "hw": self.smile_hw_version,
-                "mac_address": self.smile_mac_address,
                 "location": self._home_location,
-                "vendor": "Plugwise B.V.",
+                "mac_address": self.smile_mac_address,
             }
             self.gateway_id = self._home_location
 
             if self.smile_type == "power":
                 self._appl_data[self._home_location].update(
-                    {"model": "P1", "name": "P1"}
+                    {"model": "P1", "name": "P1", "vendor": "Plugwise B.V."}
                 )
                 # legacy p1 has no more devices
                 return
 
             if self.smile_type == "thermostat":
                 self._appl_data[self._home_location].update(
-                    {"model": "Anna", "name": "Anna"}
+                    {"model": "Anna", "name": "Anna", "vendor": "Plugwise B.V."}
                 )
 
             if self.smile_type == "stretch":
                 self._appl_data[self._home_location].update(
                     {
                         "model": "Stretch",
                         "name": "Stretch",
+                        "vendor": "Plugwise B.V.",
                         "zigbee_mac_address": self.smile_zigbee_mac_address,
                     }
                 )
@@ -666,7 +674,7 @@ def _all_appliances(self) -> None:
             # Determine class for this appliance
             appl = self._appliance_info_finder(appliance, appl)
             # Skip on heater_central when no active device present or on orphaned stretch devices
-            if not appl:
+            if appl is None:
                 continue
 
             if appl.pwclass == "gateway":
@@ -1019,7 +1027,6 @@ def _group_switches(self) -> dict[str, dict[str, Any]]:
                     "model": "Switchgroup",
                     "name": group_name,
                     "members": members,
-                    "types": {"switch_group"},
                     "vendor": None,
                 }
 

plugwise/smile.py

@@ -386,7 +386,7 @@ async def _smile_detect(self, result: etree, dsmrmain: etree) -> None:
         self.smile_version = (self.smile_fw_version, ver)
 
         if "legacy" in SMILES[target_smile]:
-            self._smile_legacy = SMILES[target_smile].get("legacy")
+            self._smile_legacy = SMILES[target_smile]["legacy"]
 
         if self.smile_type == "stretch":
             self._stretch_v2 = self.smile_version[1].major == 2