python-omnilogic-local 0.14.4__py3-none-any.whl → 0.15.1__py3-none-any.whl

pyomnilogic_local/api.py

@@ -1,22 +1,23 @@
+# pylint: disable=too-many-positional-arguments
 from __future__ import annotations
 
 import asyncio
 import logging
-from typing import Literal, overload
 import xml.etree.ElementTree as ET
+from typing import Literal, overload
 
 from .models.filter_diagnostics import FilterDiagnostics
 from .models.mspconfig import MSPConfig
 from .models.telemetry import Telemetry
 from .models.util import to_pydantic
-from .protocol import OmniLogicProtocol
-from .types import (
+from .omnitypes import (
     ColorLogicBrightness,
     ColorLogicShow,
     ColorLogicSpeed,
     HeaterMode,
     MessageType,
 )
+from .protocol import OmniLogicProtocol
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -30,12 +31,10 @@ class OmniLogicAPI:
         self._protocol_factory = OmniLogicProtocol
 
     @overload
-    async def async_send_message(self, message_type: MessageType, message: str | None, need_response: Literal[True]) -> str:
-        ...
+    async def async_send_message(self, message_type: MessageType, message: str | None, need_response: Literal[True]) -> str: ...
 
     @overload
-    async def async_send_message(self, message_type: MessageType, message: str | None, need_response: Literal[False]) -> None:
-        ...
+    async def async_send_message(self, message_type: MessageType, message: str | None, need_response: Literal[False]) -> None: ...
 
     async def async_send_message(self, message_type: MessageType, message: str | None, need_response: bool = False) -> str | None:
         """Send a message via the Hayward Omni UDP protocol along with properly handling timeouts and responses.
@@ -97,7 +96,11 @@ class OmniLogicAPI:
         return await self.async_send_message(MessageType.REQUEST_CONFIGURATION, req_body, True)
 
     @to_pydantic(pydantic_type=FilterDiagnostics)
-    async def async_get_filter_diagnostics(self, pool_id: int, equipment_id: int) -> str:
+    async def async_get_filter_diagnostics(
+        self,
+        pool_id: int,
+        equipment_id: int,
+    ) -> str:
         """Retrieve filter diagnostics from the Omni, optionally parse it into a pydantic model.
 
         Args:
@@ -146,7 +149,13 @@ class OmniLogicAPI:
 
         return await self.async_send_message(MessageType.GET_TELEMETRY, req_body, True)
 
-    async def async_set_heater(self, pool_id: int, equipment_id: int, temperature: int, unit: str) -> None:
+    async def async_set_heater(
+        self,
+        pool_id: int,
+        equipment_id: int,
+        temperature: int,
+        unit: str,
+    ) -> None:
         """Set the temperature for a heater on the Omni
 
         Args:
@@ -175,7 +184,13 @@ class OmniLogicAPI:
 
         return await self.async_send_message(MessageType.SET_HEATER_COMMAND, req_body, False)
 
-    async def async_set_solar_heater(self, pool_id: int, equipment_id: int, temperature: int, unit: str) -> None:
+    async def async_set_solar_heater(
+        self,
+        pool_id: int,
+        equipment_id: int,
+        temperature: int,
+        unit: str,
+    ) -> None:
         """Set the solar set point for a heater on the Omni.
 
         Args:
@@ -204,7 +219,12 @@ class OmniLogicAPI:
 
         return await self.async_send_message(MessageType.SET_SOLAR_SET_POINT_COMMAND, req_body, False)
 
-    async def async_set_heater_mode(self, pool_id: int, equipment_id: int, mode: HeaterMode) -> None:
+    async def async_set_heater_mode(
+        self,
+        pool_id: int,
+        equipment_id: int,
+        mode: HeaterMode,
+    ) -> None:
         """Set what mode (Heat/Cool/Auto) the heater should use.
 
         Args:
@@ -232,7 +252,12 @@ class OmniLogicAPI:
 
         return await self.async_send_message(MessageType.SET_HEATER_MODE_COMMAND, req_body, False)
 
-    async def async_set_heater_enable(self, pool_id: int, equipment_id: int, enabled: int | bool) -> None:
+    async def async_set_heater_enable(
+        self,
+        pool_id: int,
+        equipment_id: int,
+        enabled: int | bool,
+    ) -> None:
         """async_set_heater_enable handles sending a SetHeaterEnable XML API call to the Hayward Omni pool controller
 
         Args:
@@ -436,12 +461,12 @@ class OmniLogicAPI:
         pool_id: int,
         equipment_id: int,
         timed_percent: int,
+        cell_type: int,
+        op_mode: int,
+        sc_timeout: int,
+        bow_type: int,
+        orp_timeout: int,
         cfg_state: int = 3,
-        op_mode: int = 1,
-        bow_type: int = 0,
-        cell_type: int = 4,
-        sc_timeout: int = 24,
-        orp_timeout: int = 24,
     ) -> None:
         body_element = ET.Element("Request", {"xmlns": "http://nextgen.hayward.com/api"})
 
@@ -472,7 +497,12 @@ class OmniLogicAPI:
 
         return await self.async_send_message(MessageType.SET_CHLOR_PARAMS, req_body, False)
 
-    async def async_set_chlorinator_superchlorinate(self, pool_id: int, equipment_id: int, enabled: int | bool) -> None:
+    async def async_set_chlorinator_superchlorinate(
+        self,
+        pool_id: int,
+        equipment_id: int,
+        enabled: int | bool,
+    ) -> None:
         body_element = ET.Element("Request", {"xmlns": "http://nextgen.hayward.com/api"})
 
         name_element = ET.SubElement(body_element, "Name")

pyomnilogic_local/cli.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-
 import asyncio
 import logging
 import os

pyomnilogic_local/models/filter_diagnostics.py

@@ -23,6 +23,7 @@ class FilterDiagnostics(BaseModel):
         orm_mode = True
 
     def get_param_by_name(self, name: str) -> int:
+        # pylint: disable=not-an-iterable
         return [param.value for param in self.parameters if param.name == name][0]
 
     @staticmethod

pyomnilogic_local/models/mspconfig.py

@@ -13,8 +13,9 @@ from pydantic.v1 import BaseModel, Field, ValidationError
 from xmltodict import parse as xml_parse
 
 from ..exceptions import OmniParsingException
-from ..types import (
+from ..omnitypes import (
     BodyOfWaterType,
+    ChlorinatorCellType,
     ChlorinatorDispenserType,
     ColorLogicLightType,
     ColorLogicShow,
@@ -151,7 +152,9 @@ class MSPChlorinator(OmniBase):
     enabled: Literal["yes", "no"] = Field(alias="Enabled")
     timed_percent: int = Field(alias="Timed-Percent")
     superchlor_timeout: int = Field(alias="SuperChlor-Timeout")
+    orp_timeout: int = Field(alias="ORP-Timeout")
     dispenser_type: ChlorinatorDispenserType | str = Field(alias="Dispenser-Type")
+    cell_type: ChlorinatorCellType = Field(alias="Cell-Type")
     chlorinator_equipment: list[MSPChlorinatorEquip] | None
 
     def __init__(self, **data: Any) -> None:
@@ -216,7 +219,7 @@ class MSPBackyard(OmniBase):
     colorlogic_light: list[MSPColorLogicLight] | None = Field(alias="ColorLogic-Light")
 
 
-class MSPSchedule(OmniBase):
+class MSPSchedule(OmniBase):  # type: ignore[override]
     omni_type: OmniType = OmniType.SCHEDULE
     system_id: int = Field(alias="schedule-system-id")
     bow_id: int = Field(alias="bow-system-id")

pyomnilogic_local/models/telemetry.py

@@ -6,7 +6,7 @@ from pydantic.v1 import BaseModel, Field, ValidationError
 from xmltodict import parse as xml_parse
 
 from ..exceptions import OmniParsingException
-from ..types import (
+from ..omnitypes import (
     BackyardState,
     ChlorinatorOperatingMode,
     ColorLogicBrightness,
@@ -200,12 +200,10 @@ class Telemetry(BaseModel):
         TypeVar("VT", SupportsInt, Any)
 
         @overload
-        def xml_postprocessor(path: Any, key: Any, value: SupportsInt) -> tuple[Any, SupportsInt]:
-            ...
+        def xml_postprocessor(path: Any, key: Any, value: SupportsInt) -> tuple[Any, SupportsInt]: ...
 
         @overload
-        def xml_postprocessor(path: Any, key: Any, value: Any) -> tuple[Any, Any]:
-            ...
+        def xml_postprocessor(path: Any, key: Any, value: Any) -> tuple[Any, Any]: ...
 
         def xml_postprocessor(path: Any, key: Any, value: SupportsInt | Any) -> tuple[Any, SupportsInt | Any]:
             """Post process XML to attempt to convert values to int.

pyomnilogic_local/models/util.py

@@ -1,5 +1,5 @@
-from collections.abc import Awaitable, Callable
 import logging
+from collections.abc import Awaitable, Callable
 from typing import Any, Literal, TypeVar, cast, overload
 
 from pydantic.v1.utils import GetterDict
@@ -24,17 +24,17 @@ F = TypeVar("F", bound=Callable[..., Awaitable[str]])
 TPydanticTypes = Telemetry | MSPConfig | FilterDiagnostics
 
 
-def to_pydantic(pydantic_type: type[TPydanticTypes]) -> Callable[..., Any]:
+def to_pydantic(
+    pydantic_type: type[TPydanticTypes],
+) -> Callable[..., Any]:
     def inner(func: F, *args: Any, **kwargs: Any) -> F:
         """Wrap an API function that returns XML and parse it into a Pydantic model"""
 
         @overload
-        async def wrapper(*args: Any, raw: Literal[True], **kwargs: Any) -> str:
-            ...
+        async def wrapper(*args: Any, raw: Literal[True], **kwargs: Any) -> str: ...
 
         @overload
-        async def wrapper(*args: Any, raw: Literal[False], **kwargs: Any) -> TPydanticTypes:
-            ...
+        async def wrapper(*args: Any, raw: Literal[False], **kwargs: Any) -> TPydanticTypes: ...
 
         async def wrapper(*args: Any, raw: bool = False, **kwargs: Any) -> TPydanticTypes | str:
             resp_body = await func(*args, **kwargs)

pyomnilogic_local/{types.py → omnitypes.py}

@@ -1,4 +1,4 @@
-from enum import Enum
+from enum import Enum, IntEnum
 
 from .util import PrettyEnum
 
@@ -87,13 +87,38 @@ class BodyOfWaterType(str, PrettyEnum):
 # Chlorinator status is a bitmask that we still need to figure out
 # class ChlorinatorStatus(str,Enum):
 #     pass
-class ChlorinatorOperatingMode(PrettyEnum):
+
+
+# I have seen one pool that had an operatingMode of 3, I am not sure what that means, perhaps that is an OFF mode
+class ChlorinatorOperatingMode(IntEnum):
+    DISABLED = 0
     TIMED = 1
     ORP = 2
+    OFF = 3
 
 
 class ChlorinatorDispenserType(str, PrettyEnum):
     SALT = "SALT_DISPENSING"
+    LIQUID = "LIQUID_DISPENSING"
+
+
+class ChlorinatorCellType(PrettyEnum):
+    T3 = "CELL_TYPE_T3"
+    T5 = "CELL_TYPE_T5"
+    T9 = "CELL_TYPE_T9"
+    T15 = "CELL_TYPE_T15"
+    LIQUID = "CELL_TYPE_LIQUID"
+
+    # There is probably an easier way to do this
+    def __int__(self) -> int:
+        return ChlorinatorCellInt[self.name].value
+
+
+class ChlorinatorCellInt(IntEnum):
+    T3 = 1
+    T5 = 2
+    T9 = 3
+    T15 = 4
 
 
 # Lights

pyomnilogic_local/protocol.py

@@ -3,15 +3,15 @@ import logging
 import random
 import struct
 import time
-from typing import Any, cast
 import xml.etree.ElementTree as ET
 import zlib
+from typing import Any, cast
 
 from typing_extensions import Self
 
 from .exceptions import OmniTimeoutException
 from .models.leadmessage import LeadMessage
-from .types import ClientType, MessageType
+from .omnitypes import ClientType, MessageType
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -28,7 +28,13 @@ class OmniLogicMessage:
     compressed: bool = False
     reserved_2: int = 0
 
-    def __init__(self, msg_id: int, msg_type: MessageType, payload: str | None = None, version: str = "1.19") -> None:
+    def __init__(
+        self,
+        msg_id: int,
+        msg_type: MessageType,
+        payload: str | None = None,
+        version: str = "1.19",
+    ) -> None:
         self.id = msg_id
         self.type = msg_type
         # If we are speaking the XML API, it seems like we need client_type 0, otherwise we need client_type 1
@@ -67,7 +73,7 @@ class OmniLogicMessage:
         header = data[:24]
         rdata: bytes = data[24:]
 
-        msg_id, tstamp, vers, msg_type, client_type, res1, compressed, res2 = struct.unpack(cls.header_format, header)
+        (msg_id, tstamp, vers, msg_type, client_type, res1, compressed, res2) = struct.unpack(cls.header_format, header)
         message = cls(msg_id=msg_id, msg_type=MessageType(msg_type), version=vers.decode("utf-8"))
         message.timestamp = tstamp
         message.client_type = ClientType(int(client_type))
@@ -125,7 +131,11 @@ class OmniLogicProtocol(asyncio.DatagramProtocol):
             # eventually time out waiting for it, that way we can deal with the dropped packets
             message = await self.data_queue.get()
 
-    async def _ensure_sent(self, message: OmniLogicMessage, max_attempts: int = 5) -> None:
+    async def _ensure_sent(
+        self,
+        message: OmniLogicMessage,
+        max_attempts: int = 5,
+    ) -> None:
         for attempt in range(0, max_attempts):
             self.transport.sendto(bytes(message))
 
@@ -143,12 +153,22 @@ class OmniLogicProtocol(asyncio.DatagramProtocol):
                 else:
                     raise OmniTimeoutException("Failed to receive acknowledgement of command, max retries exceeded") from exc
 
-    async def send_and_receive(self, msg_type: MessageType, payload: str | None, msg_id: int | None = None) -> str:
+    async def send_and_receive(
+        self,
+        msg_type: MessageType,
+        payload: str | None,
+        msg_id: int | None = None,
+    ) -> str:
         await self.send_message(msg_type, payload, msg_id)
         return await self._receive_file()
 
     # Send a message that you do NOT need a response to
-    async def send_message(self, msg_type: MessageType, payload: str | None, msg_id: int | None = None) -> None:
+    async def send_message(
+        self,
+        msg_type: MessageType,
+        payload: str | None,
+        msg_id: int | None = None,
+    ) -> None:
         # If we aren't sending a specific msg_id, lets randomize it
         if not msg_id:
             msg_id = random.randrange(2**32)

pyomnilogic_local/util.py

@@ -1,5 +1,5 @@
-from enum import Enum
 import sys
+from enum import Enum
 
 if sys.version_info >= (3, 11):
     from typing import Self

{python_omnilogic_local-0.14.4.dist-info → python_omnilogic_local-0.15.1.dist-info}/METADATA

@@ -1,26 +1,19 @@
 Metadata-Version: 2.3
 Name: python-omnilogic-local
-Version: 0.14.4
+Version: 0.15.1
 Summary: A library for local control of Hayward OmniHub/OmniLogic pool controllers using their local API
-Home-page: https://github.com/cryptk/python-omnilogic-local
 License: Apache-2.0
-Author: cryptk
-Author-email: cryptk@users.noreply.github.com
-Requires-Python: >=3.10,<4.0
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
+Author: Chris Jowett
+Author-email: 421501+cryptk@users.noreply.github.com
+Requires-Python: >=3.10,<3.14
 Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Natural Language :: English
-Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Classifier: Topic :: Software Development :: Libraries
 Requires-Dist: pydantic (>=1.10.17)
 Requires-Dist: xmltodict (>=0.13.0,<0.14.0)
-Project-URL: Repository, https://github.com/cryptk/python-omnilogic-local
 Description-Content-Type: text/markdown
 
 # Pyomnilogic Local

python_omnilogic_local-0.15.1.dist-info/RECORD

@@ -0,0 +1,18 @@
+pyomnilogic_local/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pyomnilogic_local/api.py,sha256=G991ro3UM-ksVg9gGjTArOvZe41MWsSopbcyqPwwdsU,28390
+pyomnilogic_local/cli.py,sha256=YsLPDuBUM9hDmSiYVfz0H346OtPUgRwiLHfKWUKbD7Q,3930
+pyomnilogic_local/exceptions.py,sha256=7-EYTP-_VgGrA8WWGwQPUE1NGjJEDWB-ovyvSM2iaNY,164
+pyomnilogic_local/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pyomnilogic_local/models/const.py,sha256=j4HSiPJW5If296yJ-AiIsBI9EdlckF4QkVFIpTLb5C4,51
+pyomnilogic_local/models/filter_diagnostics.py,sha256=74-VjHB-Rf6imeJTYawybA40_m_wb1Dww-Eu4ucGBdo,1577
+pyomnilogic_local/models/leadmessage.py,sha256=XnzXTpLLQzhLQR1OgfAjKmW5N8BBgM7OrntUi1I2VRY,410
+pyomnilogic_local/models/mspconfig.py,sha256=6YUz5e1V25KX0VynT6iwyZyzi8cPUvZwwLSY0M2bTV0,10594
+pyomnilogic_local/models/telemetry.py,sha256=8ncC-10SRQneFmrH-LrnlVTS3Q-oqeXS_EtYKiIfDks,10612
+pyomnilogic_local/models/util.py,sha256=X9jCiU3hFbI0Nc6NSCnvwyVK9XyA3BsiA9W7JYCJmKs,1462
+pyomnilogic_local/omnitypes.py,sha256=rmmBo1xKgsHsX9bjbBh-0YPv4lID1jGrNNU1W1m6zBo,7832
+pyomnilogic_local/protocol.py,sha256=M2vyj8o_PCKyLEswb6JGpUIdyj_swEJC18KrqcQV4kI,10356
+pyomnilogic_local/util.py,sha256=sLkCn2eWbwP4FRiEgYlfmNxiHPeiWYjeUyvRRhWuNYE,359
+python_omnilogic_local-0.15.1.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+python_omnilogic_local-0.15.1.dist-info/METADATA,sha256=qrnrN1w8YOaQiQWHvUyYMMC85LJxMDxgnfDBEHYkaUE,2634
+python_omnilogic_local-0.15.1.dist-info/WHEEL,sha256=RaoafKOydTQ7I_I3JTrPCg6kUmTgtm4BornzOqyEfJ8,88
+python_omnilogic_local-0.15.1.dist-info/RECORD,,

python_omnilogic_local-0.14.4.dist-info/RECORD

@@ -1,19 +0,0 @@
-pyomnilogic_local/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pyomnilogic_local/api.py,sha256=3Xdd1ouAcSrSiLvmQnwrJl_3hgRl6KiloBXp0_JDVkE,28134
-pyomnilogic_local/cli.py,sha256=RwzKydC612-ay6TGrlSg8UEQPjYIlylxjf11S062bsk,3931
-pyomnilogic_local/exceptions.py,sha256=7-EYTP-_VgGrA8WWGwQPUE1NGjJEDWB-ovyvSM2iaNY,164
-pyomnilogic_local/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pyomnilogic_local/models/const.py,sha256=j4HSiPJW5If296yJ-AiIsBI9EdlckF4QkVFIpTLb5C4,51
-pyomnilogic_local/models/filter_diagnostics.py,sha256=DnkbjOsmfa39-sbD5qO5PV_Ltn5FHSiImrPBxr7Y0cI,1535
-pyomnilogic_local/models/leadmessage.py,sha256=XnzXTpLLQzhLQR1OgfAjKmW5N8BBgM7OrntUi1I2VRY,410
-pyomnilogic_local/models/mspconfig.py,sha256=mXfryaHSA8ecJGazpD_4rmrA2vhWtl32_OBmoSCmxGU,10427
-pyomnilogic_local/models/telemetry.py,sha256=pBebgBKLClXyLH831GzQdfxbFR7NqyMlktwZzGf1ROg,10632
-pyomnilogic_local/models/util.py,sha256=MgqHmDy7OE-62vFX5Rq1tRxs6GmzamBuWoaLYGm-fPI,1479
-pyomnilogic_local/protocol.py,sha256=1Z7U70mV0sUlqrp3XK1Fvj6NuChRKLz0ejzKaQLSPE8,10194
-pyomnilogic_local/types.py,sha256=km_tagtJ43m4_cIynalis7oiDa1LUUR-ta5B9HQUG1Q,7264
-pyomnilogic_local/util.py,sha256=agbRBKnecrYycC9iUmo1aJDjbVg9VxHyq4QY0D8-bfA,359
-python_omnilogic_local-0.14.4.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-python_omnilogic_local-0.14.4.dist-info/METADATA,sha256=JxeeJko3UZKJ5tmEDArSQlQFCoIBROIsmmjsM1jha18,2984
-python_omnilogic_local-0.14.4.dist-info/WHEEL,sha256=RaoafKOydTQ7I_I3JTrPCg6kUmTgtm4BornzOqyEfJ8,88
-python_omnilogic_local-0.14.4.dist-info/entry_points.txt,sha256=PUvdumqSijeB0dHH_s5oE2TnWtPWdJSNpSOsn8yTtOo,56
-python_omnilogic_local-0.14.4.dist-info/RECORD,,

python_omnilogic_local-0.14.4.dist-info/entry_points.txt

@@ -1,3 +0,0 @@
-[console_scripts]
-omnilogic=pyomnilogic_local.cli:main
-