PyPlumIO 0.5.36__tar.gz → 0.5.37__tar.gz

{pyplumio-0.5.36 → pyplumio-0.5.37}/.pre-commit-config.yaml

@@ -2,13 +2,13 @@
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.9.3
+    rev: v0.9.4
     hooks:
       - id: ruff
         args:
           - --fix
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.4.0
+    rev: v2.4.1
     hooks:
         - id: codespell
   - repo: https://github.com/pre-commit/mirrors-mypy

{pyplumio-0.5.36 → pyplumio-0.5.37}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: PyPlumIO
-Version: 0.5.36
+Version: 0.5.37
 Summary: PyPlumIO is a native ecoNET library for Plum ecoMAX controllers.
 Author-email: Denis Paavilainen <denpa@denpa.pro>
 License: MIT License
@@ -27,15 +27,15 @@ 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.4.0; extra == "test"
+Requires-Dist: codespell==2.4.1; 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.25.2; extra == "test"
-Requires-Dist: ruff==0.9.3; extra == "test"
+Requires-Dist: pytest-asyncio==0.25.3; extra == "test"
+Requires-Dist: ruff==0.9.4; extra == "test"
 Requires-Dist: tox==4.24.1; extra == "test"
-Requires-Dist: types-pyserial==3.5.0.20250124; extra == "test"
+Requires-Dist: types-pyserial==3.5.0.20250130; extra == "test"
 Provides-Extra: docs
 Requires-Dist: sphinx==8.1.3; extra == "docs"
 Requires-Dist: sphinx_rtd_theme==3.0.2; extra == "docs"
@@ -49,8 +49,8 @@ Requires-Dist: tomli==2.2.1; extra == "dev"
 [![PyPI version](https://badge.fury.io/py/PyPlumIO.svg)](https://badge.fury.io/py/PyPlumIO)
 [![PyPI Supported Python Versions](https://img.shields.io/pypi/pyversions/pyplumio.svg)](https://pypi.python.org/pypi/pyplumio/)
 [![PyPlumIO CI](https://github.com/denpamusic/PyPlumIO/actions/workflows/ci.yml/badge.svg)](https://github.com/denpamusic/PyPlumIO/actions/workflows/ci.yml)
-[![Maintainability](https://api.codeclimate.com/v1/badges/9f275fbc50fe9082a909/maintainability)](https://codeclimate.com/github/denpamusic/PyPlumIO/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/9f275fbc50fe9082a909/test_coverage)](https://codeclimate.com/github/denpamusic/PyPlumIO/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/e802127770476b7ba6fd/maintainability)](https://codeclimate.com/github/denpamusic/PyPlumIO/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/e802127770476b7ba6fd/test_coverage)](https://codeclimate.com/github/denpamusic/PyPlumIO/test_coverage)
 [![stability-release-candidate](https://img.shields.io/badge/stability-pre--release-48c9b0.svg)](https://guidelines.denpa.pro/stability#release-candidate)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 

{pyplumio-0.5.36 → pyplumio-0.5.37}/PyPlumIO.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: PyPlumIO
-Version: 0.5.36
+Version: 0.5.37
 Summary: PyPlumIO is a native ecoNET library for Plum ecoMAX controllers.
 Author-email: Denis Paavilainen <denpa@denpa.pro>
 License: MIT License
@@ -27,15 +27,15 @@ 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.4.0; extra == "test"
+Requires-Dist: codespell==2.4.1; 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.25.2; extra == "test"
-Requires-Dist: ruff==0.9.3; extra == "test"
+Requires-Dist: pytest-asyncio==0.25.3; extra == "test"
+Requires-Dist: ruff==0.9.4; extra == "test"
 Requires-Dist: tox==4.24.1; extra == "test"
-Requires-Dist: types-pyserial==3.5.0.20250124; extra == "test"
+Requires-Dist: types-pyserial==3.5.0.20250130; extra == "test"
 Provides-Extra: docs
 Requires-Dist: sphinx==8.1.3; extra == "docs"
 Requires-Dist: sphinx_rtd_theme==3.0.2; extra == "docs"
@@ -49,8 +49,8 @@ Requires-Dist: tomli==2.2.1; extra == "dev"
 [![PyPI version](https://badge.fury.io/py/PyPlumIO.svg)](https://badge.fury.io/py/PyPlumIO)
 [![PyPI Supported Python Versions](https://img.shields.io/pypi/pyversions/pyplumio.svg)](https://pypi.python.org/pypi/pyplumio/)
 [![PyPlumIO CI](https://github.com/denpamusic/PyPlumIO/actions/workflows/ci.yml/badge.svg)](https://github.com/denpamusic/PyPlumIO/actions/workflows/ci.yml)
-[![Maintainability](https://api.codeclimate.com/v1/badges/9f275fbc50fe9082a909/maintainability)](https://codeclimate.com/github/denpamusic/PyPlumIO/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/9f275fbc50fe9082a909/test_coverage)](https://codeclimate.com/github/denpamusic/PyPlumIO/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/e802127770476b7ba6fd/maintainability)](https://codeclimate.com/github/denpamusic/PyPlumIO/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/e802127770476b7ba6fd/test_coverage)](https://codeclimate.com/github/denpamusic/PyPlumIO/test_coverage)
 [![stability-release-candidate](https://img.shields.io/badge/stability-pre--release-48c9b0.svg)](https://guidelines.denpa.pro/stability#release-candidate)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 

{pyplumio-0.5.36 → pyplumio-0.5.37}/PyPlumIO.egg-info/requires.txt

@@ -13,12 +13,12 @@ sphinx_rtd_theme==3.0.2
 readthedocs-sphinx-search==0.3.2
 
 [test]
-codespell==2.4.0
+codespell==2.4.1
 coverage==7.6.10
 mypy==1.14.1
 pyserial-asyncio-fast==0.14
 pytest==8.3.4
-pytest-asyncio==0.25.2
-ruff==0.9.3
+pytest-asyncio==0.25.3
+ruff==0.9.4
 tox==4.24.1
-types-pyserial==3.5.0.20250124
+types-pyserial==3.5.0.20250130

{pyplumio-0.5.36 → pyplumio-0.5.37}/README.md

@@ -2,8 +2,8 @@
 [![PyPI version](https://badge.fury.io/py/PyPlumIO.svg)](https://badge.fury.io/py/PyPlumIO)
 [![PyPI Supported Python Versions](https://img.shields.io/pypi/pyversions/pyplumio.svg)](https://pypi.python.org/pypi/pyplumio/)
 [![PyPlumIO CI](https://github.com/denpamusic/PyPlumIO/actions/workflows/ci.yml/badge.svg)](https://github.com/denpamusic/PyPlumIO/actions/workflows/ci.yml)
-[![Maintainability](https://api.codeclimate.com/v1/badges/9f275fbc50fe9082a909/maintainability)](https://codeclimate.com/github/denpamusic/PyPlumIO/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/9f275fbc50fe9082a909/test_coverage)](https://codeclimate.com/github/denpamusic/PyPlumIO/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/e802127770476b7ba6fd/maintainability)](https://codeclimate.com/github/denpamusic/PyPlumIO/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/e802127770476b7ba6fd/test_coverage)](https://codeclimate.com/github/denpamusic/PyPlumIO/test_coverage)
 [![stability-release-candidate](https://img.shields.io/badge/stability-pre--release-48c9b0.svg)](https://guidelines.denpa.pro/stability#release-candidate)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 

{pyplumio-0.5.36 → pyplumio-0.5.37}/docs/source/index.rst

@@ -6,8 +6,9 @@
 Welcome to PyPlumIO's documentation!
 ====================================
 
-This project aims to provide complete and easy to use solution for communicating with
-climate devices by `Plum Sp. z o.o. <https://www.plum.pl/>`_
+The `PyPlumIO <https://github.com/denpamusic/PyPlumIO/>`_ projects 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/>`_
 
 Currently it supports reading and writing parameters of ecoMAX controllers by
 Plum Sp. z o.o., getting service password and sending network information to

{pyplumio-0.5.36 → pyplumio-0.5.37}/pyplumio/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.5.36'
-__version_tuple__ = version_tuple = (0, 5, 36)
+__version__ = version = '0.5.37'
+__version_tuple__ = version_tuple = (0, 5, 37)

{pyplumio-0.5.36 → pyplumio-0.5.37}/pyplumio/helpers/parameter.py

@@ -28,7 +28,7 @@ def unpack_parameter(
     data: bytearray, offset: int = 0, size: int = 1
 ) -> ParameterValues | None:
     """Unpack a device parameter."""
-    if not validate_parameter(data[offset : offset + size * 3]):
+    if not is_valid_parameter(data[offset : offset + size * 3]):
         return None
 
     value = data[offset : offset + size]
@@ -42,7 +42,7 @@ def unpack_parameter(
     )
 
 
-def validate_parameter(data: bytearray) -> bool:
+def is_valid_parameter(data: bytearray) -> bool:
     """Check if parameter contains any bytes besides 0xFF."""
     return any(x for x in data if x != BYTE_UNDEFINED)
 
@@ -75,6 +75,7 @@ class ParameterDescription:
     """Represents a parameter description."""
 
     name: str
+    optimistic: bool = False
 
 
 class Parameter(ABC):
@@ -204,13 +205,21 @@ class Parameter(ABC):
         self, value: int, retries: int = 5, timeout: float = 5.0
     ) -> bool:
         """Attempt to update a parameter value on the remote device."""
+        _LOGGER.debug(
+            "Attempting to update '%s' parameter to %d", self.description.name, value
+        )
         if value == self.values.value:
             # Value is unchanged
             return True
 
-        self._pending_update = True
         self._values.value = value
-        initial_retries = retries
+        request = await self.create_request()
+        if self.description.optimistic or not (initial_retries := retries):
+            # No retries
+            await self.device.queue.put(request)
+            return True
+
+        self._pending_update = True
         while self.pending_update:
             if retries <= 0:
                 _LOGGER.warning(
@@ -220,7 +229,7 @@ class Parameter(ABC):
                 )
                 return False
 
-            await self.device.queue.put(await self.create_request())
+            await self.device.queue.put(request)
             await asyncio.sleep(timeout)
             retries -= 1
 

{pyplumio-0.5.36 → pyplumio-0.5.37}/pyplumio/structures/ecomax_parameters.py

@@ -825,7 +825,9 @@ ECOMAX_PARAMETERS: dict[ProductType, tuple[EcomaxParameterDescription, ...]] = {
     ),
 }
 
-ECOMAX_CONTROL_PARAMETER = EcomaxSwitchDescription(name=ATTR_ECOMAX_CONTROL)
+ECOMAX_CONTROL_PARAMETER = EcomaxSwitchDescription(
+    name=ATTR_ECOMAX_CONTROL, optimistic=True
+)
 THERMOSTAT_PROFILE_PARAMETER = EcomaxNumberDescription(name=ATTR_THERMOSTAT_PROFILE)
 
 

{pyplumio-0.5.36 → pyplumio-0.5.37}/pyproject.toml

@@ -37,15 +37,15 @@ dynamic = ["version"]
 
 [project.optional-dependencies]
 test = [
-    "codespell==2.4.0",
+    "codespell==2.4.1",
     "coverage==7.6.10",
     "mypy==1.14.1",
     "pyserial-asyncio-fast==0.14",
     "pytest==8.3.4",
-    "pytest-asyncio==0.25.2",
-    "ruff==0.9.3",
+    "pytest-asyncio==0.25.3",
+    "ruff==0.9.4",
     "tox==4.24.1",
-    "types-pyserial==3.5.0.20250124"
+    "types-pyserial==3.5.0.20250130"
 ]
 docs = [
     "sphinx==8.1.3",
@@ -243,7 +243,7 @@ asyncio_default_fixture_loop_scope = "function"
 [tool.tox]
 legacy_tox_ini = """
     [tox]
-    envlist = lint, type, py{39,310,311,312}
+    envlist = lint, type, py{39,310,311,312,313}
     isolated_build = True
     skip_missing_interpreters = True
     ignore_basepython_conflict = True
@@ -253,7 +253,8 @@ legacy_tox_ini = """
         3.9: py39
         3.10: py310
         3.11: py311
-        3.12: py312, lint, type
+        3.12: py312
+        3.13: py313, lint, type
 
     [testenv]
     deps =

{pyplumio-0.5.36 → pyplumio-0.5.37}/requirements_test.txt

@@ -1,11 +1,11 @@
-codespell==2.4.0
+codespell==2.4.1
 coverage==7.6.10
 mypy==1.14.1
 pre-commit==4.1.0
 pyserial-asyncio-fast==0.14
-pytest-asyncio==0.25.2
+pytest-asyncio==0.25.3
 pytest==8.3.4
-ruff==0.9.3
+ruff==0.9.4
 tomli==2.2.1
 tox==4.24.1
-types-pyserial==3.5.0.20250124
+types-pyserial==3.5.0.20250130

{pyplumio-0.5.36 → pyplumio-0.5.37}/tests/helpers/test_parameter.py

@@ -15,7 +15,7 @@ from pyplumio.helpers.parameter import (
     ParameterValues,
     Switch,
     SwitchDescription,
-    validate_parameter,
+    is_valid_parameter,
 )
 
 
@@ -41,16 +41,16 @@ def fixture_switch(ecomax: EcoMAX) -> Switch:
     )
 
 
-def test_validate_parameter() -> None:
+def test_is_valid_parameter() -> None:
     """Test checking if parameter is valid."""
-    assert validate_parameter(
+    assert is_valid_parameter(
         bytearray([BYTE_UNDEFINED, 0xFE, BYTE_UNDEFINED, BYTE_UNDEFINED])
     )
 
 
-def test_validate_parameter_invalid() -> None:
+def test_is_valid_parameter_invalid() -> None:
     """Test checking if parameter is invalid."""
-    assert not validate_parameter(
+    assert not is_valid_parameter(
         bytearray([BYTE_UNDEFINED, BYTE_UNDEFINED, BYTE_UNDEFINED, BYTE_UNDEFINED])
     )
 
@@ -120,14 +120,36 @@ async def test_number_validate(number: Number) -> None:
 async def test_number_set(number: Number, bypass_asyncio_sleep) -> None:
     """Test setting a number."""
     await number.set(5)
+    assert number.pending_update
     number.update(ParameterValues(value=5, min_value=0, max_value=5))
     assert number == 5
     assert not number.pending_update
-    with patch("pyplumio.helpers.parameter.Parameter.pending_update", False):
+    with patch("pyplumio.helpers.parameter.Parameter.pending_update", False):  # type: ignore [unreachable]
         assert await number.set(3)
         assert number == 3
 
 
+async def test_number_set_with_no_retries(number: Number, bypass_asyncio_sleep) -> None:
+    """Test setting a number with no retries."""
+    with patch("asyncio.Queue.put") as mock_put:
+        assert await number.set(5, retries=0)
+
+    mock_put.assert_awaited_once_with(await number.create_request())
+    assert number == 5
+    assert not number.pending_update
+
+
+async def test_number_set_optimistic(number: Number, bypass_asyncio_sleep) -> None:
+    """Test setting a number optimistically."""
+    number.description.optimistic = True
+    with patch("asyncio.Queue.put") as mock_put:
+        assert await number.set(5)
+
+    mock_put.assert_awaited_once_with(await number.create_request())
+    assert number == 5
+    assert not number.pending_update
+
+
 async def test_switch_validate(switch: Switch) -> None:
     """Test the switch validation."""
     assert switch.validate(STATE_ON)
@@ -139,15 +161,37 @@ async def test_switch_validate(switch: Switch) -> None:
 async def test_switch_set(switch: Switch, bypass_asyncio_sleep) -> None:
     """Test setting a number."""
     await switch.set(STATE_ON)
+    assert switch.pending_update
     switch.update(ParameterValues(value=1, min_value=0, max_value=1))
     assert switch == 1
     assert not switch.pending_update
-    with patch("pyplumio.helpers.parameter.Parameter.pending_update", False):
+    with patch("pyplumio.helpers.parameter.Parameter.pending_update", False):  # type: ignore [unreachable]
         assert await switch.set(STATE_OFF)
 
     assert switch == 0
 
 
+async def test_switch_set_with_no_retries(switch: Switch, bypass_asyncio_sleep) -> None:
+    """Test setting a switch with no retries."""
+    with patch("asyncio.Queue.put") as mock_put:
+        assert await switch.set(STATE_ON, retries=0)
+
+    mock_put.assert_awaited_once_with(await switch.create_request())
+    assert switch == 1
+    assert not switch.pending_update
+
+
+async def test_switch_set_optimistic(switch: Switch, bypass_asyncio_sleep) -> None:
+    """Test setting a switch optimistically."""
+    switch.description.optimistic = True
+    with patch("asyncio.Queue.put") as mock_put:
+        assert await switch.set(STATE_ON)
+
+    mock_put.assert_awaited_once_with(await switch.create_request())
+    assert switch == 1
+    assert not switch.pending_update
+
+
 async def test_number_set_nowait(number: Number):
     """Test setting a number without waiting for result."""
     number.set_nowait(5)
@@ -241,7 +285,7 @@ def test_number_repr(number: Number) -> None:
     """Test a number representation."""
     assert repr(number) == (
         "Number(device=EcoMAX, "
-        "description=NumberDescription(name='test_number', "
+        "description=NumberDescription(name='test_number', optimistic=False, "
         "unit_of_measurement=<UnitOfMeasurement.CELSIUS: '°C'>), "
         "values=ParameterValues(value=1, min_value=0, max_value=5), "
         "index=0)"
@@ -252,7 +296,7 @@ def test_switch_repr(switch: Switch) -> None:
     """Test a number representation."""
     assert repr(switch) == (
         "Switch(device=EcoMAX, "
-        "description=SwitchDescription(name='test_switch'), "
+        "description=SwitchDescription(name='test_switch', optimistic=False), "
         "values=ParameterValues(value=0, min_value=0, max_value=1), "
         "index=0)"
     )