dimplex-controller 0.15.1__tar.gz → 0.16.0__tar.gz

{dimplex_controller-0.15.1 → dimplex_controller-0.16.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dimplex-controller
-Version: 0.15.1
+Version: 0.16.0
 Summary: Unofficial async Python client for Dimplex (GDHV IoT) heating appliances — not affiliated with Glen Dimplex
 Keywords: dimplex,heating,control,iot,asyncio
 Author: Kieran Roper

{dimplex_controller-0.15.1 → dimplex_controller-0.16.0}/dimplex_controller/client.py

@@ -42,6 +42,7 @@ from .models import (
     Hub,
     HygieneFrequency,
     ProductModel,
+    ScheduleProfile,
     SetbackStatus,
     TimerMode,
     TimerModeSettings,
@@ -416,19 +417,38 @@ class DimplexControl:
             return []
         return [ProductModel.model_validate(item) for item in data]
 
-    async def get_appliance_features(self, hub_id: str, appliance_id: str) -> TimerModeSettings:
-        """Get timer details (and mode) for an appliance."""
+    async def get_appliance_features(
+        self,
+        hub_id: str,
+        appliance_id: str,
+        *,
+        timer_mode: int | ScheduleProfile = 0,
+    ) -> TimerModeSettings:
+        """Get a profile's timer periods for an appliance.
+
+        ``timer_mode`` selects which profile's periods come back (0 = user
+        timer, 1 = home all day, 2 = out all day); the app fetches each profile
+        separately and caches one entry per value. The response ``TimerMode``
+        echoes the request — it is not the active schedule, which lives in
+        ``ApplianceStatus.StatusTwo`` (dimplex-controller-py#149).
+        """
         payload = {
             "HubId": hub_id,
             "ApplianceId": appliance_id,
-            "TimerMode": 0,  # Required field in request; value ignored on read
+            "TimerMode": int(timer_mode),
         }
         data = await self._request("POST", "/RemoteControl/GetTimerModeDetailsForAppliance", json=payload)
         return TimerModeSettings.model_validate(data)
 
-    async def get_schedule(self, hub_id: str, appliance_id: str) -> TimerModeSettings:
-        """Return the current timer mode + periods (alias of :meth:`get_appliance_features`)."""
-        return await self.get_appliance_features(hub_id, appliance_id)
+    async def get_schedule(
+        self,
+        hub_id: str,
+        appliance_id: str,
+        *,
+        timer_mode: int | ScheduleProfile = 0,
+    ) -> TimerModeSettings:
+        """Return a profile's timer periods (alias of :meth:`get_appliance_features`)."""
+        return await self.get_appliance_features(hub_id, appliance_id, timer_mode=timer_mode)
 
     async def _write_timer_settings(self, settings: TimerModeSettings) -> TimerModeSettings:
         """POST a full :class:`TimerModeSettings` payload and return it."""
@@ -572,6 +592,7 @@ class DimplexControl:
         until: datetime | str | None = None,
         number_of_days: int = 0,
         frequency: int | HygieneFrequency = 0,
+        status_two: int | ScheduleProfile = 0,
         endpoint: str = "/RemoteControl/SetApplianceMode",
     ) -> None:
         """Engage or clear a single :class:`ApplianceModeFlag`.
@@ -588,6 +609,7 @@ class DimplexControl:
             Date=_iso_away_until(until) if enable else NULL_DATETIME,
             NumberOfDays=int(number_of_days) if enable else 0,
             Frequency=int(frequency) if enable else 0,
+            StatusTwo=int(status_two) if enable else 0,
         )
         payload = {
             "Settings": settings.model_dump(mode="json"),
@@ -788,6 +810,26 @@ class DimplexControl:
             temperature=temperature,
         )
 
+    async def set_schedule_profile(
+        self,
+        hub_id: str,
+        appliance_ids: list[str],
+        profile: int | ScheduleProfile,
+    ) -> None:
+        """Apply a schedule profile (User timer / Home all day / Out all day).
+
+        Sends ``ApplianceModes=1`` (:attr:`TIMER_MODE`) with ``Status=1`` and
+        the profile in ``StatusTwo`` — the exact payload the official app's
+        schedule picker sends (dimplex-controller-py#147). Accepts a
+        :class:`ScheduleProfile` or its int value.
+        """
+        await self.set_mode_flag(
+            hub_id,
+            appliance_ids,
+            ApplianceModeFlag.TIMER_MODE,
+            status_two=int(profile),
+        )
+
     async def set_appliance_setpoint_temperature(
         self, hub_id: str, appliance_ids: list[str], temperature: float
     ) -> None:

{dimplex_controller-0.15.1 → dimplex_controller-0.16.0}/dimplex_controller/models.py

@@ -15,6 +15,13 @@ class TimerMode(IntEnum):
 
     Exact product names vary by appliance firmware; these are the values used
     by the Dimplex Control mobile client and reverse-engineered traffic.
+
+    .. caution::
+       App 2.29.1 uses 0/1/2 here as the *profile* domain (user timer, home all
+       day, out all day) and has no manual/frost/off timer modes — those go
+       through ``SetApplianceMode`` mode bits instead. ``MANUAL``,
+       ``FROST_PROTECTION`` and ``OFF`` are therefore unverified in that client
+       and kept only because consumers map them (dimplex-controller-py#149).
     """
 
     USER_TIMER = 0

{dimplex_controller-0.15.1 → dimplex_controller-0.16.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "dimplex-controller"
-version = "0.15.1"
+version = "0.16.0"
 description = "Unofficial async Python client for Dimplex (GDHV IoT) heating appliances — not affiliated with Glen Dimplex"
 license = "MIT"
 license-files = ["LICENSE"]

{dimplex_controller-0.15.1 → dimplex_controller-0.16.0}/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "dimplex-controller"
-version = "0.15.1"
+version = "0.16.0"
 description = "Unofficial async Python client for Dimplex (GDHV IoT) heating appliances — not affiliated with Glen Dimplex"
 authors = [{ name = "Kieran Roper" }]
 license = "MIT"