python-omnilogic-local 0.20.12__tar.gz → 0.21.0__tar.gz

{python_omnilogic_local-0.20.12 → python_omnilogic_local-0.21.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-omnilogic-local
-Version: 0.20.12
+Version: 0.21.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-0.20.12 → python_omnilogic_local-0.21.0}/pyomnilogic_local/api/api.py

@@ -373,7 +373,7 @@ class OmniLogicAPI:
         self,
         pool_id: int,
         equipment_id: int,
-        is_on: int | bool,
+        is_on: int | bool | str,
         is_countdown_timer: bool = False,
         start_time_hours: int = 0,
         start_time_minutes: int = 0,
@@ -540,6 +540,54 @@ class OmniLogicAPI:
 
         return await self.async_send_message(MessageType.SET_CHLOR_ENABLED, req_body, False)
 
+    # This is used to set the ORP target value on a CSAD
+    async def async_set_csad_orp_target_level(
+        self,
+        pool_id: int,
+        csad_id: int,
+        orp_target: int,
+    ) -> None:
+        body_element = ET.Element("Request", {"xmlns": XML_NAMESPACE})
+
+        name_element = ET.SubElement(body_element, "Name")
+        name_element.text = "SetUICSADORPTargetLevel"
+
+        parameters_element = ET.SubElement(body_element, "Parameters")
+        parameter = ET.SubElement(parameters_element, "Parameter", name="PoolId", dataType="int")
+        parameter.text = str(pool_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="ORPTargetValue", dataType="byte", alias="Data1")
+        parameter.text = str(orp_target)
+
+        req_body = ET.tostring(body_element, xml_declaration=True, encoding=XML_ENCODING)
+
+        return await self.async_send_message(MessageType.SET_CSAD_ORP_TARGET, req_body, False)
+
+    # This is used to set the pH target value on a CSAD
+    async def async_set_csad_target_value(
+        self,
+        pool_id: int,
+        csad_id: int,
+        ph_target: float,
+    ) -> None:
+        body_element = ET.Element("Request", {"xmlns": XML_NAMESPACE})
+
+        name_element = ET.SubElement(body_element, "Name")
+        name_element.text = "UISetCSADTargetValue"
+
+        parameters_element = ET.SubElement(body_element, "Parameters")
+        parameter = ET.SubElement(parameters_element, "Parameter", name="PoolId", dataType="int")
+        parameter.text = str(pool_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="TargetValue", dataType="float", alias="Data1")
+        parameter.text = str(ph_target)
+
+        req_body = ET.tostring(body_element, xml_declaration=True, encoding=XML_ENCODING)
+
+        return await self.async_send_message(MessageType.SET_CSAD_TARGET_VALUE, req_body, False)
+
     async def async_set_chlorinator_params(
         self,
         pool_id: int,

{python_omnilogic_local-0.20.12 → python_omnilogic_local-0.21.0}/pyomnilogic_local/cli/debug/commands.py

@@ -182,22 +182,15 @@ def set_equipment(ctx: click.Context, bow_id: int, equip_id: int, is_on: str) ->
     ensure_connection(ctx)
     omni: OmniLogicAPI = ctx.obj["OMNI"]
 
+    is_on_value: int | bool | str
     # Parse is_on parameter - can be bool-like string or integer
     is_on_lower = is_on.lower()
     if is_on_lower in ("true", "on", "yes", "1"):
-        is_on_value: int | bool = True
+        is_on_value = True
     elif is_on_lower in ("false", "off", "no", "0"):
         is_on_value = False
     else:
-        # Try to parse as integer for variable speed equipment
-        try:
-            is_on_value = int(is_on)
-            if not 0 <= is_on_value <= 100:
-                click.echo(f"Error: Integer value must be between 0-100, got {is_on_value}", err=True)
-                raise click.Abort
-        except ValueError as exc:
-            click.echo(f"Error: Invalid value '{is_on}'. Use true/false, on/off, or 0-100 for speed.", err=True)
-            raise click.Abort from exc
+        is_on_value = is_on
 
     # Execute the command
     try:
@@ -326,3 +319,82 @@ def set_chlor_params(ctx: click.Context, bow_id: int, equip_id: int, timed_perce
     except Exception as e:
         click.echo(f"Error setting chlorinator parameters: {e}", err=True)
         raise click.Abort from e
+
+
+@debug.command()
+@click.argument("bow_id", type=int)
+@click.argument("csad_id", type=int)
+@click.argument("target", type=float)
+@click.pass_context
+def set_csad_ph(ctx: click.Context, bow_id: int, csad_id: int, target: float) -> None:
+    """Set the pH target value for a CSAD (Chemical Sense and Dispense).
+
+    This command sets the target pH level that the CSAD will attempt to maintain.
+
+    BOW_ID: The Body of Water (pool/spa) system ID
+    CSAD_ID: The CSAD equipment system ID
+    TARGET: Target pH value (typically 7.0-8.0)
+
+    Examples:
+        # Set pH target to 7.4
+        omnilogic --host 192.168.1.100 debug set-csad-ph 7 20 7.4
+
+        # Set pH target to 7.2
+        omnilogic --host 192.168.1.100 debug set-csad-ph 7 20 7.2
+
+    """
+    ensure_connection(ctx)
+    omni: OmniLogicAPI = ctx.obj["OMNI"]
+
+    # Validate target pH (typical range is 6.8-8.2, but allow wider range)
+    if not 0.0 <= target <= 14.0:
+        click.echo(f"Error: pH target must be between 0.0-14.0, got {target}", err=True)
+        raise click.Abort
+
+    # Execute the command
+    try:
+        asyncio.run(omni.async_set_csad_target_value(pool_id=bow_id, csad_id=csad_id, ph_target=target))
+        click.echo(f"Successfully set CSAD {csad_id} in BOW {bow_id} pH target to {target}")
+    except Exception as e:
+        click.echo(f"Error setting CSAD pH 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("target", type=int)
+@click.pass_context
+def set_csad_orp(ctx: click.Context, bow_id: int, csad_id: int, target: int) -> None:
+    """Set the ORP target level for a CSAD (Chemical Sense and Dispense).
+
+    This command sets the target ORP (Oxidation-Reduction Potential) level in
+    millivolts that the CSAD will attempt to maintain.
+
+    BOW_ID: The Body of Water (pool/spa) system ID
+    CSAD_ID: The CSAD equipment system ID
+    TARGET: Target ORP value in millivolts (typically 600-800 mV)
+
+    Examples:
+        # Set ORP target to 700 mV
+        omnilogic --host 192.168.1.100 debug set-csad-orp 7 20 700
+
+        # Set ORP target to 650 mV
+        omnilogic --host 192.168.1.100 debug set-csad-orp 7 20 650
+
+    """
+    ensure_connection(ctx)
+    omni: OmniLogicAPI = ctx.obj["OMNI"]
+
+    # Validate target ORP (typical range is 400-900 mV, but allow 0-1000)
+    if not 0 <= target <= 1000:
+        click.echo(f"Error: ORP target must be between 0-1000 mV, got {target}", err=True)
+        raise click.Abort
+
+    # Execute the command
+    try:
+        asyncio.run(omni.async_set_csad_orp_target_level(pool_id=bow_id, csad_id=csad_id, orp_target=target))
+        click.echo(f"Successfully set CSAD {csad_id} in BOW {bow_id} ORP target to {target} mV")
+    except Exception as e:
+        click.echo(f"Error setting CSAD ORP target: {e}", err=True)
+        raise click.Abort from e

{python_omnilogic_local-0.20.12 → python_omnilogic_local-0.21.0}/pyomnilogic_local/omnitypes.py

@@ -21,7 +21,10 @@ class MessageType(IntEnum, PrettyEnum):
     CREATE_SCHEDULE = 230
     DELETE_SCHEDULE = 231
     EDIT_SCHEDULE = 233
+    SET_CSAD_TARGET_VALUE = 253
+    SET_CSAD_ORP_TARGET = 281
     GET_TELEMETRY = 300
+    GET_ALARM_LIST = 304
     SET_STANDALONE_LIGHT_SHOW = 308
     SET_SPILLOVER = 311
     RUN_GROUP_CMD = 317
@@ -31,6 +34,7 @@ class MessageType(IntEnum, PrettyEnum):
     ACK = 1002
     MSP_TELEMETRY_UPDATE = 1004
     MSP_CONFIGURATIONUPDATE = 1003
+    MSP_ALARM_LIST_RESPONSE = 1304
     MSP_LEADMESSAGE = 1998
     MSP_BLOCKMESSAGE = 1999
 

{python_omnilogic_local-0.20.12 → python_omnilogic_local-0.21.0}/pyproject.toml

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