PyPlumIO 0.4.0.post1__tar.gz → 0.4.1__tar.gz

{PyPlumIO-0.4.0.post1 → PyPlumIO-0.4.1}/.vscode/settings.json

@@ -1,7 +1,7 @@
 {
     "python.testing.unittestEnabled": false,
     "python.testing.pytestEnabled": true,
-    "python.formatting.provider": "black",
+    "python.formatting.provider": "none",
     "editor.formatOnSave": true,
     "editor.codeActionsOnSave": {
         "source.organizeImports": true
@@ -16,5 +16,8 @@
     "editor.rulers": [
         72,
         88
-    ]
+    ],
+    "[python]": {
+        "editor.defaultFormatter": "ms-python.black-formatter"
+    }
 }

{PyPlumIO-0.4.0.post1 → PyPlumIO-0.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyPlumIO
-Version: 0.4.0.post1
+Version: 0.4.1
 Summary: PyPlumIO is a native ecoNET library for Plum ecoMAX controllers.
 Author-email: Denis Paavilainen <denpa@denpa.pro>
 License: MIT License

{PyPlumIO-0.4.0.post1 → PyPlumIO-0.4.1}/PyPlumIO.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyPlumIO
-Version: 0.4.0.post1
+Version: 0.4.1
 Summary: PyPlumIO is a native ecoNET library for Plum ecoMAX controllers.
 Author-email: Denis Paavilainen <denpa@denpa.pro>
 License: MIT License

PyPlumIO-0.4.1/pyplumio/_version.py

@@ -0,0 +1,4 @@
+# file generated by setuptools_scm
+# don't change, don't track in version control
+__version__ = version = '0.4.1'
+__version_tuple__ = version_tuple = (0, 4, 1)

{PyPlumIO-0.4.0.post1 → PyPlumIO-0.4.1}/pyplumio/const.py

@@ -12,6 +12,7 @@ STATE_OFF: Final = "off"
 ATTR_CONNECTED: Final = "connected"
 ATTR_CURRENT_TEMP: Final = "current_temp"
 ATTR_DEVICE_INDEX: Final = "device_index"
+ATTR_FRAME_ERRORS: Final = "frame_errors"
 ATTR_INDEX: Final = "index"
 ATTR_LOADED: Final = "loaded"
 ATTR_OFFSET: Final = "offset"

{PyPlumIO-0.4.0.post1 → PyPlumIO-0.4.1}/pyplumio/devices/__init__.py

@@ -6,7 +6,7 @@ import logging
 from typing import ClassVar
 
 from pyplumio import util
-from pyplumio.const import ATTR_LOADED, DeviceType, FrameType
+from pyplumio.const import ATTR_FRAME_ERRORS, ATTR_LOADED, DeviceType, FrameType
 from pyplumio.exceptions import ParameterNotFoundError, UnknownDeviceError
 from pyplumio.frames import DataFrameDescription, Frame, Request, get_frame_handler
 from pyplumio.helpers.event_manager import EventManager
@@ -99,22 +99,23 @@ class Addressable(Device):
 
     async def async_setup(self) -> bool:
         """Setup addressable device object."""
-        try:
-            await asyncio.gather(
-                *{
-                    self.create_task(
-                        self.request(description.provides, description.frame_type)
-                    )
-                    for description in self._frame_types
-                },
-                return_exceptions=False,
-            )
-            await self.dispatch(ATTR_LOADED, True)
-            return True
-        except ValueError as e:
-            _LOGGER.error("Request failed: %s", e)
-            await self.dispatch(ATTR_LOADED, False)
-            return False
+        results = await asyncio.gather(
+            *{
+                self.create_task(
+                    self.request(description.provides, description.frame_type)
+                )
+                for description in self._frame_types
+            },
+            return_exceptions=True,
+        )
+
+        errors = [
+            result.args[1] for result in results if isinstance(result, ValueError)
+        ]
+
+        await self.dispatch(ATTR_FRAME_ERRORS, errors)
+        await self.dispatch(ATTR_LOADED, True)
+        return True
 
     async def request(
         self,
@@ -136,7 +137,7 @@ class Addressable(Device):
             except asyncio.TimeoutError:
                 retries -= 1
 
-        raise ValueError(f'could not request "{name}" with "{frame_type.name}"')
+        raise ValueError(f'could not request "{name}"', frame_type)
 
 
 class SubDevice(Device):

{PyPlumIO-0.4.0.post1 → PyPlumIO-0.4.1}/pyplumio/devices/ecomax.py

@@ -8,6 +8,7 @@ import time
 from typing import ClassVar, Final
 
 from pyplumio.const import (
+    ATTR_FRAME_ERRORS,
     ATTR_PASSWORD,
     ATTR_SENSORS,
     ATTR_STATE,
@@ -140,12 +141,24 @@ class EcoMAX(Addressable):
 
         super().handle_frame(frame)
 
+    def _has_frame_version(self, frame_type: FrameType | int, version: int) -> bool:
+        """Check if device instance has a version of the frame."""
+        return (
+            frame_type in self._frame_versions
+            and self._frame_versions[frame_type] == version
+        )
+
+    def _frame_is_supported(self, frame_type: FrameType | int) -> bool:
+        """Check if frame is supported by the device."""
+        return frame_type not in self.data.get(ATTR_FRAME_ERRORS, [])
+
     async def _update_frame_versions(self, versions: dict[int, int]) -> None:
         """Check versions and fetch outdated frames."""
         for frame_type, version in versions.items():
-            if is_known_frame_type(frame_type) and (
-                frame_type not in self._frame_versions
-                or self._frame_versions[frame_type] != version
+            if (
+                is_known_frame_type(frame_type)
+                and self._frame_is_supported(frame_type)
+                and not self._has_frame_version(frame_type, version)
             ):
                 # We don't have this frame or it's version has changed.
                 request = factory(get_frame_handler(frame_type), recipient=self.address)

{PyPlumIO-0.4.0.post1 → PyPlumIO-0.4.1}/pyplumio/structures/ecomax_parameters.py

@@ -10,13 +10,15 @@ from pyplumio.devices import Addressable
 from pyplumio.frames import Request
 from pyplumio.helpers.factory import factory
 from pyplumio.helpers.parameter import BinaryParameter, Parameter, ParameterDescription
-from pyplumio.helpers.typing import EventDataType, ParameterDataType, ParameterValueType
+from pyplumio.helpers.typing import EventDataType, ParameterValueType
 from pyplumio.structures import StructureDecoder, ensure_device_data
 from pyplumio.structures.thermostat_parameters import ATTR_THERMOSTAT_PROFILE
 
 ATTR_ECOMAX_CONTROL: Final = "ecomax_control"
 ATTR_ECOMAX_PARAMETERS: Final = "ecomax_parameters"
 
+ECOMAX_PARAMETER_SIZE: Final = 3
+
 
 class EcomaxParameter(Parameter):
     """Represents ecoMAX parameter."""
@@ -301,22 +303,33 @@ THERMOSTAT_PROFILE_PARAMETER = EcomaxParameterDescription(name=ATTR_THERMOSTAT_P
 class EcomaxParametersStructure(StructureDecoder):
     """Represents ecoMAX parameters data structure."""
 
+    _offset: int
+
+    def _ecomax_parameter(self, message: bytearray, start: int, end: int):
+        """Yields ecoMAX parameters."""
+        for index in range(start, start + end):
+            if parameter := util.unpack_parameter(message, self._offset):
+                yield (index, parameter)
+
+            self._offset += ECOMAX_PARAMETER_SIZE
+
     def decode(
         self, message: bytearray, offset: int = 0, data: EventDataType | None = None
     ) -> tuple[EventDataType, int]:
         """Decode bytes and return message data and offset."""
-        first_index = message[offset + 1]
-        last_index = message[offset + 2]
-        offset += 3
-        ecomax_parameters: list[tuple[int, ParameterDataType]] = []
-        for index in range(first_index, first_index + last_index):
-            parameter = util.unpack_parameter(message, offset)
-            if parameter is not None:
-                ecomax_parameters.append((index, parameter))
 
-            offset += 3
+        start = message[offset + 1]
+        end = message[offset + 2]
+        self._offset = offset + 3
 
         return (
-            ensure_device_data(data, {ATTR_ECOMAX_PARAMETERS: ecomax_parameters}),
-            offset,
+            ensure_device_data(
+                data,
+                {
+                    ATTR_ECOMAX_PARAMETERS: list(
+                        self._ecomax_parameter(message, start, end)
+                    )
+                },
+            ),
+            self._offset,
         )

{PyPlumIO-0.4.0.post1 → PyPlumIO-0.4.1}/pyplumio/structures/mixer_parameters.py

@@ -1,7 +1,6 @@
 """Contains mixer parameter structure decoder."""
 from __future__ import annotations
 
-from collections.abc import Iterable
 from dataclasses import dataclass
 from typing import TYPE_CHECKING, Final
 
@@ -18,6 +17,8 @@ if TYPE_CHECKING:
 
 ATTR_MIXER_PARAMETERS: Final = "mixer_parameters"
 
+MIXER_PARAMETER_SIZE: Final = 3
+
 
 class MixerParameter(Parameter):
     """Represents mixer parameter."""
@@ -117,48 +118,41 @@ ECOMAX_I_MIXER_PARAMETERS: tuple[MixerParameterDescription, ...] = (
 )
 
 
-def _decode_mixer_parameters(
-    message: bytearray, offset: int, indexes: Iterable
-) -> tuple[list[tuple[int, ParameterDataType]], int]:
-    """Decode parameters for a single mixer."""
-    parameters: list[tuple[int, ParameterDataType]] = []
-    for index in indexes:
-        parameter = util.unpack_parameter(message, offset)
-        if parameter is not None:
-            parameters.append((index, parameter))
+class MixerParametersStructure(StructureDecoder):
+    """Represent mixer parameters data structure."""
 
-        offset += 3
+    _offset: int
 
-    return parameters, offset
+    def _mixer_parameter(self, message: bytearray, start: int, end: int):
+        """Yields mixer parameters."""
+        for index in range(start, start + end):
+            if (parameter := util.unpack_parameter(message, self._offset)) is not None:
+                yield (index, parameter)
 
-
-class MixerParametersStructure(StructureDecoder):
-    """Represent mixer parameters data structure."""
+            self._offset += MIXER_PARAMETER_SIZE
 
     def decode(
         self, message: bytearray, offset: int = 0, data: EventDataType | None = None
     ) -> tuple[EventDataType, int]:
         """Decode bytes and return message data and offset."""
-        first_index = message[offset + 1]
-        last_index = message[offset + 2]
-        mixer_count = message[offset + 3]
-        parameter_count_per_mixer = first_index + last_index
-        offset += 4
+        start = message[offset + 1]
+        end = message[offset + 2]
+        mixers = message[offset + 3]
+        self._offset = offset + 4
+
         mixer_parameters: dict[int, list[tuple[int, ParameterDataType]]] = {}
-        for index in range(mixer_count):
-            parameters, offset = _decode_mixer_parameters(
-                message,
-                offset,
-                range(first_index, parameter_count_per_mixer),
-            )
-            if parameters:
-                mixer_parameters[index] = parameters
-
-        if not mixer_parameters:
-            # No mixer parameters detected.
-            return ensure_device_data(data, {ATTR_MIXER_PARAMETERS: None}), offset
+        for mixer in range(mixers):
+            if parameters := list(self._mixer_parameter(message, start, end)):
+                mixer_parameters[mixer] = parameters
 
         return (
-            ensure_device_data(data, {ATTR_MIXER_PARAMETERS: mixer_parameters}),
-            offset,
+            ensure_device_data(
+                data,
+                {
+                    ATTR_MIXER_PARAMETERS: (
+                        None if not mixer_parameters else mixer_parameters
+                    )
+                },
+            ),
+            self._offset,
         )

{PyPlumIO-0.4.0.post1 → PyPlumIO-0.4.1}/pyplumio/structures/thermostat_parameters.py

@@ -1,7 +1,6 @@
 """Contains thermostat parameter structure decoder."""
 from __future__ import annotations
 
-from collections.abc import Iterable
 from dataclasses import dataclass
 from typing import TYPE_CHECKING, Final
 
@@ -14,12 +13,15 @@ from pyplumio.helpers.typing import EventDataType, ParameterDataType, ParameterV
 from pyplumio.structures import StructureDecoder, ensure_device_data
 from pyplumio.structures.thermostat_sensors import ATTR_THERMOSTAT_COUNT
 
+if TYPE_CHECKING:
+    from pyplumio.devices.thermostat import Thermostat
+
+
 ATTR_THERMOSTAT_PROFILE: Final = "thermostat_profile"
 ATTR_THERMOSTAT_PARAMETERS: Final = "thermostat_parameters"
 ATTR_THERMOSTAT_PARAMETERS_DECODER: Final = "thermostat_parameters_decoder"
 
-if TYPE_CHECKING:
-    from pyplumio.devices.thermostat import Thermostat
+THERMOSTAT_PARAMETER_SIZE: Final = 3
 
 
 class ThermostatParameter(Parameter):
@@ -107,72 +109,68 @@ THERMOSTAT_PARAMETERS: tuple[ThermostatParameterDescription, ...] = (
 )
 
 
-def _decode_thermostat_parameters(
-    message: bytearray, offset: int, indexes: Iterable
-) -> tuple[list[tuple[int, ParameterDataType]], int]:
-    """Decode parameters for a single thermostat."""
-    parameters: list[tuple[int, ParameterDataType]] = []
-    for index in indexes:
-        description = THERMOSTAT_PARAMETERS[index]
-        parameter = util.unpack_parameter(message, offset, size=description.size)
-        if parameter is not None:
-            parameters.append((index, parameter))
-
-        offset += 3 * description.size
-
-    return parameters, offset
+def _empty_response(
+    offset: int, data: EventDataType | None = None
+) -> tuple[EventDataType, int]:
+    """Return empty response."""
+    return (
+        ensure_device_data(
+            data,
+            {ATTR_THERMOSTAT_PARAMETERS: None, ATTR_THERMOSTAT_PROFILE: None},
+        ),
+        offset,
+    )
 
 
 class ThermostatParametersStructure(StructureDecoder):
     """Represent thermostat parameters data structure."""
 
+    _offset: int
+
+    def _thermostat_parameter(
+        self, message: bytearray, thermostats: int, start: int, end: int
+    ):
+        """Yields thermostat parameters."""
+        for index in range(start, (start + end) // thermostats):
+            description = THERMOSTAT_PARAMETERS[index]
+            if (
+                parameter := util.unpack_parameter(
+                    message, self._offset, size=description.size
+                )
+            ) is not None:
+                yield (index, parameter)
+
+            self._offset += THERMOSTAT_PARAMETER_SIZE * description.size
+
     def decode(
         self, message: bytearray, offset: int = 0, data: EventDataType | None = None
     ) -> tuple[EventDataType, int]:
         """Decode bytes and return message data and offset."""
         data = ensure_device_data(data)
-        thermostat_count = data.get(ATTR_THERMOSTAT_COUNT, 0)
-        if thermostat_count == 0:
-            return (
-                ensure_device_data(
-                    data,
-                    {ATTR_THERMOSTAT_PARAMETERS: None, ATTR_THERMOSTAT_PROFILE: None},
-                ),
-                offset,
-            )
-
-        first_index = message[offset + 1]
-        last_index = message[offset + 2]
+        thermostats = data.get(ATTR_THERMOSTAT_COUNT, 0)
+        if thermostats == 0:
+            return _empty_response(offset, data)
+
+        start = message[offset + 1]
+        end = message[offset + 2]
         thermostat_profile = util.unpack_parameter(message, offset + 3)
-        parameter_count_per_thermostat = (first_index + last_index) // thermostat_count
-        offset += 6
+        self._offset = offset + 6
         thermostat_parameters: dict[int, list[tuple[int, ParameterDataType]]] = {}
-        for index in range(thermostat_count):
-            parameters, offset = _decode_thermostat_parameters(
-                message,
-                offset,
-                range(first_index, parameter_count_per_thermostat),
-            )
-            if parameters:
-                thermostat_parameters[index] = parameters
-
-        if not thermostat_parameters:
-            # No thermostat parameters detected.
-            return (
-                ensure_device_data(
-                    data,
-                    {ATTR_THERMOSTAT_PARAMETERS: None, ATTR_THERMOSTAT_PROFILE: None},
-                ),
-                offset,
-            )
+        for thermostat in range(thermostats):
+            if parameters := list(
+                self._thermostat_parameter(message, thermostats, start, end)
+            ):
+                thermostat_parameters[thermostat] = parameters
 
         return (
             ensure_device_data(
                 data,
                 {
                     ATTR_THERMOSTAT_PROFILE: thermostat_profile,
-                    ATTR_THERMOSTAT_PARAMETERS: thermostat_parameters,
+                    ATTR_THERMOSTAT_PARAMETERS: None
+                    if not thermostat_parameters
+                    else thermostat_parameters,
                 },
             ),
-            offset,
+            self._offset,
         )

{PyPlumIO-0.4.0.post1 → PyPlumIO-0.4.1}/tests/test_devices.py

@@ -7,6 +7,7 @@ import pytest
 
 from pyplumio.const import (
     ATTR_DEVICE_INDEX,
+    ATTR_FRAME_ERRORS,
     ATTR_INDEX,
     ATTR_LOADED,
     ATTR_OFFSET,
@@ -117,6 +118,7 @@ async def test_async_setup() -> None:
         await ecomax.wait_until_done()
 
     assert await ecomax.get(ATTR_LOADED)
+    assert not ecomax.data[ATTR_FRAME_ERRORS]
     assert mock_request.await_count == len(DATA_FRAME_TYPES)
 
 
@@ -126,13 +128,22 @@ async def test_async_setup_error(caplog) -> None:
 
     with patch("pyplumio.devices.ecomax.EcoMAX.wait_for"), patch(
         "pyplumio.devices.ecomax.EcoMAX.request",
-        side_effect=(ValueError("test"), True, True, True, True, True, True, True),
+        side_effect=(
+            ValueError("test", FrameType.REQUEST_ALERTS),
+            True,
+            True,
+            True,
+            True,
+            True,
+            True,
+            True,
+        ),
     ) as mock_request:
         await ecomax.async_setup()
         await ecomax.wait_until_done()
 
-    assert "Request failed" in caplog.text
-    assert not await ecomax.get(ATTR_LOADED)
+    assert await ecomax.get(ATTR_LOADED)
+    assert ecomax.data[ATTR_FRAME_ERRORS][0] == FrameType.REQUEST_ALERTS
     assert mock_request.await_count == len(DATA_FRAME_TYPES)
 
 

PyPlumIO-0.4.0.post1/pyplumio/_version.py

@@ -1,4 +0,0 @@
-# file generated by setuptools_scm
-# don't change, don't track in version control
-__version__ = version = '0.4.0.post1'
-__version_tuple__ = version_tuple = (0, 4, 0)