PyPlumIO 0.6.0__tar.gz → 0.6.1__tar.gz

{pyplumio-0.6.0 → pyplumio-0.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPlumIO
-Version: 0.6.0
+Version: 0.6.1
 Summary: PyPlumIO is a native ecoNET library for Plum ecoMAX controllers.
 Author-email: Denis Paavilainen <denpa@denpa.pro>
 License: MIT License
@@ -25,16 +25,16 @@ 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.6; extra == "test"
+Requires-Dist: coverage==7.10.7; extra == "test"
 Requires-Dist: freezegun==1.5.5; extra == "test"
-Requires-Dist: mypy==1.18.1; 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.1.0; extra == "test"
-Requires-Dist: ruff==0.13.0; extra == "test"
+Requires-Dist: pytest-asyncio==1.2.0; extra == "test"
+Requires-Dist: ruff==0.13.2; extra == "test"
 Requires-Dist: tox==4.30.2; extra == "test"
-Requires-Dist: types-pyserial==3.5.0.20250822; extra == "test"
+Requires-Dist: types-pyserial==3.5.0.20250919; extra == "test"
 Provides-Extra: docs
 Requires-Dist: sphinx==8.1.3; extra == "docs"
 Requires-Dist: sphinx_rtd_theme==3.0.2; extra == "docs"
@@ -79,7 +79,6 @@ through network by using RS-485 to Ethernet/WiFi converter.
 - [Callbacks](https://pyplumio.denpa.pro/callbacks.html)
 - [Mixers/Thermostats](https://pyplumio.denpa.pro/mixers_thermostats.html)
 - [Schedules](https://pyplumio.denpa.pro/schedules.html)
-- [Statistics](https://pyplumio.denpa.pro/statistics.html)
 - [Protocol](https://pyplumio.denpa.pro/protocol.html)
   - [Frame Structure](https://pyplumio.denpa.pro/protocol.html#frame-structure)
   - [Requests and Responses](https://pyplumio.denpa.pro/protocol.html#requests-and-responses)

{pyplumio-0.6.0 → pyplumio-0.6.1}/PyPlumIO.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPlumIO
-Version: 0.6.0
+Version: 0.6.1
 Summary: PyPlumIO is a native ecoNET library for Plum ecoMAX controllers.
 Author-email: Denis Paavilainen <denpa@denpa.pro>
 License: MIT License
@@ -25,16 +25,16 @@ 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.6; extra == "test"
+Requires-Dist: coverage==7.10.7; extra == "test"
 Requires-Dist: freezegun==1.5.5; extra == "test"
-Requires-Dist: mypy==1.18.1; 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.1.0; extra == "test"
-Requires-Dist: ruff==0.13.0; extra == "test"
+Requires-Dist: pytest-asyncio==1.2.0; extra == "test"
+Requires-Dist: ruff==0.13.2; extra == "test"
 Requires-Dist: tox==4.30.2; extra == "test"
-Requires-Dist: types-pyserial==3.5.0.20250822; extra == "test"
+Requires-Dist: types-pyserial==3.5.0.20250919; extra == "test"
 Provides-Extra: docs
 Requires-Dist: sphinx==8.1.3; extra == "docs"
 Requires-Dist: sphinx_rtd_theme==3.0.2; extra == "docs"
@@ -79,7 +79,6 @@ through network by using RS-485 to Ethernet/WiFi converter.
 - [Callbacks](https://pyplumio.denpa.pro/callbacks.html)
 - [Mixers/Thermostats](https://pyplumio.denpa.pro/mixers_thermostats.html)
 - [Schedules](https://pyplumio.denpa.pro/schedules.html)
-- [Statistics](https://pyplumio.denpa.pro/statistics.html)
 - [Protocol](https://pyplumio.denpa.pro/protocol.html)
   - [Frame Structure](https://pyplumio.denpa.pro/protocol.html#frame-structure)
   - [Requests and Responses](https://pyplumio.denpa.pro/protocol.html#requests-and-responses)

{pyplumio-0.6.0 → pyplumio-0.6.1}/PyPlumIO.egg-info/SOURCES.txt

@@ -34,7 +34,6 @@ docs/source/mixers_thermostats.rst
 docs/source/protocol.rst
 docs/source/reading.rst
 docs/source/schedules.rst
-docs/source/statistics.rst
 docs/source/writing.rst
 images/ecomax.png
 images/rs485.png

{pyplumio-0.6.0 → pyplumio-0.6.1}/PyPlumIO.egg-info/requires.txt

@@ -12,13 +12,13 @@ readthedocs-sphinx-search==0.3.2
 
 [test]
 codespell==2.4.1
-coverage==7.10.6
+coverage==7.10.7
 freezegun==1.5.5
-mypy==1.18.1
+mypy==1.18.2
 numpy<3.0.0,>=2.0.0
 pyserial-asyncio-fast==0.16
 pytest==8.4.2
-pytest-asyncio==1.1.0
-ruff==0.13.0
+pytest-asyncio==1.2.0
+ruff==0.13.2
 tox==4.30.2
-types-pyserial==3.5.0.20250822
+types-pyserial==3.5.0.20250919

{pyplumio-0.6.0 → pyplumio-0.6.1}/README.md

@@ -32,7 +32,6 @@ through network by using RS-485 to Ethernet/WiFi converter.
 - [Callbacks](https://pyplumio.denpa.pro/callbacks.html)
 - [Mixers/Thermostats](https://pyplumio.denpa.pro/mixers_thermostats.html)
 - [Schedules](https://pyplumio.denpa.pro/schedules.html)
-- [Statistics](https://pyplumio.denpa.pro/statistics.html)
 - [Protocol](https://pyplumio.denpa.pro/protocol.html)
   - [Frame Structure](https://pyplumio.denpa.pro/protocol.html#frame-structure)
   - [Requests and Responses](https://pyplumio.denpa.pro/protocol.html#requests-and-responses)

{pyplumio-0.6.0 → pyplumio-0.6.1}/docs/source/connecting.rst

@@ -142,6 +142,43 @@ In the example below, we'll set both ethernet and wireless parameters.
         ) as conn:
             ...
 
+Statistics
+----------
+
+Since PyPlumIO v0.5.56, you can access statistics via following property.
+
+.. autoattribute:: pyplumio.protocol.AsyncProtocol.statistics
+
+Statistics contain transfer data consisting of number of received/sent frames and bytes
+as well as datetime of when connection was established, when connection was lost and
+number of connection loss event.
+
+.. autoclass:: pyplumio.protocol.Statistics
+    :members:
+    :exclude-members: update_sent, update_received, update_connection_lost, update_devices, reset_transfer_statistics
+
+The `devices` property of statistics class of also contains a list of
+device statistics objects. Those statistics include time the device was initially
+connected as well as time, when device was last seen (sent an :ref:`RegulatorData`
+message).
+
+.. autoclass:: pyplumio.protocol.DeviceStatistics
+    :members:
+    :exclude-members: __hash__, update_last_seen
+
+In the following example we'll print connection statistics after establishing a
+connection.
+
+.. code-block:: python
+
+    import pyplumio
+
+
+    async def main():
+        """Print connection statistics."""
+        async with pyplumio.open_tcp_connection("localhost", 8899) as conn:
+            print(conn.statistics)
+            ...
 
 Connection Examples
 -------------------

{pyplumio-0.6.0 → pyplumio-0.6.1}/docs/source/index.rst

@@ -51,7 +51,6 @@ Documentation
    callbacks
    mixers_thermostats
    schedules
-   statistics
    protocol
    frames
 

{pyplumio-0.6.0 → pyplumio-0.6.1}/pyplumio/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.6.0'
-__version_tuple__ = version_tuple = (0, 6, 0)
+__version__ = version = '0.6.1'
+__version_tuple__ = version_tuple = (0, 6, 1)
 
-__commit_id__ = commit_id = 'gfb1c17ddb'
+__commit_id__ = commit_id = 'g7cf7d589c'

{pyplumio-0.6.0 → pyplumio-0.6.1}/pyplumio/connection.py

@@ -116,42 +116,6 @@ class Connection(ABC, TaskManager):
 
         yield await self.protocol.get(name, timeout=timeout)
 
-    @property
-    def get(self):  # type: ignore[no-untyped-def]
-        """Access the remote device.
-
-        Raise NotImplementedError when using protocol
-        different from AsyncProtocol.
-        """
-        if isinstance(self.protocol, AsyncProtocol):
-            return self.protocol.get
-
-        raise NotImplementedError
-
-    @property
-    def get_nowait(self):  # type: ignore[no-untyped-def]
-        """Access the remote device without waiting.
-
-        Raise NotImplementedError when using protocol
-        different from AsyncProtocol.
-        """
-        if isinstance(self.protocol, AsyncProtocol):
-            return self.protocol.get_nowait
-
-        raise NotImplementedError
-
-    @property
-    def wait_for(self):  # type: ignore[no-untyped-def]
-        """Wait for the remote device to become available.
-
-        Raise NotImplementedError when using protocol
-        different from AsyncProtocol.
-        """
-        if isinstance(self.protocol, AsyncProtocol):
-            return self.protocol.wait_for
-
-        raise NotImplementedError
-
     @property
     def protocol(self) -> Protocol:
         """Return the protocol object."""

{pyplumio-0.6.0 → pyplumio-0.6.1}/pyplumio/protocol.py

@@ -145,25 +145,29 @@ class Statistics:
     connection_losses: int = 0
 
     #: List of statistics for connected devices
-    devices: list[DeviceStatistics] = field(default_factory=list)
+    devices: set[DeviceStatistics] = field(default_factory=set)
 
-    def update_transfer_statistics(
-        self, sent: Frame | None = None, received: Frame | None = None
-    ) -> None:
-        """Update transfer statistics."""
-        if sent:
-            self.sent_bytes += sent.length
-            self.sent_frames += 1
+    def update_sent(self, frame: Frame) -> None:
+        """Update sent frames statistics."""
+        self.sent_bytes += frame.length
+        self.sent_frames += 1
 
-        if received:
-            self.received_bytes += received.length
-            self.received_frames += 1
+    def update_received(self, frame: Frame) -> None:
+        """Update received frames statistics."""
+        self.received_bytes += frame.length
+        self.received_frames += 1
 
-    def track_connection_loss(self) -> None:
-        """Increase connection loss counter and store the datetime."""
+    def update_connection_lost(self) -> None:
+        """Update connection lost counter."""
         self.connection_losses += 1
         self.connection_loss_at = datetime.now()
 
+    def update_devices(self, device: PhysicalDevice) -> None:
+        """Update connected devices."""
+        device_statistics = DeviceStatistics(address=device.address)
+        device.subscribe(ATTR_REGDATA, device_statistics.update_last_seen)
+        self.devices.add(device_statistics)
+
     def reset_transfer_statistics(self) -> None:
         """Reset transfer statistics."""
         self.sent_bytes = 0
@@ -173,18 +177,22 @@ class Statistics:
         self.failed_frames = 0
 
 
-@dataclass(slots=True)
+@dataclass(slots=True, kw_only=True)
 class DeviceStatistics:
     """Represents a device statistics."""
 
-    #: Device name
-    name: str
+    #: Device address
+    address: int
 
     #: Datetime object representing connection time
-    connected_since: datetime | Literal["never"] = NEVER
+    connected_since: datetime = field(default_factory=datetime.now)
 
     #: Datetime object representing time when device was last seen
-    last_seen: datetime | Literal["never"] = NEVER
+    last_seen: datetime = field(default_factory=datetime.now)
+
+    def __hash__(self) -> int:
+        """Return a hash of the statistics based on unique address."""
+        return self.address
 
     async def update_last_seen(self, _: Any) -> None:
         """Update last seen property."""
@@ -241,10 +249,10 @@ class AsyncProtocol(Protocol, EventManager[PhysicalDevice]):
             self.frame_producer(self._queues, reader=self.reader, writer=self.writer),
             name="frame_producer_task",
         )
-        for consumer in range(self.consumers_count):
+        for consumer_id in range(self.consumers_count):
             self.create_task(
                 self.frame_consumer(self._queues.read),
-                name=f"frame_consumer_task ({consumer})",
+                name=f"frame_consumer_task ({consumer_id})",
             )
 
         for device in self.data.values():
@@ -277,30 +285,39 @@ class AsyncProtocol(Protocol, EventManager[PhysicalDevice]):
             await self._connection_close()
             await asyncio.gather(*(device.shutdown() for device in self.data.values()))
 
+    async def _write_from_queue(
+        self, writer: FrameWriter, queue: asyncio.Queue[Frame]
+    ) -> None:
+        """Send frame from the queue to the remote device."""
+        frame = await queue.get()
+        await writer.write(frame)
+        queue.task_done()
+        self.statistics.update_sent(frame)
+
+    async def _read_into_queue(
+        self, reader: FrameReader, queue: asyncio.Queue[Frame]
+    ) -> None:
+        """Read frame from the remote device into the queue."""
+        if frame := await reader.read():
+            queue.put_nowait(frame)
+            self.statistics.update_received(frame)
+
     async def frame_producer(
         self, queues: Queues, reader: FrameReader, writer: FrameWriter
     ) -> None:
         """Handle frame reads and writes."""
-        statistics = self.statistics
         await self.connected.wait()
         while self.connected.is_set():
             try:
-                request = None
                 if not queues.write.empty():
-                    request = await queues.write.get()
-                    await writer.write(request)
-                    queues.write.task_done()
-
-                if response := await reader.read():
-                    queues.read.put_nowait(response)
-
-                statistics.update_transfer_statistics(request, response)
+                    await self._write_from_queue(writer, queues.write)
 
+                await self._read_into_queue(reader, queues.read)
             except ProtocolError as e:
-                statistics.failed_frames += 1
+                self.statistics.failed_frames += 1
                 _LOGGER.debug("Can't process received frame: %s", e)
             except (OSError, asyncio.TimeoutError):
-                statistics.track_connection_loss()
+                self.statistics.update_connection_lost()
                 self.create_task(self.connection_lost())
                 break
             except Exception:
@@ -327,14 +344,7 @@ class AsyncProtocol(Protocol, EventManager[PhysicalDevice]):
                 device.dispatch_nowait(ATTR_CONNECTED, True)
                 device.dispatch_nowait(ATTR_SETUP, True)
                 await self.dispatch(name, device)
-                self.statistics.devices.append(
-                    device_statistics := DeviceStatistics(
-                        name=name,
-                        connected_since=datetime.now(),
-                        last_seen=datetime.now(),
-                    )
-                )
-                device.subscribe(ATTR_REGDATA, device_statistics.update_last_seen)
+                self.statistics.update_devices(device)
 
         return self.data[name]
 

{pyplumio-0.6.0 → pyplumio-0.6.1}/pyproject.toml

@@ -35,16 +35,16 @@ dynamic = ["version"]
 [project.optional-dependencies]
 test = [
     "codespell==2.4.1",
-    "coverage==7.10.6",
+    "coverage==7.10.7",
     "freezegun==1.5.5",
-    "mypy==1.18.1",
+    "mypy==1.18.2",
     "numpy<3.0.0,>=2.0.0",
     "pyserial-asyncio-fast==0.16",
     "pytest==8.4.2",
-    "pytest-asyncio==1.1.0",
-    "ruff==0.13.0",
+    "pytest-asyncio==1.2.0",
+    "ruff==0.13.2",
     "tox==4.30.2",
-    "types-pyserial==3.5.0.20250822"
+    "types-pyserial==3.5.0.20250919"
 ]
 docs = [
     "sphinx==8.1.3",

{pyplumio-0.6.0 → pyplumio-0.6.1}/requirements_test.txt

@@ -1,13 +1,13 @@
 codespell==2.4.1
-coverage==7.10.6
+coverage==7.10.7
 freezegun==1.5.5
-mypy==1.18.1
+mypy==1.18.2
 numpy<3.0.0,>=2.0.0
 pre-commit==4.3.0
 pyserial-asyncio-fast==0.16
-pytest-asyncio==1.1.0
+pytest-asyncio==1.2.0
 pytest==8.4.2
-ruff==0.13.0
+ruff==0.13.2
 tomli==2.2.1
 tox==4.30.2
-types-pyserial==3.5.0.20250822
+types-pyserial==3.5.0.20250919

{pyplumio-0.6.0 → pyplumio-0.6.1}/tests/test_connection.py

@@ -189,21 +189,6 @@ class TestConnection:
         mock_protocol.some_method = Mock(return_value="called")
         assert connection.some_method() == "called"
 
-    @pytest.mark.parametrize("func", ("get", "get_nowait", "wait_for"))
-    async def test_protocol_proxy_calls(self, func: str) -> None:
-        """Test calls proxied to protocol instance."""
-        mock_protocol = AsyncMock(spec=AsyncProtocol, autospec=True)
-        connection = DummyConnection(protocol=mock_protocol)
-        connection_func = getattr(connection, func)
-        protocol_func = getattr(mock_protocol, func)
-        assert connection_func is protocol_func
-
-        # Test with error.
-        mock_protocol = AsyncMock(spec=DummyProtocol, autospec=True)
-        connection = DummyConnection(protocol=mock_protocol)
-        with pytest.raises(NotImplementedError):
-            getattr(connection, func)
-
 
 HOST: Final = "localhost"
 PORT: Final = 8899

{pyplumio-0.6.0 → pyplumio-0.6.1}/tests/test_protocol.py

@@ -109,25 +109,28 @@ async def test_dummy_protocol() -> None:
 @pytest.mark.usefixtures("frozen_time")
 def test_statistics() -> None:
     """Test statistics dataclass."""
-    statistics = Statistics()
-    statistics.update_transfer_statistics(sent=Request())
-    statistics.update_transfer_statistics(received=Response())
-    statistics.failed_frames = 1
+    statistics = Statistics(failed_frames=1)
     assert statistics.connected_since == "never"
+    assert statistics.failed_frames == 1
+    assert statistics.connection_losses == 0
+    assert statistics.connection_loss_at == "never"
+    assert statistics.sent_bytes == 0
+    assert statistics.sent_frames == 0
+    assert statistics.received_bytes == 0
+    assert statistics.received_frames == 0
+    statistics.update_sent(Request())
     assert statistics.sent_bytes == 10
     assert statistics.sent_frames == 1
+    statistics.update_received(Response())
     assert statistics.received_bytes == 10
     assert statistics.received_frames == 1
-    assert statistics.failed_frames == 1
-    assert statistics.connection_losses == 0
-    assert statistics.connection_loss_at == "never"
     statistics.reset_transfer_statistics()
     assert statistics.sent_bytes == 0
     assert statistics.sent_frames == 0
     assert statistics.received_bytes == 0
     assert statistics.received_frames == 0
     assert statistics.failed_frames == 0
-    statistics.track_connection_loss()
+    statistics.update_connection_lost()
     assert statistics.connection_losses == 1
     assert statistics.connection_loss_at == datetime.now()
 
@@ -376,7 +379,7 @@ async def test_async_protocol_frame_producer(
         "failed_frames": 5,
         "connection_losses": 1,
         "connection_loss_at": datetime.now(),
-        "devices": [],
+        "devices": set(),
     }
 
 
@@ -453,12 +456,8 @@ async def test_async_protocol_frame_consumer(
     assert mock_read_queue.task_done.call_count == 2
 
     # Test statistics.
-    connected_since = datetime.now()
     frozen_time.tick(timedelta(seconds=10))
     ecomax = cast(EcoMAX, async_protocol.get_nowait("ecomax"))
     await ecomax.dispatch(ATTR_REGDATA, True)
-    assert asdict(async_protocol.statistics.devices[0]) == {
-        "name": "ecomax",
-        "connected_since": connected_since,
-        "last_seen": datetime.now(),
-    }
+    device_statistics = async_protocol.statistics.devices.pop()
+    assert device_statistics.address == DeviceType.ECOMAX

pyplumio-0.6.0/docs/source/statistics.rst

@@ -1,47 +0,0 @@
-Statistics
-==========
-
-About Statistics
-----------------
-
-Since PyPlumIO v0.5.56, you can access statistics via following property.
-
-.. autoattribute:: pyplumio.protocol.AsyncProtocol.statistics
-
-Statistics contain transfer data consisting of number of received/sent frames and bytes
-as well as datetime of when connection was established, when connection was lost and
-number of connection loss event.
-
-.. autoclass:: pyplumio.protocol.Statistics
-    :members:
-    :exclude-members: update_transfer_statistics, track_connection_loss, reset_transfer_statistics
-
-The `devices` property of statistics class of also contains a list of
-device statistics objects. Those statistics include time the device was initially
-connected as well as time, when device was last seen (sent an :ref:`RegulatorData`
-message).
-
-.. autoclass:: pyplumio.protocol.DeviceStatistics
-    :members:
-    :exclude-members: update_last_seen
-
-Statistics Examples
--------------------
-
-You can easily access statistic object via proxy call through Connection object
-as in example below.
-
-.. code-block:: python
-
-    import asyncio
-
-    import pyplumio
-
-    async def main():
-        """Read the current heating temperature."""
-        async with pyplumio.open_tcp_connection("localhost", 8899) as conn:
-            print(conn.statistics)
-
-
-    asyncio.run(main())
-