python-omnilogic-local 0.14.6__tar.gz → 0.15.2__tar.gz

{python_omnilogic_local-0.14.6 → python_omnilogic_local-0.15.2}/PKG-INFO

@@ -1,26 +1,19 @@
 Metadata-Version: 2.3
 Name: python-omnilogic-local
-Version: 0.14.6
+Version: 0.15.2
 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.14.6 → python_omnilogic_local-0.15.2}/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:
@@ -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")

{python_omnilogic_local-0.14.6 → python_omnilogic_local-0.15.2}/pyomnilogic_local/cli.py

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

{python_omnilogic_local-0.14.6 → python_omnilogic_local-0.15.2}/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

{python_omnilogic_local-0.14.6 → python_omnilogic_local-0.15.2}/pyomnilogic_local/models/mspconfig.py

@@ -13,7 +13,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 (
     BodyOfWaterType,
     ChlorinatorCellType,
     ChlorinatorDispenserType,
@@ -219,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")

{python_omnilogic_local-0.14.6 → python_omnilogic_local-0.15.2}/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,
@@ -71,7 +71,7 @@ class TelemetryChlorinator(BaseModel):
     sc_mode: int = Field(alias="@scMode")
     operating_state: int = Field(alias="@operatingState")
     timed_percent: int | None = Field(alias="@Timed-Percent")
-    operating_mode: ChlorinatorOperatingMode = Field(alias="@operatingMode")
+    operating_mode: ChlorinatorOperatingMode | int = Field(alias="@operatingMode")
     enable: bool = Field(alias="@enable")
 
     # Still need to do a bit more work to determine if a chlorinator is actively chlorinating
@@ -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.

{python_omnilogic_local-0.14.6 → python_omnilogic_local-0.15.2}/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)

python_omnilogic_local-0.14.6/pyomnilogic_local/types.py → python_omnilogic_local-0.15.2/pyomnilogic_local/omnitypes.py

@@ -87,14 +87,19 @@ class BodyOfWaterType(str, PrettyEnum):
 # Chlorinator status is a bitmask that we still need to figure out
 # class ChlorinatorStatus(str,Enum):
 #     pass
+
+
+# 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):
@@ -102,6 +107,7 @@ class ChlorinatorCellType(PrettyEnum):
     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:

{python_omnilogic_local-0.14.6 → python_omnilogic_local-0.15.2}/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)

{python_omnilogic_local-0.14.6 → python_omnilogic_local-0.15.2}/pyproject.toml

@@ -1,43 +1,35 @@
-[tool.poetry]
+[project]
 name = "python-omnilogic-local"
-version = "0.14.6"
+version = "0.15.2"
 description = "A library for local control of Hayward OmniHub/OmniLogic pool controllers using their local API"
-authors = ["cryptk <cryptk@users.noreply.github.com>", "djtimca", "garionphx"]
-license = "Apache-2.0"
+authors = [
+    {name = "Chris Jowett",email = "421501+cryptk@users.noreply.github.com"},
+    {name = "djtimca"},
+    {name = "garionphx"}
+]
+license = {text = "Apache-2.0"}
 readme = "README.md"
-repository = "https://github.com/cryptk/python-omnilogic-local"
-classifiers = [
-    "Development Status :: 3 - Alpha",
-    "Intended Audience :: Developers",
-    "Natural Language :: English",
-    "Operating System :: OS Independent",
-    "Topic :: Software Development :: Libraries",
+requires-python = ">=3.10,<3.14"
+dependencies = [
+    "pydantic (>=1.10.17)",
+    "xmltodict (>=0.13.0,<0.14.0)"
 ]
-packages = [{include = "pyomnilogic_local"}]
 
-[tool.poetry.scripts]
+[project.scripts]
 omnilogic = "pyomnilogic_local.cli:main"
 
-[tool.poetry.dependencies]
-python = "^3.10"
-pydantic = ">=1.10.17"
-xmltodict = "^0.13.0"
+[tool.poetry]
+packages = [{include = "pyomnilogic_local"}]
 
 [tool.poetry.group.dev.dependencies]
-pre-commit = "^3.0.0"
-mypy = "^1.2.0"
-pylint = "^3.2.3"
-pydantic = "^1.10.7"
-pytest = "^7.3.1"
+pre-commit = "^3.8.0"
+mypy = "^1.14.0"
+pylint = "^3.3.3"
+pytest = "^7.4.4"
 pytest-cov = "^4.1.0"
 
-[tool.pytest.ini_options]
-addopts = [
-    "--import-mode=importlib",
-]
-
 [build-system]
-requires = ["poetry-core"]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
 build-backend = "poetry.core.masonry.api"
 
 [tool.black]
@@ -46,43 +38,15 @@ line-length=140
 [tool.isort]
 # https://github.com/PyCQA/isort/wiki/isort-Settings
 profile = "black"
-# will group `import x` and `from x import` of the same module.
-force_sort_within_sections = true
-known_first_party = [
-    "homeassistant",
-    "tests",
-]
-forced_separate = [
-    "tests",
-]
-combine_as_imports = true
 
 [tool.mypy]
-python_version = "3.10"
+python_version = "3.13"
 plugins = "pydantic.mypy"
 follow_imports = "silent"
 strict = true
 ignore_missing_imports = true
 disallow_subclassing_any = false
 warn_return_any = false
-# local_partial_types = true
-# strict_equality = true
-# no_implicit_optional = true
-# warn_incomplete_stub = true
-# warn_redundant_casts = true
-# warn_unused_configs = true
-# warn_unused_ignores = true
-# enable_error_code = "ignore-without-code, redundant-self, truthy-iterable"
-# disable_error_code = "annotation-unchecked"
-# strict_concatenate = false
-# check_untyped_defs = true
-# disallow_incomplete_defs = true
-# disallow_untyped_calls = true
-# disallow_untyped_decorators = true
-# disallow_untyped_defs = true
-# warn_unreachable = true
-# no_implicit_reexport = true
-# disallow_any_generics = true
 
 [tool.pydantic-mypy]
 init_forbid_extra = true
@@ -91,7 +55,7 @@ warn_required_dynamic_aliases = true
 warn_untyped_fields = true
 
 [tool.pylint.MAIN]
-py-version = "3.11"
+py-version = "3.13"
 ignore = [
     "tests",
 ]
@@ -102,31 +66,6 @@ load-plugins = [
     "pylint.extensions.code_style",
     "pylint.extensions.typing",
 ]
-persistent = false
-extension-pkg-allow-list = [
-    "pydantic",
-]
-fail-on = [
-    "I",
-]
-
-[tool.pylint.BASIC]
-class-const-naming-style = "any"
-good-names = [
-    "_",
-    "ev",
-    "ex",
-    "fp",
-    "i",
-    "id",
-    "j",
-    "k",
-    "Run",
-    "ip",
-]
-
-[tool.pylint.CODE_STYLE]
-max-line-length-suggestions = 72
 
 [tool.pylint."FORMAT"]
 expected-line-ending-format = "LF"
@@ -175,25 +114,20 @@ disable = [
     "wrong-import-order",
     "wrong-import-position",
     "consider-using-f-string",
-    "consider-using-namedtuple-or-dataclass",
-    "consider-using-assignment-expr",
     # The below are only here for now, we should fully document once the codebase stops fluctuating so much
     "missing-class-docstring",
     "missing-function-docstring",
     "missing-module-docstring",
 ]
 enable = [
-    "useless-suppression",  # temporarily every now and then to clean them up
+    "useless-suppression",
     "use-symbolic-message-instead",
 ]
 
-[tool.pylint.REPORTS]
-score = false
-
 [tool.ruff]
 line-length = 140
 
 [tool.semantic_release]
 branch = "main"
-version_toml = "pyproject.toml:tool.poetry.version"
+version_toml = "pyproject.toml:project.version"
 build_command = "pip install poetry && poetry build"

{python_omnilogic_local-0.14.6 → python_omnilogic_local-0.15.2}/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