dimplex-controller 0.7.0__tar.gz → 0.8.0__tar.gz

{dimplex_controller-0.7.0 → dimplex_controller-0.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dimplex-controller
-Version: 0.7.0
+Version: 0.8.0
 Summary: Python client for Dimplex heating controllers (GDHV IoT)
 License: MIT
 License-File: LICENSE
@@ -22,7 +22,6 @@ Classifier: Topic :: Home Automation
 Requires-Dist: aiohttp (>=3.9.0,<4.0.0)
 Requires-Dist: beautifulsoup4 (>=4.14.3,<5.0.0)
 Requires-Dist: pydantic (>=2.0.0,<3.0.0)
-Requires-Dist: python-dotenv (>=1.2.1,<2.0.0)
 Project-URL: Homepage, https://github.com/KRoperUK/dimplex-controller-py
 Project-URL: Repository, https://github.com/KRoperUK/dimplex-controller-py
 Description-Content-Type: text/markdown

{dimplex_controller-0.7.0 → dimplex_controller-0.8.0}/dimplex_controller/__init__.py

@@ -10,6 +10,7 @@ from .models import (
     ApplianceStatus,
     AutomaticProvisioning,
     Hub,
+    ProductModel,
     TimerMode,
     TimerModeSettings,
     TimerPeriod,
@@ -37,6 +38,7 @@ __all__ = [
     "TimerModeSettings",
     "TimerPeriod",
     "AutomaticProvisioning",
+    "ProductModel",
     "TsiEnergyReport",
     "parse_telemetry_points",
     "filter_telemetry_points",

{dimplex_controller-0.7.0 → dimplex_controller-0.8.0}/dimplex_controller/client.py

@@ -24,6 +24,7 @@ from .models import (
     ApplianceModeSettings,
     ApplianceStatus,
     Hub,
+    ProductModel,
     TimerMode,
     TimerModeSettings,
     TimerPeriod,
@@ -174,6 +175,16 @@ class DimplexControl:
         data = await self._request("GET", "/Identity/GetUserContext")
         return UserContext.model_validate(data)
 
+    async def get_product_models(self) -> list[ProductModel]:
+        """Return the cloud product catalogue (models + provisioning metadata).
+
+        The catalogue is largely static; callers may cache the result.
+        """
+        data = await self._request("GET", "/Appliances/GetProductModels")
+        if not data:
+            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."""
         payload = {

{dimplex_controller-0.7.0 → dimplex_controller-0.8.0}/dimplex_controller/models.py

@@ -4,7 +4,7 @@ import json
 from datetime import datetime, time
 from enum import IntEnum, IntFlag
 
-from pydantic import BaseModel, Field, field_validator
+from pydantic import BaseModel, ConfigDict, Field, field_validator
 
 
 class TimerMode(IntEnum):
@@ -39,8 +39,16 @@ class AutomaticProvisioning(BaseModel):
 
     The cloud stores this as a JSON string; :class:`Appliance` decodes it
     automatically so callers can read the heater's electrical characteristics.
+
+    Observed units (from product catalogue / live Quantum payloads):
+
+    * power ratings — kW
+    * charge capacity — kWh
+    * charge element resistance — ohms
     """
 
+    model_config = ConfigDict(populate_by_name=True)
+
     bottom_element_power_rating: float | None = Field(None, alias="bottomElementPowerRating")
     top_element_power_rating: float | None = Field(None, alias="topElementPowerRating")
     rated_power: float | None = Field(None, alias="ratedPower")
@@ -49,6 +57,38 @@ class AutomaticProvisioning(BaseModel):
     power_offset: float | None = Field(None, alias="powerOffset")
 
 
+class ProductModel(BaseModel):
+    """A row from ``GET /Appliances/GetProductModels``."""
+
+    model_config = ConfigDict(populate_by_name=True)
+
+    ProductModelId: str | None = None
+    ProductTypeId: str | None = None
+    ProductModelName: str | None = None
+    ProductTypeName: str | None = None
+    ProductModelExtensions: dict[str, str] | None = None
+
+    @field_validator("ProductModelExtensions", mode="before")
+    @classmethod
+    def _coerce_extensions(cls, value):
+        if value is None:
+            return None
+        if isinstance(value, dict):
+            return {str(k): v if isinstance(v, str) else json.dumps(v) for k, v in value.items()}
+        return value
+
+    @property
+    def automatic_provisioning(self) -> AutomaticProvisioning | None:
+        """Return decoded AUTOMATIC_PROVISIONING, if present."""
+        raw = (self.ProductModelExtensions or {}).get("AUTOMATIC_PROVISIONING")
+        if not raw:
+            return None
+        try:
+            return AutomaticProvisioning.model_validate_json(raw)
+        except (json.JSONDecodeError, ValueError):
+            return None
+
+
 class Appliance(BaseModel):
     ApplianceId: str
     ApplianceType: str

{dimplex_controller-0.7.0 → dimplex_controller-0.8.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "dimplex-controller"
-version = "0.7.0"
+version = "0.8.0"
 description = "Python client for Dimplex heating controllers (GDHV IoT)"
 authors = ["Kieran Roper"]
 license = "MIT"
@@ -28,7 +28,7 @@ python = "^3.10"
 aiohttp = "^3.9.0"
 pydantic = "^2.0.0"
 beautifulsoup4 = "^4.14.3"
-python-dotenv = "^1.2.1"
+
 [tool.poetry.group.dev.dependencies]
 pytest = "^8.0.0"
 pytest-asyncio = "^0.23.0"
@@ -37,6 +37,8 @@ aresponses = "^3.0.0"
 ruff = "^0.3.0"
 pre-commit = "^3.6.0"
 twine = "^6.2.0"
+python-dotenv = "^1.2.1"
+mypy = "^1.0.0"
 
 [tool.ruff]
 line-length = 120