PyPlumIO 0.5.30__py3-none-any.whl → 0.5.31__py3-none-any.whl

{PyPlumIO-0.5.30.dist-info → PyPlumIO-0.5.31.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: PyPlumIO
-Version: 0.5.30
+Version: 0.5.31
 Summary: PyPlumIO is a native ecoNET library for Plum ecoMAX controllers.
 Author-email: Denis Paavilainen <denpa@denpa.pro>
 License: MIT License
@@ -17,6 +17,7 @@ Classifier: Programming Language :: Python :: 3.9
 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
 Classifier: Topic :: Home Automation
 Requires-Python: >=3.9
@@ -27,14 +28,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.8; extra == "test"
-Requires-Dist: mypy==1.13.0; extra == "test"
+Requires-Dist: coverage==7.6.10; extra == "test"
+Requires-Dist: mypy==1.14.1; extra == "test"
 Requires-Dist: pyserial-asyncio-fast==0.14; extra == "test"
 Requires-Dist: pytest==8.3.4; extra == "test"
-Requires-Dist: pytest-asyncio==0.24.0; extra == "test"
-Requires-Dist: ruff==0.8.1; extra == "test"
+Requires-Dist: pytest-asyncio==0.25.2; extra == "test"
+Requires-Dist: ruff==0.9.2; extra == "test"
 Requires-Dist: tox==4.23.2; extra == "test"
-Requires-Dist: types-pyserial==3.5.0.20240826; extra == "test"
+Requires-Dist: types-pyserial==3.5.0.20241221; extra == "test"
 Provides-Extra: docs
 Requires-Dist: sphinx==8.1.3; extra == "docs"
 Requires-Dist: sphinx_rtd_theme==3.0.2; extra == "docs"

{PyPlumIO-0.5.30.dist-info → PyPlumIO-0.5.31.dist-info}/RECORD

@@ -1,15 +1,15 @@
 pyplumio/__init__.py,sha256=ditJTIOFGJDg60atHzOpiggdUrZHpSynno7MtpZUGVk,3299
 pyplumio/__main__.py,sha256=3IwHHSq-iay5FaeMc95klobe-xv82yydSKcBE7BFZ6M,500
-pyplumio/_version.py,sha256=PRcySwknPDLJzIxasFyVZNYI8LFj_28fjnJMHK2q0Ko,413
+pyplumio/_version.py,sha256=Kr7Tq9KjyxEp8tm444HGzXvFWTTLR8xyIJ5ABXwwKGA,413
 pyplumio/connection.py,sha256=6mUbcjGxxEhMVIbzZgCqH-Ez-fcYoRj7ZbVSzpikpNA,5949
 pyplumio/const.py,sha256=LyXa5aVy2KxnZq7H7F8s5SYsAgEC2UzZYMMRauliB2E,5502
 pyplumio/exceptions.py,sha256=Wn-y5AJ5xfaBlHhTUVKB27_0Us8_OVHqh-sicnr9sYA,700
-pyplumio/filters.py,sha256=KK_AV_EHy5gj9s9BNZbn9i0RnT3uZsdEg6gdve1WYrY,11152
+pyplumio/filters.py,sha256=AMW1zHQ1YjJfHX7e87Dhv7AGixJ3y9Vn-_JAQn7vIsg,12526
 pyplumio/protocol.py,sha256=VRxrj8vZ1FMawqblKkyxg_V61TBSvVynd9u0JXYnMUU,8090
 pyplumio/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pyplumio/stream.py,sha256=mtMpnUR3TfEmL5JUGXr6GnpPGBwzCokqIKDWp4vYiVg,4654
 pyplumio/utils.py,sha256=TnBzRopinyp92wruguijxcIYmaeyNVTFX0dygI5FCMU,823
-pyplumio/devices/__init__.py,sha256=YN09bGsyJ5WVmF8_-veUckqUl57eBwmfNr8M5qhyqy0,8149
+pyplumio/devices/__init__.py,sha256=BEUpL2XxEk4YDfp4w0VX_LI4JQwK27eGWoJ6al_e1nE,8038
 pyplumio/devices/ecomax.py,sha256=ybFLJN7O3unBcyzuVmYTssBv86bPiiTGvFpFJezwUE4,15478
 pyplumio/devices/ecoster.py,sha256=jNWli7ye9T6yfkcFJZhhUHH7KOv-L6AgYFp_dKyv3OM,263
 pyplumio/devices/mixer.py,sha256=CnHWrJELtFgs2YTHGpQwKr2UTRdetX76OvLBA2PH-fs,3207
@@ -22,7 +22,7 @@ pyplumio/helpers/__init__.py,sha256=H2xxdkF-9uADLwEbfBUoxNTdwru3L5Z2cfJjgsuRsn0,
 pyplumio/helpers/data_types.py,sha256=nB3afOLmppgSCWkZoX1-1yWPNMMNSem77x7XQ1Mi8H8,9103
 pyplumio/helpers/event_manager.py,sha256=xQOfiP_nP1Pz5zhB6HU5gXyyJXjhisYshL8_HRxDgt8,6412
 pyplumio/helpers/factory.py,sha256=6ArzJDq3MiiMaRpMEP0kC6wJWsoqOqe32V1RCxg1478,1005
-pyplumio/helpers/parameter.py,sha256=yO3KSX8FtU-dMe5FzNW-RXs5yW-lYu2F5Po-4ghcSnM,12533
+pyplumio/helpers/parameter.py,sha256=hOGYkhd7-MG1euNdbHYN_2vXFlWPi-XLy_yAotYSyck,12311
 pyplumio/helpers/schedule.py,sha256=PnVEkgthg6tHpHvZK9fXJz9VKNDyQ_7BFT4TTVEwNhI,5310
 pyplumio/helpers/task_manager.py,sha256=HAd69yGTRL0zQsu-ywnbLu1UXiJzgHWuhYWA--vs4lQ,1181
 pyplumio/helpers/timeout.py,sha256=JAhWNtIpcXyVILIwHWVy5mYofqbbRDGKLdTUKkQuajs,772
@@ -31,13 +31,13 @@ pyplumio/structures/__init__.py,sha256=EjK-5qJZ0F7lpP2b6epvTMg9cIBl4Kn91nqNkEcLw
 pyplumio/structures/alerts.py,sha256=8ievMl5_tUBlnTLCiZoIloucIngCcoAYy6uI9sSXrt0,3664
 pyplumio/structures/boiler_load.py,sha256=p3mOzZUU-g7A2tG_yp8podEqpI81hlsOZmHELyPNRY8,838
 pyplumio/structures/boiler_power.py,sha256=72qsvccg49FdRdXv2f2K5sGpjT7wAOLFjlIGWpO-DVg,901
-pyplumio/structures/ecomax_parameters.py,sha256=ki9YSzVRhCD_rYHFogJoyk0NwyNlWdZrHcp-rrCuKCU,28440
+pyplumio/structures/ecomax_parameters.py,sha256=wLwhTdKee-UtCU5NuRfOHRPvnjDOtDNUDeUgeO0VH8w,27974
 pyplumio/structures/fan_power.py,sha256=Q5fv-7_2NVuLeQPIVIylvgN7M8-a9D8rRUE0QGjyS3w,871
 pyplumio/structures/frame_versions.py,sha256=hbcVuhuPNy5qd39Vk7w4WdPCW-TNx1cAYWzA2mXocyk,1548
 pyplumio/structures/fuel_consumption.py,sha256=_p2dI4H67Eopn7IF0Gj77A8c_8lNKhhDDAtmugxLd4s,976
 pyplumio/structures/fuel_level.py,sha256=mJpp1dnRD1wXi_6EyNX7TNXosjcr905rSHOnuZ5VD74,1069
 pyplumio/structures/lambda_sensor.py,sha256=JNSCiBJoM8Uk3OGbmFIigaLOntQST5U_UrmCpaQBlM0,1595
-pyplumio/structures/mixer_parameters.py,sha256=S_YOigzM9TsdEjk5EluME5fJ8owO84-xOFT9tTdBgEo,9553
+pyplumio/structures/mixer_parameters.py,sha256=idF3tYukfAz1EM1CE-hZBjjmGrNZN6X1MlcZr3FHrzA,9089
 pyplumio/structures/mixer_sensors.py,sha256=-cN7U-Fr2fmAQ5McQL7bZUC8CFlb1y8TN0f_dqy3UK0,2312
 pyplumio/structures/modules.py,sha256=oXUIqrOAV1dZzBV5zUH3HDUSFvNOjpUSx0TF9nZVnbs,2569
 pyplumio/structures/network_info.py,sha256=kPxmIaDGm5SyLRKVFzcrODlUtB0u5JjiZqekoKSyDpA,4159
@@ -48,13 +48,13 @@ pyplumio/structures/product_info.py,sha256=uiEN6DFQlzmBvQByTirFzXQShoex0YGdFS9WI
 pyplumio/structures/program_version.py,sha256=R-medELYHDlk_ALsw5HOVbZRb7JD3yBUsGwqwVCjrkU,2550
 pyplumio/structures/regulator_data.py,sha256=z2mSE-cxImn8YRr_yZCcDlIbXnKdETkN7GigV5vEJqA,2265
 pyplumio/structures/regulator_data_schema.py,sha256=XM6M9ep3NyogbLPqp88mMTg8Sa9e5SFzV5I5pSYw5GY,1487
-pyplumio/structures/schedules.py,sha256=rKPWC5qcKAh6xxs91oY23NqQcWby8e3gXrD6qJAVDGo,7153
+pyplumio/structures/schedules.py,sha256=_D8HmxMVvAAPb0cc_xSxXFRNwR9u-RWuyTy0Z5KscUk,6717
 pyplumio/structures/statuses.py,sha256=wkoynyMRr1VREwfBC6vU48kPA8ZQ83pcXuciy2xHJrk,1166
 pyplumio/structures/temperatures.py,sha256=1CDzehNmbALz1Jyt_9gZNIk52q6Wv-xQXjijVDCVYec,2337
-pyplumio/structures/thermostat_parameters.py,sha256=6r8_EU9T1IJ0vzZMduiLzsAaaWr6cKW_zHHAGsfGZI4,8804
+pyplumio/structures/thermostat_parameters.py,sha256=QA-ZyulBG3P10sqgdI7rmpQYlKm9SJIXxBxAXs8Bwow,8295
 pyplumio/structures/thermostat_sensors.py,sha256=8e1TxYIJTQKT0kIGO9gG4hGdLOBUpIhiPToQyOMyeNE,3237
-PyPlumIO-0.5.30.dist-info/LICENSE,sha256=m-UuZFjXJ22uPTGm9kSHS8bqjsf5T8k2wL9bJn1Y04o,1088
-PyPlumIO-0.5.30.dist-info/METADATA,sha256=KMMtx2B4gTlnFBoLVzVHGs75Od9qf6BN1tH3pqeYgqM,5458
-PyPlumIO-0.5.30.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-PyPlumIO-0.5.30.dist-info/top_level.txt,sha256=kNBz9UPPkPD9teDn3U_sEy5LjzwLm9KfADCXtBlbw8A,9
-PyPlumIO-0.5.30.dist-info/RECORD,,
+PyPlumIO-0.5.31.dist-info/LICENSE,sha256=m-UuZFjXJ22uPTGm9kSHS8bqjsf5T8k2wL9bJn1Y04o,1088
+PyPlumIO-0.5.31.dist-info/METADATA,sha256=thPWL1GWRLLFkIdMOBz4CUN4LZmGxEA_BvvWYKjR-xA,5510
+PyPlumIO-0.5.31.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+PyPlumIO-0.5.31.dist-info/top_level.txt,sha256=kNBz9UPPkPD9teDn3U_sEy5LjzwLm9KfADCXtBlbw8A,9
+PyPlumIO-0.5.31.dist-info/RECORD,,

{PyPlumIO-0.5.30.dist-info → PyPlumIO-0.5.31.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.6.0)
+Generator: setuptools (75.8.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

pyplumio/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.5.30'
-__version_tuple__ = version_tuple = (0, 5, 30)
+__version__ = version = '0.5.31'
+__version_tuple__ = version_tuple = (0, 5, 31)

pyplumio/devices/__init__.py

@@ -107,9 +107,6 @@ class Device(ABC, EventManager):
             this value is used to determine failure when
             retrying and doesn't block, defaults to `None`
         :type timeout: float, optional
-        :return: `True` if parameter was successfully set, `False`
-            otherwise.
-        :rtype: bool
         """
         self.create_task(self.set(name, value, retries, timeout))
 

pyplumio/filters.py

@@ -125,6 +125,52 @@ class Filter(ABC):
         """Set a new value for the callback."""
 
 
+class _Clamp(Filter):
+    """Represents a clamp filter.
+
+    Calls callback with a value clamped between specified boundaries.
+    """
+
+    __slots__ = ("_min_value", "_max_value")
+
+    _min_value: float
+    _max_value: float
+
+    def __init__(self, callback: Callback, min_value: float, max_value: float) -> None:
+        """Initialize a new clamp filter."""
+        super().__init__(callback)
+        self._min_value = min_value
+        self._max_value = max_value
+
+    async def __call__(self, new_value: Any) -> Any:
+        """Set a new value for the callback."""
+        if new_value < self._min_value:
+            return await self._callback(self._min_value)
+
+        if new_value > self._max_value:
+            return await self._callback(self._max_value)
+
+        return await self._callback(new_value)
+
+
+def clamp(callback: Callback, min_value: float, max_value: float) -> _Clamp:
+    """Return a clamp filter.
+
+    A callback function will be called with value clamped between
+    specified boundaries.
+
+    :param callback: A callback function to be awaited on new value
+    :type callback: Callback
+    :param min_value: A lower boundary
+    :type min_value: float
+    :param max_value: An upper boundary
+    :type max_value: float
+    :return: An instance of callable filter
+    :rtype: _Clamp
+    """
+    return _Clamp(callback, min_value, max_value)
+
+
 class _OnChange(Filter):
     """Represents a value changed filter.
 
@@ -151,7 +197,7 @@ def on_change(callback: Callback) -> _OnChange:
 
     :param callback: A callback function to be awaited on value change
     :type callback: Callback
-    :return: A instance of callable filter
+    :return: An instance of callable filter
     :rtype: _OnChange
     """
     return _OnChange(callback)
@@ -201,7 +247,7 @@ def debounce(callback: Callback, min_calls: int) -> _Debounce:
     :param min_calls: Value shouldn't change for this amount of
         filter calls
     :type min_calls: int
-    :return: A instance of callable filter
+    :return: An instance of callable filter
     :rtype: _Debounce
     """
     return _Debounce(callback, min_calls)
@@ -248,7 +294,7 @@ def throttle(callback: Callback, seconds: float) -> _Throttle:
     :param seconds: A callback will be awaited at most once per
         this amount of seconds
     :type seconds: float
-    :return: A instance of callable filter
+    :return: An instance of callable filter
     :rtype: _Throttle
     """
     return _Throttle(callback, seconds)
@@ -285,7 +331,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: Callback
-    :return: A instance of callable filter
+    :return: An instance of callable filter
     :rtype: _Delta
     """
     return _Delta(callback)
@@ -340,7 +386,7 @@ def aggregate(callback: Callback, seconds: float) -> _Aggregate:
     :param seconds: A callback will be awaited with a sum of values
         aggregated over this amount of seconds.
     :type seconds: float
-    :return: A instance of callable filter
+    :return: An instance of callable filter
     :rtype: _Aggregate
     """
     return _Aggregate(callback, seconds)
@@ -382,7 +428,7 @@ def custom(callback: Callback, filter_fn: Callable[[Any], bool]) -> _Custom:
     :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]
-    :return: A instance of callable filter
+    :return: An instance of callable filter
     :rtype: _Custom
     """
     return _Custom(callback, filter_fn)

pyplumio/helpers/parameter.py

@@ -184,16 +184,31 @@ 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:
-        """Set a parameter value."""
-        if (value := _normalize_parameter_value(value)) == self.values.value:
-            return True
+    def validate(self, value: ParameterValue) -> int:
+        """Validate a parameter value."""
+        value = _normalize_parameter_value(value)
+        if value == self.values.value:
+            raise ValueError("Parameter value is unchanged.")
 
         if value < self.values.min_value or value > self.values.max_value:
             raise ValueError(
                 f"Value must be between '{self.min_value}' and '{self.max_value}'"
             )
 
+        return value
+
+    async def set(self, value: Any, retries: int = 5, timeout: float = 5.0) -> bool:
+        """Set a parameter value."""
+        return await self._try_set(self.validate(value), retries, timeout)
+
+    def set_nowait(self, value: Any, retries: int = 5, timeout: float = 5.0) -> None:
+        """Set a parameter value without waiting."""
+        self.device.create_task(self._try_set(self.validate(value), retries, timeout))
+
+    async def _try_set(
+        self, value: Any, retries: int = 5, timeout: float = 5.0
+    ) -> bool:
+        """Try to set a parameter value."""
         self._previous_value = self._values.value
         self._values.value = value
         self._pending_update = True
@@ -206,9 +221,6 @@ class Parameter(ABC):
                 return False
 
             await self.device.queue.put(await self.create_request())
-            if not self.is_tracking_changes:
-                await self.force_refresh()
-
             await asyncio.sleep(timeout)
             retries -= 1
 
@@ -221,15 +233,6 @@ class Parameter(ABC):
 
         self._values = values
 
-    async def force_refresh(self) -> None:
-        """Refresh the parameter from remote."""
-        await self.device.queue.put(await self.create_refresh_request())
-
-    @property
-    def is_tracking_changes(self) -> bool:
-        """Return True if remote's tracking changes, False otherwise."""
-        return False
-
     @property
     def pending_update(self) -> bool:
         """Check if parameter is pending update on the device."""
@@ -278,10 +281,6 @@ class Parameter(ABC):
     async def create_request(self) -> Request:
         """Create a request to change the parameter."""
 
-    @abstractmethod
-    async def create_refresh_request(self) -> Request:
-        """Create a request to refresh the parameter."""
-
 
 @dataslots
 @dataclass
@@ -308,16 +307,12 @@ class Number(Parameter):
         self, value: int | float, retries: int = 5, timeout: float = 5.0
     ) -> None:
         """Set a parameter value without waiting."""
-        self.device.create_task(self.set(value, retries, timeout))
+        super().set_nowait(value, retries, timeout)
 
     async def create_request(self) -> Request:
         """Create a request to change the number."""
         return Request()
 
-    async def create_refresh_request(self) -> Request:
-        """Create a request to refresh the number."""
-        return Request()
-
     @property
     def value(self) -> int | float:
         """Return the value."""
@@ -362,7 +357,7 @@ class Switch(Parameter):
         self, value: bool | Literal["off", "on"], retries: int = 5, timeout: float = 5.0
     ) -> None:
         """Set a switch value without waiting."""
-        self.device.create_task(self.set(value, retries, timeout))
+        super().set_nowait(value, retries, timeout)
 
     async def turn_on(self) -> bool:
         """Set a switch value to 'on'.
@@ -394,10 +389,6 @@ class Switch(Parameter):
         """Create a request to change the switch."""
         return Request()
 
-    async def create_refresh_request(self) -> Request:
-        """Create a request to refresh the switch."""
-        return Request()
-
     @property
     def value(self) -> Literal["off", "on"]:
         """Return the value."""

pyplumio/structures/ecomax_parameters.py

@@ -83,17 +83,6 @@ class EcomaxParameter(Parameter):
             data={ATTR_INDEX: self._index, ATTR_VALUE: self.values.value},
         )
 
-    async def create_refresh_request(self) -> Request:
-        """Create a request to refresh the parameter."""
-        return await Request.create(
-            FrameType.REQUEST_ECOMAX_PARAMETERS, recipient=self.device.address
-        )
-
-    @property
-    def is_tracking_changes(self) -> bool:
-        """Return True if remote's tracking changes, False otherwise."""
-        return self.device.has_frame_version(FrameType.REQUEST_ECOMAX_PARAMETERS)
-
 
 @dataslots
 @dataclass
@@ -479,8 +468,8 @@ ECOMAX_PARAMETERS: dict[ProductType, tuple[EcomaxParameterDescription, ...]] = {
         ),
         EcomaxNumberDescription(
             name="max_fuel_flow",
-            multiplier=0.1,
-            unit_of_measurement=UnitOfMeasurement.KILOGRAMS_PER_HOUR,
+            multiplier=20,
+            unit_of_measurement=UnitOfMeasurement.GRAMS,
         ),
         EcomaxNumberDescription(
             name="feeder_calibration",

pyplumio/structures/mixer_parameters.py

@@ -65,17 +65,6 @@ class MixerParameter(Parameter):
             },
         )
 
-    async def create_refresh_request(self) -> Request:
-        """Create a request to refresh the parameter."""
-        return await Request.create(
-            FrameType.REQUEST_MIXER_PARAMETERS, recipient=self.device.parent.address
-        )
-
-    @property
-    def is_tracking_changes(self) -> bool:
-        """Return True if remote's tracking changes, False otherwise."""
-        return self.device.parent.has_frame_version(FrameType.REQUEST_MIXER_PARAMETERS)
-
 
 @dataslots
 @dataclass

pyplumio/structures/schedules.py

@@ -107,17 +107,6 @@ class ScheduleParameter(Parameter):
             data=collect_schedule_data(schedule_name, self.device),
         )
 
-    async def create_refresh_request(self) -> Request:
-        """Create a request to refresh the parameter."""
-        return await Request.create(
-            FrameType.REQUEST_SCHEDULES, recipient=self.device.address
-        )
-
-    @property
-    def is_tracking_changes(self) -> bool:
-        """Return True if remote's tracking changes, False otherwise."""
-        return self.device.has_frame_version(FrameType.REQUEST_SCHEDULES)
-
 
 @dataslots
 @dataclass

pyplumio/structures/thermostat_parameters.py

@@ -86,20 +86,6 @@ class ThermostatParameter(Parameter):
             },
         )
 
-    async def create_refresh_request(self) -> Request:
-        """Create a request to refresh the parameter."""
-        return await Request.create(
-            FrameType.REQUEST_THERMOSTAT_PARAMETERS,
-            recipient=self.device.parent.address,
-        )
-
-    @property
-    def is_tracking_changes(self) -> bool:
-        """Return True if remote's tracking changes, False otherwise."""
-        return self.device.parent.has_frame_version(
-            FrameType.REQUEST_THERMOSTAT_PARAMETERS
-        )
-
 
 @dataslots
 @dataclass