dimplex-controller 0.10.0__tar.gz → 0.10.1__tar.gz

{dimplex_controller-0.10.0 → dimplex_controller-0.10.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dimplex-controller
-Version: 0.10.0
+Version: 0.10.1
 Summary: Python client for Dimplex heating controllers (GDHV IoT)
 License: MIT
 License-File: LICENSE
@@ -167,6 +167,8 @@ for status in status_list:
     print(f"Comfort status: {status.ComfortStatus}")
 ```
 
+> **A note on empty responses:** when every requested appliance is offline (e.g. radiators switched off at the wall) the cloud returns HTTP 200 with an empty list. `get_appliance_overview` surfaces that as `[]` — it is **not** an error. If you need a stable id → status mapping, use `get_appliance_overview_map(...)`, which fills in `None` for missing ids.
+
 ### Sending control commands
 
 ```python
@@ -281,6 +283,10 @@ If `parse_telemetry_points` returns an empty list, the API likely returned an un
 
 The GDHV cloud API has rate limits. If you hit them, back off for a few minutes before retrying. The library does not currently implement automatic retries with back-off.
 
+### `get_appliance_overview` returns an empty list
+
+This is the cloud's normal response when every requested appliance is offline (e.g. radiators turned off at the wall, or a hub that has dropped off the network). It is **not** an error — `get_appliance_overview` returns `[]` and `get_appliance_overview_map` returns a dict of `None` values. Treat the call as a successful poll; the appliances will reappear in subsequent calls once they come back online. See the note in [Reading status](#reading-status) for details.
+
 
 ## CLI
 

{dimplex_controller-0.10.0 → dimplex_controller-0.10.1}/README.md

@@ -139,6 +139,8 @@ for status in status_list:
     print(f"Comfort status: {status.ComfortStatus}")
 ```
 
+> **A note on empty responses:** when every requested appliance is offline (e.g. radiators switched off at the wall) the cloud returns HTTP 200 with an empty list. `get_appliance_overview` surfaces that as `[]` — it is **not** an error. If you need a stable id → status mapping, use `get_appliance_overview_map(...)`, which fills in `None` for missing ids.
+
 ### Sending control commands
 
 ```python
@@ -253,6 +255,10 @@ If `parse_telemetry_points` returns an empty list, the API likely returned an un
 
 The GDHV cloud API has rate limits. If you hit them, back off for a few minutes before retrying. The library does not currently implement automatic retries with back-off.
 
+### `get_appliance_overview` returns an empty list
+
+This is the cloud's normal response when every requested appliance is offline (e.g. radiators turned off at the wall, or a hub that has dropped off the network). It is **not** an error — `get_appliance_overview` returns `[]` and `get_appliance_overview_map` returns a dict of `None` values. Treat the call as a successful poll; the appliances will reappear in subsequent calls once they come back online. See the note in [Reading status](#reading-status) for details.
+
 
 ## CLI
 

{dimplex_controller-0.10.0 → dimplex_controller-0.10.1}/dimplex_controller/__init__.py

@@ -1,4 +1,15 @@
-"""Dimplex Controller Client."""
+"""Dimplex Controller Client.
+
+Async Python client for the Glen Dimplex Heating & Ventilation (GDHV) cloud
+API. See :class:`~dimplex_controller.client.DimplexControl` for the entry
+point and :meth:`DimplexControl.get_appliance_overview` for the read path
+used by the Home Assistant integration.
+
+A note on the API: ``get_appliance_overview`` may return an empty list
+with HTTP 200 when the requested appliances are offline. That is a
+successful poll, not an error — use ``get_appliance_overview_map`` if you
+need a stable id → status mapping.
+"""
 
 from .auth import TokenBundle
 from .capabilities import ApplianceCapabilities, capabilities_for

{dimplex_controller-0.10.0 → dimplex_controller-0.10.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "dimplex-controller"
-version = "0.10.0"
+version = "0.10.1"
 description = "Python client for Dimplex heating controllers (GDHV IoT)"
 authors = ["Kieran Roper"]
 license = "MIT"