PyPlumIO 0.6.2__tar.gz → 0.6.4__tar.gz

{pyplumio-0.6.2 → pyplumio-0.6.4}/.pre-commit-config.yaml

@@ -3,7 +3,7 @@
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.14.0
+    rev: v0.14.4
     hooks:
       - id: ruff
         args:

{pyplumio-0.6.2 → pyplumio-0.6.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPlumIO
-Version: 0.6.2
+Version: 0.6.4
 Summary: PyPlumIO is a native ecoNET library for Plum ecoMAX controllers.
 Author-email: Denis Paavilainen <denpa@denpa.pro>
 License: MIT License
@@ -25,15 +25,15 @@ License-File: LICENSE
 Requires-Dist: pyserial-asyncio==0.6
 Provides-Extra: test
 Requires-Dist: codespell==2.4.1; extra == "test"
-Requires-Dist: coverage==7.10.7; extra == "test"
+Requires-Dist: coverage==7.11.0; extra == "test"
 Requires-Dist: freezegun==1.5.5; extra == "test"
 Requires-Dist: mypy==1.18.2; extra == "test"
 Requires-Dist: numpy<3.0.0,>=2.0.0; extra == "test"
 Requires-Dist: pyserial-asyncio-fast==0.16; extra == "test"
 Requires-Dist: pytest==8.4.2; extra == "test"
 Requires-Dist: pytest-asyncio==1.2.0; extra == "test"
-Requires-Dist: ruff==0.13.3; extra == "test"
-Requires-Dist: tox==4.30.3; extra == "test"
+Requires-Dist: ruff==0.14.3; extra == "test"
+Requires-Dist: tox==4.32.0; extra == "test"
 Requires-Dist: types-pyserial==3.5.0.20251001; extra == "test"
 Provides-Extra: docs
 Requires-Dist: sphinx==8.1.3; extra == "docs"
@@ -42,7 +42,7 @@ Requires-Dist: readthedocs-sphinx-search==0.3.2; extra == "docs"
 Provides-Extra: dev
 Requires-Dist: pyplumio[docs,test]; extra == "dev"
 Requires-Dist: pre-commit==4.3.0; extra == "dev"
-Requires-Dist: tomli==2.2.1; extra == "dev"
+Requires-Dist: tomli==2.3.0; extra == "dev"
 Dynamic: license-file
 
 # PyPlumIO is a native ecoNET library for Plum ecoMAX controllers

{pyplumio-0.6.2 → pyplumio-0.6.4}/PyPlumIO.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPlumIO
-Version: 0.6.2
+Version: 0.6.4
 Summary: PyPlumIO is a native ecoNET library for Plum ecoMAX controllers.
 Author-email: Denis Paavilainen <denpa@denpa.pro>
 License: MIT License
@@ -25,15 +25,15 @@ License-File: LICENSE
 Requires-Dist: pyserial-asyncio==0.6
 Provides-Extra: test
 Requires-Dist: codespell==2.4.1; extra == "test"
-Requires-Dist: coverage==7.10.7; extra == "test"
+Requires-Dist: coverage==7.11.0; extra == "test"
 Requires-Dist: freezegun==1.5.5; extra == "test"
 Requires-Dist: mypy==1.18.2; extra == "test"
 Requires-Dist: numpy<3.0.0,>=2.0.0; extra == "test"
 Requires-Dist: pyserial-asyncio-fast==0.16; extra == "test"
 Requires-Dist: pytest==8.4.2; extra == "test"
 Requires-Dist: pytest-asyncio==1.2.0; extra == "test"
-Requires-Dist: ruff==0.13.3; extra == "test"
-Requires-Dist: tox==4.30.3; extra == "test"
+Requires-Dist: ruff==0.14.3; extra == "test"
+Requires-Dist: tox==4.32.0; extra == "test"
 Requires-Dist: types-pyserial==3.5.0.20251001; extra == "test"
 Provides-Extra: docs
 Requires-Dist: sphinx==8.1.3; extra == "docs"
@@ -42,7 +42,7 @@ Requires-Dist: readthedocs-sphinx-search==0.3.2; extra == "docs"
 Provides-Extra: dev
 Requires-Dist: pyplumio[docs,test]; extra == "dev"
 Requires-Dist: pre-commit==4.3.0; extra == "dev"
-Requires-Dist: tomli==2.2.1; extra == "dev"
+Requires-Dist: tomli==2.3.0; extra == "dev"
 Dynamic: license-file
 
 # PyPlumIO is a native ecoNET library for Plum ecoMAX controllers

{pyplumio-0.6.2 → pyplumio-0.6.4}/PyPlumIO.egg-info/requires.txt

@@ -3,7 +3,7 @@ pyserial-asyncio==0.6
 [dev]
 pyplumio[docs,test]
 pre-commit==4.3.0
-tomli==2.2.1
+tomli==2.3.0
 
 [docs]
 sphinx==8.1.3
@@ -12,13 +12,13 @@ readthedocs-sphinx-search==0.3.2
 
 [test]
 codespell==2.4.1
-coverage==7.10.7
+coverage==7.11.0
 freezegun==1.5.5
 mypy==1.18.2
 numpy<3.0.0,>=2.0.0
 pyserial-asyncio-fast==0.16
 pytest==8.4.2
 pytest-asyncio==1.2.0
-ruff==0.13.3
-tox==4.30.3
+ruff==0.14.3
+tox==4.32.0
 types-pyserial==3.5.0.20251001

{pyplumio-0.6.2 → pyplumio-0.6.4}/docs/source/frames.rst

@@ -568,6 +568,8 @@ Message
 Handler
 ^^^^^^^
 
+.. autoclass:: pyplumio.structures.frame_versions.FrameVersionsStructure
+
 .. autoclass:: pyplumio.structures.regulator_data.RegulatorDataStructure
 
 SensorData
@@ -697,30 +699,6 @@ Message
 Handlers
 ^^^^^^^^
 
-.. autoclass:: pyplumio.structures.outputs.OutputsStructure
-
-.. autoclass:: pyplumio.structures.output_flags.OutputFlagsStructure
-
-.. autoclass:: pyplumio.structures.temperatures.TemperaturesStructure
-
-.. autoclass:: pyplumio.structures.statuses.StatusesStructure
-
-.. autoclass:: pyplumio.structures.pending_alerts.PendingAlertsStructure
-
-.. autoclass:: pyplumio.structures.fuel_level.FuelLevelStructure
-
-.. autoclass:: pyplumio.structures.fan_power.FanPowerStructure
-
-.. autoclass:: pyplumio.structures.boiler_load.BoilerLoadStructure
-
-.. autoclass:: pyplumio.structures.boiler_power.BoilerPowerStructure
-
-.. autoclass:: pyplumio.structures.fuel_consumption.FuelConsumptionStructure
-
-.. autoclass:: pyplumio.structures.modules.ModulesStructure
-
-.. autoclass:: pyplumio.structures.lambda_sensor.LambdaSensorStructure
-
-.. autoclass:: pyplumio.structures.thermostat_sensors.ThermostatSensorsStructure
+.. autoclass:: pyplumio.structures.frame_versions.FrameVersionsStructure
 
-.. autoclass:: pyplumio.structures.mixer_sensors.MixerSensorsStructure
+.. autoclass:: pyplumio.structures.sensor_data.SensorDataStructure

{pyplumio-0.6.2 → pyplumio-0.6.4}/pyplumio/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.6.2'
-__version_tuple__ = version_tuple = (0, 6, 2)
+__version__ = version = '0.6.4'
+__version_tuple__ = version_tuple = (0, 6, 4)
 
-__commit_id__ = commit_id = 'g4f707ffa0'
+__commit_id__ = commit_id = 'gc17c7ed5e'

{pyplumio-0.6.2 → pyplumio-0.6.4}/pyplumio/connection.py

@@ -19,8 +19,8 @@ from pyplumio.utils import timeout
 
 _LOGGER = logging.getLogger(__name__)
 
-CONNECT_TIMEOUT: Final = 5
-RECONNECT_TIMEOUT: Final = 20
+TRY_CONNECT_FOR_SECONDS: Final = 5
+RECONNECT_AFTER_SECONDS: Final = 20
 
 try:
     import serial_asyncio_fast as pyserial_asyncio
@@ -88,9 +88,9 @@ class Connection(ABC, TaskManager):
         except ConnectionFailedError:
             _LOGGER.error(
                 "Can't connect to the device, retrying in %.1f seconds",
-                RECONNECT_TIMEOUT,
+                RECONNECT_AFTER_SECONDS,
             )
-            await asyncio.sleep(RECONNECT_TIMEOUT)
+            await asyncio.sleep(RECONNECT_AFTER_SECONDS)
             self.create_task(self._reconnect(), name="reconnect_task")
 
     async def connect(self) -> None:
@@ -126,7 +126,7 @@ class Connection(ABC, TaskManager):
         """Return connection options."""
         return self._options
 
-    @timeout(CONNECT_TIMEOUT)
+    @timeout(TRY_CONNECT_FOR_SECONDS)
     @abstractmethod
     async def _open_connection(
         self,
@@ -162,7 +162,7 @@ class TcpConnection(Connection):
             f"TcpConnection(host={self.host}, port={self.port}, options={self.options})"
         )
 
-    @timeout(CONNECT_TIMEOUT)
+    @timeout(TRY_CONNECT_FOR_SECONDS)
     async def _open_connection(
         self,
     ) -> tuple[asyncio.StreamReader, asyncio.StreamWriter]:
@@ -203,7 +203,7 @@ class SerialConnection(Connection):
             f"options={self.options})"
         )
 
-    @timeout(CONNECT_TIMEOUT)
+    @timeout(TRY_CONNECT_FOR_SECONDS)
     async def _open_connection(
         self,
     ) -> tuple[asyncio.StreamReader, asyncio.StreamWriter]:

{pyplumio-0.6.2 → pyplumio-0.6.4}/pyplumio/devices/__init__.py

@@ -52,14 +52,18 @@ def get_device_handler(device_type: int) -> str:
 class Device(ABC, EventManager):
     """Represents a device."""
 
-    __slots__ = ("queue",)
+    __slots__ = ("_write_queue",)
 
-    queue: asyncio.Queue[Frame]
+    _write_queue: asyncio.Queue[Frame]
 
-    def __init__(self, queue: asyncio.Queue[Frame]) -> None:
+    def __init__(self, write_queue: asyncio.Queue[Frame]) -> None:
         """Initialize a new device."""
         super().__init__()
-        self.queue = queue
+        self._write_queue = write_queue
+
+    def queue_send(self, frame: Frame) -> None:
+        """Send frame to the write queue."""
+        self._write_queue.put_nowait(frame)
 
     async def set(
         self,
@@ -130,17 +134,19 @@ class PhysicalDevice(Device, ABC):
     virtual devices associated with them via parent property.
     """
 
-    __slots__ = ("address", "_network", "_frame_versions")
+    __slots__ = ("address", "_network_info", "_frame_versions")
 
     address: ClassVar[int]
 
-    _network: NetworkInfo
+    _network_info: NetworkInfo
     _frame_versions: dict[int, int]
 
-    def __init__(self, queue: asyncio.Queue[Frame], network: NetworkInfo) -> None:
+    def __init__(
+        self, write_queue: asyncio.Queue[Frame], network_info: NetworkInfo
+    ) -> None:
         """Initialize a new physical device."""
-        super().__init__(queue)
-        self._network = network
+        super().__init__(write_queue)
+        self._network_info = network_info
         self._frame_versions = {}
 
     @event_listener(filter=on_change)
@@ -167,7 +173,7 @@ class PhysicalDevice(Device, ABC):
         """Request frame version from the device."""
         _LOGGER.debug("Updating frame %s to version %i", repr(frame_type), version)
         request = await Request.create(frame_type, recipient=self.address)
-        self.queue.put_nowait(request)
+        self.queue_send(request)
 
     def has_frame_version(self, frame_type: FrameType | int, version: int) -> bool:
         """Return True if frame data is up to date, False otherwise."""
@@ -199,7 +205,7 @@ class PhysicalDevice(Device, ABC):
         initial_retries = retries
         while retries > 0:
             try:
-                self.queue.put_nowait(request)
+                self.queue_send(request)
                 return await self.get(name, timeout=timeout)
             except asyncio.TimeoutError:
                 retries -= 1
@@ -211,7 +217,7 @@ class PhysicalDevice(Device, ABC):
         )
 
     @classmethod
-    async def create(cls, device_type: int, **kwargs: Any) -> PhysicalDevice:
+    async def create(cls, device_type: DeviceType, **kwargs: Any) -> PhysicalDevice:
         """Create a physical device handler object."""
         return await create_instance(get_device_handler(device_type), cls=cls, **kwargs)
 
@@ -225,10 +231,10 @@ class VirtualDevice(Device, ABC):
     index: int
 
     def __init__(
-        self, queue: asyncio.Queue[Frame], parent: PhysicalDevice, index: int = 0
+        self, write_queue: asyncio.Queue[Frame], parent: PhysicalDevice, index: int = 0
     ) -> None:
         """Initialize a new sub-device."""
-        super().__init__(queue)
+        super().__init__(write_queue)
         self.parent = parent
         self.index = index
 

{pyplumio-0.6.2 → pyplumio-0.6.4}/pyplumio/devices/ecomax.py

@@ -42,7 +42,7 @@ from pyplumio.structures.ecomax_parameters import (
     ATTR_ECOMAX_PARAMETERS,
 )
 from pyplumio.structures.mixer_parameters import ATTR_MIXER_PARAMETERS
-from pyplumio.structures.network_info import ATTR_NETWORK, NetworkInfo
+from pyplumio.structures.network_info import ATTR_NETWORK_INFO, NetworkInfo
 from pyplumio.structures.product_info import ATTR_PRODUCT, ProductInfo
 from pyplumio.structures.regulator_data_schema import ATTR_REGDATA_SCHEMA
 from pyplumio.structures.schedules import (
@@ -121,7 +121,7 @@ REQUIRED_KEYS: tuple[DataKey, ...] = (
 
 REQUIRED_TYPES = [frame_type for _, frame_type in REQUIRED_KEYS]
 
-SETUP_TIMEOUT: Final = 60.0
+WAIT_FOR_SETUP_SECONDS: Final = 60.0
 
 
 @device_handler(DeviceType.ECOMAX)
@@ -132,34 +132,38 @@ class EcoMAX(PhysicalDevice):
 
     _fuel_meter: FuelMeter
 
-    def __init__(self, queue: asyncio.Queue[Frame], network: NetworkInfo) -> None:
+    def __init__(
+        self, write_queue: asyncio.Queue[Frame], network_info: NetworkInfo
+    ) -> None:
         """Initialize a new ecoMAX controller."""
-        super().__init__(queue, network)
+        super().__init__(write_queue, network_info)
         self._fuel_meter = FuelMeter()
 
     def handle_frame(self, frame: Frame) -> None:
         """Handle frame received from the ecoMAX device."""
         if isinstance(frame, Request) and (
-            response := frame.response(data={ATTR_NETWORK: self._network})
+            response := frame.response(data={ATTR_NETWORK_INFO: self._network_info})
         ):
-            self.queue.put_nowait(response)
+            self.queue_send(response)
 
         super().handle_frame(frame)
 
     def _mixers(self, indexes: Iterable[int]) -> Generator[Mixer]:
-        """Iterate through the mixer indexes.
+        """Iterate through indexes and yield a Mixer instance.
 
         For each index, return or create an instance of the mixer class.
         Once done, dispatch the 'mixers' event without waiting.
         """
         mixers: dict[int, Mixer] = self._data.setdefault(ATTR_MIXERS, {})
         for index in indexes:
-            yield mixers.setdefault(index, Mixer(self.queue, parent=self, index=index))
+            yield mixers.setdefault(
+                index, Mixer(self._write_queue, parent=self, index=index)
+            )
 
         return self.dispatch_nowait(ATTR_MIXERS, mixers)
 
     def _thermostats(self, indexes: Iterable[int]) -> Generator[Thermostat]:
-        """Iterate through the thermostat indexes.
+        """Iterate through indexes and yield a Thermostat instance.
 
         For each index, return or create an instance of the thermostat
         class. Once done, dispatch the 'thermostats' event without
@@ -168,7 +172,7 @@ class EcoMAX(PhysicalDevice):
         thermostats: dict[int, Thermostat] = self._data.setdefault(ATTR_THERMOSTATS, {})
         for index in indexes:
             yield thermostats.setdefault(
-                index, Thermostat(self.queue, parent=self, index=index)
+                index, Thermostat(self._write_queue, parent=self, index=index)
             )
 
         return self.dispatch_nowait(ATTR_THERMOSTATS, thermostats)
@@ -220,11 +224,11 @@ class EcoMAX(PhysicalDevice):
         _LOGGER.debug("Setting up device entry")
 
         try:
-            await self.wait_for(ATTR_SENSORS, timeout=SETUP_TIMEOUT)
+            await self.wait_for(ATTR_SENSORS, timeout=WAIT_FOR_SETUP_SECONDS)
         except asyncio.TimeoutError:
             _LOGGER.error(
                 "Could not setup device entry; no response from device for %u seconds",
-                SETUP_TIMEOUT,
+                WAIT_FOR_SETUP_SECONDS,
             )
             return False
 

{pyplumio-0.6.2 → pyplumio-0.6.4}/pyplumio/parameters/__init__.py

@@ -204,7 +204,7 @@ class Parameter(ABC):
         self._values = replace(self._values, value=value)
         request = await self.create_request()
         if self.description.optimistic:
-            await self.device.queue.put(request)
+            self.device.queue_send(request)
             return True
 
         self.update_done.clear()
@@ -233,7 +233,7 @@ class Parameter(ABC):
 
     async def _send_update_request(self, request: Request, timeout: float) -> bool:
         """Send update request to the remote and confirm the result."""
-        await self.device.queue.put(request)
+        self.device.queue_send(request)
         with suppress(asyncio.TimeoutError):
             # Wait for the update to be done
             await asyncio.wait_for(self.update_done.wait(), timeout=timeout)

{pyplumio-0.6.2 → pyplumio-0.6.4}/pyplumio/parameters/ecomax.py

@@ -435,7 +435,9 @@ PARAMETER_TYPES: dict[ProductType, list[EcomaxParameterDescription]] = {
             name="feeder_calibration",
         ),
         EcomaxNumberDescription(
-            name="fuel_factor",
+            name="fuel_tank_capacity",
+            step=50.0,
+            unit_of_measurement=UnitOfMeasurement.KILOGRAMS,
         ),
         EcomaxNumberDescription(
             name="fuel_calorific_value",