pysaltsentry 0.1.0__tar.gz

pysaltsentry-0.1.0/PKG-INFO

@@ -0,0 +1,36 @@
+Metadata-Version: 2.4
+Name: pysaltsentry
+Version: 0.1.0
+Summary: Async Python client for the Salt Sentry water softener sensor
+Project-URL: Homepage, https://github.com/Lemcke-solutions/Salt-sentry-ha-integration
+License: MIT
+Requires-Python: >=3.11
+Requires-Dist: aiohttp>=3.9.0
+Description-Content-Type: text/markdown
+
+# pysaltsentry
+
+Async Python client for the [Salt Sentry](https://github.com/Lemcke-solutions/Salt-sentry-ha-integration) water softener sensor.
+
+## Installation
+
+```bash
+pip install pysaltsentry
+```
+
+## Usage
+
+```python
+import aiohttp
+from pysaltsentry import SaltSentryDevice
+
+async with aiohttp.ClientSession() as session:
+    device = SaltSentryDevice("192.168.1.100", session)
+    status = await device.get_status()
+    print(status.measurement_cm)
+    print(status.firmware_version)
+```
+
+## License
+
+MIT

pysaltsentry-0.1.0/README.md

@@ -0,0 +1,26 @@
+# pysaltsentry
+
+Async Python client for the [Salt Sentry](https://github.com/Lemcke-solutions/Salt-sentry-ha-integration) water softener sensor.
+
+## Installation
+
+```bash
+pip install pysaltsentry
+```
+
+## Usage
+
+```python
+import aiohttp
+from pysaltsentry import SaltSentryDevice
+
+async with aiohttp.ClientSession() as session:
+    device = SaltSentryDevice("192.168.1.100", session)
+    status = await device.get_status()
+    print(status.measurement_cm)
+    print(status.firmware_version)
+```
+
+## License
+
+MIT

pysaltsentry-0.1.0/pyproject.toml

@@ -0,0 +1,15 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "pysaltsentry"
+version = "0.1.0"
+description = "Async Python client for the Salt Sentry water softener sensor"
+readme = "README.md"
+license = {text = "MIT"}
+requires-python = ">=3.11"
+dependencies = ["aiohttp>=3.9.0"]
+
+[project.urls]
+Homepage = "https://github.com/Lemcke-solutions/Salt-sentry-ha-integration"

pysaltsentry-0.1.0/pysaltsentry/__init__.py

@@ -0,0 +1,10 @@
+from .device import SaltSentryDevice, SaltSentryStatus
+from .exceptions import SaltSentryConnectionError, SaltSentryError, SaltSentryInvalidDataError
+
+__all__ = [
+    "SaltSentryDevice",
+    "SaltSentryStatus",
+    "SaltSentryError",
+    "SaltSentryConnectionError",
+    "SaltSentryInvalidDataError",
+]

pysaltsentry-0.1.0/pysaltsentry/device.py

@@ -0,0 +1,66 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+import aiohttp
+
+from .exceptions import SaltSentryConnectionError, SaltSentryInvalidDataError
+
+_TIMEOUT = aiohttp.ClientTimeout(total=10)
+
+
+@dataclass
+class SaltSentryStatus:
+    unique_id: str
+    measurement_cm: float
+    firmware_version: str
+    hardware_revision: str
+
+
+class SaltSentryDevice:
+    def __init__(self, host: str, session: aiohttp.ClientSession) -> None:
+        self._host = host
+        self._session = session
+
+    async def get_status(self) -> SaltSentryStatus:
+        url = f"http://{self._host}/status"
+        try:
+            async with self._session.get(url, timeout=_TIMEOUT) as resp:
+                resp.raise_for_status()
+                data = await resp.json()
+        except aiohttp.ClientError as err:
+            raise SaltSentryConnectionError(f"Cannot connect to device at {self._host}") from err
+
+        if not data.get("valid", False):
+            raise SaltSentryInvalidDataError("Device returned an invalid measurement")
+
+        unique_id = data.get("unique_id")
+        if not unique_id:
+            raise SaltSentryInvalidDataError("Device did not return a unique_id")
+
+        distance_mm = data.get("distance_mm")
+        if distance_mm is None:
+            raise SaltSentryInvalidDataError("Device did not return a distance measurement")
+
+        return SaltSentryStatus(
+            unique_id=unique_id,
+            measurement_cm=distance_mm / 10,
+            firmware_version=data.get("firmware_version", "unknown"),
+            hardware_revision=data.get("hardware_revision", "A"),
+        )
+
+    async def install_firmware(self, firmware_data: bytes) -> None:
+        url = f"http://{self._host}/update"
+        form = aiohttp.FormData()
+        form.add_field(
+            "firmware",
+            firmware_data,
+            filename="firmware.bin",
+            content_type="application/octet-stream",
+        )
+        try:
+            async with self._session.post(url, data=form, timeout=_TIMEOUT) as resp:
+                if resp.status != 200:
+                    raise SaltSentryConnectionError(f"OTA update failed with status {resp.status}")
+        except aiohttp.ClientError as err:
+            raise SaltSentryConnectionError(f"Cannot connect to device at {self._host}") from err

pysaltsentry-0.1.0/pysaltsentry/exceptions.py

@@ -0,0 +1,10 @@
+class SaltSentryError(Exception):
+    """Base exception for Salt Sentry errors."""
+
+
+class SaltSentryConnectionError(SaltSentryError):
+    """Raised when the device cannot be reached."""
+
+
+class SaltSentryInvalidDataError(SaltSentryError):
+    """Raised when the device returns unexpected or invalid data."""