python-omnilogic-local 2.1.1__tar.gz → 2.3.0__tar.gz

{python_omnilogic_local-2.1.1 → python_omnilogic_local-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-omnilogic-local
-Version: 2.1.1
+Version: 2.3.0
 Summary: A library for local control of Hayward OmniHub/OmniLogic pool controllers using their local API
 Author: Chris Jowett, djtimca, garionphx
 Author-email: Chris Jowett <421501+cryptk@users.noreply.github.com>

{python_omnilogic_local-2.1.1 → python_omnilogic_local-2.3.0}/pyomnilogic_local/chlorinator.py

@@ -372,7 +372,7 @@ class Chlorinator(OmniEquipment[MSPChlorinator, TelemetryChlorinator]):
         Note:
             This method uses the async_set_chlorinator_params API which requires
             all chlorinator configuration parameters. The current values from
-            mspconfig are used for unchanged parameters.
+            mspconfig/telemetry are used for unchanged parameters.
         """
         if self.bow_id is None or self.system_id is None:
             msg = "Cannot set timed percent: bow_id or system_id is None"
@@ -388,17 +388,57 @@ class Chlorinator(OmniEquipment[MSPChlorinator, TelemetryChlorinator]):
             msg = f"Cannot find bow with id {self.bow_id}"
             raise OmniEquipmentNotInitializedError(msg)
 
-        # Map equipment type to numeric bow_type value
-        # BOW_POOL = 0, BOW_SPA = 1 (based on typical protocol values)
         bow_type = 0 if bow.equip_type == "BOW_POOL" else 1
 
         await self._api.async_set_chlorinator_params(
             pool_id=self.bow_id,
             equipment_id=self.system_id,
             timed_percent=percent,
-            cell_type=self.mspconfig.cell_type.value,  # ChlorinatorCellType is now IntEnum, use .value
+            cell_type=self.mspconfig.cell_type.value,
             op_mode=self.operating_mode.value,
             sc_timeout=self.superchlor_timeout,
             bow_type=bow_type,
             orp_timeout=self.orp_timeout,
         )
+
+    @control_method
+    async def set_op_mode(self, op_mode: ChlorinatorOperatingMode) -> None:
+        """Set the operating mode for chlorine generation.
+
+        Args:
+            op_mode: The operating mode for chlorine generation.
+
+        Raises:
+            OmniEquipmentNotInitializedError: If bow_id or system_id is None.
+
+        Note:
+            This method uses the async_set_chlorinator_params API which requires
+            all chlorinator configuration parameters. The current values from
+            mspconfig/telemetry are used for unchanged parameters.
+        """
+        if self.bow_id is None or self.system_id is None:
+            msg = "Cannot set operating mode: bow_id or system_id is None"
+            raise OmniEquipmentNotInitializedError(msg)
+
+        # Get the parent Bow to determine bow_type
+        # We need to find our bow in the backyard
+        if (bow := self._omni.backyard.bow.get(self.bow_id)) is None:
+            msg = f"Cannot find bow with id {self.bow_id}"
+            raise OmniEquipmentNotInitializedError(msg)
+
+        if self.timed_percent_telemetry is None:
+            msg = "Cannot set operating mode: timed_percent telemetry value is None"
+            raise OmniEquipmentNotInitializedError(msg)
+
+        bow_type = 0 if bow.equip_type == "BOW_POOL" else 1
+
+        await self._api.async_set_chlorinator_params(
+            pool_id=self.bow_id,
+            equipment_id=self.system_id,
+            timed_percent=self.timed_percent_telemetry,
+            cell_type=self.mspconfig.cell_type.value,
+            op_mode=op_mode.value,
+            sc_timeout=self.superchlor_timeout,
+            bow_type=bow_type,
+            orp_timeout=self.orp_timeout,
+        )

{python_omnilogic_local-2.1.1 → python_omnilogic_local-2.3.0}/pyomnilogic_local/cli/debug/commands.py

@@ -4,16 +4,21 @@
 from __future__ import annotations
 
 import asyncio
+import xml.etree.ElementTree as ET
+from enum import IntEnum
 from pathlib import Path
 from typing import TYPE_CHECKING, cast
 
 import click
 
+from pyomnilogic_local.api.constants import XML_ENCODING, XML_NAMESPACE
 from pyomnilogic_local.cli.pcap_utils import parse_pcap_file, process_pcap_messages
+from pyomnilogic_local.util import PrettyEnum
 
 if TYPE_CHECKING:
     from pyomnilogic_local import OmniLogic
     from pyomnilogic_local.models.telemetry import TelemetryChlorinator
+    from pyomnilogic_local.omnitypes import MessageType
 
 
 @click.group()
@@ -350,3 +355,36 @@ def set_csad_orp(ctx: click.Context, bow_id: int, csad_id: int, target: int) ->
     except Exception as e:
         click.echo(f"Error setting CSAD ORP target: {e}", err=True)
         raise click.Abort from e
+
+
+@debug.command()
+@click.argument("bow_id", type=int)
+@click.argument("csad_id", type=int)
+@click.argument("opid", type=int)
+@click.argument("is_on")
+@click.pass_context
+def set_csad_enable(ctx: click.Context, bow_id: int, csad_id: int, opid: int, is_on: bool) -> None:
+    """Attempt to enable or disable a CSAD (Chemical Sense and Dispense) device."""
+    omnilogic: OmniLogic = ctx.obj["OMNILOGIC"]
+
+    body_element = ET.Element("Request", {"xmlns": XML_NAMESPACE})
+
+    name_element = ET.SubElement(body_element, "Name")
+    name_element.text = "UISetCSADEnabled"
+
+    parameters_element = ET.SubElement(body_element, "Parameters")
+    parameter = ET.SubElement(parameters_element, "Parameter", name="poolId", dataType="int")
+    parameter.text = str(bow_id)
+    parameter = ET.SubElement(parameters_element, "Parameter", name="CSADID", dataType="int", alias="EquipmentID")
+    parameter.text = str(csad_id)
+    parameter = ET.SubElement(parameters_element, "Parameter", name="Enabled", dataType="bool", alias="Data")
+    parameter.text = str(int(is_on))
+
+    req_body = ET.tostring(body_element, xml_declaration=True, encoding=XML_ENCODING)
+
+    class CustomMessageType(PrettyEnum, IntEnum):
+        SET_CSAD_ENABLE = opid
+
+    click.echo(f"Sending UISetCSADEnabled with op ID: {opid}; body: {req_body}")
+
+    asyncio.run(omnilogic._api.async_send(cast("MessageType", CustomMessageType.SET_CSAD_ENABLE), req_body))

{python_omnilogic_local-2.1.1 → python_omnilogic_local-2.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-omnilogic-local"
-version = "2.1.1"
+version = "2.3.0"
 description = "A library for local control of Hayward OmniHub/OmniLogic pool controllers using their local API"
 readme = "README.md"
 requires-python = ">=3.14.2"