violet-poolController-api 0.0.36__tar.gz → 0.0.37__tar.gz

{violet_poolcontroller_api-0.0.36/violet_poolController_api.egg-info → violet_poolcontroller_api-0.0.37}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: violet-poolController-api
-Version: 0.0.36
+Version: 0.0.37
 Summary: Asynchronous Python client for the Violet Pool Controller.
 Author-email: "Basti (Xerolux)" <git@xerolux.de>
 License-Expression: AGPL-3.0-or-later

{violet_poolcontroller_api-0.0.36 → violet_poolcontroller_api-0.0.37}/pyproject.toml

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

{violet_poolcontroller_api-0.0.36 → violet_poolcontroller_api-0.0.37}/tests/test_api.py

@@ -22,6 +22,7 @@ from __future__ import annotations
 
 from collections.abc import Mapping
 from typing import TYPE_CHECKING, Any, Never
+from unittest.mock import AsyncMock
 
 import aiohttp
 import pytest
@@ -29,7 +30,11 @@ import pytest_asyncio
 from aioresponses import aioresponses
 from yarl import URL
 
-from violet_poolcontroller_api.api import VioletPoolAPI, VioletPoolAPIError
+from violet_poolcontroller_api.api import (
+    VioletPoolAPI,
+    VioletPoolAPIError,
+    VioletSetpointError,
+)
 from violet_poolcontroller_api.circuit_breaker import CircuitBreakerOpenError
 from violet_poolcontroller_api.const_api import (
     ERROR_CODES,
@@ -37,6 +42,7 @@ from violet_poolcontroller_api.const_api import (
     ERROR_SEVERITY_INFO,
     ERROR_SEVERITY_REMINDER,
     ERROR_SEVERITY_WARNING,
+    TARGET_PH,
 )
 
 if TYPE_CHECKING:
@@ -938,6 +944,15 @@ async def test_set_dosing_parameters(
     assert result["success"] is True
 
 
+@pytest.mark.asyncio
+async def test_set_dosing_parameters_enforces_setpoint_range(
+    api_client: VioletPoolAPI,
+) -> None:
+    """set_dosing_parameters must not bypass the pH/ORP/chlorine safety bounds."""
+    with pytest.raises(VioletSetpointError, match="outside the valid range"):
+        await api_client.set_dosing_parameters({TARGET_PH: 20.0})
+
+
 @pytest.mark.asyncio
 @pytest.mark.parametrize(("raw_value", "expected"), [("1", True), ("1.0", True), ("0.0", False)])
 async def test_is_dosage_enabled_accepts_numeric_strings(
@@ -1103,6 +1118,38 @@ async def test_get_system_services(
     }
 
 
+@pytest.mark.asyncio
+async def test_get_system_services_accepts_decimal_state(
+    mock_aioresponse: aioresponses,
+    api_client: VioletPoolAPI,
+) -> None:
+    """The controller may report service state as a decimal string like '1.0'."""
+    url = "http://192.168.1.100/getServiceStates"
+    mock_aioresponse.get(
+        url,
+        payload={"proftpd": "1.0", "shairport": "0.0"},
+        status=200,
+    )
+
+    result = await api_client.get_system_services()
+
+    assert result["ftp"] is True
+    assert result["shairport"] is False
+
+
+@pytest.mark.asyncio
+async def test_get_system_services_rejects_garbage_state(
+    mock_aioresponse: aioresponses,
+    api_client: VioletPoolAPI,
+) -> None:
+    """A non-numeric service state must raise, not crash with a bare ValueError."""
+    url = "http://192.168.1.100/getServiceStates"
+    mock_aioresponse.get(url, payload={"proftpd": "not-a-number"}, status=200)
+
+    with pytest.raises(VioletPoolAPIError, match="Invalid service state"):
+        await api_client.get_system_services()
+
+
 # ---------------------------------------------------------------------------
 # OmniTronic + RS485 + LiveTrace (P12 / P13 / P15)
 # ---------------------------------------------------------------------------
@@ -1867,6 +1914,40 @@ async def test_server_error_still_counts_for_circuit_breaker(
     assert stats["failure_count"] == 1
 
 
+@pytest.mark.asyncio
+async def test_rate_limiter_reacquired_on_every_retry(
+    mock_aioresponse: aioresponses,
+    monkeypatch: pytest.MonkeyPatch,
+) -> None:
+    """Each retry attempt must re-acquire a rate-limit token, not just the first.
+
+    Regression test: wait_if_needed() used to be awaited once before the
+    retry loop, so retries fired real HTTP requests without ever going
+    through the limiter again.
+    """
+    url = "http://192.168.1.100/getReadings?ALL"
+    mock_aioresponse.get(url, status=500, body="boom", repeat=True)
+    # Backoff sleeps aren't what this test verifies; skip them for speed.
+    monkeypatch.setattr("violet_poolcontroller_api.api.asyncio.sleep", AsyncMock())
+
+    async with aiohttp.ClientSession() as session:
+        api = VioletPoolAPI(host="192.168.1.100", session=session, max_retries=3)
+        call_count = 0
+        original_wait = api._rate_limiter.wait_if_needed  # noqa: SLF001
+
+        async def counting_wait(*args: object, **kwargs: object) -> None:
+            nonlocal call_count
+            call_count += 1
+            await original_wait(*args, **kwargs)
+
+        api._rate_limiter.wait_if_needed = counting_wait  # type: ignore[method-assign]  # noqa: SLF001
+
+        with pytest.raises(VioletPoolAPIError):
+            await api.get_readings()
+
+    assert call_count == 3
+
+
 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")

{violet_poolcontroller_api-0.0.36 → violet_poolcontroller_api-0.0.37}/tests/test_readings.py

@@ -86,6 +86,37 @@ class TestVioletReadingsTypeConversions:
         assert null_val is None
 
 
+class TestVioletReadingsDosingAmounts:
+    """Regression tests for dosing_daily_amounts_ml decimal parsing."""
+
+    def test_decimal_amounts_are_not_dropped(self):
+        """Fractional mL amounts (the controller's actual wire format) must parse."""
+        data = {
+            "DOS_1_CL_DAILY_DOSING_AMOUNT_ML": "12.5",
+            "DOS_2_ELO_DAILY_DOSING_AMOUNT_ML": "0.0",
+            "DOS_4_PHM_DAILY_DOSING_AMOUNT_ML": "8.3",
+            "DOS_5_PHP_DAILY_DOSING_AMOUNT_ML": "0.0",
+            "DOS_6_FLOC_DAILY_DOSING_AMOUNT_ML": "3.1",
+        }
+        readings = VioletReadings(data)
+        amounts = readings.dosing_daily_amounts_ml
+        assert amounts["DOS_1_CL"] == 12
+        assert amounts["DOS_4_PHM"] == 8
+        assert amounts["DOS_6_FLOC"] == 3
+
+    def test_missing_amount_is_none(self):
+        """Missing keys stay None rather than raising."""
+        readings = VioletReadings({})
+        amounts = readings.dosing_daily_amounts_ml
+        assert amounts["DOS_1_CL"] is None
+
+    def test_garbage_amount_is_none(self):
+        """Non-numeric values fall back to None instead of raising."""
+        readings = VioletReadings({"DOS_1_CL_DAILY_DOSING_AMOUNT_ML": "not-a-number"})
+        amounts = readings.dosing_daily_amounts_ml
+        assert amounts["DOS_1_CL"] is None
+
+
 class TestVioletReadingsAggregation:
     """Test readings aggregation and derived properties."""
 

{violet_poolcontroller_api-0.0.36 → violet_poolcontroller_api-0.0.37}/tests/test_sanitizer.py

@@ -23,3 +23,21 @@ def test_sanitize_integer_replaces_infinite_values(value: object) -> None:
 def test_numeric_sanitizer_rejects_non_finite_values() -> None:
     assert InputSanitizer.sanitize_numeric(float("nan")) == 0.0
     assert InputSanitizer.sanitize_numeric(float("inf")) == 0.0
+
+
+def test_numeric_sanitizer_parses_scientific_notation() -> None:
+    """'1e10' must parse as 1e10, not as digit-stripped '110'."""
+    assert InputSanitizer.sanitize_numeric("1e10") == 1e10
+    assert InputSanitizer.sanitize_numeric("-2.5e-3") == -2.5e-3
+
+
+def test_numeric_sanitizer_still_extracts_digits_from_messy_strings() -> None:
+    """Non-numeric strings still fall back to best-effort digit extraction."""
+    assert InputSanitizer.sanitize_numeric("12.5 mL") == 12.5
+
+
+def test_validate_ph_value_matches_controller_setpoint_range() -> None:
+    """The sanitizer's pH bounds must agree with SETPOINT_RANGES (6.0-8.0)."""
+    assert InputSanitizer.validate_ph_value(8.5) == 8.0
+    assert InputSanitizer.validate_ph_value(5.0) == 6.0
+    assert InputSanitizer.validate_ph_value(7.2) == 7.2

{violet_poolcontroller_api-0.0.36 → violet_poolcontroller_api-0.0.37/violet_poolController_api.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: violet-poolController-api
-Version: 0.0.36
+Version: 0.0.37
 Summary: Asynchronous Python client for the Violet Pool Controller.
 Author-email: "Basti (Xerolux)" <git@xerolux.de>
 License-Expression: AGPL-3.0-or-later

{violet_poolcontroller_api-0.0.36 → violet_poolcontroller_api-0.0.37}/violet_poolcontroller_api/_api_dosing.py

@@ -7,8 +7,10 @@ from typing import Any
 
 from ._api_mixin import APIClientMixin
 from ._api_model import (
+    SETPOINT_RANGES,
     VioletPayloadError,
     VioletPoolAPIError,
+    VioletSetpointError,
     validate_duration,
     validate_setpoint,
 )
@@ -29,6 +31,20 @@ from .const_api import (
 )
 
 
+def _to_float(field: str, value: Any) -> float:
+    """Convert ``value`` to float, raising the documented exception type.
+
+    ``float()`` alone raises a bare ``ValueError``/``TypeError`` for
+    non-numeric input, which callers relying on the ``VioletSetpointError``
+    contract documented on the setpoint setters would not catch.
+    """
+    try:
+        return float(value)
+    except (TypeError, ValueError) as err:
+        msg = f"Invalid setpoint for '{field}': {value!r} is not a number"
+        raise VioletSetpointError(msg) from err
+
+
 class DosingMixin(APIClientMixin):
     """Chemical dosing and setpoint operations."""
 
@@ -142,8 +158,9 @@ class DosingMixin(APIClientMixin):
                 is not a finite number.
 
         """
-        validate_setpoint(TARGET_PH, float(value))
-        return await self.set_target_value(TARGET_PH, float(value))
+        numeric_value = _to_float(TARGET_PH, value)
+        validate_setpoint(TARGET_PH, numeric_value)
+        return await self.set_target_value(TARGET_PH, numeric_value)
 
     async def set_orp_target(self, value: int) -> dict[str, Any]:
         """Update the ORP setpoint.
@@ -159,8 +176,9 @@ class DosingMixin(APIClientMixin):
                 is not a finite number.
 
         """
-        validate_setpoint(TARGET_ORP, float(value))
-        return await self.set_target_value(TARGET_ORP, int(value))
+        numeric_value = _to_float(TARGET_ORP, value)
+        validate_setpoint(TARGET_ORP, numeric_value)
+        return await self.set_target_value(TARGET_ORP, int(numeric_value))
 
     async def set_min_chlorine_level(self, value: float) -> dict[str, Any]:
         """Update the minimum chlorine level.
@@ -176,8 +194,9 @@ class DosingMixin(APIClientMixin):
                 is not a finite number.
 
         """
-        validate_setpoint(TARGET_MIN_CHLORINE, float(value))
-        return await self.set_target_value(TARGET_MIN_CHLORINE, float(value))
+        numeric_value = _to_float(TARGET_MIN_CHLORINE, value)
+        validate_setpoint(TARGET_MIN_CHLORINE, numeric_value)
+        return await self.set_target_value(TARGET_MIN_CHLORINE, numeric_value)
 
     async def set_target_value(self, key: str, value: float) -> dict[str, Any]:
         """Send a generic target value update to the controller.
@@ -198,7 +217,8 @@ class DosingMixin(APIClientMixin):
                 known valid range for ``key``.
 
         """
-        validate_setpoint(key, float(value))
+        numeric_value = _to_float(key, value)
+        validate_setpoint(key, numeric_value)
         return await self.set_config({key: value})
 
     async def set_dosing_parameters(
@@ -217,7 +237,15 @@ class DosingMixin(APIClientMixin):
         Returns:
             A dictionary with the command result.
 
+        Raises:
+            VioletSetpointError: If a known setpoint key (see
+                ``SETPOINT_RANGES``, e.g. ``TARGET_PH``) is present with a
+                value outside its documented valid range.
+
         """
+        for key, value in parameters.items():
+            if key in SETPOINT_RANGES:
+                validate_setpoint(key, _to_float(key, value))
         return await self.set_config(dict(parameters))
 
     async def set_dosage_enabled(
@@ -316,7 +344,7 @@ class DosingMixin(APIClientMixin):
                 f"Expected one of: {sorted(DOSING_CANISTER_ID)}"
             )
             raise VioletPoolAPIError(msg)
-        if amount_ml <= 0:
+        if int(amount_ml) <= 0:
             raise ValueError(f"amount_ml must be > 0, got {amount_ml}")
 
         action = "RESET" if reset else "ADJUST"

{violet_poolcontroller_api-0.0.36 → violet_poolcontroller_api-0.0.37}/violet_poolcontroller_api/_api_outputs.py

@@ -64,9 +64,10 @@ class OutputsMixin(APIClientMixin):
 
         duration_ms = validate_duration(duration) * 1000
         payload = f"{output},{mode},{duration_ms}"
+        query = quote(payload, safe=",")
         body = await self._request(
             API_SET_OUTPUT_TESTMODE,
-            query=payload,
+            query=query,
         )
         return self._command_result(body)
 
@@ -493,13 +494,22 @@ class OutputsMixin(APIClientMixin):
                 f"Expected one of {RS485_PUMP_MODES}"
             )
             raise VioletPoolAPIError(msg)
-        if slave_id < 1 or slave_id > 247:
+        try:
+            slave_id_int = int(slave_id)
+        except (TypeError, ValueError) as err:
+            raise ValueError(f"slave_id must be an integer, got {slave_id!r}") from err
+        if slave_id_int < 1 or slave_id_int > 247:
             raise ValueError(f"slave_id must be 1-247, got {slave_id}")
-        if not math.isfinite(float(level)):
+
+        try:
+            level_finite = math.isfinite(float(level))
+        except (TypeError, ValueError) as err:
+            raise ValueError(f"level must be a number, got {level!r}") from err
+        if not level_finite:
             raise ValueError(f"level must be finite, got {level}")
 
         url = (
-            f"{API_SET_RS485_LIVE}?{pump_name},{int(slave_id)},"
+            f"{API_SET_RS485_LIVE}?{pump_name},{slave_id_int},"
             f"{mode.lower()},{level}"
         )
         body = await self._request(

{violet_poolcontroller_api-0.0.36 → violet_poolcontroller_api-0.0.37}/violet_poolcontroller_api/_api_system.py

@@ -7,7 +7,7 @@ from collections.abc import Mapping
 from typing import Any
 
 from ._api_mixin import APIClientMixin
-from ._api_model import VioletPoolAPIError
+from ._api_model import VioletPayloadError, VioletPoolAPIError
 from .const_api import (
     API_GET_LIVE_TRACE,
     API_GET_LOG,
@@ -268,7 +268,12 @@ class SystemMixin(APIClientMixin):
             if not state_key:
                 continue
             if state_key in raw:
-                result[service] = bool(int(raw[state_key]))
+                raw_value = raw[state_key]
+                try:
+                    result[service] = bool(int(float(raw_value)))
+                except (TypeError, ValueError, OverflowError) as err:
+                    msg = f"Invalid service state for {service}: {raw_value!r}"
+                    raise VioletPayloadError(msg) from err
         return result
 
     async def get_live_trace(self) -> dict[str, str]:

{violet_poolcontroller_api-0.0.36 → violet_poolcontroller_api-0.0.37}/violet_poolcontroller_api/api.py

@@ -332,17 +332,6 @@ class VioletPoolAPI(ReadingsMixin, DosingMixin, OutputsMixin, SystemMixin):
             raise ValueError(msg)
 
         async def _execute_request() -> Any:  # noqa: ANN401
-            # Wait if the rate limit is reached
-            try:
-                await self._rate_limiter.wait_if_needed(priority=priority, timeout=10.0)
-            except TimeoutError:
-                _LOGGER.warning(
-                    "Rate limiter timeout for %s (priority: %d) - applying fallback delay",
-                    endpoint,
-                    priority,
-                )
-                await asyncio.sleep(1.0)
-
             url = self._build_url(endpoint)
             if query:
                 url = f"{url}?{query}"
@@ -352,6 +341,18 @@ class VioletPoolAPI(ReadingsMixin, DosingMixin, OutputsMixin, SystemMixin):
             attempt_limit = self._max_retries if should_retry else 1
 
             for attempt in range(1, attempt_limit + 1):
+                # Wait if the rate limit is reached; re-acquired on every
+                # attempt so retries cannot bypass the per-request cap.
+                try:
+                    await self._rate_limiter.wait_if_needed(priority=priority, timeout=10.0)
+                except TimeoutError:
+                    _LOGGER.warning(
+                        "Rate limiter timeout for %s (priority: %d) - applying fallback delay",
+                        endpoint,
+                        priority,
+                    )
+                    await asyncio.sleep(1.0)
+
                 try:
                     async with self._session.request(
                         method,
@@ -367,6 +368,9 @@ class VioletPoolAPI(ReadingsMixin, DosingMixin, OutputsMixin, SystemMixin):
                             response.status >= _HTTP_SERVER_ERROR
                             or response.status == _HTTP_TOO_MANY_REQUESTS
                         ):
+                            # Drain the body so aiohttp can return the
+                            # connection to the pool instead of closing it.
+                            await response.read()
                             # Server error or rate limit
                             # -> trigger retry via ClientError
                             response.raise_for_status()

{violet_poolcontroller_api-0.0.36 → violet_poolcontroller_api-0.0.37}/violet_poolcontroller_api/readings.py

@@ -444,7 +444,7 @@ class VioletReadings(Mapping[str, Any]):
                 result[key] = None
             else:
                 try:
-                    result[key] = int(v)
+                    result[key] = int(float(v))
                 except (ValueError, TypeError):
                     result[key] = None
         return result

{violet_poolcontroller_api-0.0.36 → violet_poolcontroller_api-0.0.37}/violet_poolcontroller_api/utils_sanitizer.py

@@ -132,6 +132,16 @@ class InputSanitizer:
                 return float(value)
 
             str_value = str(value).strip()
+            try:
+                parsed = float(str_value)
+            except ValueError:
+                pass
+            else:
+                if not math.isfinite(parsed):
+                    _LOGGER.warning("Unendlicher/NaN-Wert: %s", value)
+                    return 0.0
+                return parsed
+
             has_minus = str_value.startswith("-")
             cleaned = re.sub(r"[^0-9.]", "", str_value)
             if has_minus and cleaned:
@@ -398,13 +408,14 @@ class InputSanitizer:
             ph: pH-Wert
 
         Returns:
-            Validierter pH-Wert (6.0-9.0)
+            Validierter pH-Wert (6.0-8.0), passend zum vom Controller
+            akzeptierten Sollwertbereich (siehe ``SETPOINT_RANGES``).
 
         """
         return InputSanitizer.sanitize_float(
             ph,
             min_value=6.0,
-            max_value=9.0,
+            max_value=8.0,
             precision=1,
             default=7.2,
         )