PyPlumIO 0.5.25__tar.gz → 0.5.26__tar.gz

{pyplumio-0.5.25 → pyplumio-0.5.26}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyPlumIO
-Version: 0.5.25
+Version: 0.5.26
 Summary: PyPlumIO is a native ecoNET library for Plum ecoMAX controllers.
 Author-email: Denis Paavilainen <denpa@denpa.pro>
 License: MIT License
@@ -27,14 +27,14 @@ Requires-Dist: pyserial-asyncio==0.6
 Requires-Dist: typing-extensions==4.12.2
 Provides-Extra: test
 Requires-Dist: codespell==2.3.0; extra == "test"
-Requires-Dist: coverage==7.6.0; extra == "test"
-Requires-Dist: mypy==1.11.1; extra == "test"
+Requires-Dist: coverage==7.6.1; extra == "test"
+Requires-Dist: mypy==1.11.2; extra == "test"
 Requires-Dist: pyserial-asyncio-fast==0.14; extra == "test"
 Requires-Dist: pytest==8.3.2; extra == "test"
-Requires-Dist: pytest-asyncio==0.23.8; extra == "test"
-Requires-Dist: ruff==0.5.5; extra == "test"
-Requires-Dist: tox==4.16.0; extra == "test"
-Requires-Dist: types-pyserial==3.5.0.20240527; extra == "test"
+Requires-Dist: pytest-asyncio==0.24.0; extra == "test"
+Requires-Dist: ruff==0.5.6; extra == "test"
+Requires-Dist: tox==4.18.0; extra == "test"
+Requires-Dist: types-pyserial==3.5.0.20240826; extra == "test"
 Provides-Extra: docs
 Requires-Dist: sphinx==7.4.7; extra == "docs"
 Requires-Dist: sphinx_rtd_theme==2.0.0; extra == "docs"

{pyplumio-0.5.25 → pyplumio-0.5.26}/PyPlumIO.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyPlumIO
-Version: 0.5.25
+Version: 0.5.26
 Summary: PyPlumIO is a native ecoNET library for Plum ecoMAX controllers.
 Author-email: Denis Paavilainen <denpa@denpa.pro>
 License: MIT License
@@ -27,14 +27,14 @@ Requires-Dist: pyserial-asyncio==0.6
 Requires-Dist: typing-extensions==4.12.2
 Provides-Extra: test
 Requires-Dist: codespell==2.3.0; extra == "test"
-Requires-Dist: coverage==7.6.0; extra == "test"
-Requires-Dist: mypy==1.11.1; extra == "test"
+Requires-Dist: coverage==7.6.1; extra == "test"
+Requires-Dist: mypy==1.11.2; extra == "test"
 Requires-Dist: pyserial-asyncio-fast==0.14; extra == "test"
 Requires-Dist: pytest==8.3.2; extra == "test"
-Requires-Dist: pytest-asyncio==0.23.8; extra == "test"
-Requires-Dist: ruff==0.5.5; extra == "test"
-Requires-Dist: tox==4.16.0; extra == "test"
-Requires-Dist: types-pyserial==3.5.0.20240527; extra == "test"
+Requires-Dist: pytest-asyncio==0.24.0; extra == "test"
+Requires-Dist: ruff==0.5.6; extra == "test"
+Requires-Dist: tox==4.18.0; extra == "test"
+Requires-Dist: types-pyserial==3.5.0.20240826; extra == "test"
 Provides-Extra: docs
 Requires-Dist: sphinx==7.4.7; extra == "docs"
 Requires-Dist: sphinx_rtd_theme==2.0.0; extra == "docs"

{pyplumio-0.5.25 → pyplumio-0.5.26}/PyPlumIO.egg-info/requires.txt

@@ -14,11 +14,11 @@ readthedocs-sphinx-search==0.3.2
 
 [test]
 codespell==2.3.0
-coverage==7.6.0
-mypy==1.11.1
+coverage==7.6.1
+mypy==1.11.2
 pyserial-asyncio-fast==0.14
 pytest==8.3.2
-pytest-asyncio==0.23.8
-ruff==0.5.5
-tox==4.16.0
-types-pyserial==3.5.0.20240527
+pytest-asyncio==0.24.0
+ruff==0.5.6
+tox==4.18.0
+types-pyserial==3.5.0.20240826

{pyplumio-0.5.25 → pyplumio-0.5.26}/pyplumio/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.5.25'
-__version_tuple__ = version_tuple = (0, 5, 25)
+__version__ = version = '0.5.26'
+__version_tuple__ = version_tuple = (0, 5, 26)

{pyplumio-0.5.25 → pyplumio-0.5.26}/pyplumio/devices/__init__.py

@@ -4,7 +4,6 @@ from __future__ import annotations
 
 from abc import ABC
 import asyncio
-from collections.abc import Iterable
 from functools import cache
 from typing import Any, ClassVar
 
@@ -13,7 +12,7 @@ from pyplumio.exceptions import UnknownDeviceError
 from pyplumio.frames import DataFrameDescription, Frame, Request
 from pyplumio.helpers.event_manager import EventManager
 from pyplumio.helpers.factory import create_instance
-from pyplumio.helpers.parameter import SET_RETRIES, Parameter, ParameterValueType
+from pyplumio.helpers.parameter import Parameter, ParameterValue
 from pyplumio.structures.network_info import NetworkInfo
 from pyplumio.utils import to_camelcase
 
@@ -54,9 +53,9 @@ class Device(ABC, EventManager):
     async def set(
         self,
         name: str,
-        value: ParameterValueType,
+        value: ParameterValue,
+        retries: int = 5,
         timeout: float | None = None,
-        retries: int = SET_RETRIES,
     ) -> bool:
         """Set a parameter value.
 
@@ -64,12 +63,12 @@ class Device(ABC, EventManager):
         :type name: str
         :param value: New value for the parameter
         :type value: int | float | bool | Literal["off", "on"]
-        :param timeout: Wait this amount of seconds for confirmation,
-            defaults to `None`
-        :type timeout: float, optional
         :param retries: Try setting parameter for this amount of
             times, defaults to 5
         :type retries: int, optional
+        :param timeout: Wait this amount of seconds for confirmation,
+            defaults to `None`
+        :type timeout: float, optional
         :return: `True` if parameter was successfully set, `False`
             otherwise.
         :rtype: bool
@@ -77,7 +76,7 @@ class Device(ABC, EventManager):
         :raise ValueError: when a new value is outside of allowed range
         :raise TypeError: when found data is not valid parameter
         """
-        parameter = await self.get(name, timeout=timeout)
+        parameter = await self.get(name, timeout)
         if not isinstance(parameter, Parameter):
             raise TypeError(f"{name} is not valid parameter")
 
@@ -86,9 +85,9 @@ class Device(ABC, EventManager):
     def set_nowait(
         self,
         name: str,
-        value: ParameterValueType,
+        value: ParameterValue,
+        retries: int = 5,
         timeout: float | None = None,
-        retries: int = SET_RETRIES,
     ) -> None:
         """Set a parameter value without waiting for the result.
 
@@ -96,19 +95,19 @@ class Device(ABC, EventManager):
         :type name: str
         :param value: New value for the parameter
         :type value: int | float | bool | Literal["off", "on"]
+        :param retries: Try setting parameter for this amount of
+            times, defaults to 5
+        :type retries: int, optional
         :param timeout: Wait this amount of seconds for confirmation.
             As this method operates in the background without waiting,
             this value is used to determine failure when
             retrying and doesn't block, defaults to `None`
         :type timeout: float, optional
-        :param retries: Try setting parameter for this amount of
-            times, defaults to 5
-        :type retries: int, optional
         :return: `True` if parameter was successfully set, `False`
             otherwise.
         :rtype: bool
         """
-        self.create_task(self.set(name, value, timeout, retries))
+        self.create_task(self.set(name, value, retries, timeout))
 
     async def shutdown(self) -> None:
         """Cancel device tasks."""
@@ -116,22 +115,22 @@ class Device(ABC, EventManager):
         await self.wait_until_done()
 
 
-class AddressableDevice(Device, ABC):
-    """Represents an addressable device."""
+class PhysicalDevice(Device, ABC):
+    """Represents a physical device.
+
+    Physical device have network address and can have multiple
+    virtual devices associated with them via parent property.
+    """
 
     address: ClassVar[int]
     _network: NetworkInfo
-    _setup_frames: Iterable[DataFrameDescription]
+    _setup_frames: tuple[DataFrameDescription, ...]
 
     def __init__(self, queue: asyncio.Queue[Frame], network: NetworkInfo):
-        """Initialize a new addressable device."""
+        """Initialize a new physical device."""
         super().__init__(queue)
         self._network = network
 
-    def __int__(self) -> int:
-        """Return the device address."""
-        return int(self.address)
-
     def handle_frame(self, frame: Frame) -> None:
         """Handle frame received from the device."""
         frame.sender_device = self
@@ -176,19 +175,19 @@ class AddressableDevice(Device, ABC):
         raise ValueError(f'could not request "{name}"', frame_type)
 
     @classmethod
-    async def create(cls, device_type: int, **kwargs: Any) -> AddressableDevice:
-        """Create a device handler object."""
+    async def create(cls, device_type: int, **kwargs: Any) -> PhysicalDevice:
+        """Create a physical device handler object."""
         return await create_instance(get_device_handler(device_type), cls=cls, **kwargs)
 
 
-class SubDevice(Device, ABC):
-    """Represents a sub-device."""
+class VirtualDevice(Device, ABC):
+    """Represents a virtual device associated with physical device."""
 
-    parent: AddressableDevice
+    parent: PhysicalDevice
     index: int
 
     def __init__(
-        self, queue: asyncio.Queue[Frame], parent: AddressableDevice, index: int = 0
+        self, queue: asyncio.Queue[Frame], parent: PhysicalDevice, index: int = 0
     ):
         """Initialize a new sub-device."""
         super().__init__(queue)

{pyplumio-0.5.25 → pyplumio-0.5.26}/pyplumio/devices/ecomax.py

@@ -6,7 +6,7 @@ import asyncio
 from collections.abc import Coroutine, Generator, Iterable, Sequence
 import logging
 import time
-from typing import Any, ClassVar, Final
+from typing import Any, Final
 
 from pyplumio.const import (
     ATTR_FRAME_ERRORS,
@@ -17,7 +17,7 @@ from pyplumio.const import (
     DeviceType,
     FrameType,
 )
-from pyplumio.devices import AddressableDevice
+from pyplumio.devices import PhysicalDevice
 from pyplumio.devices.mixer import Mixer
 from pyplumio.devices.thermostat import Thermostat
 from pyplumio.filters import on_change
@@ -101,13 +101,14 @@ SETUP_FRAME_TYPES: tuple[DataFrameDescription, ...] = (
 _LOGGER = logging.getLogger(__name__)
 
 
-class EcoMAX(AddressableDevice):
+class EcoMAX(PhysicalDevice):
     """Represents an ecoMAX controller."""
 
-    address: ClassVar[int] = DeviceType.ECOMAX
-    _setup_frames: tuple[DataFrameDescription, ...] = SETUP_FRAME_TYPES
+    address = DeviceType.ECOMAX
+
     _frame_versions: dict[int, int]
     _fuel_burned_timestamp_ns: int
+    _setup_frames = SETUP_FRAME_TYPES
 
     def __init__(self, queue: asyncio.Queue[Frame], network: NetworkInfo):
         """Initialize a new ecoMAX controller."""
@@ -216,10 +217,7 @@ class EcoMAX(AddressableDevice):
                 yield self.dispatch(
                     description.name,
                     handler.create_or_update(
-                        device=self,
-                        description=description,
-                        values=values,
-                        index=index,
+                        device=self, description=description, values=values, index=index
                     ),
                 )
 
@@ -263,17 +261,16 @@ class EcoMAX(AddressableDevice):
         parameter's name and value. Events are dispatched for the
         respective mixer instance.
         """
-        if not parameters:
-            return False
-
-        await asyncio.gather(
-            *(
-                mixer.dispatch(ATTR_MIXER_PARAMETERS, parameters[mixer.index])
-                for mixer in self._mixers(indexes=parameters.keys())
+        if parameters:
+            await asyncio.gather(
+                *(
+                    mixer.dispatch(ATTR_MIXER_PARAMETERS, parameters[mixer.index])
+                    for mixer in self._mixers(indexes=parameters.keys())
+                )
             )
-        )
+            return True
 
-        return True
+        return False
 
     async def _handle_mixer_sensors(
         self, sensors: dict[int, dict[str, Any]] | None
@@ -284,17 +281,16 @@ class EcoMAX(AddressableDevice):
         sensor's name and value. Events are dispatched for the
         respective mixer instance.
         """
-        if not sensors:
-            return False
-
-        await asyncio.gather(
-            *(
-                mixer.dispatch(ATTR_MIXER_SENSORS, sensors[mixer.index])
-                for mixer in self._mixers(indexes=sensors.keys())
+        if sensors:
+            await asyncio.gather(
+                *(
+                    mixer.dispatch(ATTR_MIXER_SENSORS, sensors[mixer.index])
+                    for mixer in self._mixers(indexes=sensors.keys())
+                )
             )
-        )
+            return True
 
-        return True
+        return False
 
     async def _add_schedules(
         self, schedules: list[tuple[int, list[list[bool]]]]
@@ -332,10 +328,7 @@ class EcoMAX(AddressableDevice):
                 yield self.dispatch(
                     description.name,
                     handler.create_or_update(
-                        device=self,
-                        description=description,
-                        values=values,
-                        index=index,
+                        device=self, description=description, values=values, index=index
                     ),
                 )
 
@@ -376,29 +369,29 @@ class EcoMAX(AddressableDevice):
         parameter's name and value. Events are dispatched for the
         respective thermostat instance.
         """
-        if not parameters:
-            return False
-
-        await asyncio.gather(
-            *(
-                thermostat.dispatch(
-                    ATTR_THERMOSTAT_PARAMETERS, parameters[thermostat.index]
+        if parameters:
+            await asyncio.gather(
+                *(
+                    thermostat.dispatch(
+                        ATTR_THERMOSTAT_PARAMETERS, parameters[thermostat.index]
+                    )
+                    for thermostat in self._thermostats(indexes=parameters.keys())
                 )
-                for thermostat in self._thermostats(indexes=parameters.keys())
             )
-        )
-        return True
+            return True
+
+        return False
 
     async def _add_thermostat_profile_parameter(
         self, values: ParameterValues | None
     ) -> EcomaxNumber | None:
         """Add thermostat profile parameter to the dataset."""
-        if not values:
-            return None
+        if values:
+            return EcomaxNumber(
+                device=self, description=THERMOSTAT_PROFILE_PARAMETER, values=values
+            )
 
-        return EcomaxNumber(
-            device=self, description=THERMOSTAT_PROFILE_PARAMETER, values=values
-        )
+        return None
 
     async def _handle_thermostat_sensors(
         self, sensors: dict[int, dict[str, Any]] | None
@@ -409,18 +402,19 @@ class EcoMAX(AddressableDevice):
         sensor's name and value. Events are dispatched for the
         respective thermostat instance.
         """
-        if not sensors:
-            return False
-
-        await asyncio.gather(
-            *(
-                thermostat.dispatch(ATTR_THERMOSTAT_SENSORS, sensors[thermostat.index])
-                for thermostat in self._thermostats(indexes=sensors.keys())
-            ),
-            return_exceptions=True,
-        )
+        if sensors:
+            await asyncio.gather(
+                *(
+                    thermostat.dispatch(
+                        ATTR_THERMOSTAT_SENSORS, sensors[thermostat.index]
+                    )
+                    for thermostat in self._thermostats(indexes=sensors.keys())
+                ),
+                return_exceptions=True,
+            )
+            return True
 
-        return True
+        return False
 
     async def turn_on(self) -> bool:
         """Turn on the ecoMAX controller."""

pyplumio-0.5.26/pyplumio/devices/ecoster.py

@@ -0,0 +1,12 @@
+"""Contains an ecoSTER class."""
+
+from __future__ import annotations
+
+from pyplumio.const import DeviceType
+from pyplumio.devices import PhysicalDevice
+
+
+class EcoSTER(PhysicalDevice):
+    """Represents an ecoSTER thermostat."""
+
+    address = DeviceType.ECOSTER

{pyplumio-0.5.25 → pyplumio-0.5.26}/pyplumio/devices/mixer.py

@@ -7,7 +7,7 @@ from collections.abc import Coroutine, Generator, Sequence
 import logging
 from typing import TYPE_CHECKING, Any
 
-from pyplumio.devices import AddressableDevice, SubDevice
+from pyplumio.devices import PhysicalDevice, VirtualDevice
 from pyplumio.helpers.parameter import ParameterValues
 from pyplumio.structures.mixer_parameters import (
     ATTR_MIXER_PARAMETERS,
@@ -25,11 +25,11 @@ if TYPE_CHECKING:
 _LOGGER = logging.getLogger(__name__)
 
 
-class Mixer(SubDevice):
-    """Represents an mixer."""
+class Mixer(VirtualDevice):
+    """Represents a mixer."""
 
     def __init__(
-        self, queue: asyncio.Queue[Frame], parent: AddressableDevice, index: int = 0
+        self, queue: asyncio.Queue[Frame], parent: PhysicalDevice, index: int = 0
     ):
         """Initialize a new mixer."""
         super().__init__(queue, parent, index)
@@ -85,10 +85,7 @@ class Mixer(SubDevice):
                 yield self.dispatch(
                     description.name,
                     handler.create_or_update(
-                        device=self,
-                        description=description,
-                        values=values,
-                        index=index,
+                        device=self, description=description, values=values, index=index
                     ),
                 )
 

{pyplumio-0.5.25 → pyplumio-0.5.26}/pyplumio/devices/thermostat.py

@@ -6,7 +6,7 @@ import asyncio
 from collections.abc import Coroutine, Generator, Sequence
 from typing import TYPE_CHECKING, Any
 
-from pyplumio.devices import AddressableDevice, SubDevice
+from pyplumio.devices import PhysicalDevice, VirtualDevice
 from pyplumio.helpers.parameter import ParameterValues
 from pyplumio.structures.thermostat_parameters import (
     ATTR_THERMOSTAT_PARAMETERS,
@@ -21,11 +21,11 @@ if TYPE_CHECKING:
     from pyplumio.frames import Frame
 
 
-class Thermostat(SubDevice):
+class Thermostat(VirtualDevice):
     """Represents a thermostat."""
 
     def __init__(
-        self, queue: asyncio.Queue[Frame], parent: AddressableDevice, index: int = 0
+        self, queue: asyncio.Queue[Frame], parent: PhysicalDevice, index: int = 0
     ):
         """Initialize a new thermostat."""
         super().__init__(queue, parent, index)

{pyplumio-0.5.25 → pyplumio-0.5.26}/pyplumio/filters.py

@@ -150,7 +150,7 @@ def on_change(callback: Callback) -> _OnChange:
     previous call.
 
     :param callback: A callback function to be awaited on value change
-    :type callback: Callable[[Any], Coroutine[Any, Any, Any]]
+    :type callback: Callback
     :return: A instance of callable filter
     :rtype: _OnChange
     """
@@ -197,7 +197,7 @@ def debounce(callback: Callback, min_calls: int) -> _Debounce:
     across multiple filter calls.
 
     :param callback: A callback function to be awaited on value change
-    :type callback: Callable[[Any], Coroutine[Any, Any, Any]]
+    :type callback: Callback
     :param min_calls: Value shouldn't change for this amount of
         filter calls
     :type min_calls: int
@@ -244,7 +244,7 @@ def throttle(callback: Callback, seconds: float) -> _Throttle:
 
     :param callback: A callback function that will be awaited once
         filter conditions are fulfilled
-    :type callback: Callable[[Any], Coroutine[Any, Any, Any]]
+    :type callback: Callback
     :param seconds: A callback will be awaited at most once per
         this amount of seconds
     :type seconds: float
@@ -284,7 +284,7 @@ def delta(callback: Callback) -> _Delta:
 
     :param callback: A callback function that will be awaited with
         difference between values in two subsequent calls
-    :type callback: Callable[[Any], Coroutine[Any, Any, Any]]
+    :type callback: Callback
     :return: A instance of callable filter
     :rtype: _Delta
     """
@@ -336,7 +336,7 @@ def aggregate(callback: Callback, seconds: float) -> _Aggregate:
 
     :param callback: A callback function to be awaited once filter
         conditions are fulfilled
-    :type callback: Callable[[Any], Coroutine[Any, Any, Any]]
+    :type callback: Callback
     :param seconds: A callback will be awaited with a sum of values
         aggregated over this amount of seconds.
     :type seconds: float
@@ -378,7 +378,7 @@ def custom(callback: Callback, filter_fn: Callable[[Any], bool]) -> _Custom:
 
     :param callback: A callback function to be awaited when
         filter function return true
-    :type callback: Callable[[Any], Coroutine[Any, Any, Any]]
+    :type callback: Callback
     :param filter_fn: Filter function, that will be called with a
         value and should return `True` to await filter's callback
     :type filter_fn: Callable[[Any], bool]

{pyplumio-0.5.25 → pyplumio-0.5.26}/pyplumio/frames/__init__.py

@@ -26,7 +26,7 @@ ECONET_VERSION: Final = 5
 struct_header = struct.Struct("<BH4B")
 
 if TYPE_CHECKING:
-    from pyplumio.devices import AddressableDevice
+    from pyplumio.devices import PhysicalDevice
 
 
 def bcc(data: bytes) -> int:
@@ -65,6 +65,9 @@ class DataFrameDescription:
     provides: str
 
 
+FrameT = TypeVar("FrameT", bound="Frame")
+
+
 class Frame(ABC):
     """Represents a frame."""
 
@@ -80,9 +83,9 @@ class Frame(ABC):
     )
 
     recipient: DeviceType
-    recipient_device: AddressableDevice | None
+    recipient_device: PhysicalDevice | None
     sender: DeviceType
-    sender_device: AddressableDevice | None
+    sender_device: PhysicalDevice | None
     econet_type: int
     econet_version: int
     frame_type: ClassVar[FrameType]
@@ -234,9 +237,6 @@ class Frame(ABC):
         """Decode frame message."""
 
 
-FrameT = TypeVar("FrameT", bound=Frame)
-
-
 class Request(Frame):
     """Represents a request."""
 

{pyplumio-0.5.25 → pyplumio-0.5.26}/pyplumio/frames/messages.py

@@ -3,7 +3,7 @@
 from __future__ import annotations
 
 from contextlib import suppress
-from typing import Any, ClassVar
+from typing import Any
 
 from pyplumio.const import (
     ATTR_SENSORS,
@@ -37,7 +37,7 @@ class RegulatorDataMessage(Message):
 
     __slots__ = ()
 
-    frame_type: ClassVar[FrameType] = FrameType.MESSAGE_REGULATOR_DATA
+    frame_type = FrameType.MESSAGE_REGULATOR_DATA
 
     def decode_message(self, message: bytearray) -> dict[str, Any]:
         """Decode a frame message."""
@@ -49,7 +49,7 @@ class SensorDataMessage(Message):
 
     __slots__ = ()
 
-    frame_type: ClassVar[FrameType] = FrameType.MESSAGE_SENSOR_DATA
+    frame_type = FrameType.MESSAGE_SENSOR_DATA
 
     def decode_message(self, message: bytearray) -> dict[str, Any]:
         """Decode a frame message."""