PyPlumIO 0.5.22__tar.gz → 0.5.23__tar.gz

{pyplumio-0.5.22 → pyplumio-0.5.23}/.pre-commit-config.yaml

@@ -2,7 +2,7 @@
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.5.0
+    rev: v0.5.5
     hooks:
       - id: ruff
         args:
@@ -12,6 +12,6 @@ repos:
     hooks:
         - id: codespell
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.10.1
+    rev: v1.11.0
     hooks:
         - id: mypy

{pyplumio-0.5.22 → pyplumio-0.5.23}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyPlumIO
-Version: 0.5.22
+Version: 0.5.23
 Summary: PyPlumIO is a native ecoNET library for Plum ecoMAX controllers.
 Author-email: Denis Paavilainen <denpa@denpa.pro>
 License: MIT License
@@ -22,24 +22,26 @@ Classifier: Topic :: Home Automation
 Requires-Python: >=3.9
 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.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.10.1; extra == "test"
-Requires-Dist: pyserial-asyncio-fast==0.13; extra == "test"
-Requires-Dist: pytest==8.2.2; extra == "test"
-Requires-Dist: pytest-asyncio==0.23.7; extra == "test"
-Requires-Dist: ruff==0.5.2; extra == "test"
+Requires-Dist: mypy==1.11.1; 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"
 Provides-Extra: docs
-Requires-Dist: sphinx==7.4.0; extra == "docs"
+Requires-Dist: sphinx==7.4.7; extra == "docs"
 Requires-Dist: sphinx_rtd_theme==2.0.0; extra == "docs"
 Requires-Dist: readthedocs-sphinx-search==0.3.2; extra == "docs"
 Provides-Extra: dev
 Requires-Dist: pyplumio[docs,test]; extra == "dev"
-Requires-Dist: pre-commit==3.7.1; extra == "dev"
+Requires-Dist: pre-commit==3.8.0; extra == "dev"
 Requires-Dist: tomli==2.0.1; extra == "dev"
 
 # PyPlumIO is a native ecoNET library for Plum ecoMAX controllers.

{pyplumio-0.5.22 → pyplumio-0.5.23}/PyPlumIO.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyPlumIO
-Version: 0.5.22
+Version: 0.5.23
 Summary: PyPlumIO is a native ecoNET library for Plum ecoMAX controllers.
 Author-email: Denis Paavilainen <denpa@denpa.pro>
 License: MIT License
@@ -22,24 +22,26 @@ Classifier: Topic :: Home Automation
 Requires-Python: >=3.9
 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.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.10.1; extra == "test"
-Requires-Dist: pyserial-asyncio-fast==0.13; extra == "test"
-Requires-Dist: pytest==8.2.2; extra == "test"
-Requires-Dist: pytest-asyncio==0.23.7; extra == "test"
-Requires-Dist: ruff==0.5.2; extra == "test"
+Requires-Dist: mypy==1.11.1; 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"
 Provides-Extra: docs
-Requires-Dist: sphinx==7.4.0; extra == "docs"
+Requires-Dist: sphinx==7.4.7; extra == "docs"
 Requires-Dist: sphinx_rtd_theme==2.0.0; extra == "docs"
 Requires-Dist: readthedocs-sphinx-search==0.3.2; extra == "docs"
 Provides-Extra: dev
 Requires-Dist: pyplumio[docs,test]; extra == "dev"
-Requires-Dist: pre-commit==3.7.1; extra == "dev"
+Requires-Dist: pre-commit==3.8.0; extra == "dev"
 Requires-Dist: tomli==2.0.1; extra == "dev"
 
 # PyPlumIO is a native ecoNET library for Plum ecoMAX controllers.

{pyplumio-0.5.22 → pyplumio-0.5.23}/PyPlumIO.egg-info/requires.txt

@@ -1,22 +1,24 @@
+dataslots==1.2.0
 pyserial-asyncio==0.6
+typing-extensions==4.12.2
 
 [dev]
 pyplumio[docs,test]
-pre-commit==3.7.1
+pre-commit==3.8.0
 tomli==2.0.1
 
 [docs]
-sphinx==7.4.0
+sphinx==7.4.7
 sphinx_rtd_theme==2.0.0
 readthedocs-sphinx-search==0.3.2
 
 [test]
 codespell==2.3.0
 coverage==7.6.0
-mypy==1.10.1
-pyserial-asyncio-fast==0.13
-pytest==8.2.2
-pytest-asyncio==0.23.7
-ruff==0.5.2
+mypy==1.11.1
+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

{pyplumio-0.5.22 → pyplumio-0.5.23}/docs/source/writing.rst

@@ -32,45 +32,57 @@ Parameters
 ----------
 
 It's possible to get the ``Parameter`` object and then modify it using
-it's own setter methods. When using the parameter object, you don't
+it's own setter methods.
+
+.. autoclass:: pyplumio.helpers.parameter.Parameter
+
+When using the parameter object, you don't
 need to pass the parameter name.
 
-.. code-block:: python
+Numbers
+^^^^^^^
+
+Numbers are parameters that have numerical value associated with them.
 
-    from pyplumio.helpers.parameter import Parameter
+.. code-block:: python
 
+    from pyplumio.helpers.parameter import Number
 
     ecomax = await conn.get("ecomax")
-    heating_target: Parameter = ecomax.get("heating_target_temp")
+    heating_target: Number = ecomax.get("heating_target_temp")
     result = heating_target.set(65)
 
-Each parameter has a range of allowed values.
-PyPlumIO will raise ``ValueError`` if value is not within the
-acceptable range.
+Each number has a range of allowed values.
+PyPlumIO will raise ``ValueError`` if value isn't within acceptable
+range.
 
 You can check allowed range by reading ``min_value`` and ``max_value``
 properties of the parameter object. Both values are **inclusive**.
 
 .. code-block:: python
 
+    from pyplumio.helpers.parameter import Number
+
     ecomax = await connection.get("ecomax")
-    target_temp = await ecomax.get("heating_target_temp")
+    target_temp: Number = await ecomax.get("heating_target_temp")
     print(target_temp.min_value)  # Minimum allowed target temperature.
     print(target_temp.max_value)  # Maximum allowed target temperature.
 
-Binary Parameters
------------------
+Switches
+^^^^^^^^
 
-For binary parameters, you can also use boolean `True` or `False`,
+Switches are parameters that could only have two possible states: on or off.
+
+Thus, for switches, you can use boolean `True` or `False`,
 string literals "on" or "off" or special ``turn_on()`` and
 ``turn_off()`` methods.
 
-.. autofunction:: pyplumio.helpers.parameter.BinaryParameter.turn_on
-.. autofunction:: pyplumio.helpers.parameter.BinaryParameter.turn_on_nowait
-.. autofunction:: pyplumio.helpers.parameter.BinaryParameter.turn_off
-.. autofunction:: pyplumio.helpers.parameter.BinaryParameter.turn_off_nowait
+.. autofunction:: pyplumio.helpers.parameter.Switch.turn_on
+.. autofunction:: pyplumio.helpers.parameter.Switch.turn_on_nowait
+.. autofunction:: pyplumio.helpers.parameter.Switch.turn_off
+.. autofunction:: pyplumio.helpers.parameter.Switch.turn_off_nowait
 
-One such parameter is "ecomax_control" that allows you to switch
+One such switch is "ecomax_control" that allows you to switch
 the ecoMAX on or off.
 
 .. code-block:: python
@@ -83,12 +95,14 @@ object.
 
 .. code-block:: python
 
+    from pyplumio.helpers.parameter import Switch
+
     # Get an ecomax_control parameter and turn it on.
-    ecomax_control = await ecomax.get("ecomax_control")
+    ecomax_control: Switch = await ecomax.get("ecomax_control")
     result = await ecomax_control.turn_on()
 
-If you simply want to turn on or off the ecoMAX controller there's,
-handy shortcut built-in the controller object itself.
+If you simply want to turn on or off the ecoMAX controller itself,
+there's a handy shortcut built in the controller handler.
 
 .. code-block:: python
     

{pyplumio-0.5.22 → pyplumio-0.5.23}/pyplumio/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.5.22'
-__version_tuple__ = version_tuple = (0, 5, 22)
+__version__ = version = '0.5.23'
+__version_tuple__ = version_tuple = (0, 5, 23)

{pyplumio-0.5.22 → pyplumio-0.5.23}/pyplumio/connection.py

@@ -4,7 +4,6 @@ from __future__ import annotations
 
 from abc import ABC, abstractmethod
 import asyncio
-from collections.abc import MutableMapping
 import logging
 from typing import Any, Final, cast
 
@@ -36,7 +35,7 @@ class Connection(ABC, TaskManager):
 
     _protocol: Protocol
     _reconnect_on_failure: bool
-    _kwargs: MutableMapping[str, Any]
+    _kwargs: dict[str, Any]
 
     def __init__(
         self,

{pyplumio-0.5.22 → pyplumio-0.5.23}/pyplumio/devices/__init__.py

@@ -63,7 +63,7 @@ class Device(ABC, EventManager):
         :param name: Name of the parameter
         :type name: str
         :param value: New value for the parameter
-        :type value: int | float | bool | Literal["on"] | Literal["off"]
+        :type value: int | float | bool | Literal["off", "on"]
         :param timeout: Wait this amount of seconds for confirmation,
             defaults to `None`
         :type timeout: float, optional
@@ -95,7 +95,7 @@ class Device(ABC, EventManager):
         :param name: Name of the parameter
         :type name: str
         :param value: New value for the parameter
-        :type value: int | float | bool | Literal["on"] | Literal["off"]
+        :type value: int | float | bool | Literal["off", "on"]
         :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

{pyplumio-0.5.22 → pyplumio-0.5.23}/pyplumio/devices/ecomax.py

@@ -31,9 +31,9 @@ from pyplumio.structures.ecomax_parameters import (
     ECOMAX_CONTROL_PARAMETER,
     ECOMAX_PARAMETERS,
     THERMOSTAT_PROFILE_PARAMETER,
-    EcomaxBinaryParameter,
-    EcomaxBinaryParameterDescription,
-    EcomaxParameter,
+    EcomaxNumber,
+    EcomaxSwitch,
+    EcomaxSwitchDescription,
 )
 from pyplumio.structures.frame_versions import ATTR_FRAME_VERSIONS
 from pyplumio.structures.fuel_consumption import ATTR_FUEL_CONSUMPTION
@@ -47,9 +47,9 @@ from pyplumio.structures.schedules import (
     ATTR_SCHEDULES,
     SCHEDULE_PARAMETERS,
     SCHEDULES,
-    ScheduleBinaryParameter,
-    ScheduleBinaryParameterDescription,
-    ScheduleParameter,
+    ScheduleNumber,
+    ScheduleSwitch,
+    ScheduleSwitchDescription,
 )
 from pyplumio.structures.thermostat_parameters import (
     ATTR_THERMOSTAT_PARAMETERS,
@@ -209,9 +209,9 @@ class EcoMAX(AddressableDevice):
                     )
 
                 handler = (
-                    EcomaxBinaryParameter
-                    if isinstance(description, EcomaxBinaryParameterDescription)
-                    else EcomaxParameter
+                    EcomaxSwitch
+                    if isinstance(description, EcomaxSwitchDescription)
+                    else EcomaxNumber
                 )
                 yield self.dispatch(
                     description.name,
@@ -325,9 +325,9 @@ class EcoMAX(AddressableDevice):
             for index, values in parameters:
                 description = SCHEDULE_PARAMETERS[index]
                 handler = (
-                    ScheduleBinaryParameter
-                    if isinstance(description, ScheduleBinaryParameterDescription)
-                    else ScheduleParameter
+                    ScheduleSwitch
+                    if isinstance(description, ScheduleSwitchDescription)
+                    else ScheduleNumber
                 )
                 yield self.dispatch(
                     description.name,
@@ -357,7 +357,7 @@ class EcoMAX(AddressableDevice):
         """Create ecoMAX control parameter instance and dispatch an event."""
         await self.dispatch(
             ECOMAX_CONTROL_PARAMETER.name,
-            EcomaxBinaryParameter.create_or_update(
+            EcomaxSwitch.create_or_update(
                 description=ECOMAX_CONTROL_PARAMETER,
                 device=self,
                 values=ParameterValues(
@@ -391,12 +391,12 @@ class EcoMAX(AddressableDevice):
 
     async def _add_thermostat_profile_parameter(
         self, values: ParameterValues | None
-    ) -> EcomaxParameter | None:
+    ) -> EcomaxNumber | None:
         """Add thermostat profile parameter to the dataset."""
         if not values:
             return None
 
-        return EcomaxParameter(
+        return EcomaxNumber(
             device=self, description=THERMOSTAT_PROFILE_PARAMETER, values=values
         )
 
@@ -425,7 +425,7 @@ class EcoMAX(AddressableDevice):
     async def turn_on(self) -> bool:
         """Turn on the ecoMAX controller."""
         try:
-            ecomax_control: EcomaxBinaryParameter = self.data[ATTR_ECOMAX_CONTROL]
+            ecomax_control: EcomaxSwitch = self.data[ATTR_ECOMAX_CONTROL]
             return await ecomax_control.turn_on()
         except KeyError:
             _LOGGER.error("ecoMAX control isn't available, please try later")
@@ -434,7 +434,7 @@ class EcoMAX(AddressableDevice):
     async def turn_off(self) -> bool:
         """Turn off the ecoMAX controller."""
         try:
-            ecomax_control: EcomaxBinaryParameter = self.data[ATTR_ECOMAX_CONTROL]
+            ecomax_control: EcomaxSwitch = self.data[ATTR_ECOMAX_CONTROL]
             return await ecomax_control.turn_off()
         except KeyError:
             _LOGGER.error("ecoMAX control isn't available, please try later")

{pyplumio-0.5.22 → pyplumio-0.5.23}/pyplumio/devices/mixer.py

@@ -12,9 +12,9 @@ from pyplumio.helpers.parameter import ParameterValues
 from pyplumio.structures.mixer_parameters import (
     ATTR_MIXER_PARAMETERS,
     MIXER_PARAMETERS,
-    MixerBinaryParameter,
-    MixerBinaryParameterDescription,
-    MixerParameter,
+    MixerNumber,
+    MixerSwitch,
+    MixerSwitchDescription,
 )
 from pyplumio.structures.mixer_sensors import ATTR_MIXER_SENSORS
 from pyplumio.structures.product_info import ATTR_PRODUCT, ProductInfo
@@ -78,9 +78,9 @@ class Mixer(SubDevice):
                     return
 
                 handler = (
-                    MixerBinaryParameter
-                    if isinstance(description, MixerBinaryParameterDescription)
-                    else MixerParameter
+                    MixerSwitch
+                    if isinstance(description, MixerSwitchDescription)
+                    else MixerNumber
                 )
                 yield self.dispatch(
                     description.name,

{pyplumio-0.5.22 → pyplumio-0.5.23}/pyplumio/devices/thermostat.py

@@ -11,9 +11,9 @@ from pyplumio.helpers.parameter import ParameterValues
 from pyplumio.structures.thermostat_parameters import (
     ATTR_THERMOSTAT_PARAMETERS,
     THERMOSTAT_PARAMETERS,
-    ThermostatBinaryParameter,
-    ThermostatBinaryParameterDescription,
-    ThermostatParameter,
+    ThermostatNumber,
+    ThermostatSwitch,
+    ThermostatSwitchDescription,
 )
 from pyplumio.structures.thermostat_sensors import ATTR_THERMOSTAT_SENSORS
 
@@ -57,9 +57,9 @@ class Thermostat(SubDevice):
             for index, values in parameters:
                 description = THERMOSTAT_PARAMETERS[index]
                 handler = (
-                    ThermostatBinaryParameter
-                    if isinstance(description, ThermostatBinaryParameterDescription)
-                    else ThermostatParameter
+                    ThermostatSwitch
+                    if isinstance(description, ThermostatSwitchDescription)
+                    else ThermostatNumber
                 )
                 yield self.dispatch(
                     description.name,

{pyplumio-0.5.22 → pyplumio-0.5.23}/pyplumio/helpers/event_manager.py

@@ -4,20 +4,23 @@ from __future__ import annotations
 
 import asyncio
 from collections.abc import Callable, Coroutine
-from typing import Any, TypeVar
+from typing import Any, Generic, TypeVar, overload
+
+from typing_extensions import TypeAlias
 
 from pyplumio.helpers.task_manager import TaskManager
 
-Callback = Callable[[Any], Coroutine[Any, Any, Any]]
+Callback: TypeAlias = Callable[[Any], Coroutine[Any, Any, Any]]
 CallbackT = TypeVar("CallbackT", bound=Callback)
+T = TypeVar("T")
 
 
-class EventManager(TaskManager):
+class EventManager(TaskManager, Generic[T]):
     """Represents an event manager."""
 
     __slots__ = ("data", "_events", "_callbacks")
 
-    data: dict[str, Any]
+    data: dict[str, T]
     _events: dict[str, asyncio.Event]
     _callbacks: dict[str, list[Callback]]
 
@@ -28,7 +31,7 @@ class EventManager(TaskManager):
         self._events = {}
         self._callbacks = {}
 
-    def __getattr__(self, name: str) -> Any:
+    def __getattr__(self, name: str) -> T:
         """Return attributes from the underlying data dictionary."""
         try:
             return self.data[name]
@@ -48,7 +51,7 @@ class EventManager(TaskManager):
         if name not in self.data:
             await asyncio.wait_for(self.create_event(name).wait(), timeout=timeout)
 
-    async def get(self, name: str, timeout: float | None = None) -> Any:
+    async def get(self, name: str, timeout: float | None = None) -> T:
         """Get the value by name.
 
         :param name: Event name or ID
@@ -62,6 +65,12 @@ class EventManager(TaskManager):
         await self.wait_for(name, timeout=timeout)
         return self.data[name]
 
+    @overload
+    def get_nowait(self, name: str, default: None = ...) -> T | None: ...
+
+    @overload
+    def get_nowait(self, name: str, default: T) -> T: ...
+
     def get_nowait(self, name: str, default: Any = None) -> Any:
         """Get the value by name without waiting.
 
@@ -136,7 +145,7 @@ class EventManager(TaskManager):
 
         return False
 
-    async def dispatch(self, name: str, value: Any) -> None:
+    async def dispatch(self, name: str, value: T) -> None:
         """Call registered callbacks and dispatch the event."""
         if callbacks := self._callbacks.get(name, None):
             for callback in list(callbacks):
@@ -146,17 +155,17 @@ class EventManager(TaskManager):
         self.data[name] = value
         self.set_event(name)
 
-    def dispatch_nowait(self, name: str, value: Any) -> None:
+    def dispatch_nowait(self, name: str, value: T) -> None:
         """Call a registered callbacks and dispatch the event without waiting."""
         self.create_task(self.dispatch(name, value))
 
-    async def load(self, data: dict[str, Any]) -> None:
+    async def load(self, data: dict[str, T]) -> None:
         """Load event data."""
         await asyncio.gather(
             *(self.dispatch(name, value) for name, value in data.items())
         )
 
-    def load_nowait(self, data: dict[str, Any]) -> None:
+    def load_nowait(self, data: dict[str, T]) -> None:
         """Load event data without waiting."""
         self.create_task(self.load(data))