Merge pull request #206 from plugwise/copy_0_18_7

Various updates & fixes

Author: bouwew

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+# v0.21.1: Smile: various updates % fixes
+- Change Anna-gateway name to Smile - related to https://developers.home-assistant.io/blog/2022/07/10/entity_naming/ and changes in the Core Plugwise(-beta) code.
+- Output elga_cooling_enabled, lortherm_cooling_enabled or adam_cooling_enabled when applicable. To be used in Core Plugwise(-beta) instead of calling api-variables.
+- Protect the self-variables that will no longer be used in Core Plugwise(-beta).
+- pyproject.toml updates.
+- Adapt test-code where needed.
+
 # v0.21.0: Smile: improve and add to output, fix cooling-bug
 - Add `domestic_hot_water_setpoint` to the output. Will become an additional Number in Plugwise(-beta).
 - Create separate dicts for `domestic_hot_water_setpoint`, `maximum_boiler_temperature`, and `thermostat` in the output.

plugwise/__init__.py

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

plugwise/connections/__init__.py

@@ -59,7 +59,6 @@ def _reader_deamon(self):
         _LOGGER.debug("Reader daemon stopped")
 
     #  TODO: 20220125 function instead of self
-    #  pylint: disable=no-self-use
     def _read_data(self):
         """placeholder."""
         return b"0000"

plugwise/constants.py

@@ -474,7 +474,6 @@
         ATTR_NAME: "water_temperature",
         ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS,
     },
-    "cooling_enabled": {ATTR_UNIT_OF_MEASUREMENT: NONE},
     "domestic_hot_water_comfort_mode": {
         ATTR_NAME: "dhw_cm_switch",
         ATTR_UNIT_OF_MEASUREMENT: NONE,
@@ -529,45 +528,18 @@
 
 # Known types of Smiles and Stretches
 SMILES: Final[dict[str, dict[str, str]]] = {
-    "smile_open_therm_v3": {
-        "type": "thermostat",
-        "friendly_name": "Adam",
-    },
-    "smile_open_therm_v2": {
-        "type": "thermostat",
-        "friendly_name": "Adam",
-    },
-    "smile_thermo_v4": {
-        "type": "thermostat",
-        "friendly_name": "Anna",
-    },
-    "smile_thermo_v3": {
-        "type": "thermostat",
-        "friendly_name": "Anna",
-    },
-    "smile_thermo_v1": {
-        "type": "thermostat",
-        "friendly_name": "Anna",
-        "legacy": "true",
-    },
-    "smile_v4": {
-        "type": "power",
-        "friendly_name": "P1",
-    },
-    "smile_v3": {
-        "type": "power",
-        "friendly_name": "P1",
-    },
-    "smile_v2": {
-        "type": "power",
-        "friendly_name": "P1",
-        "legacy": "true",
-    },
-    "stretch_v3": {"type": "stretch", "friendly_name": "Stretch", "legacy": "true"},
-    "stretch_v2": {"type": "stretch", "friendly_name": "Stretch", "legacy": "true"},
+    "smile_v2": {"type": "power", "name": "P1"},
+    "smile_v3": {"type": "power", "name": "P1"},
+    "smile_v4": {"type": "power", "name": "P1"},
+    "smile_open_therm_v2": {"type": "thermostat", "name": "Adam"},
+    "smile_open_therm_v3": {"type": "thermostat", "name": "Adam"},
+    "smile_thermo_v1": {"type": "thermostat", "name": "Smile"},
+    "smile_thermo_v3": {"type": "thermostat", "name": "Smile"},
+    "smile_thermo_v4": {"type": "thermostat", "name": "Smile"},
+    "stretch_v2": {"type": "stretch", "name": "Stretch"},
+    "stretch_v3": {"type": "stretch", "name": "Stretch"},
 }
 
-
 # All available Binary Sensor, Sensor, and Switch Types
 
 BINARY_SENSORS: Final[list[str]] = [
@@ -684,7 +656,6 @@ class SmileSensors(TypedDict, total=False):
     battery: float
     cooling_activation_outdoor_temperature: float
     cooling_deactivation_threshold: float
-    cooling_enabled: bool
     temperature: float
     electricity_consumed: float
     electricity_consumed_interval: float
@@ -782,8 +753,11 @@ class DeviceDataPoints(
 class DeviceData(ApplianceData, DeviceDataPoints, TypedDict, total=False):
     """The Device Data class, covering the collected and ordere output-data per device."""
 
+    adam_cooling_enabled: bool
     binary_sensors: SmileBinarySensors
     domestic_hot_water_setpoint: ActuatorData
+    elga_cooling_enabled: bool
+    lortherm_cooling_enabled: bool
     sensors: SmileSensors
     switches: SmileSwitches
     thermostat: ActuatorData

plugwise/helper.py

@@ -314,11 +314,11 @@ class SmileHelper:
 
     def __init__(self) -> None:
         """Set the constructor for this class."""
-        self._appl_data: dict[str, ApplianceData] = {}
-        self._appliances: etree
-        self._allowed_modes: list[str] = []
         self._adam_cooling_enabled = False
+        self._allowed_modes: list[str] = []
         self._anna_cooling_present = False
+        self._appliances: etree
+        self._appl_data: dict[str, ApplianceData] = {}
         self._cooling_activation_outdoor_temp: float
         self._cooling_deactivation_threshold: float
         self._cooling_present = False
@@ -327,8 +327,8 @@ def __init__(self) -> None:
         self._home_location: str
         self._is_thermostat = False
         self._last_active: dict[str, str | None] = {}
-        self._loc_data: dict[str, ThermoLoc] = {}
         self._locations: etree
+        self._loc_data: dict[str, ThermoLoc] = {}
         self._modules: etree
         self._on_off_device = False
         self._opentherm_device = False
@@ -338,23 +338,22 @@ def __init__(self) -> None:
         self._stretch_v2 = False
         self._stretch_v3 = False
         self._thermo_locs: dict[str, ThermoLoc] = {}
-
         ###################################################################
-        # 'elga_cooling_enabled' refers to the state of the Elga heatpump
+        # '_elga_cooling_enabled' refers to the state of the Elga heatpump
         # connected to an Anna. For Elga, 'elga_status_code' in [8, 9]
         # means cooling mode is available, next to heating mode.
         # 'elga_status_code' = 8 means cooling is active, 9 means idle.
         #
-        # 'lortherm_cooling_enabled' refers to the state of the Loria or
+        # '_lortherm_cooling_enabled' refers to the state of the Loria or
         # Thermastage heatpump connected to an Anna. For these,
         # 'cooling_state' = on means set to cooling mode, instead of to
         # heating mode.
         # 'modulation_level' = 100 means cooling is active, 0.0 means idle.
         ###################################################################
         self._elga_cooling_active = False
-        self.elga_cooling_enabled = False
+        self._elga_cooling_enabled = False
         self._lortherm_cooling_active = False
-        self.lortherm_cooling_enabled = False
+        self._lortherm_cooling_enabled = False
 
         self.gateway_id: str
         self.gw_data: GatewayData = {}
@@ -616,8 +615,8 @@ def _all_appliances(self) -> None:
             if self.smile_type == "thermostat":
                 self._appl_data[self._home_location].update(
                     {
-                        "model": "Anna",
-                        "name": "Anna",
+                        "model": "Smile",
+                        "name": "Smile",
                         "vendor": "Plugwise B.V.",
                     }
                 )
@@ -888,20 +887,25 @@ def _get_appliance_data(self, d_id: str) -> DeviceData:
         if "temperature" in data:
             data.pop("heating_state", None)
 
-        if self.smile_name == "Anna" and d_id == self._heater_id:
-            # Use elga_status_code or cooling_state to set the relevant *_cooling_enabled to True
-            if self._anna_cooling_present:
+        if d_id == self._heater_id:
+            if self._adam_cooling_enabled:
+                data["adam_cooling_enabled"] = self._adam_cooling_enabled
+            if self.smile_name == "Smile":
+                # Use elga_status_code or cooling_state to set the relevant *_cooling_enabled to True
+                if not self._anna_cooling_present:
+                    pass
+
                 # Elga:
                 if "elga_status_code" in data:
-                    self.elga_cooling_enabled = data["elga_status_code"] in [8, 9]
+                    self._elga_cooling_enabled = data["elga_status_code"] in [8, 9]
+                    data["elga_cooling_enabled"] = self._elga_cooling_enabled
                     self._elga_cooling_active = data["elga_status_code"] == 8
                     data.pop("elga_status_code", None)
-                # Loria/Thermastate:
+                # Loria/Thermastate: look at cooling_state, not at cooling_enabled, not available on R32!
                 elif "cooling_state" in data:
-                    self.lortherm_cooling_enabled = data["cooling_state"]
-                    self._lortherm_cooling_active = False
-                    if data["modulation_level"] == 100:
-                        self._lortherm_cooling_active = True
+                    self._lortherm_cooling_enabled = data["cooling_state"]
+                    data["lortherm_cooling_enabled"] = self._lortherm_cooling_enabled
+                    self._lortherm_cooling_active = data["modulation_level"] == 100
 
         # Don't show cooling_state when no cooling present
         if not self._cooling_present and "cooling_state" in data:
@@ -989,7 +993,7 @@ def _group_switches(self) -> dict[str, ApplianceData]:
         """
         switch_groups: dict[str, ApplianceData] = {}
         # P1 and Anna don't have switchgroups
-        if self.smile_type == "power" or self.smile_name == "Anna":
+        if self.smile_type == "power" or self.smile_name == "Smile":
             return switch_groups
 
         for group in self._domain_objects.findall("./group"):

plugwise/smile.py

@@ -54,7 +54,7 @@ def update_for_cooling(self, devices: dict[str, DeviceData]) -> None:
         """Helper-function for adding/updating various cooling-related values."""
         for _, device in devices.items():
             # For Anna + cooling, modify cooling_state based on provided info by Plugwise
-            if self.smile_name == "Anna":
+            if self.smile_name == "Smile":
                 if device["dev_class"] == "heater_central" and self._cooling_present:
                     device["binary_sensors"]["cooling_state"] = False
                     if self._elga_cooling_active or self._lortherm_cooling_active:
@@ -64,7 +64,7 @@ def update_for_cooling(self, devices: dict[str, DeviceData]) -> None:
                 if device["dev_class"] not in ZONE_THERMOSTATS:
                     continue
 
-                if self.elga_cooling_enabled:
+                if self._elga_cooling_enabled:
                     # Replace setpoint with setpoint_high/_low
                     thermostat = device["thermostat"]
                     sensors = device["sensors"]
@@ -153,7 +153,7 @@ def get_all_devices(self) -> None:
             search = self._domain_objects
             self._anna_cooling_present = adam_cooling_present = False
             if search.find(locator_1) is not None:
-                if self.smile_name == "Anna":
+                if self.smile_name == "Smile":
                     self._anna_cooling_present = True
                 else:
                     adam_cooling_present = True
@@ -245,9 +245,9 @@ def _device_data_climate(
         device_data["mode"] = "auto"
         if sel_schedule == "None":
             device_data["mode"] = "heat"
-            if self.elga_cooling_enabled:
+            if self._elga_cooling_enabled:
                 device_data["mode"] = "heat_cool"
-            if self._adam_cooling_enabled or self.lortherm_cooling_enabled:
+            if self._adam_cooling_enabled or self._lortherm_cooling_enabled:
                 device_data["mode"] = "cool"
 
         return device_data
@@ -450,11 +450,11 @@ async def _smile_detect(self, result: etree, dsmrmain: etree) -> None:
             )
             raise UnsupportedDeviceError("Plugwise error, check log for more info.")
 
-        self.smile_name = SMILES[target_smile]["friendly_name"]
+        self.smile_name = SMILES[target_smile]["name"]
         self.smile_type = SMILES[target_smile]["type"]
         self.smile_version = (self.smile_fw_version, ver)
 
-        if "legacy" in SMILES[target_smile]:
+        if target_smile in ["smile_thermo_v1", "smile_v2", "stretch_v3", "stretch_v2"]:
             self._smile_legacy = True
 
         if self.smile_type == "stretch":
@@ -661,7 +661,7 @@ async def set_temperature(self, loc_id: str, items: dict[str, float]) -> None:
         setpoint: float | None = None
         if "setpoint" in items:
             setpoint = items["setpoint"]
-        if self.elga_cooling_enabled:
+        if self._elga_cooling_enabled:
             if "setpoint_low" in items:
                 setpoint = items["setpoint_low"]
             if self._elga_cooling_active:

pyproject.toml

@@ -26,9 +26,9 @@ ignore = [
 # Disabled for now: https://github.com/PyCQA/pylint/issues/3584
 jobs = 2
 # Disabled pylint_strict_informational for codefactor
-load-plugins = [
-    "pylint_strict_informational",
-]
+#load-plugins = [
+#    "pylint_strict_informational",
+#]
 persistent = false
 extension-pkg-whitelist = [
     "ciso8601",
@@ -65,7 +65,6 @@ good-names = [
 # wrong-import-order - isort guards this
 disable = [
     "format",
-    "abstract-class-little-used",
     "abstract-method",
     "consider-using-f-string",
     "cyclic-import",