proconip 2.2.0__tar.gz → 2.3.0__tar.gz

{proconip-2.2.0 → proconip-2.3.0}/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [2.3.0](https://github.com/ylabonte/proconip-pypi/compare/v2.2.1...v2.3.0) (2026-10-12)
+
+
+### Features
+
+* flag the chlorine canister columns as cell data under electrolysis ([#100](https://github.com/ylabonte/proconip-pypi/issues/100)) ([27ca22a](https://github.com/ylabonte/proconip-pypi/commit/27ca22acb2e42e47647318713670ddd9f3938daf))
+
+## [2.2.1](https://github.com/ylabonte/proconip-pypi/compare/v2.2.0...v2.2.1) (2026-10-08)
+
+
+### Bug Fixes
+
+* support aiohttp 3.14 without deprecation warnings; test against it ([#94](https://github.com/ylabonte/proconip-pypi/issues/94), [#97](https://github.com/ylabonte/proconip-pypi/issues/97)) ([#98](https://github.com/ylabonte/proconip-pypi/issues/98)) ([87dcc3d](https://github.com/ylabonte/proconip-pypi/commit/87dcc3d01ab2d5cae7fb826638086665f2076c7c))
+
 ## [2.2.0](https://github.com/ylabonte/proconip-pypi/compare/v2.1.2...v2.2.0) (2026-06-14)
 
 

{proconip-2.2.0 → proconip-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: proconip
-Version: 2.2.0
+Version: 2.3.0
 Summary: Async Python library for interacting with the ProCon.IP pool controller.
 Project-URL: Homepage, https://github.com/ylabonte/proconip-pypi
 Project-URL: Documentation, https://ylabonte.github.io/proconip-pypi/
@@ -176,8 +176,8 @@ async def manual_dosage_example():
     client_session = aiohttp.ClientSession()
     config = ConfigObject("http://192.168.2.3", "admin", "admin")
     dosage_control = DosageControl(client_session, config)
-    await dosage_control.async_chlorine_dosage(3600) # start for 1 hour
-    await dosage_control.async_ph_minus_dosage(60) # start for 1 minute
+    await dosage_control.async_chlorine_dosage(3600)  # start for 1 hour
+    await dosage_control.async_ph_minus_dosage(60)  # start for 1 minute
     await client_session.close()
 
 
@@ -201,13 +201,12 @@ async def dmx_example():
         print(f"{channel.name} before: {channel.value}")
         dmx_data.set(channel.index, (channel.value + 128) % 256)
         print(f"{channel.name} after: {dmx_data.get_value(channel.index)}")
-      
+
     await dmx_control.async_set(dmx_data)
     await client_session.close()
 
 
 asyncio.run(dmx_example())
-
 ```
 
 ## A brief description of the ProCon.IP pool controller

{proconip-2.2.0 → proconip-2.3.0}/README.md

@@ -148,8 +148,8 @@ async def manual_dosage_example():
     client_session = aiohttp.ClientSession()
     config = ConfigObject("http://192.168.2.3", "admin", "admin")
     dosage_control = DosageControl(client_session, config)
-    await dosage_control.async_chlorine_dosage(3600) # start for 1 hour
-    await dosage_control.async_ph_minus_dosage(60) # start for 1 minute
+    await dosage_control.async_chlorine_dosage(3600)  # start for 1 hour
+    await dosage_control.async_ph_minus_dosage(60)  # start for 1 minute
     await client_session.close()
 
 
@@ -173,13 +173,12 @@ async def dmx_example():
         print(f"{channel.name} before: {channel.value}")
         dmx_data.set(channel.index, (channel.value + 128) % 256)
         print(f"{channel.name} after: {dmx_data.get_value(channel.index)}")
-      
+
     await dmx_control.async_set(dmx_data)
     await client_session.close()
 
 
 asyncio.run(dmx_example())
-
 ```
 
 ## A brief description of the ProCon.IP pool controller

{proconip-2.2.0 → proconip-2.3.0}/pyproject.toml

@@ -37,15 +37,11 @@ test = [
     "pytest",
     "pytest-asyncio",
     "pytest-cov",
-    "aioresponses",
-    # aioresponses 0.7.8 can't build mocked responses against aiohttp 3.14+
-    # (ClientResponse gained a required `stream_writer` kwarg), which breaks
-    # the whole test_api suite. Pin tests to the 3.13.x line HA Core ships.
-    # TODO: lift this cap once a compatible aioresponses release lands.
-    "aiohttp<3.14",
 ]
 docs = [
-    "mkdocs",
+    # MkDocs 2.0 drops the plugin system and the theming that Material and
+    # mkdocstrings rely on, with no migration path — stay on 1.x.
+    "mkdocs<2",
     "mkdocs-material",
     "mkdocstrings[python]",
     "mkdocs-include-markdown-plugin",

{proconip-2.2.0 → proconip-2.3.0}/src/proconip/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '2.2.0'
-__version_tuple__ = version_tuple = (2, 2, 0)
+__version__ = version = '2.3.0'
+__version_tuple__ = version_tuple = (2, 3, 0)
 
 __commit_id__ = commit_id = None

{proconip-2.2.0 → proconip-2.3.0}/src/proconip/api.py

@@ -26,11 +26,11 @@ subclasses so callers can handle them uniformly.
 """
 
 import asyncio
+import base64
 import contextlib
 import socket
 
 from aiohttp import (
-    BasicAuth,
     ClientError,
     ClientResponse,
     ClientSession,
@@ -84,6 +84,18 @@ class TimeoutException(ProconipApiException):
     """
 
 
+def _auth_headers(config: ConfigObject) -> dict[str, str]:
+    """Build the HTTP Basic ``Authorization`` header for the controller credentials.
+
+    Built by hand rather than via ``aiohttp.BasicAuth`` / ``auth=``, which
+    aiohttp 3.14 deprecates (removal in 4.0), while its replacement
+    ``aiohttp.encode_basic_auth`` doesn't exist on older supported versions.
+    Credentials are latin-1 encoded, matching ``BasicAuth``'s default.
+    """
+    credentials = f"{config.username}:{config.password}".encode("latin1")
+    return {"Authorization": "Basic " + base64.b64encode(credentials).decode("ascii")}
+
+
 async def _handle_response(response: ClientResponse) -> str:
     """Validate the response and return its body, mapping HTTP errors to typed exceptions."""
     if response.status in (401, 403):
@@ -130,10 +142,9 @@ async def async_get_raw_data(
         ProconipApiException: For DNS failures, connection resets, and other
             network-level errors.
     """
-    auth = BasicAuth(config.username, config.password)
     try:
         async with asyncio.timeout(timeout):
-            async with client_session.get(url, auth=auth) as response:
+            async with client_session.get(url, headers=_auth_headers(config)) as response:
                 return await _handle_response(response)
     except TimeoutError as exc:
         raise TimeoutException("API request timed out") from exc
@@ -300,15 +311,16 @@ async def async_post_usrcfg_cgi(
         ProconipApiException: For network-level errors.
     """
     url = URL(config.base_url).with_path(API_PATH_USRCFG)
-    auth = BasicAuth(config.username, config.password)
-    headers = {"Content-Type": "application/x-www-form-urlencoded; charset=UTF-8"}
+    headers = {
+        "Content-Type": "application/x-www-form-urlencoded; charset=UTF-8",
+        **_auth_headers(config),
+    }
     try:
         async with asyncio.timeout(timeout):
             async with client_session.post(
                 url=url,
                 headers=headers,
                 data=payload,
-                auth=auth,
             ) as response:
                 return await _handle_response(response)
     except TimeoutError as exc:

{proconip-2.2.0 → proconip-2.3.0}/src/proconip/definitions.py

@@ -187,7 +187,10 @@ class DataObject:
                 temperature, ``16–23`` → relay, ``24–27`` → digital input,
                 ``28–35`` → external relay, ``36–38`` → canister, ``39–41`` →
                 consumption. Anything outside this range falls into a sentinel
-                "uncategorized" bucket.
+                "uncategorized" bucket. The category is purely positional: with
+                a salt-electrolysis cell, columns 36 and 39 still land in the
+                canister/consumption categories although they describe the
+                cell (see `GetStateData.is_electrolysis_object`).
             name: Sensor name as reported by the controller (e.g. ``"Redox"``).
             unit: Unit string (``"mV"``, ``"°C"``, ``"%"``, ``"--"``, …).
             offset: Calibration offset applied to ``value``.
@@ -585,7 +588,13 @@ class GetStateData:
     @property
     def config_other_enable(self) -> int:
         """Misc configuration flags. Use the `is_*_enabled` methods to query
-        individual bits (TCP/IP boost, SD card, DMX, …)."""
+        individual bits (TCP/IP boost, SD card, DMX, …).
+
+        Not every "Sonstiges" checkbox is mirrored here on current firmware:
+        on 1.7.6, bits 0 (TCP/IP boost), 1 (SD card) and 5 (high bus load)
+        were observed as 0 although those options were enabled, while bit 2
+        (DMX) tracked its checkbox exactly. Bits 3, 4, 6, 7 and 8 are
+        unverified on hardware."""
         return self._config_other_enable
 
     @property
@@ -614,7 +623,24 @@ class GetStateData:
         return self._dosage_control & 1 == 1
 
     def is_electrolysis_enabled(self) -> bool:
-        """True if electrolysis (saltwater) chlorination is enabled (bit 4)."""
+        """True if the chlorine supply is a salt-electrolysis cell (bit 4).
+
+        When set, the chlorine channel is not fed from a canister: the
+        chlorine "canister" reading (column 36) is the cell's remaining
+        lifetime / maintenance interval in percent, and the chlorine
+        "consumption" reading (column 39) is today's *calculated* chlorine
+        production. Use `is_electrolysis_object` to tell those two objects
+        apart from real canister readings.
+
+        Polarity evidence: the TRM labels bit 4 "Cl liquid || Elektrolysis",
+        naming both options without saying which value is which. A live
+        firmware 1.7.6 controller configured for liquid chlorine
+        (``rdxcntrl.ini`` ``DTYPE=0``, chlorine dosing on) reports
+        DOSAGE_CNTRL 257 (bits 0 and 8, bit 4 clear), as does the real capture
+        in the test fixtures. So bit 4 is the chlorine device-type selector,
+        and set = electrolysis is inferred, not observed; a real electrolysis
+        capture is still pending.
+        """
         return self._dosage_control & 16 == 16
 
     def is_ph_minus_dosage_enabled(self) -> bool:
@@ -645,6 +671,33 @@ class GetStateData:
             return self.is_ph_plus_dosage_enabled()
         return False
 
+    def is_electrolysis_object(self, data_entity: DataObject) -> bool:
+        """Does this canister/consumption object describe a salt-electrolysis cell?
+
+        The controller reuses the chlorine canister columns for a salt
+        electrolysis setup instead of adding new ones. With electrolysis
+        enabled (see `is_electrolysis_enabled`):
+
+        - column 36 (`chlorine_canister`) is the cell's **remaining lifetime**
+          (or maintenance interval) in percent — the share of the configured
+          operating hours that is left, not a canister fill level;
+        - column 39 (`chlorine_consumption`) is **today's chlorine production**
+          calculated from the configured production rate, not a liquid
+          volume drawn from a canister.
+
+        Callers should label and present these objects accordingly (e.g. no
+        canister/volume wording). The pH- and pH+ columns are always real
+        canisters.
+
+        Args:
+            data_entity: Any `DataObject` from this state.
+
+        Returns:
+            True only for the chlorine canister (column 36) or chlorine
+            consumption (column 39) object while electrolysis is enabled.
+        """
+        return data_entity.column in (36, 39) and self.is_electrolysis_enabled()
+
     def get_dosage_relay(self, data_entity: DataObject) -> int | None:
         """Aggregated relay ID that handles the dosing for this canister/consumption entity.
 
@@ -749,15 +802,28 @@ class GetStateData:
         return NTP_FAULT_STATE[0]
 
     def is_tcpip_boost_enabled(self) -> bool:
-        """True if TCP/IP boost is enabled in the controller config (bit 0)."""
+        """True if bit 0 (TCP/IP boost) of `config_other_enable` is set.
+
+        Unreliable on current firmware: 1.7.6 was observed reporting this bit
+        as 0 while TCP/IP boost was enabled, so ``False`` doesn't prove the
+        feature is off.
+        """
         return self._config_other_enable & 1 == 1
 
     def is_sd_card_enabled(self) -> bool:
-        """True if SD card logging is enabled in the controller config (bit 1)."""
+        """True if bit 1 (SD card) of `config_other_enable` is set.
+
+        Unreliable on current firmware: 1.7.6 was observed reporting this bit
+        as 0 while the SD card was enabled, so ``False`` doesn't prove the
+        feature is off.
+        """
         return self._config_other_enable & 2 == 2
 
     def is_dmx_enabled(self) -> bool:
-        """True if DMX output is enabled in the controller config (bit 2)."""
+        """True if DMX output is enabled in the controller config (bit 2).
+
+        Verified on firmware 1.7.6: the bit follows the "DMX512 aktiv" checkbox.
+        """
         return self._config_other_enable & 4 == 4
 
     def is_avatar_enabled(self) -> bool:
@@ -774,7 +840,12 @@ class GetStateData:
         return self._config_other_enable & 16 == 16
 
     def is_high_bus_load_enabled(self) -> bool:
-        """True if high bus load mode is enabled in the controller config (bit 5)."""
+        """True if bit 5 (high bus load, 1-Wire) of `config_other_enable` is set.
+
+        Unreliable on current firmware: 1.7.6 was observed reporting this bit
+        as 0 while high bus load was enabled, so ``False`` doesn't prove the
+        feature is off.
+        """
         return self._config_other_enable & 32 == 32
 
     def is_flow_sensor_enabled(self) -> bool:
@@ -888,20 +959,28 @@ class GetStateData:
 
     @property
     def canister_objects(self) -> list[DataObject]:
-        """The three canister fill-level readings (columns 36–38).
+        """The three canister remaining-content readings (columns 36–38), in percent.
 
         Order: chlorine, pH-, pH+. Convenience properties `chlorine_canister`,
         `ph_minus_canister`, and `ph_plus_canister` return individual entries.
+        The values are estimates the controller derives from pump runtime and
+        configured delivery rate. With a salt-electrolysis cell the chlorine
+        entry is the cell's remaining lifetime instead — check
+        `is_electrolysis_object`.
         """
         return self._canister_objects
 
     @property
     def consumption_objects(self) -> list[DataObject]:
-        """The three dosage consumption counters (columns 39–41).
+        """The three daily dosage amounts (columns 39–41).
 
         Order: chlorine, pH-, pH+. Convenience properties
         `chlorine_consumption`, `ph_minus_consumption`, and
-        `ph_plus_consumption` return individual entries.
+        `ph_plus_consumption` return individual entries. Each is the amount
+        dosed *today* (the controller resets it daily), in the unit the
+        controller reports (``ml``; the chlorine column may report ``g``). With a
+        salt-electrolysis cell the chlorine entry is today's calculated
+        chlorine production — check `is_electrolysis_object`.
         """
         return self._consumption_objects
 
@@ -917,32 +996,41 @@ class GetStateData:
 
     @property
     def chlorine_canister(self) -> DataObject:
-        """Chlorine canister fill level (column 36)."""
+        """Chlorine canister remaining content in percent (column 36).
+
+        With a salt-electrolysis cell (`is_electrolysis_enabled`) this is the
+        cell's remaining lifetime / maintenance interval in percent instead.
+        """
         return self._canister_objects[0]
 
     @property
     def ph_minus_canister(self) -> DataObject:
-        """pH- canister fill level (column 37)."""
+        """pH- canister remaining content in percent (column 37)."""
         return self._canister_objects[1]
 
     @property
     def ph_plus_canister(self) -> DataObject:
-        """pH+ canister fill level (column 38)."""
+        """pH+ canister remaining content in percent (column 38)."""
         return self._canister_objects[2]
 
     @property
     def chlorine_consumption(self) -> DataObject:
-        """Cumulative chlorine consumption counter (column 39)."""
+        """Chlorine dosed today (column 39), in ``ml`` or ``g``.
+
+        With a salt-electrolysis cell (`is_electrolysis_enabled`) this is
+        today's chlorine production calculated from the configured
+        production rate instead.
+        """
         return self._consumption_objects[0]
 
     @property
     def ph_minus_consumption(self) -> DataObject:
-        """Cumulative pH- consumption counter (column 40)."""
+        """pH- dosed today (column 40), in ``ml``."""
         return self._consumption_objects[1]
 
     @property
     def ph_plus_consumption(self) -> DataObject:
-        """Cumulative pH+ consumption counter (column 41)."""
+        """pH+ dosed today (column 41), in ``ml``."""
         return self._consumption_objects[2]
 
     @property

{proconip-2.2.0 → proconip-2.3.0}/tests/conftest.py

@@ -36,3 +36,20 @@ def get_state_data(get_state_csv: str) -> GetStateData:
 @pytest.fixture
 def get_dmx_data(get_dmx_csv: str) -> GetDmxData:
     return GetDmxData(get_dmx_csv)
+
+
+@pytest.fixture
+def get_state_electrolysis_csv() -> str:
+    """`get_state.csv` reconfigured for a salt-electrolysis chlorine supply.
+
+    Derived from the real capture: DOSAGE_CNTRL 273 (Cl enabled + bit 4
+    electrolysis + pH- enabled), chlorine daily amount in ``g``, and non-zero
+    values in the chlorine "canister" (cell lifetime %) and "consumption"
+    (calculated production) columns, per the vendor's TRM column table.
+    """
+    return (FIXTURES_DIR / "get_state_electrolysis.csv").read_text()
+
+
+@pytest.fixture
+def get_state_electrolysis_data(get_state_electrolysis_csv: str) -> GetStateData:
+    return GetStateData(get_state_electrolysis_csv)

proconip-2.3.0/tests/fixtures/get_state_electrolysis.csv

@@ -0,0 +1,6 @@
+SYSINFO,1.7.3,9559698,1,3,0,273,4,4,5
+Time,n.a.,n.a.,n.a.,n.a.,CPU Temp,Redox,pH,Pumpe,n.a.,n.a.,n.a.,n.a.,n.a.,n.a.,n.a.,Terassenlicht,n.a.,n.a.,Gartenlicht,pH minus,Chlor,Bachlauf,Poolpumpe,TASTER1,TASTER2,TASTER3,TASTER4,n.a.,n.a.,n.a.,n.a.,n.a.,n.a.,n.a.,n.a.,Cl Rest,pH- Rest,pH+ Rest,Cl consumption,pH- consumption,pH+ consumption
+h,mV,mV,Bar,ppm,C,mV,pH,C,C,C,C,C,C,C,C,--,--,--,--,--,--,--,--,cm/s,--,--,--,--,--,--,--,--,--,--,--,%,%,%,g,ml,ml
+0,0,0,-0.400,6.00000,147.5,0.0,0.0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
+1,0.0625,0.0625,0.0000125,0.000156,-0.00468750,0.0625,0.0078125,0.0625,0.0625,0.0625,0.0625,0.0625,0.0625,0.0625,0.0625,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,0.1,0.1,0.1,1,1,1
+529,-44,-44,-44,-44,24878,14000,932,111,0,0,0,0,0,0,0,2,0,0,2,2,2,2,2,0,0,0,0,0,0,0,0,0,0,0,0,873,615,1000,412,0,0