violet-poolController-api 0.0.20__tar.gz → 0.0.24__tar.gz

{violet_poolcontroller_api-0.0.20/violet_poolController_api.egg-info → violet_poolcontroller_api-0.0.24}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: violet-poolController-api
-Version: 0.0.20
+Version: 0.0.24
 Summary: Asynchronous Python client for the Violet Pool Controller.
 Home-page: https://github.com/Xerolux/violet-poolController-api
 Author: Basti (Xerolux)

{violet_poolcontroller_api-0.0.20 → violet_poolcontroller_api-0.0.24}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "violet-poolController-api"
-version = "0.0.20"
+version = "0.0.24"
 authors = [
   { name="Basti (Xerolux)", email="git@xerolux.de" },
 ]
@@ -45,13 +45,13 @@ asyncio_mode = "auto"
 
 [tool.ruff]
 line-length = 100
-target-version = "0.0.20"
+target-version = "0.0.24"
 
 [tool.ruff.lint]
 select = ["E", "F", "W", "I", "UP"]
 ignore = ["E501"]
 
 [tool.mypy]
-python_version = "0.0.20"
+python_version = "0.0.24"
 warn_return_any = true
 warn_unused_configs = true

{violet_poolcontroller_api-0.0.20 → violet_poolcontroller_api-0.0.24}/setup.py

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

{violet_poolcontroller_api-0.0.20 → violet_poolcontroller_api-0.0.24}/tests/test_api.py

@@ -694,10 +694,9 @@ async def test_set_all_dmx_scenes_alloff(
     mock_aioresponse: aioresponses,
     api_client: VioletPoolAPI,
 ) -> None:
-    """Test set_all_dmx_scenes sends ALLOFF to all 12 DMX scenes."""
-    for i in range(1, 13):
-        url = f"http://192.168.1.100/setFunctionManually?DMX_SCENE{i},ALLOFF,0,0"
-        mock_aioresponse.get(url, body="OK", status=200)
+    """Test set_all_dmx_scenes sends a single ALLOFF request to DMX_SCENE1."""
+    url = "http://192.168.1.100/setFunctionManually?DMX_SCENE1,ALLOFF,0,0"
+    mock_aioresponse.get(url, body="OK", status=200)
 
     result = await api_client.set_all_dmx_scenes("ALLOFF")
 
@@ -777,22 +776,36 @@ async def test_set_device_temperature(
     api_client: VioletPoolAPI,
 ) -> None:
     """Test set_device_temperature sends correct target temperature."""
-    url = "http://192.168.1.100/setTargetValues?target=HEATER_TARGET_TEMP&value=28.0"
-    mock_aioresponse.get(url, body="OK", status=200)
+    url = "http://192.168.1.100/setConfig"
+    mock_aioresponse.post(url, body="OK", status=200)
 
     result = await api_client.set_device_temperature("HEATER", 28.0)
 
     assert result["success"] is True
 
 
+@pytest.mark.asyncio
+async def test_set_device_temperature_solar(
+    mock_aioresponse: aioresponses,
+    api_client: VioletPoolAPI,
+) -> None:
+    """Test set_device_temperature uses SOLAR_maxtemp for SOLAR key."""
+    url = "http://192.168.1.100/setConfig"
+    mock_aioresponse.post(url, body="OK", status=200)
+
+    result = await api_client.set_device_temperature("SOLAR", 30.0)
+
+    assert result["success"] is True
+
+
 @pytest.mark.asyncio
 async def test_set_ph_target(
     mock_aioresponse: aioresponses,
     api_client: VioletPoolAPI,
 ) -> None:
     """Test set_ph_target sends correct pH target value."""
-    url = "http://192.168.1.100/setTargetValues?target=pH&value=7.2"
-    mock_aioresponse.get(url, body="OK", status=200)
+    url = "http://192.168.1.100/setConfig"
+    mock_aioresponse.post(url, body="OK", status=200)
 
     result = await api_client.set_ph_target(7.2)
 
@@ -805,8 +818,8 @@ async def test_set_orp_target(
     api_client: VioletPoolAPI,
 ) -> None:
     """Test set_orp_target sends correct ORP target value."""
-    url = "http://192.168.1.100/setTargetValues?target=ORP&value=750"
-    mock_aioresponse.get(url, body="OK", status=200)
+    url = "http://192.168.1.100/setConfig"
+    mock_aioresponse.post(url, body="OK", status=200)
 
     result = await api_client.set_orp_target(750)
 
@@ -819,8 +832,8 @@ async def test_set_min_chlorine_level(
     api_client: VioletPoolAPI,
 ) -> None:
     """Test set_min_chlorine_level sends correct chlorine target value."""
-    url = "http://192.168.1.100/setTargetValues?target=MinChlorine&value=0.5"
-    mock_aioresponse.get(url, body="OK", status=200)
+    url = "http://192.168.1.100/setConfig"
+    mock_aioresponse.post(url, body="OK", status=200)
 
     result = await api_client.set_min_chlorine_level(0.5)
 
@@ -833,8 +846,8 @@ async def test_set_target_value(
     api_client: VioletPoolAPI,
 ) -> None:
     """Test set_target_value sends generic target value update."""
-    url = "http://192.168.1.100/setTargetValues?target=CUSTOM&value=42.0"
-    mock_aioresponse.get(url, body="OK", status=200)
+    url = "http://192.168.1.100/setConfig"
+    mock_aioresponse.post(url, body="OK", status=200)
 
     result = await api_client.set_target_value("CUSTOM", 42.0)
 
@@ -846,8 +859,8 @@ async def test_set_dosing_parameters(
     mock_aioresponse: aioresponses,
     api_client: VioletPoolAPI,
 ) -> None:
-    """Test set_dosing_parameters sends POST with dosing configuration."""
-    url = "http://192.168.1.100/setDosingParameters"
+    """Test set_dosing_parameters sends POST via /setConfig."""
+    url = "http://192.168.1.100/setConfig"
     mock_aioresponse.post(url, body="OK", status=200)
 
     result = await api_client.set_dosing_parameters({"DOS_1_CL_DOSING_TIME": 30})

{violet_poolcontroller_api-0.0.20 → violet_poolcontroller_api-0.0.24/violet_poolController_api.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: violet-poolController-api
-Version: 0.0.20
+Version: 0.0.24
 Summary: Asynchronous Python client for the Violet Pool Controller.
 Home-page: https://github.com/Xerolux/violet-poolController-api
 Author: Basti (Xerolux)

{violet_poolcontroller_api-0.0.20 → violet_poolcontroller_api-0.0.24}/violet_poolcontroller_api/api.py

@@ -42,6 +42,8 @@ from .const_api import (
     API_GET_CALIB_RAW_VALUES,
     API_GET_CONFIG,
     API_GET_HISTORY,
+    API_GET_LOG,
+    API_GET_NOTIFICATIONS,
     API_GET_OUTPUT_STATES,
     API_GET_OVERALL_DOSING,
     API_GET_WEATHER_DATA,
@@ -50,11 +52,10 @@ from .const_api import (
     API_READINGS,
     API_RESTORE_CALIBRATION,
     API_SET_CONFIG,
-    API_SET_DOSING_PARAMETERS,
     API_SET_FUNCTION_MANUALLY,
     API_SET_OUTPUT_TESTMODE,
-    API_SET_TARGET_VALUES,
     API_TRIGGER_MANUAL_DOSING,
+    DOSING_CONFIG_PREFIX,
     DOSING_FUNCTIONS,
     DOSING_OUTPUT_INDEX,
     ERROR_CODES,
@@ -1040,13 +1041,16 @@ class VioletPoolAPI:
         )
 
     async def set_all_dmx_scenes(self, action: str) -> dict[str, Any]:
-        """Send the same command to all DMX scenes.
+        """Send a global DMX command that affects all scenes and the LIGHT output.
+
+        The controller treats ALLON/ALLOFF/ALLAUTO as global actions: a single
+        request to any DMX_SCENE key switches all 12 scenes and LIGHT at once.
 
         Args:
             action: The action to perform (ALLON, ALLOFF, ALLAUTO).
 
         Returns:
-            A dictionary with the combined command results.
+            A dictionary with the command result.
 
         Raises:
             VioletPoolAPIError: If the action is unsupported.
@@ -1056,28 +1060,7 @@ class VioletPoolAPI:
             msg = f"Unsupported DMX action: {action}"
             raise VioletPoolAPIError(msg)
 
-        tasks = []
-        for scene in range(1, 13):
-            key = f"DMX_SCENE{scene}"
-            tasks.append(self.set_switch_state(key, action))
-
-        # Run requests concurrently
-        raw_results = await asyncio.gather(*tasks, return_exceptions=True)
-
-        results: list[dict[str, Any]] = []
-        for res in raw_results:
-            if isinstance(res, Exception):
-                results.append(
-                    {"success": False, "response": f"{type(res).__name__}: {res!s}"},
-                )
-            elif isinstance(res, dict):
-                results.append(res)
-
-        success = all(result.get("success") is True for result in results)
-        response = ", ".join(
-            str(result.get("response", "")) for result in results if result.get("response")
-        )
-        return {"success": success, "response": response}
+        return await self.set_switch_state("DMX_SCENE1", action)
 
     async def set_light_color_pulse(self) -> dict[str, Any]:
         """Trigger the color pulse animation for the pool light.
@@ -1136,8 +1119,8 @@ class VioletPoolAPI:
             A dictionary with the command result.
 
         """
-        target_key = f"{climate_key}_TARGET_TEMP"
-        return await self.set_target_value(target_key, float(temperature))
+        config_key = "SOLAR_maxtemp" if climate_key.upper() == "SOLAR" else f"{climate_key}_set_temp"
+        return await self.set_target_value(config_key, float(temperature))
 
     async def set_ph_target(self, value: float) -> dict[str, Any]:
         """Update the pH setpoint.
@@ -1186,18 +1169,17 @@ class VioletPoolAPI:
             A dictionary with the command result.
 
         """
-        params = {"target": key, "value": value}
-        body = await self._request(
-            API_SET_TARGET_VALUES,
-            params=params,
-        )
-        return self._command_result(body)
+        return await self.set_config({key: value})
 
     async def set_dosing_parameters(
         self,
         parameters: Mapping[str, Any],
     ) -> dict[str, Any]:
-        """Update dosing parameters via the dedicated endpoint.
+        """Update dosing parameters via /setConfig.
+
+        The /setDosingParameters endpoint does not exist on the controller
+        (firmware 1.1.9). All dosing parameters are written through
+        POST /setConfig, just like other configuration values.
 
         Args:
             parameters: A mapping of dosing parameters.
@@ -1206,12 +1188,64 @@ class VioletPoolAPI:
             A dictionary with the command result.
 
         """
-        body = await self._request(
-            API_SET_DOSING_PARAMETERS,
-            method="POST",
-            data=dict(parameters),
+        return await self.set_config(dict(parameters))
+
+    async def set_dosage_enabled(
+        self,
+        dosing_type: str,
+        enabled: bool,
+    ) -> dict[str, Any]:
+        """Enable or disable a dosing function.
+
+        Args:
+            dosing_type: One of ``"pH-"``, ``"pH+"``, ``"Chlor"``,
+                ``"Elektrolyse"``, ``"Flockmittel"``, ``"H2O2"``.
+            enabled: True to enable, False to disable.
+
+        Returns:
+            A dictionary with the command result.
+
+        Raises:
+            VioletPoolAPIError: If the dosing type is unknown.
+
+        """
+        prefix = DOSING_CONFIG_PREFIX.get(dosing_type)
+        if prefix is None:
+            msg = (
+                f"Unknown dosing type '{dosing_type}'. "
+                f"Valid: {list(DOSING_CONFIG_PREFIX)}"
+            )
+            raise VioletPoolAPIError(msg)
+
+        return await self.set_config({f"{prefix}_use": 1 if enabled else 0})
+
+    async def is_dosage_enabled(self, dosing_type: str) -> bool:
+        """Check whether a dosing function is enabled.
+
+        Args:
+            dosing_type: One of ``"pH-"``, ``"pH+"``, ``"Chlor"``,
+                ``"Elektrolyse"``, ``"Flockmittel"``, ``"H2O2"``.
+
+        Returns:
+            True if the dosing function is enabled.
+
+        Raises:
+            VioletPoolAPIError: If the dosing type is unknown.
+
+        """
+        prefix = DOSING_CONFIG_PREFIX.get(dosing_type)
+        if prefix is None:
+            msg = (
+                f"Unknown dosing type '{dosing_type}'. "
+                f"Valid: {list(DOSING_CONFIG_PREFIX)}"
+            )
+            raise VioletPoolAPIError(msg)
+
+        result = await self._request_json_dict(
+            API_GET_CONFIG,
+            query=f"{prefix}_use",
         )
-        return self._command_result(body)
+        return bool(int(result.get(f"{prefix}_use", 0)))
 
     async def set_pump_speed(
         self,
@@ -1331,3 +1365,57 @@ class VioletPoolAPI:
                 )
 
         return results
+
+    async def get_log(
+        self,
+        log_type: str,
+        page: int = 0,
+    ) -> dict[str, Any]:
+        """Fetch log entries from the controller.
+
+        Args:
+            log_type: One of ``LOG_TYPE_ACTIONS``, ``LOG_TYPE_SWITCHING``,
+                ``LOG_TYPE_ONEWIRE`` (``"actions"``, ``"switching"``,
+                ``"onewire"``).
+            page: Page number (0-based). Use -1 to download the full
+                actions log instead of paginated text.
+
+        Returns:
+            A dict with keys:
+            - ``lines``: list of pipe-delimited log line strings
+            - ``has_more``: True when ``LOAD_MORE`` sentinel was present
+            - ``raw``: the raw text response
+
+        """
+        if page < 0 and log_type == "actions":
+            url = f"{API_GET_LOG}?downloadActionsLog"
+        else:
+            url = f"{API_GET_LOG}?{log_type}&{page}"
+
+        resp = await self._api_request(
+            "GET",
+            url,
+            priority=API_PRIORITY_NORMAL,
+        )
+        text = resp.strip() if resp else ""
+        lines = text.split("\n") if text else []
+        has_more = lines and lines[-1].strip() == "LOAD_MORE"
+        if has_more:
+            lines = lines[:-1]
+        lines = [ln for ln in lines if ln.strip()]
+        return {"lines": lines, "has_more": has_more, "raw": text}
+
+    async def get_notifications(self) -> dict[str, Any]:
+        """Fetch all notification history from the controller.
+
+        Returns:
+            The JSON response dict where each key is a numeric ID and each
+            value is a notification record with fields like DATE, TIME,
+            SENSOR_ID, TYPE, TEXT, MAIL_STATE, etc.
+
+        """
+        return await self._api_request(
+            "GET",
+            f"{API_GET_NOTIFICATIONS}?ALL",
+            priority=API_PRIORITY_NORMAL,
+        )

{violet_poolcontroller_api-0.0.20 → violet_poolcontroller_api-0.0.24}/violet_poolcontroller_api/const_api.py

@@ -31,8 +31,6 @@ from __future__ import annotations
 
 API_READINGS = "/getReadings"
 API_SET_FUNCTION_MANUALLY = "/setFunctionManually"
-API_SET_DOSING_PARAMETERS = "/setDosingParameters"
-API_SET_TARGET_VALUES = "/setTargetValues"
 API_GET_CONFIG = "/getConfig"
 API_SET_CONFIG = "/setConfig"
 API_GET_CALIB_RAW_VALUES = "/getCalibRawValues"
@@ -44,6 +42,12 @@ API_GET_HISTORY = "/getHistory"
 API_GET_WEATHER_DATA = "/getWeatherdata"
 API_GET_OVERALL_DOSING = "/getOverallDosing"
 API_GET_OUTPUT_STATES = "/getOutputstates"
+API_GET_LOG = "/getLog"
+API_GET_NOTIFICATIONS = "/getNotifications"
+
+LOG_TYPE_ACTIONS = "actions"
+LOG_TYPE_SWITCHING = "switching"
+LOG_TYPE_ONEWIRE = "onewire"
 
 # Settings for optimizing data refreshes by fetching specific groups.
 SPECIFIC_READING_GROUPS = (
@@ -80,9 +84,9 @@ ACTION_UNLOCK = "UNLOCK"
 
 # Common Query and Target Parameters
 QUERY_ALL = "ALL"
-TARGET_PH = "pH"
-TARGET_ORP = "ORP"
-TARGET_MIN_CHLORINE = "MinChlorine"
+TARGET_PH = "DOSAGE_phminus_setpoint"
+TARGET_ORP = "DOSAGE_chlorine_setpoint_orp"
+TARGET_MIN_CHLORINE = "DOSAGE_chlorine_lowerval_cl"
 KEY_MAINTENANCE = "MAINTENANCE"
 KEY_PVSURPLUS = "PVSURPLUS"
 
@@ -161,6 +165,15 @@ DOSING_OUTPUT_INDEX = {
     "DOS_6_FLOC": 5,
 }
 
+DOSING_CONFIG_PREFIX = {
+    "pH-": "DOSAGE_phminus",
+    "pH+": "DOSAGE_phplus",
+    "Chlor": "DOSAGE_chlorine",
+    "Elektrolyse": "DOSAGE_electrolysis",
+    "Flockmittel": "DOSAGE_floc",
+    "H2O2": "DOSAGE_h2o2",
+}
+
 # =============================================================================
 # CONTROLLER ERROR CODES (Manual Section 27.2 - Software 1.1.9)
 # =============================================================================