python-omnilogic-local 2.2.0__tar.gz → 2.4.0__tar.gz

{python_omnilogic_local-2.2.0 → python_omnilogic_local-2.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-omnilogic-local
-Version: 2.2.0
+Version: 2.4.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.2.0 → python_omnilogic_local-2.4.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()
@@ -66,6 +71,26 @@ def get_telemetry(ctx: click.Context) -> None:
     click.echo(telemetry)
 
 
+@debug.command()
+@click.argument("bow_id", type=int)
+@click.argument("equip_id", type=int)
+@click.pass_context
+def get_filter_diagnostics(ctx: click.Context, bow_id: int, equip_id: int) -> None:
+    """Retrieve current filter diagnostics from the controller.
+
+    Filter diagnostics include real-time sensor readings, equipment states, temperatures,
+    and other operational data. Use --raw to see the unprocessed XML.
+
+    Example:
+        omnilogic debug get-filter-diagnostics
+        omnilogic debug --raw get-filter-diagnostics
+
+    """
+    omnilogic: OmniLogic = ctx.obj["OMNILOGIC"]
+    telemetry = asyncio.run(omnilogic._api.async_get_filter_diagnostics(pool_id=bow_id, equipment_id=equip_id, raw=ctx.obj["RAW"]))
+    click.echo(telemetry)
+
+
 @debug.command()
 @click.argument("pcap_file", type=click.Path(exists=True, path_type=Path))
 def parse_pcap(pcap_file: Path) -> None:
@@ -350,3 +375,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.2.0 → python_omnilogic_local-2.4.0}/pyomnilogic_local/filter.py

@@ -223,7 +223,8 @@ class Filter(OmniEquipment[MSPFilter, TelemetryFilter]):
         # This matches the behavior of the OmniLogic phone app
         target_speed: int = 100
         match self.equip_type:
-            case FilterType.VARIABLE_SPEED:
+            # Dual speed filters are controlled similar to VSPs, but they only support speed values of 0, 50, and 100
+            case FilterType.VARIABLE_SPEED | FilterType.DUAL_SPEED:
                 if self.last_speed >= self.min_percent and self.last_speed <= self.max_percent:
                     target_speed = self.last_speed
             case FilterType.SINGLE_SPEED:
@@ -310,3 +311,37 @@ class Filter(OmniEquipment[MSPFilter, TelemetryFilter]):
             equipment_id=self.system_id,
             speed=speed,
         )
+
+    @control_method
+    async def set_dual_speed(self, speed: FilterSpeedPresets) -> None:
+        """Set the filter to a specific speed for dual speed filters.
+
+        For Dual Speed filters, LOW and MEDIUM presets will set the filter to 50% speed, while HIGH will set it to 100%.
+        Semantically, it is preferred to only use LOW and HIGH presets for dual speed filters but MEDIUM is accepted for convenience
+
+        Args:
+            speed: The preset speed to use (LOW, or HIGH)
+
+        Raises:
+            OmniEquipmentNotInitializedError: If bow_id or system_id is None.
+            ValueError: If an invalid speed preset is provided or if the filter is not a dual speed filter.
+        """
+        if self.equip_type != FilterType.DUAL_SPEED:
+            msg = "set_dual_speed can only be used with dual speed filters"
+            raise ValueError(msg)
+
+        if self.bow_id is None or self.system_id is None:
+            msg = "Filter bow_id and system_id must be set"
+            raise OmniEquipmentNotInitializedError(msg)
+
+        speed_value: int
+        match speed:
+            case FilterSpeedPresets.LOW | FilterSpeedPresets.MEDIUM:
+                speed_value = 50
+            case FilterSpeedPresets.HIGH:
+                speed_value = 100
+            case _:
+                msg = f"Invalid speed preset: {speed}"
+                raise ValueError(msg)
+
+        await self.set_speed(speed_value)

{python_omnilogic_local-2.2.0 → python_omnilogic_local-2.4.0}/pyomnilogic_local/omnitypes.py

@@ -35,6 +35,7 @@ class MessageType(PrettyEnum, IntEnum):
     MSP_CONFIGURATIONUPDATE = 1003
     MSP_TELEMETRY_UPDATE = 1004
     MSP_ALARM_LIST_RESPONSE = 1304
+    MSP_FILTER_DIAGNOSTIC_INFO_RESPONSE = 1386
     MSP_LEADMESSAGE = 1998
     MSP_BLOCKMESSAGE = 1999
 

{python_omnilogic_local-2.2.0 → python_omnilogic_local-2.4.0}/pyomnilogic_local/pump.py

@@ -291,3 +291,37 @@ class Pump(OmniEquipment[MSPPump, TelemetryPump]):
             equipment_id=self.system_id,
             is_on=speed,
         )
+
+    @control_method
+    async def set_dual_speed(self, speed: PumpSpeedPresets) -> None:
+        """Set the pump to a specific speed for dual speed pumps.
+
+        For Dual Speed pumps, LOW and MEDIUM presets will set the pump to 50% speed, while HIGH will set it to 100%.
+        Semantically, it is preferred to only use LOW and HIGH presets for dual speed pumps but MEDIUM is accepted for convenience
+
+        Args:
+            speed: The preset speed to use (LOW, or HIGH)
+
+        Raises:
+            OmniEquipmentNotInitializedError: If bow_id or system_id is None.
+            ValueError: If an invalid speed preset is provided or if the pump is not a dual speed pump.
+        """
+        if self.equip_type != PumpType.DUAL_SPEED:
+            msg = "set_dual_speed can only be used with dual speed pumps"
+            raise ValueError(msg)
+
+        if self.bow_id is None or self.system_id is None:
+            msg = "Pump bow_id and system_id must be set"
+            raise OmniEquipmentNotInitializedError(msg)
+
+        speed_value: int
+        match speed:
+            case PumpSpeedPresets.LOW | PumpSpeedPresets.MEDIUM:
+                speed_value = 50
+            case PumpSpeedPresets.HIGH:
+                speed_value = 100
+            case _:
+                msg = f"Invalid speed preset: {speed}"
+                raise ValueError(msg)
+
+        await self.set_speed(speed_value)

{python_omnilogic_local-2.2.0 → python_omnilogic_local-2.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-omnilogic-local"
-version = "2.2.0"
+version = "2.4.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"