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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: violet-poolController-api
-Version: 0.0.9
+Version: 0.0.11
 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.11}/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.11}/pyproject.toml

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

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

@@ -1,35 +1,35 @@
-from setuptools import setup, find_packages
-setup(
-    name="violet-poolController-api",
-    version="0.0.9",
-    author="Basti (Xerolux)",
-    author_email="git@xerolux.de",
-    description="Asynchronous Python client for the Violet Pool Controller.",
-    long_description=open("README.md").read(),
-    long_description_content_type="text/markdown",
-    url="https://github.com/Xerolux/violet-poolController-api",
-    packages=find_packages(),
-    license="AGPL-3.0-or-later",
-    classifiers=[
-        "Programming Language :: Python :: 3",
-        "License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)",
-        "Operating System :: OS Independent",
-        "Intended Audience :: Developers",
-        "Topic :: Home Automation",
-    ],
-    python_requires=">=3.12",
-    install_requires=[
-        "aiohttp>=3.9.0",
-    ],
-    extras_require={
-        "test": [
-            "aioresponses>=0.7.6",
-            "pytest>=8.0",
-            "pytest-asyncio>=0.23",
-        ],
-    },
-    project_urls={
-        "Bug Tracker": "https://github.com/Xerolux/violet-poolController-api/issues",
-        "License": "https://www.gnu.org/licenses/agpl-3.0.html",
-    },
-)
+from setuptools import setup, find_packages
+setup(
+    name="violet-poolController-api",
+    version="0.0.11",
+    author="Basti (Xerolux)",
+    author_email="git@xerolux.de",
+    description="Asynchronous Python client for the Violet Pool Controller.",
+    long_description=open("README.md").read(),
+    long_description_content_type="text/markdown",
+    url="https://github.com/Xerolux/violet-poolController-api",
+    packages=find_packages(),
+    license="AGPL-3.0-or-later",
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)",
+        "Operating System :: OS Independent",
+        "Intended Audience :: Developers",
+        "Topic :: Home Automation",
+    ],
+    python_requires=">=3.12",
+    install_requires=[
+        "aiohttp>=3.9.0",
+    ],
+    extras_require={
+        "test": [
+            "aioresponses>=0.7.6",
+            "pytest>=8.0",
+            "pytest-asyncio>=0.23",
+        ],
+    },
+    project_urls={
+        "Bug Tracker": "https://github.com/Xerolux/violet-poolController-api/issues",
+        "License": "https://www.gnu.org/licenses/agpl-3.0.html",
+    },
+)

{violet_poolcontroller_api-0.0.9 → violet_poolcontroller_api-0.0.11}/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.11}/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.11
 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.11}/violet_poolcontroller_api/__init__.py

@@ -13,3 +13,7 @@
 #
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+from .api import VioletPoolAPI, VioletPoolAPIError
+
+__all__ = ["VioletPoolAPI", "VioletPoolAPIError"]

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

@@ -18,8 +18,6 @@
 
 from __future__ import annotations
 
-from .const_devices import DEVICE_PARAMETERS
-
 import asyncio
 import json
 import logging
@@ -55,12 +53,14 @@ from .const_api import (
     API_SET_FUNCTION_MANUALLY,
     API_SET_OUTPUT_TESTMODE,
     API_SET_TARGET_VALUES,
+    DMX_SCENE_COUNT,
     DOSING_FUNCTIONS,
     TARGET_MIN_CHLORINE,
     TARGET_ORP,
     TARGET_PH,
 )
 from .circuit_breaker import CircuitBreaker, CircuitBreakerOpenError
+from .const_devices import DEVICE_PARAMETERS
 from .utils_rate_limiter import get_global_rate_limiter
 from .utils_sanitizer import InputSanitizer
 
@@ -497,6 +497,28 @@ class VioletPoolAPI:
 
         return response
 
+    def _build_hardware_profile(self, flattened: dict[str, Any]) -> dict[str, bool]:
+        """Build a hardware presence profile from flattened getReadings data.
+
+        Args:
+            flattened: The flattened key-value readings dict.
+
+        Returns:
+            A dictionary with boolean flags for connected hardware components.
+        """
+        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"
+
+        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_readings(self) -> dict[str, Any]:
         """Returns the complete dataset from the controller.
 
@@ -511,7 +533,43 @@ class VioletPoolAPI:
             query="ALL",
             payload_name="getReadings",
         )
-        return self._flatten_getreadings_response(response)
+        flattened = self._flatten_getreadings_response(response)
+        profile = self._build_hardware_profile(flattened)
+        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 +633,24 @@ 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.
+        """
+        response = await self._request_json_dict(
+            API_READINGS,
+            query="ALL",
+            payload_name="getReadings",
+        )
+        flattened = self._flatten_getreadings_response(response)
+        return self._build_hardware_profile(flattened)
+
     async def get_overall_dosing(self) -> dict[str, Any]:
         """Returns aggregated dosing statistics.
 
@@ -760,7 +836,8 @@ class VioletPoolAPI:
         if not output:
             raise VioletPoolAPIError("Output identifier is required")
 
-        duration_ms = max(0, int(duration)) * 1000
+        safe_duration = max(0, min(86400, int(duration)))  # cap at 24 h
+        duration_ms = safe_duration * 1000
         payload = f"{output},{mode},{duration_ms}"
         body = await self._request(
             API_SET_OUTPUT_TESTMODE,
@@ -866,7 +943,7 @@ class VioletPoolAPI:
             raise VioletPoolAPIError(f"Unsupported DMX action: {action}")
 
         tasks = []
-        for scene in range(1, 13):
+        for scene in range(1, DMX_SCENE_COUNT + 1):
             key = f"DMX_SCENE{scene}"
             tasks.append(self.set_switch_state(key, action))
 

{violet_poolcontroller_api-0.0.9 → violet_poolcontroller_api-0.0.11}/violet_poolcontroller_api/circuit_breaker.py

@@ -22,7 +22,7 @@ import asyncio
 import logging
 import time
 from collections.abc import Callable
-from enum import StrEnum
+from enum import StrEnum
 from typing import Any
 
 _LOGGER = logging.getLogger(__name__)
@@ -175,12 +175,13 @@ class CircuitBreaker:
             "half_open_start_time": self.half_open_start_time,
         }
 
-    def reset(self) -> None:
-        """Manually reset the circuit breaker (call from sync context only)."""
-        self.state = CircuitBreakerState.CLOSED
-        self.failure_count = 0
-        self.last_failure_time = 0.0
-        self.half_open_start_time = 0.0
+    async def reset(self) -> None:
+        """Manually reset the circuit breaker to CLOSED state."""
+        async with self._lock:
+            self.state = CircuitBreakerState.CLOSED
+            self.failure_count = 0
+            self.last_failure_time = 0.0
+            self.half_open_start_time = 0.0
         _LOGGER.info("Circuit breaker manually reset to CLOSED state")
 
 

{violet_poolcontroller_api-0.0.9 → violet_poolcontroller_api-0.0.11}/violet_poolcontroller_api/const_api.py

@@ -123,8 +123,10 @@ for ext_bank in [1, 2]:
             f"Erweiterung {ext_bank}.{relay_num}"
         )
 
+DMX_SCENE_COUNT = 12  # Number of DMX scenes supported by the controller
+
 # Dynamically add DMX scenes
-for scene_num in range(1, 13):
+for scene_num in range(1, DMX_SCENE_COUNT + 1):
     SWITCH_FUNCTIONS[f"DMX_SCENE{scene_num}"] = f"DMX Szene {scene_num}"
 
 # Dynamically add digital input rules

{violet_poolcontroller_api-0.0.9 → violet_poolcontroller_api-0.0.11}/violet_poolcontroller_api/utils_rate_limiter.py

@@ -125,17 +125,20 @@ class RateLimiter:
             # Track failures efficiently
             self.blocked_requests += 1
             self._recent_stats["blocked_last_minute"] += 1
+            self.request_history.append(
+                {"time": current_time, "priority": priority, "blocked": True}
+            )
             return False
 
-    def _cleanup_history(self, current_time: float) -> None:
-        """Clean up old history entries to prevent memory leaks."""
-        # Remove entries older than 1 hour
-        cutoff_time = current_time - 3600
-
-        while self.request_history and self.request_history[0]["time"] <= cutoff_time:
-            self.request_history.popleft()
-
-        _LOGGER.debug("Rate limiter history cleanup completed")
+    def _cleanup_history(self, current_time: float) -> None:
+        """Clean up old history entries to prevent memory leaks."""
+        # Remove entries older than 1 hour
+        cutoff_time = current_time - 3600
+
+        while self.request_history and self.request_history[0]["time"] <= cutoff_time:
+            self.request_history.popleft()
+
+        _LOGGER.debug("Rate limiter history cleanup completed")
 
     def _update_recent_stats(self, current_time: float) -> None:
         """Update memory-efficient recent statistics."""