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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: violet-poolController-api
-Version: 0.0.24
+Version: 0.0.26
 Summary: Asynchronous Python client for the Violet Pool Controller.
 Home-page: https://github.com/Xerolux/violet-poolController-api
 Author: Basti (Xerolux)
@@ -22,9 +22,9 @@ Classifier: Topic :: Home Automation
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: aiohttp>=3.11.0
+Requires-Dist: aiohttp<3.14,>=3.11.0
 Provides-Extra: test
-Requires-Dist: aioresponses>=0.7.7; 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
@@ -158,6 +158,72 @@ print(profile)
 ```
 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.
 
+## Mock Server (Testing Without Hardware)
+
+The project includes a full mock server that simulates the Violet Pool Controller. This allows you to develop and test without needing the physical controller.
+
+### Start the Mock Server
+
+```bash
+# Without authentication (default port 8480)
+python tests/mock_server.py
+
+# With Basic Auth (like the real controller)
+python tests/mock_server.py --user admin --password secret
+
+# With simulated network latency (300ms)
+python tests/mock_server.py --user admin --password secret --delay 0.3
+
+# Dosing-standalone mode (list format responses)
+python tests/mock_server.py --standalone
+```
+
+### Connect Your Code
+
+```python
+import asyncio, aiohttp
+from violet_poolcontroller_api import VioletPoolAPI
+
+async def main():
+    async with aiohttp.ClientSession() as session:
+        api = VioletPoolAPI(
+            host="localhost:8480",
+            session=session,
+            username="admin",
+            password="secret",
+        )
+        readings = await api.get_readings()
+        print(f"pH={readings['pH_value']}, PUMP={readings['PUMP']}")
+
+asyncio.run(main())
+```
+
+### Run the Smoke Test
+
+The smoke test automatically starts the mock server, tests every public API method, and prints a detailed report:
+
+```bash
+python tests/test_api_smoke.py --user admin --password secret
+```
+
+### Mock Server Control Endpoints
+
+These endpoints exist only on the mock server (not the real controller):
+
+| Endpoint | Description |
+|---|---|
+| `GET /mock/state` | View internal state (outputs, sensors, config) as JSON |
+| `GET /mock/error?code=500&count=3` | Force next 3 requests to return HTTP 500 |
+| `GET /mock/reset` | Reset all state to defaults |
+
+### Mock Server Features
+
+- **Stateful:** Switch/dosing changes are reflected in `getReadings` (e.g. PUMP ON -> PUMP=4)
+- **Sensor drift:** pH, ORP, chlorine, and CPU temperature change slowly over time
+- **Config persistence:** Values set via `setConfig` are returned by `getConfig`
+- **Log history:** Actions are logged and returned by `getLog`
+- **Error simulation:** Test your error handling with forced HTTP errors
+
 ## License
 GNU Affero General Public License v3.0 or later (AGPLv3+)
 

{violet_poolcontroller_api-0.0.24 → violet_poolcontroller_api-0.0.26}/README.md

@@ -124,6 +124,72 @@ print(profile)
 ```
 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.
 
+## Mock Server (Testing Without Hardware)
+
+The project includes a full mock server that simulates the Violet Pool Controller. This allows you to develop and test without needing the physical controller.
+
+### Start the Mock Server
+
+```bash
+# Without authentication (default port 8480)
+python tests/mock_server.py
+
+# With Basic Auth (like the real controller)
+python tests/mock_server.py --user admin --password secret
+
+# With simulated network latency (300ms)
+python tests/mock_server.py --user admin --password secret --delay 0.3
+
+# Dosing-standalone mode (list format responses)
+python tests/mock_server.py --standalone
+```
+
+### Connect Your Code
+
+```python
+import asyncio, aiohttp
+from violet_poolcontroller_api import VioletPoolAPI
+
+async def main():
+    async with aiohttp.ClientSession() as session:
+        api = VioletPoolAPI(
+            host="localhost:8480",
+            session=session,
+            username="admin",
+            password="secret",
+        )
+        readings = await api.get_readings()
+        print(f"pH={readings['pH_value']}, PUMP={readings['PUMP']}")
+
+asyncio.run(main())
+```
+
+### Run the Smoke Test
+
+The smoke test automatically starts the mock server, tests every public API method, and prints a detailed report:
+
+```bash
+python tests/test_api_smoke.py --user admin --password secret
+```
+
+### Mock Server Control Endpoints
+
+These endpoints exist only on the mock server (not the real controller):
+
+| Endpoint | Description |
+|---|---|
+| `GET /mock/state` | View internal state (outputs, sensors, config) as JSON |
+| `GET /mock/error?code=500&count=3` | Force next 3 requests to return HTTP 500 |
+| `GET /mock/reset` | Reset all state to defaults |
+
+### Mock Server Features
+
+- **Stateful:** Switch/dosing changes are reflected in `getReadings` (e.g. PUMP ON -> PUMP=4)
+- **Sensor drift:** pH, ORP, chlorine, and CPU temperature change slowly over time
+- **Config persistence:** Values set via `setConfig` are returned by `getConfig`
+- **Log history:** Actions are logged and returned by `getLog`
+- **Error simulation:** Test your error handling with forced HTTP errors
+
 ## License
 GNU Affero General Public License v3.0 or later (AGPLv3+)
 

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

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "violet-poolController-api"
-version = "0.0.24"
+version = "0.0.26"
 authors = [
   { name="Basti (Xerolux)", email="git@xerolux.de" },
 ]
@@ -24,12 +24,12 @@ classifiers = [
     "Topic :: Home Automation",
 ]
 dependencies = [
-    "aiohttp>=3.11.0",
+    "aiohttp>=3.11.0,<3.14",
 ]
 
 [project.optional-dependencies]
 test = [
-    "aioresponses>=0.7.7",
+    "aioresponses>=0.7.8",
     "pytest>=8.3",
     "pytest-asyncio>=0.24",
 ]
@@ -45,13 +45,13 @@ asyncio_mode = "auto"
 
 [tool.ruff]
 line-length = 100
-target-version = "0.0.24"
+target-version = "0.0.26"
 
 [tool.ruff.lint]
 select = ["E", "F", "W", "I", "UP"]
 ignore = ["E501"]
 
 [tool.mypy]
-python_version = "0.0.24"
+python_version = "0.0.26"
 warn_return_any = true
 warn_unused_configs = true

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

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

violet_poolcontroller_api-0.0.26/tests/conftest.py

@@ -0,0 +1,40 @@
+# 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/>.
+
+"""Pytest configuration and fixtures."""
+
+from __future__ import annotations
+
+from inspect import signature
+
+import aiohttp.client_reqrep
+
+_original_client_response_init = aiohttp.client_reqrep.ClientResponse.__init__
+
+
+def _patched_client_response_init(
+    self: aiohttp.client_reqrep.ClientResponse,
+    *args: object,
+    **kwargs: object,
+) -> None:
+    """Patched ClientResponse.__init__ that adds stream_writer if missing."""
+    sig = signature(_original_client_response_init)
+    if "stream_writer" in sig.parameters and "stream_writer" not in kwargs:
+        kwargs["stream_writer"] = None
+    _original_client_response_init(self, *args, **kwargs)
+
+
+aiohttp.client_reqrep.ClientResponse.__init__ = _patched_client_response_init