ips-api-client 0.1.1__tar.gz → 0.2.0__tar.gz

{ips_api_client-0.1.1 → ips_api_client-0.2.0}/CHANGELOG.md

@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.2.0] - 2026-07-11
+
+### Added
+- Parse the ORP live state string (`lblorpState`) into `PoolReading.orp_state`.
+- Detect the live overfeed lockout condition per channel via
+  `PoolReading.ph_overfeed` / `orp_overfeed` (tri-state: True/False/None) and the
+  `state_is_overfeed()` helper.
+
 ## [0.1.0] - 2025-10-21
 
 ### Added

{ips_api_client-0.1.1/ips_api_client.egg-info → ips_api_client-0.2.0}/PKG-INFO

@@ -1,10 +1,16 @@
 Metadata-Version: 2.4
 Name: ips-api-client
-Version: 0.1.1
-Summary: API client for IPS Controllers pool monitoring system
+Version: 0.2.0
+Summary: Async Python client for IPS Controllers pool monitoring system
 Home-page: https://github.com/stgarrity/ips-api-client
 Author: Steve Garrity
-Author-email: sgarrity@gmail.com
+Author-email: Steve Garrity <sgarrity@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/stgarrity/ips-api-client
+Project-URL: Documentation, https://github.com/stgarrity/ips-api-client#readme
+Project-URL: Repository, https://github.com/stgarrity/ips-api-client
+Project-URL: Issues, https://github.com/stgarrity/ips-api-client/issues
+Keywords: ips,pool,chemistry,monitoring,home-assistant
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
@@ -13,21 +19,18 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Home Automation
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: aiohttp>=3.8.0
 Requires-Dist: beautifulsoup4>=4.11.0
 Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
 Dynamic: home-page
 Dynamic: license-file
-Dynamic: requires-dist
 Dynamic: requires-python
-Dynamic: summary
 
 # IPS Controllers API Client
 

{ips_api_client-0.1.1 → ips_api_client-0.2.0}/ips_api/models.py

@@ -17,9 +17,15 @@ class PoolReading:
 
     # Additional details (from detail page)
     ph_state: Optional[str] = None
+    orp_state: Optional[str] = None
     ph_setpoint: Optional[float] = None
     orp_setpoint: Optional[int] = None
 
+    # Live overfeed lockout condition per channel.
+    # True = in overfeed, False = known not in overfeed, None = state unknown.
+    ph_overfeed: Optional[bool] = None
+    orp_overfeed: Optional[bool] = None
+
 
 @dataclass
 class PoolController:

{ips_api_client-0.1.1 → ips_api_client-0.2.0}/ips_api/parser.py

@@ -124,6 +124,27 @@ def extract_first_number(value: str) -> Optional[str]:
     return match.group(1)
 
 
+def state_is_overfeed(state: Optional[str]) -> Optional[bool]:
+    """Determine if a live pH/ORP state string reports an overfeed lockout.
+
+    The controller state is a compound, dash/comma separated string (e.g.
+    "Normal - No Flow" or "Overfeed - No Flow"). When the unit exceeds its feed
+    limit it locks out dosing and adds an "Overfeed" token to this string.
+
+    Args:
+        state: Live state string from the detail page, or None.
+
+    Returns:
+        True if the state reports overfeed, False if the state is known and does
+        not report overfeed, or None if the state is missing/unknown.
+    """
+    if state is None or not state.strip():
+        return None
+
+    normalized = re.sub(r'\s+', '', state).lower()
+    return 'overfeed' in normalized
+
+
 def extract_status_from_icon(img_src: str) -> str:
     """Extract status from icon filename.
 
@@ -256,6 +277,7 @@ def parse_device_detail(html: str) -> PoolReading:
     orp_elem = soup.find('span', id='lblOrpNum')
     temp_elem = soup.find('span', id='lblTempValue')
     ph_state_elem = soup.find('span', id='lblpHState')
+    orp_state_elem = soup.find('span', id='lblorpState')
     ph_setpoint_elem = soup.find('span', id='lblphSetpoint')
     orp_setpoint_elem = soup.find('span', id='lblorpSetpoint')
     timestamp_elem = soup.find('span', id='lblLastReading')
@@ -269,13 +291,19 @@ def parse_device_detail(html: str) -> PoolReading:
         or ''
     )
 
+    ph_state = ph_state_elem.get_text(strip=True) if ph_state_elem else None
+    orp_state = orp_state_elem.get_text(strip=True) if orp_state_elem else None
+
     reading = PoolReading(
         ph=parse_float(ph_elem.get_text() if ph_elem else ''),
         orp=parse_int(orp_elem.get_text() if orp_elem else ''),
         temperature=parse_float(temp_elem.get_text() if temp_elem else ''),
-        ph_state=ph_state_elem.get_text(strip=True) if ph_state_elem else None,
+        ph_state=ph_state,
+        orp_state=orp_state,
         ph_setpoint=ph_setpoint,
         orp_setpoint=orp_setpoint,
+        ph_overfeed=state_is_overfeed(ph_state),
+        orp_overfeed=state_is_overfeed(orp_state),
         timestamp=parse_datetime(timestamp_elem.get_text() if timestamp_elem else ''),
     )
 

{ips_api_client-0.1.1 → ips_api_client-0.2.0/ips_api_client.egg-info}/PKG-INFO

@@ -1,10 +1,16 @@
 Metadata-Version: 2.4
 Name: ips-api-client
-Version: 0.1.1
-Summary: API client for IPS Controllers pool monitoring system
+Version: 0.2.0
+Summary: Async Python client for IPS Controllers pool monitoring system
 Home-page: https://github.com/stgarrity/ips-api-client
 Author: Steve Garrity
-Author-email: sgarrity@gmail.com
+Author-email: Steve Garrity <sgarrity@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/stgarrity/ips-api-client
+Project-URL: Documentation, https://github.com/stgarrity/ips-api-client#readme
+Project-URL: Repository, https://github.com/stgarrity/ips-api-client
+Project-URL: Issues, https://github.com/stgarrity/ips-api-client/issues
+Keywords: ips,pool,chemistry,monitoring,home-assistant
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
@@ -13,21 +19,18 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Home Automation
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: aiohttp>=3.8.0
 Requires-Dist: beautifulsoup4>=4.11.0
 Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
 Dynamic: home-page
 Dynamic: license-file
-Dynamic: requires-dist
 Dynamic: requires-python
-Dynamic: summary
 
 # IPS Controllers API Client
 

{ips_api_client-0.1.1 → ips_api_client-0.2.0}/ips_api_client.egg-info/SOURCES.txt

@@ -2,6 +2,7 @@ CHANGELOG.md
 LICENSE
 MANIFEST.in
 README.md
+pyproject.toml
 requirements.txt
 setup.py
 ips_api/__init__.py
@@ -15,4 +16,5 @@ ips_api_client.egg-info/SOURCES.txt
 ips_api_client.egg-info/dependency_links.txt
 ips_api_client.egg-info/requires.txt
 ips_api_client.egg-info/top_level.txt
-tests/test_client.py
+tests/test_client.py
+tests/test_parser.py

ips_api_client-0.2.0/pyproject.toml

@@ -0,0 +1,41 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ips-api-client"
+version = "0.2.0"
+authors = [
+    {name = "Steve Garrity", email = "sgarrity@gmail.com"}
+]
+description = "Async Python client for IPS Controllers pool monitoring system"
+readme = "README.md"
+license = {text = "MIT"}
+requires-python = ">=3.9"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Home Automation",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+keywords = ["ips", "pool", "chemistry", "monitoring", "home-assistant"]
+dependencies = [
+    "aiohttp>=3.8.0",
+    "beautifulsoup4>=4.11.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/stgarrity/ips-api-client"
+Documentation = "https://github.com/stgarrity/ips-api-client#readme"
+Repository = "https://github.com/stgarrity/ips-api-client"
+Issues = "https://github.com/stgarrity/ips-api-client/issues"
+
+[tool.setuptools.packages.find]
+include = ["ips_api*"]

{ips_api_client-0.1.1 → ips_api_client-0.2.0}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r", encoding="utf-8") as fh:
 
 setup(
     name="ips-api-client",
-    version="0.1.1",
+    version="0.2.0",
     author="Steve Garrity",
     author_email="sgarrity@gmail.com",
     description="API client for IPS Controllers pool monitoring system",

ips_api_client-0.2.0/tests/test_parser.py

@@ -0,0 +1,70 @@
+"""Unit tests for DeviceDetail parsing and overfeed detection."""
+
+import os
+import sys
+
+import pytest
+
+sys.path.insert(0, os.path.join(os.path.dirname(__file__), '..'))
+
+from ips_api.parser import parse_device_detail, state_is_overfeed
+
+FIXTURES = os.path.join(os.path.dirname(__file__), 'fixtures')
+
+
+def _load(name: str) -> str:
+    with open(os.path.join(FIXTURES, name)) as f:
+        return f.read()
+
+
+@pytest.mark.parametrize(
+    "state, expected",
+    [
+        ("Overfeed - No Flow", True),
+        ("Demand, Overfeed - No Flow", True),
+        ("over feed", True),  # spacing/case insensitive
+        ("OVERFEED", True),
+        ("Normal - No Flow", False),
+        ("Low Alert - No Demand - No Flow", False),
+        ("", None),
+        ("   ", None),
+        (None, None),
+    ],
+)
+def test_state_is_overfeed(state, expected):
+    assert state_is_overfeed(state) is expected
+
+
+def test_parse_device_detail_normal():
+    reading = parse_device_detail(_load('device_detail_normal.html'))
+
+    assert reading.ph == 7.20
+    assert reading.orp == 725
+    assert reading.temperature == 82
+    assert reading.ph_setpoint == 7.3
+    assert reading.orp_setpoint == 740
+    assert reading.ph_state == "Normal - No Flow"
+    assert reading.orp_state == "Demand, In Delay - No Flow"
+    # No overfeed, but state is known -> False (not None)
+    assert reading.ph_overfeed is False
+    assert reading.orp_overfeed is False
+
+
+def test_parse_device_detail_overfeed():
+    reading = parse_device_detail(_load('device_detail_overfeed.html'))
+
+    assert reading.ph_state == "Overfeed - No Flow"
+    assert reading.orp_state == "Demand, Overfeed - No Flow"
+    assert reading.ph_overfeed is True
+    assert reading.orp_overfeed is True
+
+
+def test_parse_device_detail_missing_state():
+    # No state spans at all -> overfeed flags are None (unknown), not False
+    html = '<html><body><span id="lblphNum">7.2</span></body></html>'
+    reading = parse_device_detail(html)
+
+    assert reading.ph_state is None
+    assert reading.orp_state is None
+    assert reading.ph_overfeed is None
+    assert reading.orp_overfeed is None