violet-poolController-api 0.0.5__tar.gz → 0.0.6__tar.gz

{violet_poolcontroller_api-0.0.5 → violet_poolcontroller_api-0.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: violet-poolController-api
-Version: 0.0.5
+Version: 0.0.6
 Summary: Asynchronous Python client for the Violet Pool Controller.
 Home-page: https://github.com/Xerolux/violet-poolController-api
 Author: Basti (Xerolux)
@@ -74,7 +74,8 @@ async def main():
             host="192.168.1.100",
             username="admin",
             password="your_password",
-            session=session
+            session=session,
+            dosing_standalone=False,  # True for Violet dosing standalone setups
         )
 
         try:
@@ -116,6 +117,22 @@ The API client includes many more functions tailored to the Violet Controller:
 
 For a full list of available commands and more detailed examples, please refer to the [Wiki](https://github.com/Xerolux/violet-poolController-api/wiki) or the source code in `api.py`.
 
+## Violet Dosing Standalone Mode
+
+If your Violet setup runs as dosing standalone (without the base module), enable:
+
+```python
+api = VioletPoolAPI(
+    host="192.168.1.100",
+    username="admin",
+    password="your_password",
+    session=session,
+    dosing_standalone=True,
+)
+```
+
+In this mode, dosing functions (for example `manual_dosing` and dosing parameter/target updates) stay available, while base-module-only switch functions (for example pump/light/backwash) are blocked with a clear error message.
+
 ## License
 GNU Affero General Public License v3.0 or later (AGPLv3+)
 

{violet_poolcontroller_api-0.0.5 → violet_poolcontroller_api-0.0.6}/README.md

@@ -12,11 +12,11 @@ An asynchronous Python client for interacting with the **Violet Pool Controller*
 
 This library is primarily designed to power the official [Violet Pool Controller Home Assistant Integration](https://github.com/Xerolux/violet-hass), but it can be used independently for any Python project that needs to fetch readings or control a Violet Pool system.
 
-> **📖 Documentation:**
-> - GitHub Pages: https://xerolux.github.io/violet-poolController-api/
-> - GitHub Wiki: https://github.com/Xerolux/violet-poolController-api/wiki
->
-> The `docs/` directory is the single source of truth and is used for both GitHub Pages and Wiki sync.
+> **📖 Documentation:**
+> - GitHub Pages: https://xerolux.github.io/violet-poolController-api/
+> - GitHub Wiki: https://github.com/Xerolux/violet-poolController-api/wiki
+>
+> The `docs/` directory is the single source of truth and is used for both GitHub Pages and Wiki sync.
 
 ## Features
 * **Asynchronous:** Fully async operations using `aiohttp`.
@@ -46,7 +46,8 @@ async def main():
             host="192.168.1.100",
             username="admin",
             password="your_password",
-            session=session
+            session=session,
+            dosing_standalone=False,  # True for Violet dosing standalone setups
         )
 
         try:
@@ -88,6 +89,22 @@ The API client includes many more functions tailored to the Violet Controller:
 
 For a full list of available commands and more detailed examples, please refer to the [Wiki](https://github.com/Xerolux/violet-poolController-api/wiki) or the source code in `api.py`.
 
+## Violet Dosing Standalone Mode
+
+If your Violet setup runs as dosing standalone (without the base module), enable:
+
+```python
+api = VioletPoolAPI(
+    host="192.168.1.100",
+    username="admin",
+    password="your_password",
+    session=session,
+    dosing_standalone=True,
+)
+```
+
+In this mode, dosing functions (for example `manual_dosing` and dosing parameter/target updates) stay available, while base-module-only switch functions (for example pump/light/backwash) are blocked with a clear error message.
+
 ## License
 GNU Affero General Public License v3.0 or later (AGPLv3+)
 

{violet_poolcontroller_api-0.0.5 → violet_poolcontroller_api-0.0.6}/pyproject.toml

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

{violet_poolcontroller_api-0.0.5 → violet_poolcontroller_api-0.0.6}/setup.py

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

{violet_poolcontroller_api-0.0.5 → violet_poolcontroller_api-0.0.6}/tests/test_api.py

@@ -26,8 +26,8 @@ def mock_aioresponse():
     with aioresponses() as m:
         yield m
 
-@pytest_asyncio.fixture
-async def api_client():
+@pytest_asyncio.fixture
+async def api_client():
     async with aiohttp.ClientSession() as session:
         # Pass low retry counts to make error tests faster
         api = VioletPoolAPI(
@@ -36,9 +36,23 @@ async def api_client():
             username="admin",
             password="password",
             max_retries=1
-        )
-        yield api
-
+        )
+        yield api
+
+
+@pytest_asyncio.fixture
+async def standalone_api_client():
+    async with aiohttp.ClientSession() as session:
+        api = VioletPoolAPI(
+            host="192.168.1.100",
+            session=session,
+            username="admin",
+            password="password",
+            max_retries=1,
+            dosing_standalone=True,
+        )
+        yield api
+
 @pytest.mark.asyncio
 async def test_get_readings_success(mock_aioresponse, api_client):
     """Test get_readings returns the correct parsed JSON dictionary."""
@@ -165,3 +179,26 @@ async def test_set_config_sanitizes_payload_before_request(api_client, monkeypat
     assert result["success"] is True
     assert result["response"] == "OK"
     assert captured["json_payload"] == {"poolmode": "A<mode>", "speed": 3.7}
+
+
+@pytest.mark.asyncio
+async def test_standalone_mode_allows_manual_dosing(
+    mock_aioresponse, standalone_api_client
+):
+    """Standalone mode must still allow dosing outputs."""
+    url = "http://192.168.1.100/setFunctionManually?DOS_1_CL,ON,45,0"
+    mock_aioresponse.get(url, body="OK", status=200)
+
+    result = await standalone_api_client.manual_dosing("Chlor", 45)
+
+    assert result["success"] is True
+    assert result["response"] == "OK"
+
+
+@pytest.mark.asyncio
+async def test_standalone_mode_blocks_base_module_functions(standalone_api_client):
+    """Standalone mode must reject functions that require the base module."""
+    with pytest.raises(VioletPoolAPIError) as exc_info:
+        await standalone_api_client.set_pump_speed(speed=2, duration=0)
+
+    assert "requires the Violet base module" in str(exc_info.value)

{violet_poolcontroller_api-0.0.5 → violet_poolcontroller_api-0.0.6}/violet_poolController_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: violet-poolController-api
-Version: 0.0.5
+Version: 0.0.6
 Summary: Asynchronous Python client for the Violet Pool Controller.
 Home-page: https://github.com/Xerolux/violet-poolController-api
 Author: Basti (Xerolux)
@@ -74,7 +74,8 @@ async def main():
             host="192.168.1.100",
             username="admin",
             password="your_password",
-            session=session
+            session=session,
+            dosing_standalone=False,  # True for Violet dosing standalone setups
         )
 
         try:
@@ -116,6 +117,22 @@ The API client includes many more functions tailored to the Violet Controller:
 
 For a full list of available commands and more detailed examples, please refer to the [Wiki](https://github.com/Xerolux/violet-poolController-api/wiki) or the source code in `api.py`.
 
+## Violet Dosing Standalone Mode
+
+If your Violet setup runs as dosing standalone (without the base module), enable:
+
+```python
+api = VioletPoolAPI(
+    host="192.168.1.100",
+    username="admin",
+    password="your_password",
+    session=session,
+    dosing_standalone=True,
+)
+```
+
+In this mode, dosing functions (for example `manual_dosing` and dosing parameter/target updates) stay available, while base-module-only switch functions (for example pump/light/backwash) are blocked with a clear error message.
+
 ## License
 GNU Affero General Public License v3.0 or later (AGPLv3+)
 

{violet_poolcontroller_api-0.0.5 → violet_poolcontroller_api-0.0.6}/violet_poolcontroller_api/api.py

@@ -79,18 +79,19 @@ class VioletPoolAPI:
     endpoints.
     """
 
-    def __init__(
-        self,
-        *,
-        host: str,
-        session: aiohttp.ClientSession,
+    def __init__(
+        self,
+        *,
+        host: str,
+        session: aiohttp.ClientSession,
         username: str | None = None,
         password: str | None = None,
-        use_ssl: bool = False,
-        verify_ssl: bool = True,
-        timeout: int = 10,
-        max_retries: int = 3,
-    ) -> None:
+        use_ssl: bool = False,
+        verify_ssl: bool = True,
+        timeout: int = 10,
+        max_retries: int = 3,
+        dosing_standalone: bool = False,
+    ) -> None:
         """Initializes the API helper.
 
         Args:
@@ -99,10 +100,12 @@ class VioletPoolAPI:
             username: The username for authentication.
             password: The password for authentication.
             use_ssl: Whether to use SSL for the connection.
-            verify_ssl: Whether to verify SSL certificates (security feature).
-            timeout: The request timeout in seconds.
-            max_retries: The maximum number of retries for failed requests.
-        """
+            verify_ssl: Whether to verify SSL certificates (security feature).
+            timeout: The request timeout in seconds.
+            max_retries: The maximum number of retries for failed requests.
+            dosing_standalone: Whether the controller runs in dosing-standalone
+                mode without a connected base module.
+        """
         if session is None:
             raise ValueError("A valid aiohttp session must be provided")
 
@@ -110,15 +113,16 @@ class VioletPoolAPI:
 
         self._session = session
         total_timeout = max(float(timeout), 1.0)
-        self._timeout = aiohttp.ClientTimeout(
-            total=total_timeout,
-            connect=total_timeout * 0.8,
-            sock_connect=total_timeout * 0.8,
-        )
-        self._max_retries = max(1, int(max_retries))
-        self._auth = None
-        if username:
-            self._auth = aiohttp.BasicAuth(username, password or "")
+        self._timeout = aiohttp.ClientTimeout(
+            total=total_timeout,
+            connect=total_timeout * 0.8,
+            sock_connect=total_timeout * 0.8,
+        )
+        self._max_retries = max(1, int(max_retries))
+        self._dosing_standalone = bool(dosing_standalone)
+        self._auth = None
+        if username:
+            self._auth = aiohttp.BasicAuth(username, password or "")
 
         # SSL/TLS security configuration
         self._verify_ssl = verify_ssl
@@ -158,13 +162,18 @@ class VioletPoolAPI:
         return self._timeout.total or 0.0
 
     @property
-    def max_retries(self) -> int:
-        """Get maximum retry attempts.
+    def max_retries(self) -> int:
+        """Get maximum retry attempts.
 
         Returns:
             The maximum number of retry attempts.
-        """
-        return self._max_retries
+        """
+        return self._max_retries
+
+    @property
+    def dosing_standalone(self) -> bool:
+        """Return whether dosing-standalone mode is enabled."""
+        return self._dosing_standalone
 
     # ---------------------------------------------------------------------
     # Generic helpers
@@ -399,9 +408,9 @@ class VioletPoolAPI:
             )
         return response
 
-    def _sanitize_config_payload(self, config: Mapping[str, Any]) -> dict[str, Any]:
-        """Sanitize and validate configuration payload before POSTing it."""
-        sanitized_config: dict[str, str | int | float] = {}
+    def _sanitize_config_payload(self, config: Mapping[str, Any]) -> dict[str, Any]:
+        """Sanitize and validate configuration payload before POSTing it."""
+        sanitized_config: dict[str, str | int | float] = {}
 
         for key, value in config.items():
             try:
@@ -427,7 +436,31 @@ class VioletPoolAPI:
                     f"Invalid configuration parameter: {key}"
                 ) from err
 
-        return sanitized_config
+        return sanitized_config
+
+    def _is_base_module_function(self, key: str) -> bool:
+        """Return True if the function depends on the base module."""
+        normalized = (key or "").strip().upper()
+        if not normalized:
+            return False
+
+        if normalized.startswith("DOS_"):
+            return False
+
+        if normalized.startswith(("EXT", "DMX_SCENE", "DIRULE_", "OMNI_DC")):
+            return True
+
+        return normalized in {
+            "PUMP",
+            "SOLAR",
+            "HEATER",
+            "LIGHT",
+            "ECO",
+            "BACKWASH",
+            "BACKWASHRINSE",
+            "REFILL",
+            "PVSURPLUS",
+        }
 
     # ---------------------------------------------------------------------
     # Public API surface
@@ -640,8 +673,9 @@ class VioletPoolAPI:
                         "Skipping malformed calibration history line: %s", line
                     )
             except (IndexError, AttributeError) as err:
+                err_msg = str(err) or type(err).__name__
                 _LOGGER.warning(
-                    "Error parsing calibration history line '%s': %s", line, err
+                    "Error parsing calibration history line '%s': %s", line, err_msg
                 )
         return entries
 
@@ -701,10 +735,10 @@ class VioletPoolAPI:
         )
         return self._command_result(body)
 
-    async def set_switch_state(
-        self,
-        key: str,
-        action: str,
+    async def set_switch_state(
+        self,
+        key: str,
+        action: str,
         *,
         duration: int | float | None = None,
         last_value: int | float | None = None,
@@ -717,12 +751,18 @@ class VioletPoolAPI:
             duration: An optional duration for the action.
             last_value: An optional last value (e.g., speed).
 
-        Returns:
-            A dictionary with the command result.
-        """
-        payload = self._build_manual_command(
-            key,
-            action,
+        Returns:
+            A dictionary with the command result.
+        """
+        if self._dosing_standalone and self._is_base_module_function(key):
+            raise VioletPoolAPIError(
+                f"Function '{key}' requires the Violet base module and is not "
+                "available in dosing-standalone mode"
+            )
+
+        payload = self._build_manual_command(
+            key,
+            action,
             duration=duration,
             last_value=last_value,
         )
@@ -803,7 +843,7 @@ class VioletPoolAPI:
         results: list[dict[str, Any]] = []
         for res in raw_results:
             if isinstance(res, Exception):
-                results.append({"success": False, "response": str(res)})
+                results.append({"success": False, "response": f"{type(res).__name__}: {str(res)}"})
             elif isinstance(res, dict):
                 results.append(res)
 

{violet_poolcontroller_api-0.0.5 → violet_poolcontroller_api-0.0.6}/violet_poolcontroller_api/circuit_breaker.py

@@ -22,12 +22,13 @@ import asyncio
 import logging
 import time
 from collections.abc import Callable
+from enum import StrEnum
 from typing import Any
 
 _LOGGER = logging.getLogger(__name__)
 
 
-class CircuitBreakerState:
+class CircuitBreakerState(StrEnum):
     """Circuit breaker states."""
 
     CLOSED = "CLOSED"  # Normal operation

{violet_poolcontroller_api-0.0.5 → violet_poolcontroller_api-0.0.6}/violet_poolcontroller_api/const_devices.py

@@ -30,7 +30,7 @@ from typing import Any, cast
 # DEVICE PARAMETERS - Extended Configuration
 # =============================================================================
 
-DEVICE_PARAMETERS = {
+DEVICE_PARAMETERS: dict[str, dict[str, Any]] = {
     "PUMP": {
         "supports_speed": True,
         "api_template": "PUMP,{action},{duration},{speed}",