plugwise 0.37.5__py3-none-any.whl → 0.37.7__py3-none-any.whl

plugwise/__init__.py

@@ -329,9 +329,13 @@ class Smile(SmileComm):
         key: str,
         temperature: float,
     ) -> None:
-        """Set the max. Boiler or DHW setpoint on the Central Heating boiler."""
+        """Set the maximum boiler- or DHW-setpoint on the Central Heating boiler or the temperature-offset on a Thermostat."""
         await self._smile_api.set_number(dev_id, key, temperature)
 
+    async def set_temperature_offset(self, dev_id: str, offset: float) -> None:
+        """Set the Temperature offset for thermostats that support this feature."""
+        await self._smile_api.set_offset(dev_id, offset)  # pragma: no cover
+
     async def set_switch_state(
         self, appl_id: str, members: list[str] | None, model: str, state: str
     ) -> None:

plugwise/constants.py

@@ -207,13 +207,13 @@ SMILES: Final[dict[str, SMILE]] = {
     "stretch_v2": SMILE(STRETCH, "Stretch"),
     "stretch_v3": SMILE(STRETCH, "Stretch"),
 }
-REQUIRE_APPLIANCES: Final[list[str]] = [
+REQUIRE_APPLIANCES: Final[tuple[str, ...]] = (
     "smile_thermo_v1",
     "smile_thermo_v3",
     "smile_thermo_v4",
     "stretch_v2",
     "stretch_v3",
-]
+)
 
 # Class, Literal and related tuple-definitions
 

plugwise/data.py

@@ -197,14 +197,15 @@ class SmileData(SmileHelper):
 
         # Schedule
         avail_schedules, sel_schedule = self._schedules(loc_id)
-        data["available_schedules"] = avail_schedules
-        data["select_schedule"] = sel_schedule
-        self._count += 2
+        if avail_schedules != [NONE]:
+            data["available_schedules"] = avail_schedules
+            data["select_schedule"] = sel_schedule
+            self._count += 2
 
         # Operation modes: auto, heat, heat_cool, cool and off
         data["mode"] = "auto"
         self._count += 1
-        if sel_schedule == NONE:
+        if sel_schedule in (NONE, OFF):
             data["mode"] = "heat"
             if self._cooling_present:
                 data["mode"] = "cool" if self.check_reg_mode("cooling") else "heat_cool"

plugwise/helper.py

@@ -15,8 +15,6 @@ from plugwise.constants import (
     ADAM,
     ANNA,
     ATTR_NAME,
-    ATTR_UNIT_OF_MEASUREMENT,
-    BINARY_SENSORS,
     DATA,
     DEVICE_MEASUREMENTS,
     DHW_SETPOINT,
@@ -29,9 +27,6 @@ from plugwise.constants import (
     NONE,
     OFF,
     P1_MEASUREMENTS,
-    SENSORS,
-    SPECIALS,
-    SWITCHES,
     TEMP_CELSIUS,
     THERMOSTAT_CLASSES,
     TOGGLES,
@@ -39,12 +34,9 @@ from plugwise.constants import (
     ActuatorData,
     ActuatorDataType,
     ActuatorType,
-    BinarySensorType,
     DeviceData,
     GatewayData,
     SensorType,
-    SpecialType,
-    SwitchType,
     ThermoLoc,
     ToggleNameType,
 )
@@ -56,6 +48,7 @@ from plugwise.exceptions import (
 )
 from plugwise.util import (
     check_model,
+    common_match_cases,
     escape_illegal_xml_characters,
     format_measure,
     skip_obsolete_measurements,
@@ -214,7 +207,7 @@ class SmileHelper(SmileCommon):
         self._thermo_locs: dict[str, ThermoLoc] = {}
         ###################################################################
         # '_cooling_enabled' can refer to the state of the Elga heatpump
-        # connected to an Anna. For Elga, 'elga_status_code' in [8, 9]
+        # 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.
         #
@@ -523,7 +516,7 @@ 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]
+                    self._cooling_enabled = data["elga_status_code"] in (8, 9)
                     data["binary_sensors"]["cooling_state"] = self._cooling_active = (
                         data["elga_status_code"] == 8
                     )
@@ -585,29 +578,12 @@ class SmileHelper(SmileCommon):
                     measurement = new_name
 
                 match measurement:
-                    # measurements with states "on" or "off" that need to be passed directly
-                    case "select_dhw_mode":
-                        data["select_dhw_mode"] = appl_p_loc.text
-                    case _ as measurement if measurement in BINARY_SENSORS:
-                        bs_key = cast(BinarySensorType, measurement)
-                        bs_value = appl_p_loc.text in ["on", "true"]
-                        data["binary_sensors"][bs_key] = bs_value
-                    case _ as measurement if measurement in SENSORS:
-                        s_key = cast(SensorType, measurement)
-                        s_value = format_measure(
-                            appl_p_loc.text, getattr(attrs, ATTR_UNIT_OF_MEASUREMENT)
-                        )
-                        data["sensors"][s_key] = s_value
-                    case _ as measurement if measurement in SWITCHES:
-                        sw_key = cast(SwitchType, measurement)
-                        sw_value = appl_p_loc.text in ["on", "true"]
-                        data["switches"][sw_key] = sw_value
-                    case _ as measurement if measurement in SPECIALS:
-                        sp_key = cast(SpecialType, measurement)
-                        sp_value = appl_p_loc.text in ["on", "true"]
-                        data[sp_key] = sp_value
                     case "elga_status_code":
                         data["elga_status_code"] = int(appl_p_loc.text)
+                    case "select_dhw_mode":
+                        data["select_dhw_mode"] = appl_p_loc.text
+
+                common_match_cases(measurement, attrs, appl_p_loc, data)
 
             i_locator = f'.//logs/interval_log[type="{measurement}"]/period/measurement'
             if (appl_i_loc := appliance.find(i_locator)) is not None:
@@ -1014,6 +990,8 @@ class SmileHelper(SmileCommon):
         if schedules:
             available.remove(NONE)
             available.append(OFF)
+            if selected == NONE:
+                selected = OFF
             if self._last_active.get(location) is None:
                 self._last_active[location] = self._last_used_schedule(schedules)
 

plugwise/legacy/data.py

@@ -6,7 +6,7 @@ from __future__ import annotations
 
 # Dict as class
 # Version detection
-from plugwise.constants import NONE, DeviceData
+from plugwise.constants import NONE, OFF, DeviceData
 from plugwise.legacy.helper import SmileLegacyHelper
 from plugwise.util import remove_empty_platform_dicts
 
@@ -81,12 +81,13 @@ class SmileLegacyData(SmileLegacyHelper):
 
         # Schedule
         avail_schedules, sel_schedule = self._schedules()
-        data["available_schedules"] = avail_schedules
-        data["select_schedule"] = sel_schedule
-        self._count += 2
+        if avail_schedules != [NONE]:
+            data["available_schedules"] = avail_schedules
+            data["select_schedule"] = sel_schedule
+            self._count += 2
 
         # Operation modes: auto, heat
         data["mode"] = "auto"
         self._count += 1
-        if sel_schedule == NONE:
+        if sel_schedule in (NONE, OFF):
             data["mode"] = "heat"

plugwise/legacy/helper.py

@@ -12,8 +12,6 @@ from plugwise.constants import (
     ACTUATOR_CLASSES,
     APPLIANCES,
     ATTR_NAME,
-    ATTR_UNIT_OF_MEASUREMENT,
-    BINARY_SENSORS,
     DATA,
     DEVICE_MEASUREMENTS,
     ENERGY_WATT_HOUR,
@@ -22,10 +20,8 @@ from plugwise.constants import (
     HEATER_CENTRAL_MEASUREMENTS,
     LIMITS,
     NONE,
+    OFF,
     P1_LEGACY_MEASUREMENTS,
-    SENSORS,
-    SPECIALS,
-    SWITCHES,
     TEMP_CELSIUS,
     THERMOSTAT_CLASSES,
     UOM,
@@ -33,15 +29,17 @@ from plugwise.constants import (
     ActuatorDataType,
     ActuatorType,
     ApplianceType,
-    BinarySensorType,
     DeviceData,
     GatewayData,
     SensorType,
-    SpecialType,
-    SwitchType,
     ThermoLoc,
 )
-from plugwise.util import format_measure, skip_obsolete_measurements, version_to_model
+from plugwise.util import (
+    common_match_cases,
+    format_measure,
+    skip_obsolete_measurements,
+    version_to_model,
+)
 
 # This way of importing aiohttp is because of patch/mocking in testing (aiohttp timeouts)
 from defusedxml import ElementTree as etree
@@ -340,25 +338,7 @@ class SmileLegacyHelper(SmileCommon):
                 if new_name := getattr(attrs, ATTR_NAME, None):
                     measurement = new_name
 
-                match measurement:
-                    case _ as measurement if measurement in BINARY_SENSORS:
-                        bs_key = cast(BinarySensorType, measurement)
-                        bs_value = appl_p_loc.text in ["on", "true"]
-                        data["binary_sensors"][bs_key] = bs_value
-                    case _ as measurement if measurement in SENSORS:
-                        s_key = cast(SensorType, measurement)
-                        s_value = format_measure(
-                            appl_p_loc.text, getattr(attrs, ATTR_UNIT_OF_MEASUREMENT)
-                        )
-                        data["sensors"][s_key] = s_value
-                    case _ as measurement if measurement in SWITCHES:
-                        sw_key = cast(SwitchType, measurement)
-                        sw_value = appl_p_loc.text in ["on", "true"]
-                        data["switches"][sw_key] = sw_value
-                    case _ as measurement if measurement in SPECIALS:
-                        sp_key = cast(SpecialType, measurement)
-                        sp_value = appl_p_loc.text in ["on", "true"]
-                        data[sp_key] = sp_value
+                common_match_cases(measurement, attrs, appl_p_loc, data)
 
             i_locator = f'.//logs/interval_log[type="{measurement}"]/period/measurement'
             if (appl_i_loc := appliance.find(i_locator)) is not None:
@@ -450,16 +430,15 @@ class SmileLegacyHelper(SmileCommon):
         return presets
 
     def _schedules(self) -> tuple[list[str], str]:
-        """Collect available schedules/schedules for the legacy thermostat."""
+        """Collect the schedule for the legacy thermostat."""
         available: list[str] = [NONE]
-        selected = NONE
+        rule_id = selected = NONE
         name: str | None = None
 
         search = self._domain_objects
-        for schedule in search.findall("./rule"):
-            if rule_name := schedule.find("name").text:
-                if "preset" not in rule_name:
-                    name = rule_name
+        if (result := search.find("./rule[name='Thermostat schedule']")) is not None:
+            name = "Thermostat schedule"
+            rule_id = result.attrib["id"]
 
         log_type = "schedule_state"
         locator = f"./appliance[type='thermostat']/logs/point_log[type='{log_type}']/period/measurement"
@@ -467,10 +446,11 @@ class SmileLegacyHelper(SmileCommon):
         if (result := search.find(locator)) is not None:
             active = result.text == "on"
 
-        if name is not None:
-            available = [name]
-            if active:
-                selected = name
+        # Show an empty schedule as no schedule found
+        directives = search.find(f'./rule[@id="{rule_id}"]/directives/when/then') is not None
+        if directives and name is not None:
+            available = [name, OFF]
+            selected = name if active else OFF
 
         return available, selected
 
@@ -478,5 +458,4 @@ class SmileLegacyHelper(SmileCommon):
         """Determine the location-set_temperature uri - from APPLIANCES."""
         locator = "./appliance[type='thermostat']"
         appliance_id = self._appliances.find(locator).attrib["id"]
-
         return f"{APPLIANCES};id={appliance_id}/thermostat"

plugwise/legacy/smile.py

@@ -15,6 +15,7 @@ from plugwise.constants import (
     LOCATIONS,
     LOGGER,
     MODULES,
+    OFF,
     REQUIRE_APPLIANCES,
     RULES,
     DeviceData,
@@ -162,6 +163,9 @@ class SmileLegacyAPI(SmileComm, SmileLegacyData):
     ) -> None:
         """Set-function placeholder for legacy devices."""
 
+    async def set_offset(self, dev_id: str, offset: float) -> None:
+        """Set-function placeholder for legacy devices."""
+
     async def set_preset(self, _: str, preset: str) -> None:
         """Set the given Preset on the relevant Thermostat - from DOMAIN_OBJECTS."""
         if (presets := self._presets()) is None:
@@ -178,16 +182,19 @@ class SmileLegacyAPI(SmileComm, SmileLegacyData):
     async def set_regulation_mode(self, mode: str) -> None:
         """Set-function placeholder for legacy devices."""
 
-    async def set_schedule_state(self, _: str, state: str, __: str | None) -> None:
+    async def set_schedule_state(self, _: str, state: str, name: str | None) -> None:
         """Activate/deactivate the Schedule.
 
         Determined from - DOMAIN_OBJECTS.
         Used in HA Core to set the hvac_mode: in practice switch between schedule on - off.
         """
-        if state not in ["on", "off"]:
+        if state not in ("on", "off"):
             raise PlugwiseError("Plugwise: invalid schedule state.")
 
-        name = "Thermostat schedule"
+        # Handle no schedule-name / Off-schedule provided
+        if name is None or name == OFF:
+            name = "Thermostat schedule"
+
         schedule_rule_id: str | None = None
         for rule in self._domain_objects.findall("rule"):
             if rule.find("name").text == name:

plugwise/smile.py

@@ -266,7 +266,7 @@ class SmileAPI(SmileComm, SmileData):
         Used in HA Core to set the hvac_mode: in practice switch between schedule on - off.
         """
         # Input checking
-        if new_state not in ["on", "off"]:
+        if new_state not in ("on", "off"):
             raise PlugwiseError("Plugwise: invalid schedule state.")
 
         # Translate selection of Off-schedule-option to disabling the active schedule

plugwise/util.py

@@ -3,19 +3,30 @@ from __future__ import annotations
 
 import datetime as dt
 import re
+from typing import cast
 
 from plugwise.constants import (
     ATTR_UNIT_OF_MEASUREMENT,
+    BINARY_SENSORS,
+    DATA,
     ELECTRIC_POTENTIAL_VOLT,
     ENERGY_KILO_WATT_HOUR,
     HW_MODELS,
     OBSOLETE_MEASUREMENTS,
     PERCENTAGE,
     POWER_WATT,
+    SENSORS,
     SPECIAL_FORMAT,
+    SPECIALS,
+    SWITCHES,
     TEMP_CELSIUS,
+    UOM,
+    BinarySensorType,
     DeviceData,
     ModelData,
+    SensorType,
+    SpecialType,
+    SwitchType,
 )
 
 from defusedxml import ElementTree as etree
@@ -23,7 +34,7 @@ from munch import Munch
 
 
 def check_alternative_location(loc: Munch, legacy: bool) -> Munch:
-    """Try."""
+    """Helper-function for _power_data_peak_value()."""
     if in_alternative_location(loc, legacy):
         # Avoid double processing by skipping one peak-list option
         if loc.peak_select == "nl_offpeak":
@@ -102,6 +113,32 @@ def check_model(name: str | None, vendor_name: str | None) -> str | None:
     return name
 
 
+def common_match_cases(
+    measurement: str,
+    attrs: DATA | UOM,
+    location: etree,
+    data: DeviceData,
+) -> None:
+    """Helper-function for common match-case execution."""
+    value = location.text in ("on", "true")
+    match measurement:
+        case _ as measurement if measurement in BINARY_SENSORS:
+            bs_key = cast(BinarySensorType, measurement)
+            data["binary_sensors"][bs_key] = value
+        case _ as measurement if measurement in SENSORS:
+            s_key = cast(SensorType, measurement)
+            s_value = format_measure(
+                location.text, getattr(attrs, ATTR_UNIT_OF_MEASUREMENT)
+            )
+            data["sensors"][s_key] = s_value
+        case _ as measurement if measurement in SWITCHES:
+            sw_key = cast(SwitchType, measurement)
+            data["switches"][sw_key] = value
+        case _ as measurement if measurement in SPECIALS:
+            sp_key = cast(SpecialType, measurement)
+            data[sp_key] = value
+
+
 def escape_illegal_xml_characters(xmldata: str) -> str:
     """Replace illegal &-characters."""
     return re.sub(r"&([^a-zA-Z#])", r"&\1", xmldata)

{plugwise-0.37.5.dist-info → plugwise-0.37.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: plugwise
-Version: 0.37.5
+Version: 0.37.7
 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-0.37.7.dist-info/RECORD

@@ -0,0 +1,17 @@
+plugwise/__init__.py,sha256=KMLU90T2k_z1MuZGEPnLPtHoNbw32kboeGK8rCqjibE,14084
+plugwise/common.py,sha256=P4sUYzgVcFsIR2DmQxeVeOiZvFZWpZXgwHA3XRc1Sx0,12538
+plugwise/constants.py,sha256=dvafW3u7LBbWUN05D1Tss7s4jxEDJiZDqnh4-q9isUM,16580
+plugwise/data.py,sha256=9sH2FkwGh5Uvbf42LmZPWutY9Qa-j9qmFZBobwJkLQo,9022
+plugwise/exceptions.py,sha256=rymGtWnXosdFkzSehc_41HVl2jXJEg_9Hq9APDEUwrk,1223
+plugwise/helper.py,sha256=nF1xJEw-frvuGMAydFAJrz_tN24Q3PcBnYNIwPeueZg,42817
+plugwise/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+plugwise/smile.py,sha256=9eJR8iLyYOMrWq8MMw3-uQrN8fS5sZCHdJpp5Kspszo,17177
+plugwise/util.py,sha256=9ld46KJHWFze2eUrVSgUYn0g3zNerlpboM0iUa0H3ak,7830
+plugwise/legacy/data.py,sha256=DsHR9xgiFDg_Vh_6ZpOskw8ZhNQ3CmwjstI3yiH6MEk,3048
+plugwise/legacy/helper.py,sha256=6-tYQMEXepE5rec-hn6lt2EeknADI3J8UFuBSLgu8dk,17878
+plugwise/legacy/smile.py,sha256=Jo0ynhhxfOC6NGemgVNN-LBwUWmA736lHTO5WXQ65r4,10492
+plugwise-0.37.7.dist-info/LICENSE,sha256=mL22BjmXtg_wnoDnnaqps5_Bg_VGj_yHueX5lsKwbCc,1144
+plugwise-0.37.7.dist-info/METADATA,sha256=dEKKzLXlGY7SRjbD2PXNGMPG17dN-7g4faHxtM_lmwI,8939
+plugwise-0.37.7.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+plugwise-0.37.7.dist-info/top_level.txt,sha256=MYOmktMFf8ZmX6_OE1y9MoCZFfY-L8DA0F2tA2IvE4s,9
+plugwise-0.37.7.dist-info/RECORD,,

plugwise-0.37.5.dist-info/RECORD

@@ -1,17 +0,0 @@
-plugwise/__init__.py,sha256=6htaD3AMGbtiuI30EJX9D6gy-gYjA9Lfdl_GZ7Syzmw,13796
-plugwise/common.py,sha256=P4sUYzgVcFsIR2DmQxeVeOiZvFZWpZXgwHA3XRc1Sx0,12538
-plugwise/constants.py,sha256=adi2UFHJUcPRWNz1bn155NC9DLzhYbeNriMKTpSyWAg,16574
-plugwise/data.py,sha256=OTkPJ80b1L1h_TeddfvmUPX1-jBacTjbHKD0XgUIfeg,8965
-plugwise/exceptions.py,sha256=rymGtWnXosdFkzSehc_41HVl2jXJEg_9Hq9APDEUwrk,1223
-plugwise/helper.py,sha256=bNT_Tdc0LAxmVZEikMgKm461jeGP-WY-cI1r3JGgIcI,44037
-plugwise/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-plugwise/smile.py,sha256=iGaA_1pWHeFUSK4k_jAS1qV7Bm3hDJsIDAj2GSixyms,17177
-plugwise/util.py,sha256=w24CiW-xSV3ARZAeNYZ9T5C4kJpYGCcBoIlX2BhNOYg,6618
-plugwise/legacy/data.py,sha256=y7gBG9Sg40lltB3B5CpWPtAXggMbcx2IMay-mwvOB1M,2986
-plugwise/legacy/helper.py,sha256=tSrqA2UeMO7HSYudQHAxBThBTevAOKIxHqN6NCN-r5k,18947
-plugwise/legacy/smile.py,sha256=ltg9XQBPSCCZV4QnqSZ3e9Ta1Zkdqs8MwQJgyyavg3A,10250
-plugwise-0.37.5.dist-info/LICENSE,sha256=mL22BjmXtg_wnoDnnaqps5_Bg_VGj_yHueX5lsKwbCc,1144
-plugwise-0.37.5.dist-info/METADATA,sha256=ho502aS821_t2yuQA8C2fvAyqPSaFfRJaEq5NHyQEWQ,8939
-plugwise-0.37.5.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-plugwise-0.37.5.dist-info/top_level.txt,sha256=MYOmktMFf8ZmX6_OE1y9MoCZFfY-L8DA0F2tA2IvE4s,9
-plugwise-0.37.5.dist-info/RECORD,,