PyPlumIO 0.5.50__tar.gz → 0.5.52__tar.gz

{pyplumio-0.5.50 → pyplumio-0.5.52}/.pre-commit-config.yaml

@@ -3,7 +3,7 @@
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.11.6
+    rev: v0.11.11
     hooks:
       - id: ruff
         args:

{pyplumio-0.5.50 → pyplumio-0.5.52}/.qlty/qlty.toml

@@ -49,7 +49,7 @@ file_patterns = ["pyplumio/structures/network_info.py"]
 
 # Ignore unused **kwargs argument due to inheritance.
 [[ignore]]
-rules = ["radarlint-python:python.S1172"]
+rules = ["radarlint-python:python:S1172"]
 file_patterns = ["pyplumio/frames/__init__.py"]
 
 [[source]]

{pyplumio-0.5.50 → pyplumio-0.5.52}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPlumIO
-Version: 0.5.50
+Version: 0.5.52
 Summary: PyPlumIO is a native ecoNET library for Plum ecoMAX controllers.
 Author-email: Denis Paavilainen <denpa@denpa.pro>
 License: MIT License
@@ -25,18 +25,18 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: dataslots==1.2.0
 Requires-Dist: pyserial-asyncio==0.6
-Requires-Dist: typing-extensions==4.13.2
+Requires-Dist: typing-extensions==4.14.0
 Provides-Extra: test
 Requires-Dist: codespell==2.4.1; extra == "test"
-Requires-Dist: coverage==7.8.0; extra == "test"
-Requires-Dist: freezegun==1.5.1; extra == "test"
-Requires-Dist: mypy==1.15.0; extra == "test"
+Requires-Dist: coverage==7.9.1; extra == "test"
+Requires-Dist: freezegun==1.5.2; extra == "test"
+Requires-Dist: mypy==1.16.1; extra == "test"
 Requires-Dist: numpy<3.0.0,>=2.0.0; extra == "test"
 Requires-Dist: pyserial-asyncio-fast==0.16; extra == "test"
-Requires-Dist: pytest==8.3.5; extra == "test"
-Requires-Dist: pytest-asyncio==0.26.0; extra == "test"
-Requires-Dist: ruff==0.11.9; extra == "test"
-Requires-Dist: tox==4.25.0; extra == "test"
+Requires-Dist: pytest==8.4.1; extra == "test"
+Requires-Dist: pytest-asyncio==1.0.0; extra == "test"
+Requires-Dist: ruff==0.11.13; extra == "test"
+Requires-Dist: tox==4.26.0; extra == "test"
 Requires-Dist: types-pyserial==3.5.0.20250326; extra == "test"
 Provides-Extra: docs
 Requires-Dist: sphinx==8.1.3; extra == "docs"

{pyplumio-0.5.50 → pyplumio-0.5.52}/PyPlumIO.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPlumIO
-Version: 0.5.50
+Version: 0.5.52
 Summary: PyPlumIO is a native ecoNET library for Plum ecoMAX controllers.
 Author-email: Denis Paavilainen <denpa@denpa.pro>
 License: MIT License
@@ -25,18 +25,18 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: dataslots==1.2.0
 Requires-Dist: pyserial-asyncio==0.6
-Requires-Dist: typing-extensions==4.13.2
+Requires-Dist: typing-extensions==4.14.0
 Provides-Extra: test
 Requires-Dist: codespell==2.4.1; extra == "test"
-Requires-Dist: coverage==7.8.0; extra == "test"
-Requires-Dist: freezegun==1.5.1; extra == "test"
-Requires-Dist: mypy==1.15.0; extra == "test"
+Requires-Dist: coverage==7.9.1; extra == "test"
+Requires-Dist: freezegun==1.5.2; extra == "test"
+Requires-Dist: mypy==1.16.1; extra == "test"
 Requires-Dist: numpy<3.0.0,>=2.0.0; extra == "test"
 Requires-Dist: pyserial-asyncio-fast==0.16; extra == "test"
-Requires-Dist: pytest==8.3.5; extra == "test"
-Requires-Dist: pytest-asyncio==0.26.0; extra == "test"
-Requires-Dist: ruff==0.11.9; extra == "test"
-Requires-Dist: tox==4.25.0; extra == "test"
+Requires-Dist: pytest==8.4.1; extra == "test"
+Requires-Dist: pytest-asyncio==1.0.0; extra == "test"
+Requires-Dist: ruff==0.11.13; extra == "test"
+Requires-Dist: tox==4.26.0; extra == "test"
 Requires-Dist: types-pyserial==3.5.0.20250326; extra == "test"
 Provides-Extra: docs
 Requires-Dist: sphinx==8.1.3; extra == "docs"

{pyplumio-0.5.50 → pyplumio-0.5.52}/PyPlumIO.egg-info/SOURCES.txt

@@ -62,10 +62,8 @@ pyplumio/helpers/__init__.py
 pyplumio/helpers/async_cache.py
 pyplumio/helpers/event_manager.py
 pyplumio/helpers/factory.py
-pyplumio/helpers/schedule.py
 pyplumio/helpers/task_manager.py
 pyplumio/helpers/timeout.py
-pyplumio/helpers/uid.py
 pyplumio/parameters/__init__.py
 pyplumio/parameters/ecomax.py
 pyplumio/parameters/mixer.py
@@ -123,7 +121,6 @@ tests/helpers/__init__.py
 tests/helpers/test_async_cache.py
 tests/helpers/test_event_manager.py
 tests/helpers/test_factory.py
-tests/helpers/test_schedule.py
 tests/helpers/test_task_manager.py
 tests/helpers/test_timeout.py
 tests/helpers/test_uid.py
@@ -135,6 +132,19 @@ tests/parameters/test_thermostats.py
 tests/parameters/custom/__init__.py
 tests/parameters/custom/test_ecomax_860d3_hb.py
 tests/parameters/custom/test_init.py
+tests/structures/__init__.py
+tests/structures/test_alerts.py
+tests/structures/test_boiler_load.py
+tests/structures/test_boiler_power.py
+tests/structures/test_ecomax_parameters.py
+tests/structures/test_fan_power.py
+tests/structures/test_frame_versions.py
+tests/structures/test_fuel_consumption.py
+tests/structures/test_fuel_level.py
+tests/structures/test_lambda_sensor.py
+tests/structures/test_mixer_parameters.py
+tests/structures/test_product_info.py
+tests/structures/test_schedules.py
 tests/testdata/messages/regulator_data.json
 tests/testdata/messages/sensor_data.json
 tests/testdata/parameters/ecomax_860d3_hb.json

{pyplumio-0.5.50 → pyplumio-0.5.52}/PyPlumIO.egg-info/requires.txt

@@ -1,6 +1,6 @@
 dataslots==1.2.0
 pyserial-asyncio==0.6
-typing-extensions==4.13.2
+typing-extensions==4.14.0
 
 [dev]
 pyplumio[docs,test]
@@ -14,13 +14,13 @@ readthedocs-sphinx-search==0.3.2
 
 [test]
 codespell==2.4.1
-coverage==7.8.0
-freezegun==1.5.1
-mypy==1.15.0
+coverage==7.9.1
+freezegun==1.5.2
+mypy==1.16.1
 numpy<3.0.0,>=2.0.0
 pyserial-asyncio-fast==0.16
-pytest==8.3.5
-pytest-asyncio==0.26.0
-ruff==0.11.9
-tox==4.25.0
+pytest==8.4.1
+pytest-asyncio==1.0.0
+ruff==0.11.13
+tox==4.26.0
 types-pyserial==3.5.0.20250326

{pyplumio-0.5.50 → pyplumio-0.5.52}/docs/source/index.rst

@@ -6,7 +6,7 @@
 Welcome to PyPlumIO's documentation!
 ====================================
 
-The `PyPlumIO <https://github.com/denpamusic/PyPlumIO/>`_ projects aims to
+The `PyPlumIO <https://github.com/denpamusic/PyPlumIO/>`_ project aims to
 provide complete and easy to use solution for communicating with
 climate devices manufactured by `Plum Sp. z o.o. <https://www.plum.pl/>`_
 

{pyplumio-0.5.50 → pyplumio-0.5.52}/docs/source/schedules.rst

@@ -60,11 +60,11 @@ switches back to daytime mode from 07:00 to 00:00.
     await heating_schedule.commit()
 
 For clarity sake, you might want to use ``STATE_OFF`` and
-``STATE_ON`` constants from ``pyplumio.helpers.schedule`` module.
+``STATE_ON`` constants from ``pyplumio.const`` module.
 
 .. code-block:: python
 
-    from pyplumio.helpers.schedule import STATE_OFF
+    from pyplumio.const import STATE_OFF
 
     heating_schedule.monday["18:00"] = STATE_OFF
     heating_schedule.monday.set_state(STATE_OFF, "00:00", "07:00")
@@ -110,7 +110,7 @@ Schedule Examples
 .. code-block:: python
 
     import pyplumio
-    from pyplumio.helpers.schedule import STATE_ON, STATE_OFF
+    from pyplumio.const import STATE_ON, STATE_OFF
 
 
     async def main():

{pyplumio-0.5.50 → pyplumio-0.5.52}/pyplumio/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.5.50'
-__version_tuple__ = version_tuple = (0, 5, 50)
+__version__ = version = '0.5.52'
+__version_tuple__ = version_tuple = (0, 5, 52)

{pyplumio-0.5.50 → pyplumio-0.5.52}/pyplumio/const.py

@@ -91,13 +91,6 @@ class ProductType(IntEnum):
     ECOMAX_I = 1
 
 
-@unique
-class ProductModel(Enum):
-    """Contains device models."""
-
-    ECOMAX_860D3_HB = "ecoMAX 860D3-HB"
-
-
 @unique
 class AlertType(IntEnum):
     """Contains alert types."""

{pyplumio-0.5.50 → pyplumio-0.5.52}/pyplumio/devices/__init__.py

@@ -64,7 +64,7 @@ class Device(ABC, EventManager):
         self,
         name: str,
         value: NumericType | State | bool,
-        retries: int = 5,
+        retries: int = 0,
         timeout: float | None = None,
     ) -> bool:
         """Set a parameter value.
@@ -74,7 +74,7 @@ class Device(ABC, EventManager):
         :param value: New value for the parameter
         :type value: int | float | bool | Literal["on", "off"]
         :param retries: Try setting parameter for this amount of
-            times, defaults to 5
+            times, defaults to 0 (disabled)
         :type retries: int, optional
         :param timeout: Wait this amount of seconds for confirmation,
             defaults to `None`
@@ -96,7 +96,7 @@ class Device(ABC, EventManager):
         self,
         name: str,
         value: NumericType | State | bool,
-        retries: int = 5,
+        retries: int = 0,
         timeout: float | None = None,
     ) -> None:
         """Set a parameter value without waiting for the result.
@@ -106,7 +106,7 @@ class Device(ABC, EventManager):
         :param value: New value for the parameter
         :type value: int | float | bool | Literal["on", "off"]
         :param retries: Try setting parameter for this amount of
-            times, defaults to 5
+            times, defaults to 0 (disabled)
         :type retries: int, optional
         :param timeout: Wait this amount of seconds for confirmation.
             As this method operates in the background without waiting,

{pyplumio-0.5.50 → pyplumio-0.5.52}/pyplumio/devices/ecomax.py

@@ -27,7 +27,6 @@ from pyplumio.exceptions import RequestError
 from pyplumio.filters import on_change
 from pyplumio.frames import DataFrameDescription, Frame, Request
 from pyplumio.helpers.event_manager import event_listener
-from pyplumio.helpers.schedule import Schedule, ScheduleDay
 from pyplumio.parameters import ParameterValues
 from pyplumio.parameters.ecomax import (
     ECOMAX_CONTROL_PARAMETER,
@@ -51,6 +50,8 @@ from pyplumio.structures.schedules import (
     ATTR_SCHEDULES,
     SCHEDULE_PARAMETERS,
     SCHEDULES,
+    Schedule,
+    ScheduleDay,
     ScheduleNumber,
     ScheduleSwitch,
     ScheduleSwitchDescription,
@@ -303,8 +304,7 @@ class EcoMAX(PhysicalDevice):
 
     @event_listener
     async def on_event_mixer_parameters(
-        self,
-        parameters: dict[int, list[tuple[int, ParameterValues]]] | None,
+        self, parameters: dict[int, Any] | None
     ) -> bool:
         """Handle mixer parameters and dispatch the events."""
         _LOGGER.debug("Received mixer parameters")
@@ -320,9 +320,7 @@ class EcoMAX(PhysicalDevice):
         return False
 
     @event_listener
-    async def on_event_mixer_sensors(
-        self, sensors: dict[int, dict[str, Any]] | None
-    ) -> bool:
+    async def on_event_mixer_sensors(self, sensors: dict[int, Any] | None) -> bool:
         """Update mixer sensors and dispatch the events."""
         _LOGGER.debug("Received mixer sensors")
         if sensors:
@@ -372,8 +370,7 @@ class EcoMAX(PhysicalDevice):
 
     @event_listener
     async def on_event_thermostat_parameters(
-        self,
-        parameters: dict[int, list[tuple[int, ParameterValues]]] | None,
+        self, parameters: dict[int, Any] | None
     ) -> bool:
         """Handle thermostat parameters and dispatch the events."""
         _LOGGER.debug("Received thermostat parameters")
@@ -403,9 +400,7 @@ class EcoMAX(PhysicalDevice):
         return None
 
     @event_listener
-    async def on_event_thermostat_sensors(
-        self, sensors: dict[int, dict[str, Any]] | None
-    ) -> bool:
+    async def on_event_thermostat_sensors(self, sensors: dict[int, Any] | None) -> bool:
         """Update thermostat sensors and dispatch the events."""
         _LOGGER.debug("Received thermostat sensors")
         if sensors:

{pyplumio-0.5.50 → pyplumio-0.5.52}/pyplumio/filters.py

@@ -86,7 +86,7 @@ def is_close(
 ) -> bool:
     """Check if value is significantly changed."""
     if isinstance(old, Parameter) and isinstance(new, Parameter):
-        return new.pending_update or old.values.__ne__(new.values)
+        return new.update_pending.is_set() or old.values.__ne__(new.values)
 
     if tolerance and isinstance(old, SupportsFloat) and isinstance(new, SupportsFloat):
         return not math.isclose(old, new, abs_tol=tolerance)

{pyplumio-0.5.50 → pyplumio-0.5.52}/pyplumio/frames/__init__.py

@@ -15,10 +15,14 @@ from pyplumio.utils import ensure_dict, to_camelcase
 
 FRAME_START: Final = 0x68
 FRAME_END: Final = 0x16
-HEADER_OFFSET: Final = 0
+
+
+HEADER_INDEX: Final = 0
 FRAME_TYPE_SIZE: Final = 1
-CRC_SIZE: Final = 1
+BCC_SIZE: Final = 1
+BCC_INDEX: Final = -2
 DELIMITER_SIZE: Final = 1
+
 ECONET_TYPE: Final = 48
 ECONET_VERSION: Final = 5
 
@@ -199,7 +203,7 @@ class Frame(ABC):
             struct_header.size
             + FRAME_TYPE_SIZE
             + len(self.message)
-            + CRC_SIZE
+            + BCC_SIZE
             + DELIMITER_SIZE
         )
 
@@ -209,7 +213,7 @@ class Frame(ABC):
         buffer = bytearray(struct_header.size)
         struct_header.pack_into(
             buffer,
-            HEADER_OFFSET,
+            HEADER_INDEX,
             FRAME_START,
             self.length,
             int(self.recipient),

{pyplumio-0.5.50 → pyplumio-0.5.52}/pyplumio/parameters/__init__.py

@@ -4,6 +4,7 @@ from __future__ import annotations
 
 from abc import ABC, abstractmethod
 import asyncio
+from contextlib import suppress
 from dataclasses import dataclass
 import logging
 from typing import TYPE_CHECKING, Any, Literal, TypeVar, Union, get_args
@@ -72,11 +73,19 @@ NumericType: TypeAlias = Union[int, float]
 class Parameter(ABC):
     """Represents a base parameter."""
 
-    __slots__ = ("device", "description", "_pending_update", "_index", "_values")
+    __slots__ = (
+        "device",
+        "description",
+        "_update_done",
+        "_update_pending",
+        "_index",
+        "_values",
+    )
 
     device: Device
     description: ParameterDescription
-    _pending_update: bool
+    _update_done: asyncio.Event
+    _update_pending: asyncio.Event
     _index: int
     _values: ParameterValues
 
@@ -91,8 +100,9 @@ class Parameter(ABC):
         self.device = device
         self.description = description
         self._index = index
-        self._pending_update = False
         self._index = index
+        self._update_done = asyncio.Event()
+        self._update_pending = asyncio.Event()
         self._values = values if values else ParameterValues(0, 0, 0)
 
     def __repr__(self) -> str:
@@ -171,21 +181,19 @@ class Parameter(ABC):
         )
         return type(self)(self.device, self.description, values)
 
-    async def set(self, value: Any, retries: int = 5, timeout: float = 5.0) -> bool:
+    async def set(self, value: Any, retries: int = 0, timeout: float = 5.0) -> bool:
         """Set a parameter value."""
         self.validate(value)
         return await self._attempt_update(self._pack_value(value), retries, timeout)
 
-    def set_nowait(self, value: Any, retries: int = 5, timeout: float = 5.0) -> None:
+    def set_nowait(self, value: Any, retries: int = 0, timeout: float = 5.0) -> None:
         """Set a parameter value without waiting."""
         self.validate(value)
         self.device.create_task(
             self._attempt_update(self._pack_value(value), retries, timeout)
         )
 
-    async def _attempt_update(
-        self, value: int, retries: int = 5, timeout: float = 5.0
-    ) -> bool:
+    async def _attempt_update(self, value: int, retries: int, timeout: float) -> bool:
         """Attempt to update a parameter value on the remote device."""
         _LOGGER.info(
             "Attempting to update '%s' parameter to %d", self.description.name, value
@@ -196,36 +204,58 @@ class Parameter(ABC):
 
         self._values.value = value
         request = await self.create_request()
-        if self.description.optimistic or not (initial_retries := retries):
-            # No retries
+        if self.description.optimistic:
             await self.device.queue.put(request)
             return True
 
-        self._pending_update = True
-        while self.pending_update:
-            if retries <= 0:
-                _LOGGER.warning(
-                    "Unable to confirm update of '%s' parameter after %d retries",
-                    self.description.name,
-                    initial_retries,
-                )
-                return False
+        self.update_done.clear()
+        self.update_pending.set()
+        if retries > 0:
+            return await self._attempt_update_with_retries(
+                request, retries=retries, timeout=timeout
+            )
 
-            await self.device.queue.put(request)
-            await asyncio.sleep(timeout)
-            retries -= 1
+        return await self._send_update_request(request, timeout=timeout)
 
-        return True
+    async def _attempt_update_with_retries(
+        self, request: Request, retries: int, timeout: float
+    ) -> bool:
+        """Send update request and retry until success."""
+        for _ in range(retries):
+            if await self._send_update_request(request, timeout=timeout):
+                return True
+
+        _LOGGER.warning(
+            "Unable to confirm update of '%s' parameter after %d retries",
+            self.description.name,
+            retries,
+        )
+        return False
+
+    async def _send_update_request(self, request: Request, timeout: float) -> bool:
+        """Send update request to the remote and confirm the result."""
+        await self.device.queue.put(request)
+        with suppress(asyncio.TimeoutError):
+            # Wait for the update to be done
+            await asyncio.wait_for(self.update_done.wait(), timeout=timeout)
+
+        return self.update_done.is_set()
 
     def update(self, values: ParameterValues) -> None:
         """Update the parameter values."""
-        self._pending_update = False
+        self.update_done.set()
+        self.update_pending.clear()
         self._values = values
 
     @property
-    def pending_update(self) -> bool:
-        """Check if parameter is pending update on the device."""
-        return self._pending_update
+    def update_done(self) -> asyncio.Event:
+        """Check if parameter is updated on the device."""
+        return self._update_done
+
+    @property
+    def update_pending(self) -> asyncio.Event:
+        """Check if parameter is updated on the device."""
+        return self._update_pending
 
     @property
     def values(self) -> ParameterValues:
@@ -325,16 +355,16 @@ class Number(Parameter):
         return True
 
     async def set(
-        self, value: NumericType, retries: int = 5, timeout: float = 5.0
+        self, value: NumericType, retries: int = 0, timeout: float = 5.0
     ) -> bool:
         """Set a parameter value."""
-        return await super().set(value, retries, timeout)
+        return await super().set(value, retries=retries, timeout=timeout)
 
     def set_nowait(
-        self, value: NumericType, retries: int = 5, timeout: float = 5.0
+        self, value: NumericType, retries: int = 0, timeout: float = 5.0
     ) -> None:
         """Set a parameter value without waiting."""
-        super().set_nowait(value, retries, timeout)
+        super().set_nowait(value, retries=retries, timeout=timeout)
 
     async def create_request(self) -> Request:
         """Create a request to change the number."""
@@ -420,16 +450,16 @@ class Switch(Parameter):
         return True
 
     async def set(
-        self, value: State | bool, retries: int = 5, timeout: float = 5.0
+        self, value: State | bool, retries: int = 0, timeout: float = 5.0
     ) -> bool:
         """Set a parameter value."""
-        return await super().set(value, retries, timeout)
+        return await super().set(value, retries=retries, timeout=timeout)
 
     def set_nowait(
-        self, value: State | bool, retries: int = 5, timeout: float = 5.0
+        self, value: State | bool, retries: int = 0, timeout: float = 5.0
     ) -> None:
         """Set a switch value without waiting."""
-        super().set_nowait(value, retries, timeout)
+        super().set_nowait(value, retries=retries, timeout=timeout)
 
     async def turn_on(self) -> bool:
         """Set a switch value to 'on'.

{pyplumio-0.5.50 → pyplumio-0.5.52}/pyplumio/parameters/custom/__init__.py

@@ -29,7 +29,7 @@ class Signature:
 class CustomParameter:
     """Represents a custom parameter."""
 
-    __slot__ = ("original", "replacement")
+    __slots__ = ("original", "replacement")
 
     original: str
     replacement: ParameterDescription
@@ -38,8 +38,6 @@ class CustomParameter:
 class CustomParameters:
     """Represents a custom parameters."""
 
-    __slots__ = ("signature", "replacements")
-
     signature: ClassVar[Signature]
     replacements: ClassVar[Sequence[CustomParameter]]
 

{pyplumio-0.5.50 → pyplumio-0.5.52}/pyplumio/parameters/custom/ecomax_860d3_hb.py

@@ -8,8 +8,6 @@ from pyplumio.parameters.ecomax import EcomaxNumberDescription, EcomaxSwitchDesc
 class EcoMAX860D3HB(CustomParameters):
     """Replacements for ecoMAX 860D3-HB."""
 
-    __slots__ = ()
-
     signature = Signature(model="ecoMAX 860D3-HB", id=48)
 
     replacements = (

{pyplumio-0.5.50 → pyplumio-0.5.52}/pyplumio/protocol.py

@@ -230,15 +230,15 @@ class AsyncProtocol(Protocol, EventManager[PhysicalDevice]):
     @acache
     async def get_device_entry(self, device_type: DeviceType) -> PhysicalDevice:
         """Return the device entry."""
+        name = device_type.name.lower()
         async with self._entry_lock:
-            name = device_type.name.lower()
             if name not in self.data:
                 device = await PhysicalDevice.create(
                     device_type, queue=self._queues.write, network=self._network
                 )
                 device.dispatch_nowait(ATTR_CONNECTED, True)
                 device.dispatch_nowait(ATTR_SETUP, True)
-                await self.dispatch(device_type.name.lower(), device)
+                await self.dispatch(name, device)
 
         return self.data[name]