violet-poolController-api 0.0.26__tar.gz → 0.0.29__tar.gz

{violet_poolcontroller_api-0.0.26/violet_poolController_api.egg-info → violet_poolcontroller_api-0.0.29}/PKG-INFO

@@ -1,15 +1,13 @@
 Metadata-Version: 2.4
 Name: violet-poolController-api
-Version: 0.0.26
+Version: 0.0.29
 Summary: Asynchronous Python client for the Violet Pool Controller.
-Home-page: https://github.com/Xerolux/violet-poolController-api
-Author: Basti (Xerolux)
 Author-email: "Basti (Xerolux)" <git@xerolux.de>
 License: AGPL-3.0-or-later
-Project-URL: Homepage, https://github.com/Xerolux/violet-poolController-api
-Project-URL: Bug Tracker, https://github.com/Xerolux/violet-poolController-api/issues
+Project-URL: Homepage, https://github.com/Xerolux/violet-hass
+Project-URL: Bug Tracker, https://github.com/Xerolux/violet-hass/issues
 Project-URL: License, https://www.gnu.org/licenses/agpl-3.0.html
-Project-URL: Changelog, https://github.com/Xerolux/violet-poolController-api/blob/main/CHANGELOG.md
+Project-URL: Changelog, https://github.com/Xerolux/violet-hass/blob/main/violet_poolcontroller_api/CHANGELOG.md
 Keywords: pool,violet,controller,home-assistant,async
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.12
@@ -27,10 +25,7 @@ Provides-Extra: test
 Requires-Dist: aioresponses>=0.7.8; extra == "test"
 Requires-Dist: pytest>=8.3; extra == "test"
 Requires-Dist: pytest-asyncio>=0.24; extra == "test"
-Dynamic: author
-Dynamic: home-page
 Dynamic: license-file
-Dynamic: requires-python
 
 # Violet Pool Controller API
 

{violet_poolcontroller_api-0.0.26 → violet_poolcontroller_api-0.0.29}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "violet-poolController-api"
-version = "0.0.26"
+version = "0.0.29"
 authors = [
   { name="Basti (Xerolux)", email="git@xerolux.de" },
 ]
@@ -35,23 +35,23 @@ test = [
 ]
 
 [project.urls]
-"Homepage" = "https://github.com/Xerolux/violet-poolController-api"
-"Bug Tracker" = "https://github.com/Xerolux/violet-poolController-api/issues"
+"Homepage" = "https://github.com/Xerolux/violet-hass"
+"Bug Tracker" = "https://github.com/Xerolux/violet-hass/issues"
 "License" = "https://www.gnu.org/licenses/agpl-3.0.html"
-"Changelog" = "https://github.com/Xerolux/violet-poolController-api/blob/main/CHANGELOG.md"
+"Changelog" = "https://github.com/Xerolux/violet-hass/blob/main/violet_poolcontroller_api/CHANGELOG.md"
 
 [tool.pytest.ini_options]
 asyncio_mode = "auto"
 
 [tool.ruff]
 line-length = 100
-target-version = "0.0.26"
+target-version = "py312"
 
 [tool.ruff.lint]
 select = ["E", "F", "W", "I", "UP"]
 ignore = ["E501"]
 
 [tool.mypy]
-python_version = "0.0.26"
+python_version = "3.12"
 warn_return_any = true
 warn_unused_configs = true

{violet_poolcontroller_api-0.0.26 → violet_poolcontroller_api-0.0.29}/tests/test_api.py

@@ -1,4 +1,4 @@
-# violet-poolController-api - API für Violet Pool Controller
+# violet-poolController-api - API f├╝r Violet Pool Controller
 # Copyright (C) 2024-2026  Xerolux
 #
 # This program is free software: you can redistribute it and/or modify
@@ -26,6 +26,7 @@ import aiohttp
 import pytest
 import pytest_asyncio
 from aioresponses import aioresponses
+from yarl import URL
 
 from violet_poolcontroller_api.api import VioletPoolAPI, VioletPoolAPIError
 from violet_poolcontroller_api.circuit_breaker import CircuitBreakerOpenError
@@ -483,7 +484,7 @@ async def test_ext1_readings_filtered_when_not_detected(mock_aioresponse, api_cl
         payload={
             "getReadings": {
                 "PUMPSTATE": "2",
-                # No SYSTEM_ext1module_alive_count → module not connected
+                # No SYSTEM_ext1module_alive_count  module not connected
                 "EXT1_1": 0,
                 "EXT1_2": 0,
             }
@@ -1179,6 +1180,35 @@ async def test_manual_dosing_stop(
     assert "MANDOS_STOPPED" in result["response"]
 
 
+@pytest.mark.asyncio
+async def test_dosing_auto_action_sends_dosstop(
+    mock_aioresponse: aioresponses,
+    api_client: VioletPoolAPI,
+) -> None:
+    """AUTO on a dosing output must stop the run, never start one.
+
+    setFunctionManually does not work for DOS_* outputs (PoolDigital forum),
+    so AUTO maps to DOSSTOP via /triggerManualDosing - stopping the manual
+    run returns the channel to automatic mode.
+    """
+    url = "http://192.168.1.100/triggerManualDosing"
+    mock_aioresponse.post(url, body="MANDOS_STOPPED\nOK", status=200)
+
+    result = await api_client.set_switch_state("DOS_6_FLOC", "AUTO")
+
+    assert result["success"] is True
+    request_key = ("POST", URL(url))
+    sent = mock_aioresponse.requests[request_key][0].kwargs["data"]
+    assert sent["action"] == "DOSSTOP"
+
+
+@pytest.mark.asyncio
+async def test_dosing_unknown_action_rejected(api_client: VioletPoolAPI) -> None:
+    """Unknown dosing actions raise instead of defaulting to DOSSTART."""
+    with pytest.raises(VioletPoolAPIError, match="Unsupported dosing action"):
+        await api_client.set_switch_state("DOS_1_CL", "PUSH")
+
+
 @pytest.mark.asyncio
 async def test_pv_surplus_with_speed(
     mock_aioresponse: aioresponses,
@@ -1235,3 +1265,124 @@ async def test_pump_off_with_duration(
 
     assert result["success"] is True
     assert result["message"] == "MANUELL AUS\n600 Sekunden"
+
+
+@pytest.mark.asyncio
+async def test_pv_surplus_auto_is_mapped_to_off(
+    mock_aioresponse: aioresponses,
+    api_client: VioletPoolAPI,
+) -> None:
+    """PVSURPLUS supports only ON/OFF (manual 26.3); AUTO is sent as OFF."""
+    url = "http://192.168.1.100/setFunctionManually?PVSURPLUS,OFF,0,0"
+    mock_aioresponse.get(url, body="OK\nPVSURPLUS\nOFF", status=200)
+
+    result = await api_client.set_switch_state("PVSURPLUS", "AUTO")
+
+    assert result["success"] is True
+    assert result["output"] == "PVSURPLUS"
+
+
+@pytest.mark.asyncio
+async def test_pv_surplus_rejects_unknown_action(
+    api_client: VioletPoolAPI,
+) -> None:
+    """PVSURPLUS rejects actions that cannot be mapped to ON/OFF."""
+    with pytest.raises(VioletPoolAPIError, match="manual section 26.3"):
+        await api_client.set_switch_state("PVSURPLUS", "PUSH")
+
+
+@pytest.mark.asyncio
+async def test_pv_surplus_speed_is_clamped(
+    mock_aioresponse: aioresponses,
+    api_client: VioletPoolAPI,
+) -> None:
+    """Pump speed for PVSURPLUS is clamped to the documented 1-3 range."""
+    url = "http://192.168.1.100/setFunctionManually?PVSURPLUS,ON,3,0"
+    mock_aioresponse.get(url, body="OK\nPVSURPLUS\nON", status=200)
+
+    result = await api_client.set_pv_surplus(active=True, pump_speed=5)
+
+    assert result["success"] is True
+
+
+@pytest.mark.asyncio
+async def test_client_error_fails_fast_without_retry(
+    mock_aioresponse: aioresponses,
+    api_client: VioletPoolAPI,
+) -> None:
+    """A 4xx response raises immediately instead of being retried."""
+    url = "http://192.168.1.100/getReadings?ALL"
+    mock_aioresponse.get(url, status=401, body="Unauthorized")
+
+    with pytest.raises(VioletPoolAPIError, match="HTTP 401"):
+        await api_client.get_readings()
+
+
+@pytest.mark.asyncio
+async def test_client_error_does_not_trip_circuit_breaker(
+    mock_aioresponse: aioresponses,
+    api_client: VioletPoolAPI,
+) -> None:
+    """Deterministic 4xx errors must not count as circuit breaker failures."""
+    url = "http://192.168.1.100/getReadings?ALL"
+    threshold = api_client._circuit_breaker.failure_threshold
+
+    for _ in range(threshold + 1):
+        mock_aioresponse.get(url, status=401, body="Unauthorized")
+        with pytest.raises(VioletPoolAPIError, match="HTTP 401"):
+            await api_client.get_readings()
+
+    stats = api_client._circuit_breaker.get_stats()
+    assert stats["failure_count"] == 0
+    assert stats["state"] == "CLOSED"
+
+
+@pytest.mark.asyncio
+async def test_server_error_still_counts_for_circuit_breaker(
+    mock_aioresponse: aioresponses,
+    api_client: VioletPoolAPI,
+) -> None:
+    """5xx errors keep counting as circuit breaker failures."""
+    url = "http://192.168.1.100/getReadings?ALL"
+    mock_aioresponse.get(url, status=500, body="boom")
+
+    with pytest.raises(VioletPoolAPIError):
+        await api_client.get_readings()
+
+    stats = api_client._circuit_breaker.get_stats()
+    assert stats["failure_count"] == 1
+
+
+def test_command_result_error_first_line() -> None:
+    """Line 1 of the response decides success per manual section 26.2."""
+    result = VioletPoolAPI._command_result("ERROR\nPUMP\nUNKNOWN OUTPUT")
+    assert result["success"] is False
+
+    result = VioletPoolAPI._command_result("OK\nPUMP\nInfo about error handling")
+    assert result["success"] is True
+
+
+def test_state_translation_language_switch() -> None:
+    """Display texts are language-configurable instead of hardwired German."""
+    from violet_poolcontroller_api.const_devices import (
+        VioletState,
+        get_state_translation_language,
+        set_state_translation_language,
+    )
+
+    assert get_state_translation_language() == "de"
+    state = VioletState("0")
+    assert state.display_mode == "Automatik (Bereit)"
+    assert state.display_mode_for("en") == "Auto (Ready)"
+
+    english_state = VioletState("0", language="en")
+    assert english_state.display_mode == "Auto (Ready)"
+
+    set_state_translation_language("en")
+    try:
+        assert VioletState("4").display_mode == "Manual On"
+    finally:
+        set_state_translation_language("de")
+
+    with pytest.raises(ValueError, match="Unsupported language"):
+        set_state_translation_language("fr")

{violet_poolcontroller_api-0.0.26 → violet_poolcontroller_api-0.0.29}/tests/test_mock_server.py

@@ -7,11 +7,15 @@ credentials, and verifies that authentication is enforced properly.
 from __future__ import annotations
 
 import asyncio
+import socket
 import subprocess
 import sys
 import time
+from collections.abc import Iterator
+from pathlib import Path
 
 import aiohttp
+import pytest
 
 from violet_poolcontroller_api.api import VioletPoolAPI, VioletPoolAPIError
 
@@ -20,6 +24,50 @@ PORT = 8499
 USER = "admin"
 PASS = "secret"
 
+_MOCK_SERVER_PATH = Path(__file__).parent / "mock_server.py"
+
+
+def _start_mock_server() -> subprocess.Popen[bytes]:
+    """Start the mock server subprocess and wait until it accepts connections."""
+    proc = subprocess.Popen(
+        [
+            sys.executable,
+            str(_MOCK_SERVER_PATH),
+            "--port",
+            str(PORT),
+            "--user",
+            USER,
+            "--password",
+            PASS,
+        ],
+        stdout=subprocess.DEVNULL,
+        stderr=subprocess.DEVNULL,
+    )
+    deadline = time.monotonic() + 10
+    while time.monotonic() < deadline:
+        if proc.poll() is not None:
+            msg = f"Mock server exited early with code {proc.returncode}"
+            raise RuntimeError(msg)
+        try:
+            with socket.create_connection((HOST, PORT), timeout=0.5):
+                return proc
+        except OSError:
+            time.sleep(0.1)
+    proc.terminate()
+    msg = f"Mock server did not start listening on port {PORT} within 10s"
+    raise RuntimeError(msg)
+
+
+@pytest.fixture(scope="module", autouse=True)
+def mock_server() -> Iterator[subprocess.Popen[bytes]]:
+    """Run the mock server for all tests in this module."""
+    proc = _start_mock_server()
+    try:
+        yield proc
+    finally:
+        proc.terminate()
+        proc.wait(timeout=5)
+
 
 async def _request(url: str, auth: aiohttp.BasicAuth | None = None) -> tuple[int, str]:
     async with aiohttp.ClientSession() as session:
@@ -211,12 +259,7 @@ async def test_api_client() -> None:
 
 def main() -> None:
     print(f"Starting mock server on port {PORT} with auth ({USER}:{PASS})...")
-    proc = subprocess.Popen(
-        [sys.executable, "tests/mock_server.py", "--port", str(PORT), "--user", USER, "--password", PASS],
-        stdout=subprocess.DEVNULL,
-        stderr=subprocess.DEVNULL,
-    )
-    time.sleep(2)
+    proc = _start_mock_server()
 
     try:
         asyncio.run(test_raw_auth())

{violet_poolcontroller_api-0.0.26 → violet_poolcontroller_api-0.0.29/violet_poolController_api.egg-info}/PKG-INFO

@@ -1,15 +1,13 @@
 Metadata-Version: 2.4
 Name: violet-poolController-api
-Version: 0.0.26
+Version: 0.0.29
 Summary: Asynchronous Python client for the Violet Pool Controller.
-Home-page: https://github.com/Xerolux/violet-poolController-api
-Author: Basti (Xerolux)
 Author-email: "Basti (Xerolux)" <git@xerolux.de>
 License: AGPL-3.0-or-later
-Project-URL: Homepage, https://github.com/Xerolux/violet-poolController-api
-Project-URL: Bug Tracker, https://github.com/Xerolux/violet-poolController-api/issues
+Project-URL: Homepage, https://github.com/Xerolux/violet-hass
+Project-URL: Bug Tracker, https://github.com/Xerolux/violet-hass/issues
 Project-URL: License, https://www.gnu.org/licenses/agpl-3.0.html
-Project-URL: Changelog, https://github.com/Xerolux/violet-poolController-api/blob/main/CHANGELOG.md
+Project-URL: Changelog, https://github.com/Xerolux/violet-hass/blob/main/violet_poolcontroller_api/CHANGELOG.md
 Keywords: pool,violet,controller,home-assistant,async
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.12
@@ -27,10 +25,7 @@ Provides-Extra: test
 Requires-Dist: aioresponses>=0.7.8; extra == "test"
 Requires-Dist: pytest>=8.3; extra == "test"
 Requires-Dist: pytest-asyncio>=0.24; extra == "test"
-Dynamic: author
-Dynamic: home-page
 Dynamic: license-file
-Dynamic: requires-python
 
 # Violet Pool Controller API
 

{violet_poolcontroller_api-0.0.26 → violet_poolcontroller_api-0.0.29}/violet_poolController_api.egg-info/SOURCES.txt

@@ -1,10 +1,6 @@
 LICENSE
 README.md
 pyproject.toml
-setup.py
-tests/__init__.py
-tests/conftest.py
-tests/mock_server.py
 tests/test_api.py
 tests/test_api_smoke.py
 tests/test_mock_server.py
@@ -18,5 +14,7 @@ violet_poolcontroller_api/api.py
 violet_poolcontroller_api/circuit_breaker.py
 violet_poolcontroller_api/const_api.py
 violet_poolcontroller_api/const_devices.py
+violet_poolcontroller_api/parsers.py
+violet_poolcontroller_api/readings.py
 violet_poolcontroller_api/utils_rate_limiter.py
 violet_poolcontroller_api/utils_sanitizer.py

{violet_poolcontroller_api-0.0.26 → violet_poolcontroller_api-0.0.29}/violet_poolController_api.egg-info/top_level.txt

@@ -1,2 +1 @@
-tests
 violet_poolcontroller_api

{violet_poolcontroller_api-0.0.26 → violet_poolcontroller_api-0.0.29}/violet_poolcontroller_api/__init__.py

@@ -1,72 +1,135 @@
-# violet-poolController-api - API für Violet Pool Controller
-# Copyright (C) 2024-2026  Xerolux
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Affero General Public License as published
-# by the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Affero General Public License for more details.
-#
-# 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/>.
-
-"""Violet Pool Controller API client library."""
-
-from .api import VioletPoolAPI, VioletPoolAPIError
-from .circuit_breaker import CircuitBreaker, CircuitBreakerOpenError
-from .const_api import (  # noqa: F401
-    ACTION_ALLAUTO,
-    ACTION_ALLOFF,
-    ACTION_ALLON,
-    ACTION_AUTO,
-    ACTION_COLOR,
-    ACTION_LOCK,
-    ACTION_OFF,
-    ACTION_ON,
-    ACTION_PUSH,
-    ACTION_UNLOCK,
-    ERROR_CODES,
-    ERROR_SEVERITY_ALARM,
-    ERROR_SEVERITY_INFO,
-    ERROR_SEVERITY_WARNING,
-)
-from .const_devices import (  # noqa: F401
-    COVER_FUNCTIONS,
-    COVER_STATE_MAP,
-    DEVICE_PARAMETERS,
-    VioletState,
-)
-from .utils_rate_limiter import RateLimiter, get_global_rate_limiter
-from .utils_sanitizer import InputSanitizer
-
-__all__ = [
-    "VioletPoolAPI",
-    "VioletPoolAPIError",
-    "CircuitBreaker",
-    "CircuitBreakerOpenError",
-    "VioletState",
-    "InputSanitizer",
-    "RateLimiter",
-    "get_global_rate_limiter",
-    "ACTION_ALLAUTO",
-    "ACTION_ALLOFF",
-    "ACTION_ALLON",
-    "ACTION_AUTO",
-    "ACTION_COLOR",
-    "ACTION_LOCK",
-    "ACTION_OFF",
-    "ACTION_ON",
-    "ACTION_PUSH",
-    "ACTION_UNLOCK",
-    "COVER_FUNCTIONS",
-    "COVER_STATE_MAP",
-    "DEVICE_PARAMETERS",
-    "ERROR_CODES",
-    "ERROR_SEVERITY_ALARM",
-    "ERROR_SEVERITY_INFO",
-    "ERROR_SEVERITY_WARNING",
-]
+# violet-poolController-api - API f├╝r Violet Pool Controller
+# Copyright (C) 2024-2026  Xerolux
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# 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/>.
+
+"""Violet Pool Controller API client library."""
+
+from .api import (
+    SETPOINT_RANGES,
+    VioletAuthError,
+    VioletPayloadError,
+    VioletPoolAPI,
+    VioletPoolAPIError,
+    VioletSetpointError,
+    VioletTimeoutError,
+    VioletUnsafeOperationError,
+    validate_setpoint,
+)
+from .circuit_breaker import CircuitBreaker, CircuitBreakerOpenError
+from .const_api import (  # noqa: F401
+    ACTION_ALLAUTO,
+    ACTION_ALLOFF,
+    ACTION_ALLON,
+    ACTION_AUTO,
+    ACTION_COLOR,
+    ACTION_LOCK,
+    ACTION_OFF,
+    ACTION_ON,
+    ACTION_PUSH,
+    ACTION_UNLOCK,
+    ERROR_CODES,
+    ERROR_SEVERITY_ALARM,
+    ERROR_SEVERITY_INFO,
+    ERROR_SEVERITY_WARNING,
+)
+from .const_devices import (  # noqa: F401
+    COVER_FUNCTIONS,
+    COVER_STATE_MAP,
+    DEVICE_PARAMETERS,
+    STATE_TRANSLATIONS,
+    CoverState,
+    DmxSceneState,
+    OnewireState,
+    OutputState,
+    PvSurplusState,
+    RuleState,
+    VioletState,
+    get_state_translation_language,
+    set_state_translation_language,
+)
+from .parsers import (  # noqa: F401
+    parse_epoch_milliseconds,
+    parse_epoch_seconds,
+    parse_hms_string,
+    parse_optional_seconds,
+    parse_runtime_string,
+    parse_uptime_string,
+)
+from .readings import VioletReadings
+from .utils_rate_limiter import RateLimiter, get_global_rate_limiter
+from .utils_sanitizer import InputSanitizer
+
+__all__ = [
+    # Core client
+    "VioletPoolAPI",
+    # Exception hierarchy
+    "VioletPoolAPIError",
+    "VioletAuthError",
+    "VioletTimeoutError",
+    "VioletPayloadError",
+    "VioletSetpointError",
+    "VioletUnsafeOperationError",
+    # Setpoint validation
+    "SETPOINT_RANGES",
+    "validate_setpoint",
+    # Circuit breaker
+    "CircuitBreaker",
+    "CircuitBreakerOpenError",
+    # Enums
+    "OutputState",
+    "DmxSceneState",
+    "RuleState",
+    "CoverState",
+    "OnewireState",
+    "PvSurplusState",
+    # State helpers
+    "VioletState",
+    "STATE_TRANSLATIONS",
+    "get_state_translation_language",
+    "set_state_translation_language",
+    # Typed readings snapshot
+    "VioletReadings",
+    # Parsers
+    "parse_runtime_string",
+    "parse_hms_string",
+    "parse_uptime_string",
+    "parse_epoch_seconds",
+    "parse_epoch_milliseconds",
+    "parse_optional_seconds",
+    # Utilities
+    "InputSanitizer",
+    "RateLimiter",
+    "get_global_rate_limiter",
+    # Action constants
+    "ACTION_ALLAUTO",
+    "ACTION_ALLOFF",
+    "ACTION_ALLON",
+    "ACTION_AUTO",
+    "ACTION_COLOR",
+    "ACTION_LOCK",
+    "ACTION_OFF",
+    "ACTION_ON",
+    "ACTION_PUSH",
+    "ACTION_UNLOCK",
+    # Device constants
+    "COVER_FUNCTIONS",
+    "COVER_STATE_MAP",
+    "DEVICE_PARAMETERS",
+    # Error codes
+    "ERROR_CODES",
+    "ERROR_SEVERITY_ALARM",
+    "ERROR_SEVERITY_INFO",
+    "ERROR_SEVERITY_WARNING",
+]