python-duco-connectivity 0.6.0__tar.gz → 0.7.1__tar.gz

{python_duco_connectivity-0.6.0/src/python_duco_connectivity.egg-info → python_duco_connectivity-0.7.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-duco-connectivity
-Version: 0.6.0
+Version: 0.7.1
 Summary: Async HTTP client for the local Duco Connectivity API
 Author: Ronald van der Meer
 License-Expression: MIT
@@ -63,6 +63,7 @@ in the development examples below.
 - HTTP only
 - asynchronous communication via `aiohttp`
 - typed stable config families for the documented `/config` branches
+- typed helpers for stable `/info` fields such as heat recovery filter time
 - typed models that stay close to the API response shape
 - preserved `raw_payload` data on typed response models for forward compatibility
 
@@ -192,6 +193,7 @@ development pass, covering:
 - `PATCH /config` with a no-op `TimeZone` write against the current value
 - `GET /info?module=General&submodule=Board`
 - `GET /info?module=General&submodule=Lan`
+- `GET /info?module=HeatRecovery`
 - `GET /info/nodes`
 - `GET /info?module=General&submodule=PublicApi`
 - `POST /action/nodes/{node}` with a no-op `SetVentilationState`

{python_duco_connectivity-0.6.0 → python_duco_connectivity-0.7.1}/README.md

@@ -31,6 +31,7 @@ in the development examples below.
 - HTTP only
 - asynchronous communication via `aiohttp`
 - typed stable config families for the documented `/config` branches
+- typed helpers for stable `/info` fields such as heat recovery filter time
 - typed models that stay close to the API response shape
 - preserved `raw_payload` data on typed response models for forward compatibility
 
@@ -160,6 +161,7 @@ development pass, covering:
 - `PATCH /config` with a no-op `TimeZone` write against the current value
 - `GET /info?module=General&submodule=Board`
 - `GET /info?module=General&submodule=Lan`
+- `GET /info?module=HeatRecovery`
 - `GET /info/nodes`
 - `GET /info?module=General&submodule=PublicApi`
 - `POST /action/nodes/{node}` with a no-op `SetVentilationState`

{python_duco_connectivity-0.6.0 → python_duco_connectivity-0.7.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-duco-connectivity"
-version = "0.6.0"
+version = "0.7.1"
 description = "Async HTTP client for the local Duco Connectivity API"
 readme = "README.md"
 license = "MIT"

{python_duco_connectivity-0.6.0 → python_duco_connectivity-0.7.1}/src/duco_connectivity/client.py

@@ -281,6 +281,31 @@ class DucoClient:
     def _read_wrapped_value(payload: dict[str, Any], key: str) -> Any:
         return payload[key]["Val"]
 
+    @staticmethod
+    def _read_optional_wrapped_int(
+        payload: dict[str, Any],
+        key: str,
+        *,
+        path: str,
+    ) -> int | None:
+        """Read an optional wrapped integer from a typed-stable API branch."""
+        if key not in payload:
+            return None
+        raw_entry = payload[key]
+        if not isinstance(raw_entry, dict):
+            msg = f"Expected wrapped Val object for {path}.{key}, got {type(raw_entry).__name__}"
+            raise DucoError(msg)
+        if "Val" not in raw_entry:
+            msg = f"Expected wrapped Val object for {path}.{key}"
+            raise DucoError(msg)
+
+        raw_value = raw_entry["Val"]
+        if type(raw_value) is not int:
+            msg = f"Expected integer value for {path}.{key}, got {type(raw_value).__name__}"
+            raise DucoError(msg)
+
+        return raw_value
+
     @staticmethod
     def _read_scalar_value(payload: dict[str, Any], key: str) -> Any:
         raw_value = payload[key]
@@ -2085,6 +2110,55 @@ class DucoClient:
         )
         return int(self._read_wrapped_value(payload["General"]["PublicApi"], "WriteReqCntRemain"))
 
+    async def async_get_time_filter_remaining(self) -> int | None:
+        """Return the remaining heat recovery filter time when the box reports it."""
+        try:
+            payload = await self.async_get_info(module=InfoModuleSelector.HEAT_RECOVERY)
+        except DucoResponseError as err:
+            if err.status == 400 and err.path == "/info":
+                try:
+                    error_payload = json.loads(err.body)
+                except json.JSONDecodeError:
+                    pass
+                else:
+                    if (
+                        isinstance(error_payload, dict)
+                        and error_payload.get("Code") == 3
+                        and error_payload.get("Result") == "FAILED"
+                    ):
+                        return None
+            raise
+
+        if not isinstance(payload, dict):
+            msg = (
+                "Expected object payload from /info?module=HeatRecovery, got "
+                f"{type(payload).__name__}"
+            )
+            raise DucoError(msg)
+
+        heat_recovery = payload.get("HeatRecovery")
+        if heat_recovery is None:
+            return None
+        if not isinstance(heat_recovery, dict):
+            msg = "Expected object payload at HeatRecovery in /info?module=HeatRecovery response"
+            raise DucoError(msg)
+
+        general = heat_recovery.get("General")
+        if general is None:
+            return None
+        if not isinstance(general, dict):
+            msg = (
+                "Expected object payload at HeatRecovery.General in "
+                "/info?module=HeatRecovery response"
+            )
+            raise DucoError(msg)
+
+        return self._read_optional_wrapped_int(
+            general,
+            "TimeFilterRemain",
+            path="HeatRecovery.General",
+        )
+
     async def async_get_write_req_remaining(self) -> int:
         """Backward-compatible alias for the old write budget method name."""
         caller = _compat_caller()

{python_duco_connectivity-0.6.0 → python_duco_connectivity-0.7.1/src/python_duco_connectivity.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-duco-connectivity
-Version: 0.6.0
+Version: 0.7.1
 Summary: Async HTTP client for the local Duco Connectivity API
 Author: Ronald van der Meer
 License-Expression: MIT
@@ -63,6 +63,7 @@ in the development examples below.
 - HTTP only
 - asynchronous communication via `aiohttp`
 - typed stable config families for the documented `/config` branches
+- typed helpers for stable `/info` fields such as heat recovery filter time
 - typed models that stay close to the API response shape
 - preserved `raw_payload` data on typed response models for forward compatibility
 
@@ -192,6 +193,7 @@ development pass, covering:
 - `PATCH /config` with a no-op `TimeZone` write against the current value
 - `GET /info?module=General&submodule=Board`
 - `GET /info?module=General&submodule=Lan`
+- `GET /info?module=HeatRecovery`
 - `GET /info/nodes`
 - `GET /info?module=General&submodule=PublicApi`
 - `POST /action/nodes/{node}` with a no-op `SetVentilationState`

{python_duco_connectivity-0.6.0 → python_duco_connectivity-0.7.1}/tests/test_client.py

@@ -3666,6 +3666,103 @@ async def test_get_write_requests_remaining_is_parsed() -> None:
     assert remaining == 197
 
 
+async def test_get_time_filter_remaining_is_parsed() -> None:
+    """Heat recovery filter time should be parsed when the box reports it."""
+    payload: dict[str, object] = {"HeatRecovery": {"General": {"TimeFilterRemain": {"Val": 180}}}}
+    mock_response = _response(json_payload=payload)
+
+    async with aiohttp.ClientSession() as session:
+        client = DucoClient(session=session, host="192.0.2.94")
+        with patch.object(session, "request", _request(mock_response)):
+            remaining = await client.async_get_time_filter_remaining()
+
+    assert remaining == 180
+
+
+async def test_get_time_filter_remaining_returns_none_when_not_reported() -> None:
+    """Heat recovery filter time should stay optional for boxes that omit it."""
+    payload: dict[str, object] = {"HeatRecovery": {"General": {}}}
+    mock_response = _response(json_payload=payload)
+
+    async with aiohttp.ClientSession() as session:
+        client = DucoClient(session=session, host="192.0.2.94")
+        with patch.object(session, "request", _request(mock_response)):
+            remaining = await client.async_get_time_filter_remaining()
+
+    assert remaining is None
+
+
+async def test_get_time_filter_remaining_returns_none_when_module_unsupported() -> None:
+    """Heat recovery filter time should stay optional for boxes without that module."""
+    mock_response = _response(
+        status=400,
+        text_payload='{"Code":3,"Result":"FAILED"}',
+    )
+
+    async with aiohttp.ClientSession() as session:
+        client = DucoClient(session=session, host="192.0.2.94")
+        with patch.object(session, "request", _request(mock_response)):
+            remaining = await client.async_get_time_filter_remaining()
+
+    assert remaining is None
+
+
+@pytest.mark.parametrize(
+    ("payload", "message"),
+    [
+        pytest.param(
+            [],
+            "Expected object payload from /info?module=HeatRecovery, got list",
+            id="root_not_object",
+        ),
+        pytest.param(
+            {"HeatRecovery": []},
+            "Expected object payload at HeatRecovery in /info?module=HeatRecovery response",
+            id="heat_recovery_not_object",
+        ),
+        pytest.param(
+            {"HeatRecovery": {"General": []}},
+            "Expected object payload at HeatRecovery.General in /info?module=HeatRecovery response",
+            id="general_not_object",
+        ),
+        pytest.param(
+            {"HeatRecovery": {"General": {"TimeFilterRemain": 180}}},
+            "Expected wrapped Val object for HeatRecovery.General.TimeFilterRemain, got int",
+            id="leaf_not_object",
+        ),
+        pytest.param(
+            {"HeatRecovery": {"General": {"TimeFilterRemain": None}}},
+            "Expected wrapped Val object for HeatRecovery.General.TimeFilterRemain, got NoneType",
+            id="leaf_null",
+        ),
+        pytest.param(
+            {"HeatRecovery": {"General": {"TimeFilterRemain": {}}}},
+            "Expected wrapped Val object for HeatRecovery.General.TimeFilterRemain",
+            id="leaf_missing_val",
+        ),
+        pytest.param(
+            {"HeatRecovery": {"General": {"TimeFilterRemain": {"Val": "180"}}}},
+            "Expected integer value for HeatRecovery.General.TimeFilterRemain, got str",
+            id="leaf_non_int_val",
+        ),
+    ],
+)
+async def test_get_time_filter_remaining_rejects_malformed_payloads(
+    payload: object,
+    message: str,
+) -> None:
+    """Malformed heat recovery payloads should raise DucoError."""
+    mock_response = _response(json_payload=payload)
+
+    async with aiohttp.ClientSession() as session:
+        client = DucoClient(session=session, host="192.0.2.94")
+        with (
+            patch.object(session, "request", _request(mock_response)),
+            pytest.raises(DucoError, match=re.escape(message)),
+        ):
+            await client.async_get_time_filter_remaining()
+
+
 async def test_get_write_req_remaining_alias_is_parsed() -> None:
     """The old write budget method name should remain available."""
     payload: dict[str, object] = {"General": {"PublicApi": {"WriteReqCntRemain": {"Val": 197}}}}