violet-poolController-api 0.0.9__tar.gz → 0.0.10__tar.gz

{violet_poolcontroller_api-0.0.9 → violet_poolcontroller_api-0.0.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: violet-poolController-api
-Version: 0.0.9
+Version: 0.0.10
 Summary: Asynchronous Python client for the Violet Pool Controller.
 Home-page: https://github.com/Xerolux/violet-poolController-api
 Author: Basti (Xerolux)
@@ -136,6 +136,22 @@ In this mode, dosing functions (for example `manual_dosing` and dosing parameter
 **Note on getReadings format:**
 As of version `0.0.7`, the API client automatically detects and normalizes the payload output from the controller. Whether your Violet Controller returns the classic base-module `dict` structure (`{"PUMPSTATE": "2", "PH": 7.2}`) or the new standalone `list` structure, the `get_readings()` and `get_specific_readings()` functions will always return a seamless, flattened key-value dictionary. Your Home Assistant integration or downstream application will work uniformly with both formats without requiring any extra code!
 
+**Hardware Profile Detection:**
+As of the latest release, the API client provides a method to detect the specific hardware configuration of your Violet Controller.
+The API automatically detects the connected modules and updates internal states based on the available readings.
+```python
+profile = await api.get_hardware_profile()
+print(profile)
+# Output example:
+# {
+#     "base_module": True,
+#     "dosing_module": True,
+#     "extension_module_1": True,
+#     "extension_module_2": False,
+# }
+```
+This detection parses `get_readings()` to check for the presence of certain internal status parameters (`SYSTEM_dosagemodule_cpu_temperature`, `EXT1_1`, `EXT2_1`), allowing your application to dynamically adapt to the connected modules (Base Module, Dosing Module, Relay Extension 1 and 2). By utilizing this detection, developers and integrations can accurately filter out features for missing hardware, ensuring that only supported options are exposed to the user.
+
 ## License
 GNU Affero General Public License v3.0 or later (AGPLv3+)
 

{violet_poolcontroller_api-0.0.9 → violet_poolcontroller_api-0.0.10}/README.md

@@ -108,6 +108,22 @@ In this mode, dosing functions (for example `manual_dosing` and dosing parameter
 **Note on getReadings format:**
 As of version `0.0.7`, the API client automatically detects and normalizes the payload output from the controller. Whether your Violet Controller returns the classic base-module `dict` structure (`{"PUMPSTATE": "2", "PH": 7.2}`) or the new standalone `list` structure, the `get_readings()` and `get_specific_readings()` functions will always return a seamless, flattened key-value dictionary. Your Home Assistant integration or downstream application will work uniformly with both formats without requiring any extra code!
 
+**Hardware Profile Detection:**
+As of the latest release, the API client provides a method to detect the specific hardware configuration of your Violet Controller.
+The API automatically detects the connected modules and updates internal states based on the available readings.
+```python
+profile = await api.get_hardware_profile()
+print(profile)
+# Output example:
+# {
+#     "base_module": True,
+#     "dosing_module": True,
+#     "extension_module_1": True,
+#     "extension_module_2": False,
+# }
+```
+This detection parses `get_readings()` to check for the presence of certain internal status parameters (`SYSTEM_dosagemodule_cpu_temperature`, `EXT1_1`, `EXT2_1`), allowing your application to dynamically adapt to the connected modules (Base Module, Dosing Module, Relay Extension 1 and 2). By utilizing this detection, developers and integrations can accurately filter out features for missing hardware, ensuring that only supported options are exposed to the user.
+
 ## License
 GNU Affero General Public License v3.0 or later (AGPLv3+)
 

{violet_poolcontroller_api-0.0.9 → violet_poolcontroller_api-0.0.10}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "violet-poolController-api"
-version = "0.0.9"
+version = "0.0.10"
 authors = [
   { name="Basti (Xerolux)", email="git@xerolux.de" },
 ]

{violet_poolcontroller_api-0.0.9 → violet_poolcontroller_api-0.0.10}/setup.py

@@ -1,7 +1,7 @@
 from setuptools import setup, find_packages
 setup(
     name="violet-poolController-api",
-    version="0.0.9",
+    version="0.0.10",
     author="Basti (Xerolux)",
     author_email="git@xerolux.de",
     description="Asynchronous Python client for the Violet Pool Controller.",

{violet_poolcontroller_api-0.0.9 → violet_poolcontroller_api-0.0.10}/tests/test_api.py

@@ -254,3 +254,64 @@ async def test_dosing_standalone_detection_dict_format(mock_aioresponse, standal
 
     assert isinstance(result, dict)
     assert standalone_api_client.dosing_standalone is False
+
+@pytest.mark.asyncio
+async def test_get_hardware_profile(mock_aioresponse, api_client):
+    """Test get_hardware_profile correctly detects components."""
+    url = "http://192.168.1.100/getReadings?ALL"
+
+    # 1. Base module only (no DOS, EXT)
+    mock_aioresponse.get(url, payload={"getReadings": {"PUMPSTATE": "2", "SYSTEM_dosagemodule_cpu_temperature": "N/A"}}, status=200)
+    profile = await api_client.get_hardware_profile()
+    assert profile == {
+        "base_module": True,
+        "dosing_module": False,
+        "extension_module_1": False,
+        "extension_module_2": False,
+    }
+
+    # 2. Base module + Dosing + Ext1
+    mock_aioresponse.get(url, payload={"getReadings": {"PUMPSTATE": "2", "SYSTEM_dosagemodule_cpu_temperature": 45.5, "EXT1_1": "1"}}, status=200)
+    profile = await api_client.get_hardware_profile()
+    assert profile == {
+        "base_module": True,
+        "dosing_module": True,
+        "extension_module_1": True,
+        "extension_module_2": False,
+    }
+
+    # 3. Base module + Ext1 + Ext2 (no Dosing)
+    mock_aioresponse.get(url, payload={"getReadings": {"PUMPSTATE": "2", "EXT1_1": "1", "EXT2_1": "1"}}, status=200)
+    profile = await api_client.get_hardware_profile()
+    assert profile == {
+        "base_module": True,
+        "dosing_module": False,
+        "extension_module_1": True,
+        "extension_module_2": True,
+    }
+
+@pytest.mark.asyncio
+async def test_get_hardware_profile_standalone_dosing(mock_aioresponse, standalone_api_client):
+    """Test get_hardware_profile with a standalone dosing configuration."""
+    url = "http://192.168.1.100/getReadings?ALL"
+    # Using the standalone list format
+    mock_data = {
+        "getReadings": [
+            {
+                "VALUE NAME": "   \"DOS_1_CL\"",
+                "DESCRIPTION": "Current state of OUTPUT: CL-DOSING",
+                "FORMAT": "INTEGER",
+                "DETAILS": "0 - AUTO (not on)",
+                "VALUE": 2
+            }
+        ]
+    }
+    mock_aioresponse.get(url, payload=mock_data, status=200)
+
+    profile = await standalone_api_client.get_hardware_profile()
+    assert profile == {
+        "base_module": False,
+        "dosing_module": True,
+        "extension_module_1": False,
+        "extension_module_2": False,
+    }

{violet_poolcontroller_api-0.0.9 → violet_poolcontroller_api-0.0.10}/violet_poolController_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: violet-poolController-api
-Version: 0.0.9
+Version: 0.0.10
 Summary: Asynchronous Python client for the Violet Pool Controller.
 Home-page: https://github.com/Xerolux/violet-poolController-api
 Author: Basti (Xerolux)
@@ -136,6 +136,22 @@ In this mode, dosing functions (for example `manual_dosing` and dosing parameter
 **Note on getReadings format:**
 As of version `0.0.7`, the API client automatically detects and normalizes the payload output from the controller. Whether your Violet Controller returns the classic base-module `dict` structure (`{"PUMPSTATE": "2", "PH": 7.2}`) or the new standalone `list` structure, the `get_readings()` and `get_specific_readings()` functions will always return a seamless, flattened key-value dictionary. Your Home Assistant integration or downstream application will work uniformly with both formats without requiring any extra code!
 
+**Hardware Profile Detection:**
+As of the latest release, the API client provides a method to detect the specific hardware configuration of your Violet Controller.
+The API automatically detects the connected modules and updates internal states based on the available readings.
+```python
+profile = await api.get_hardware_profile()
+print(profile)
+# Output example:
+# {
+#     "base_module": True,
+#     "dosing_module": True,
+#     "extension_module_1": True,
+#     "extension_module_2": False,
+# }
+```
+This detection parses `get_readings()` to check for the presence of certain internal status parameters (`SYSTEM_dosagemodule_cpu_temperature`, `EXT1_1`, `EXT2_1`), allowing your application to dynamically adapt to the connected modules (Base Module, Dosing Module, Relay Extension 1 and 2). By utilizing this detection, developers and integrations can accurately filter out features for missing hardware, ensuring that only supported options are exposed to the user.
+
 ## License
 GNU Affero General Public License v3.0 or later (AGPLv3+)
 

{violet_poolcontroller_api-0.0.9 → violet_poolcontroller_api-0.0.10}/violet_poolcontroller_api/api.py

@@ -511,7 +511,57 @@ class VioletPoolAPI:
             query="ALL",
             payload_name="getReadings",
         )
-        return self._flatten_getreadings_response(response)
+        flattened = self._flatten_getreadings_response(response)
+
+        # Determine hardware profile based on the flattened readings
+        def is_present(key: str) -> bool:
+            if not isinstance(flattened, dict):
+                return False
+            val = flattened.get(key)
+            return val is not None and str(val).strip().upper() != "N/A"
+
+        profile = {
+            "base_module": not self.dosing_standalone,
+            "dosing_module": self.dosing_standalone or is_present("SYSTEM_dosagemodule_cpu_temperature"),
+            "extension_module_1": is_present("EXT1_1"),
+            "extension_module_2": is_present("EXT2_1"),
+        }
+
+        return self._filter_unsupported_readings(flattened, profile)
+
+    def _filter_unsupported_readings(self, readings: dict[str, Any], profile: dict[str, bool]) -> dict[str, Any]:
+        """Filters out readings for hardware modules that are not present."""
+        if not isinstance(readings, dict):
+            return readings
+
+        filtered_readings = {}
+        for key, value in readings.items():
+            normalized_key = key.upper()
+
+            # Base Module specific keys
+            if not profile.get("base_module"):
+                if normalized_key in {
+                    "PUMPSTATE", "PUMP_SPEED", "HEATER", "LIGHT", "ECO",
+                    "BACKWASH", "BACKWASHRINSE", "REFILL", "PVSURPLUS", "TEMP_PUMP"
+                } or (normalized_key.startswith("SYSTEM_") and normalized_key != "SYSTEM_DOSAGEMODULE_CPU_TEMPERATURE"):
+                    continue
+
+            # Extension Module 1 specific keys
+            if not profile.get("extension_module_1") and normalized_key.startswith("EXT1_"):
+                continue
+
+            # Extension Module 2 specific keys
+            if not profile.get("extension_module_2") and normalized_key.startswith("EXT2_"):
+                continue
+
+            # Dosing Module specific keys
+            if not profile.get("dosing_module"):
+                if normalized_key.startswith("DOS_") or normalized_key == "SYSTEM_DOSAGEMODULE_CPU_TEMPERATURE":
+                    continue
+
+            filtered_readings[key] = value
+
+        return filtered_readings
 
     async def get_specific_readings(
         self, categories: list[str] | tuple[str, ...]
@@ -575,6 +625,31 @@ class VioletPoolAPI:
             payload_name="getWeatherdata",
         )
 
+    async def get_hardware_profile(self) -> dict[str, bool]:
+        """Detects connected hardware based on available readings.
+
+        Returns:
+            A dictionary with boolean flags for connected hardware components:
+            - base_module: True if the base module is present.
+            - dosing_module: True if the dosing module is present.
+            - extension_module_1: True if the first relay extension is present.
+            - extension_module_2: True if the second relay extension is present.
+        """
+        readings = await self.get_readings()
+
+        def is_present(key: str) -> bool:
+            if not isinstance(readings, dict):
+                return False
+            val = readings.get(key)
+            return val is not None and str(val).strip().upper() != "N/A"
+
+        return {
+            "base_module": not self.dosing_standalone,
+            "dosing_module": self.dosing_standalone or is_present("SYSTEM_dosagemodule_cpu_temperature"),
+            "extension_module_1": is_present("EXT1_1"),
+            "extension_module_2": is_present("EXT2_1"),
+        }
+
     async def get_overall_dosing(self) -> dict[str, Any]:
         """Returns aggregated dosing statistics.