PyPlumIO 0.5.55__tar.gz → 0.6.0__tar.gz

{pyplumio-0.5.55 → pyplumio-0.6.0}/.github/workflows/ci.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
 
     steps:
       - uses: actions/checkout@v4

{pyplumio-0.5.55 → pyplumio-0.6.0}/.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.12.11
+    rev: v0.13.0
     hooks:
       - id: ruff
         args:
@@ -13,6 +13,6 @@ repos:
     hooks:
       - id: codespell
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.17.1
+    rev: v1.18.1
     hooks:
       - id: mypy

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPlumIO
-Version: 0.5.55
+Version: 0.6.0
 Summary: PyPlumIO is a native ecoNET library for Plum ecoMAX controllers.
 Author-email: Denis Paavilainen <denpa@denpa.pro>
 License: MIT License
@@ -13,30 +13,27 @@ Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
-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
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: dataslots==1.2.0
 Requires-Dist: pyserial-asyncio==0.6
-Requires-Dist: typing-extensions<5.0,>=4.14.0
 Provides-Extra: test
 Requires-Dist: codespell==2.4.1; extra == "test"
-Requires-Dist: coverage==7.10.5; extra == "test"
+Requires-Dist: coverage==7.10.6; extra == "test"
 Requires-Dist: freezegun==1.5.5; extra == "test"
-Requires-Dist: mypy==1.17.1; extra == "test"
+Requires-Dist: mypy==1.18.1; 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.1; extra == "test"
+Requires-Dist: pytest==8.4.2; extra == "test"
 Requires-Dist: pytest-asyncio==1.1.0; extra == "test"
-Requires-Dist: ruff==0.12.10; extra == "test"
-Requires-Dist: tox==4.28.4; extra == "test"
+Requires-Dist: ruff==0.13.0; extra == "test"
+Requires-Dist: tox==4.30.2; extra == "test"
 Requires-Dist: types-pyserial==3.5.0.20250822; extra == "test"
 Provides-Extra: docs
 Requires-Dist: sphinx==8.1.3; extra == "docs"
@@ -53,8 +50,8 @@ Dynamic: license-file
 [![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://qlty.sh/badges/2455933c-6c18-45bc-a205-da5cc0b49d0b/maintainability.svg)](https://qlty.sh/gh/denpamusic/projects/PyPlumIO)
-[![Code Coverage](https://qlty.sh/badges/2455933c-6c18-45bc-a205-da5cc0b49d0b/test_coverage.svg)](https://qlty.sh/gh/denpamusic/projects/PyPlumIO)
+[![Maintainability](https://qlty.sh/gh/denpamusic/projects/PyPlumIO/maintainability.svg)](https://qlty.sh/gh/denpamusic/projects/PyPlumIO)
+[![Code Coverage](https://qlty.sh/gh/denpamusic/projects/PyPlumIO/coverage.svg)](https://qlty.sh/gh/denpamusic/projects/PyPlumIO)
 [![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)
 
@@ -82,11 +79,13 @@ 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)
   - [Communication](https://pyplumio.denpa.pro/protocol.html#communication)
   - [Versioning](https://pyplumio.denpa.pro/protocol.html#versioning)
+- [Supported frames](https://pyplumio.denpa.pro/frames.html)
 
 ## Quickstart
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPlumIO
-Version: 0.5.55
+Version: 0.6.0
 Summary: PyPlumIO is a native ecoNET library for Plum ecoMAX controllers.
 Author-email: Denis Paavilainen <denpa@denpa.pro>
 License: MIT License
@@ -13,30 +13,27 @@ Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
-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
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: dataslots==1.2.0
 Requires-Dist: pyserial-asyncio==0.6
-Requires-Dist: typing-extensions<5.0,>=4.14.0
 Provides-Extra: test
 Requires-Dist: codespell==2.4.1; extra == "test"
-Requires-Dist: coverage==7.10.5; extra == "test"
+Requires-Dist: coverage==7.10.6; extra == "test"
 Requires-Dist: freezegun==1.5.5; extra == "test"
-Requires-Dist: mypy==1.17.1; extra == "test"
+Requires-Dist: mypy==1.18.1; 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.1; extra == "test"
+Requires-Dist: pytest==8.4.2; extra == "test"
 Requires-Dist: pytest-asyncio==1.1.0; extra == "test"
-Requires-Dist: ruff==0.12.10; extra == "test"
-Requires-Dist: tox==4.28.4; extra == "test"
+Requires-Dist: ruff==0.13.0; extra == "test"
+Requires-Dist: tox==4.30.2; extra == "test"
 Requires-Dist: types-pyserial==3.5.0.20250822; extra == "test"
 Provides-Extra: docs
 Requires-Dist: sphinx==8.1.3; extra == "docs"
@@ -53,8 +50,8 @@ Dynamic: license-file
 [![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://qlty.sh/badges/2455933c-6c18-45bc-a205-da5cc0b49d0b/maintainability.svg)](https://qlty.sh/gh/denpamusic/projects/PyPlumIO)
-[![Code Coverage](https://qlty.sh/badges/2455933c-6c18-45bc-a205-da5cc0b49d0b/test_coverage.svg)](https://qlty.sh/gh/denpamusic/projects/PyPlumIO)
+[![Maintainability](https://qlty.sh/gh/denpamusic/projects/PyPlumIO/maintainability.svg)](https://qlty.sh/gh/denpamusic/projects/PyPlumIO)
+[![Code Coverage](https://qlty.sh/gh/denpamusic/projects/PyPlumIO/coverage.svg)](https://qlty.sh/gh/denpamusic/projects/PyPlumIO)
 [![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)
 
@@ -82,11 +79,13 @@ 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)
   - [Communication](https://pyplumio.denpa.pro/protocol.html#communication)
   - [Versioning](https://pyplumio.denpa.pro/protocol.html#versioning)
+- [Supported frames](https://pyplumio.denpa.pro/frames.html)
 
 ## Quickstart
 

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

@@ -34,6 +34,7 @@ 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.5.55 → pyplumio-0.6.0}/PyPlumIO.egg-info/requires.txt

@@ -1,6 +1,4 @@
-dataslots==1.2.0
 pyserial-asyncio==0.6
-typing-extensions<5.0,>=4.14.0
 
 [dev]
 pyplumio[docs,test]
@@ -14,13 +12,13 @@ readthedocs-sphinx-search==0.3.2
 
 [test]
 codespell==2.4.1
-coverage==7.10.5
+coverage==7.10.6
 freezegun==1.5.5
-mypy==1.17.1
+mypy==1.18.1
 numpy<3.0.0,>=2.0.0
 pyserial-asyncio-fast==0.16
-pytest==8.4.1
+pytest==8.4.2
 pytest-asyncio==1.1.0
-ruff==0.12.10
-tox==4.28.4
+ruff==0.13.0
+tox==4.30.2
 types-pyserial==3.5.0.20250822

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

@@ -3,8 +3,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://qlty.sh/badges/2455933c-6c18-45bc-a205-da5cc0b49d0b/maintainability.svg)](https://qlty.sh/gh/denpamusic/projects/PyPlumIO)
-[![Code Coverage](https://qlty.sh/badges/2455933c-6c18-45bc-a205-da5cc0b49d0b/test_coverage.svg)](https://qlty.sh/gh/denpamusic/projects/PyPlumIO)
+[![Maintainability](https://qlty.sh/gh/denpamusic/projects/PyPlumIO/maintainability.svg)](https://qlty.sh/gh/denpamusic/projects/PyPlumIO)
+[![Code Coverage](https://qlty.sh/gh/denpamusic/projects/PyPlumIO/coverage.svg)](https://qlty.sh/gh/denpamusic/projects/PyPlumIO)
 [![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)
 
@@ -32,11 +32,13 @@ 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)
   - [Communication](https://pyplumio.denpa.pro/protocol.html#communication)
   - [Versioning](https://pyplumio.denpa.pro/protocol.html#versioning)
+- [Supported frames](https://pyplumio.denpa.pro/frames.html)
 
 ## Quickstart
 

{pyplumio-0.5.55 → pyplumio-0.6.0}/docs/source/callbacks.rst

@@ -166,16 +166,13 @@ processing.
     async def main():
         """Subscribes callback to the current heating temperature."""
         async with pyplumio.open_tcp_connection("localhost", 8899) as conn:
+            async with conn.device("ecomax") as ecomax:
+                # Await the callback on value change but no faster than
+                # once per 5 seconds.
+                ecomax.subscribe("heating_temp", throttle(on_change(my_callback), seconds=5))
 
-            # Get the ecoMAX device.
-            ecomax = await conn.get("ecomax")
-
-            # Await the callback on value change but no faster than
-            # once per 5 seconds.
-            ecomax.subscribe("heating_temp", throttle(on_change(my_callback), seconds=5))
-
-            # Wait until disconnected (forever)
-            await conn.wait_until_done()
+                # Wait until disconnected (forever)
+                await conn.wait_until_done()
 
 
     asyncio.run(main())
@@ -199,15 +196,12 @@ current heating temperature on every SensorDataMessage.
     async def main():
         """Subscribes callback to the current heating temperature."""
         async with pyplumio.open_tcp_connection("localhost", 8899) as conn:
+            async with conn.device("ecomax") as ecomax:
+                # Subscribe my_callback to heating_temp event.
+                ecomax.subscribe("heating_temp", my_callback)
 
-            # Get the ecoMAX device.
-            ecomax = await conn.get("ecomax")
-
-            # Subscribe my_callback to heating_temp event.
-            ecomax.subscribe("heating_temp", my_callback)
-
-            # Wait until disconnected (forever)
-            await conn.wait_until_done()
+                # Wait until disconnected (forever)
+                await conn.wait_until_done()
 
 
     asyncio.run(main())
@@ -235,17 +229,15 @@ when heating temperature will change more the 0.1 degrees Celsius.
     async def main():
         """Subscribes callback to the current heating temperature."""
         async with pyplumio.open_tcp_connection("localhost", 8899) as conn:
-            # Get the ecoMAX device.
-            ecomax = await conn.get("ecomax")
-
-            # Subscribe my_callback to heating_target_temp event.
-            ecomax.subscribe_once("heating_target_temp", my_callback)
+            async with conn.device("ecomax") as ecomax:
+                # Subscribe my_callback to heating_target_temp event.
+                ecomax.subscribe_once("heating_target_temp", my_callback)
 
-            # Subscribe my_callback2 to heating_temp changes.
-            ecomax.subscribe("heating_temp", on_change(my_callback2))
+                # Subscribe my_callback2 to heating_temp changes.
+                ecomax.subscribe("heating_temp", on_change(my_callback2))
 
-            # Wait until disconnected (forever)
-            await conn.wait_until_done()
+                # Wait until disconnected (forever)
+                await conn.wait_until_done()
 
 
     asyncio.run(main())

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

@@ -70,15 +70,15 @@ working with device classes and queues.
         """Open a connection and request alerts."""
         async with pyplumio.open_tcp_connection(
             host="localhost", port=8899, protocol=pyplumio.DummyProtocol()
-        ) as connection:
-            await connection.writer.write(
+        ) as conn:
+            await conn.writer.write(
                 requests.AlertsRequest(recipient=DeviceType.ECOMAX, start=0, count=5)
             )
 
-            while connection.connected:
+            while conn.connected:
                 try:
                     if isinstance(
-                        (frame := await connection.reader.read()), responses.AlertsResponse
+                        (frame := await conn.reader.read()), responses.AlertsResponse
                     ):
                         print(frame.data)
                         break
@@ -139,7 +139,7 @@ In the example below, we'll set both ethernet and wireless parameters.
                     signal_quality=100,
                 ),
             ),
-        ) as connection:
+        ) as conn:
             ...
 
 
@@ -165,7 +165,8 @@ context manager.
         async with pyplumio.open_tcp_connection("localhost", port=8899) as conn:
             try:
                 # Get the ecoMAX device within 10 seconds or timeout.
-                ecomax = await conn.get("ecomax", timeout=10)
+                async with conn.device("ecomax", timeout=10) as ecomax:
+                    ...
             except asyncio.TimeoutError:
                 # If device times out, log the error.
                 _LOGGER.error("Failed to get the device within 10 seconds")
@@ -197,11 +198,12 @@ using Python's context manager.
         
         try:
             # Get the ecoMAX device within 10 seconds or timeout.
-            ecomax = await connection.get("ecomax", timeout=10)
+            async with conn.device("ecomax", timeout=10) as ecomax:
+                ...
         except asyncio.TimeoutError:
             # If device times out, log the error.
             _LOGGER.error("Failed to get the device within 10 seconds")
-        
+
         # Close the connection.
         await connection.close()
         

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

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

{pyplumio-0.5.55 → pyplumio-0.6.0}/docs/source/mixers_thermostats.rst

@@ -10,9 +10,9 @@ respective properties.
 
 .. code-block:: python
 
-    ecomax = await conn.get("ecomax")
-    thermostats = await ecomax.get("thermostats")
-    mixers = await ecomax.get("mixers")
+    async with conn.device("ecomax") as ecomax:
+        thermostats = await ecomax.get("thermostats")
+        mixers = await ecomax.get("mixers")
 
 Result of this call will be a dictionary of ``Mixer`` or ``Thermostat``
 object keyed by the device indexes.
@@ -34,20 +34,18 @@ get it's current_temp property and set it's target temperature to
 
     from pyplumio.devices import Mixer
 
-    # Get the ecoMAX device.
-    ecomax = await conn.get("ecomax")
+    async with conn.device("ecomax") as ecomax:
+        # Get connected mixers.
+        mixers = await ecomax.get("mixers")
 
-    # Get connected mixers.
-    mixers = await ecomax.get("mixers")
+        # Get a single mixer.
+        mixer: Mixer = mixers[1]
 
-    # Get single mixer.
-    mixer: Mixer = mixers[1]
+        # Get current mixer temperature.
+        mixer_current_temp = await mixer.get("current_temp")
 
-    # Get current mixer temperature.
-    mixer_current_temp = await mixer.get("current_temp")
-
-    # Set mixer target temperature to 50 degrees Celsius.
-    await mixer.set("mixer_target_temp", 50)
+        # Set mixer target temperature to 50 degrees Celsius.
+        await mixer.set("mixer_target_temp", 50)
 
 Thermostat Examples
 -------------------
@@ -60,17 +58,15 @@ degrees Celsius.
 
     from pyplumio.device import Thermostat
 
-    # Get the ecoMAX device.
-    ecomax = await conn.get("ecomax")
-
-    # Get connected thermostats.
-    thermostats = await ecomax.get("thermostats")
+    async with conn.device("ecomax") as ecomax:
+        # Get connected thermostats.
+        thermostats = await ecomax.get("thermostats")
 
-    # Get single thermostat.
-    thermostat: Thermostat = thermostats[1]
+        # Get single thermostat.
+        thermostat: Thermostat = thermostats[1]
 
-    # Get current room temperature.
-    thermostat_current_temp = await thermostat.get("current_temp")
+        # Get current room temperature.
+        thermostat_current_temp = await thermostat.get("current_temp")
 
-    # Set day target temperature to 20 degrees Celsius.
-    await thermostat.set("day_target_temp", 20)
+        # Set day target temperature to 20 degrees Celsius.
+        await thermostat.set("day_target_temp", 20)

{pyplumio-0.5.55 → pyplumio-0.6.0}/docs/source/reading.rst

@@ -10,8 +10,8 @@ You can use this property get a full device dataset.
 
 .. code-block:: python
 
-    ecomax = await conn.get("ecomax")
-    print(ecomax.data)
+    async with conn.device("ecomax") as ecomax:
+        print(ecomax.data)
 
 In a pinch, you can also use this attribute to directly access the data,
 but this is not recommended, please use getters instead.
@@ -36,12 +36,11 @@ and close the connection.
         """Read the current heating temperature."""
         async with pyplumio.open_tcp_connection("localhost", 8899) as conn:
             # Get the ecoMAX device.
-            ecomax = await conn.get("ecomax")
-
-            # Get the heating temperature.
-            heating_temp = await ecomax.get("heating_temp")
-            print(heating_temp)
-            ...
+            async with conn.device("ecomax") as ecomax:
+                # Get the heating temperature.
+                heating_temp = await ecomax.get("heating_temp")
+                print(heating_temp)
+                ...
             
 
     asyncio.run(main())
@@ -92,11 +91,14 @@ keys, and can be accessed via the **regdata** property.
 
 .. code-block:: python
 
-    ecomax = await conn.get("ecomax")
-    regdata = await ecomax.get("regdata")
+    from typing import Any
+
+    async with conn.device("ecomax") as ecomax:
+        # Get regulator data.
+        regdata: dict[int, Any] = await ecomax.get("regdata")
 
-    # Get regulator data with the 1280 key.
-    heating_target = regdata[1280]
+        # Get regulator data with the 1280 key.
+        heating_target = regdata[1280]
 
 
 Reading Examples
@@ -119,18 +121,17 @@ to the terminal.
         """
         async with pyplumio.open_tcp_connection("localhost", 8899) as conn:
             # Get the ecoMAX device.
-            ecomax = await conn.get("ecomax")
-
-            # Get heating temperature, if it's available otherwise
-            # return the default value (65).
-            heating_temp = ecomax.get_nowait("heating_temp", default=65)
+            async with conn.device("ecomax") as ecomax:
+                # Get heating temperature, if it's available otherwise
+                # return the default value (65).
+                heating_temp = ecomax.get_nowait("heating_temp", default=65)
 
-            # Wait for heating temperature and get it's value.
-            heating_target_temp = await ecomax.get("heating_target_temp")
+                # Wait for heating temperature and get it's value.
+                heating_target_temp = await ecomax.get("heating_target_temp")
 
-            # Wait until regulator data is available then grab key 1792.
-            await ecomax.wait_for("regdata")
-            status = ecomax.regdata[1792]
+                # Wait until regulator data is available then grab key 1792.
+                await ecomax.wait_for("regdata")
+                status = ecomax.regdata[1792]
 
             print(
                 f"Current temp: {heating_temp}, "

{pyplumio-0.5.55 → pyplumio-0.6.0}/docs/source/schedules.rst

@@ -115,27 +115,27 @@ Schedule Examples
 
     async def main():
         """Set a device schedule."""
-        async with pyplumio.open_tcp_connection("localhost", 8899) as connection:
-            ecomax = await connection.get("ecomax")
-            schedules = await ecomax.get("schedules")
-            heating_schedule = schedules["heating"]
-
-            # Turn the heating schedule on.
-            await ecomax.set("schedule_heating_switch", "on")
-
-            # Drop the heating temperature by 10 degrees in the nighttime mode.
-            await ecomax.set("schedule_heating_parameter", 10)
-
-            for weekday in heating_schedule:
-                weekday.set_state(STATE_ON, "00:00", "00:30")
-                weekday.set_state(STATE_OFF, "00:30", "09:00")
-                weekday.set_state(STATE_ON, "09:00", "00:00")
-                weekday["19:00"] = STATE_OFF
-
-            # There will be no nighttime mode on sunday.
-            heating_schedule.sunday.set_state(STATE_ON)
-            
-            await heating_schedule.commit()
+        async with pyplumio.open_tcp_connection("localhost", 8899) as conn:
+            async with conn.device("ecomax") as ecomax:
+                schedules = await ecomax.get("schedules")
+                heating_schedule = schedules["heating"]
+
+                # Turn the heating schedule on.
+                await ecomax.set("schedule_heating_switch", "on")
+
+                # Drop the heating temperature by 10 degrees in the nighttime mode.
+                await ecomax.set("schedule_heating_parameter", 10)
+
+                for weekday in heating_schedule:
+                    weekday.set_state(STATE_ON, "00:00", "00:30")
+                    weekday.set_state(STATE_OFF, "00:30", "09:00")
+                    weekday.set_state(STATE_ON, "09:00", "00:00")
+                    weekday["19:00"] = STATE_OFF
+
+                # There will be no nighttime mode on sunday.
+                heating_schedule.sunday.set_state(STATE_ON)
+                
+                await heating_schedule.commit()
 
 
     asyncio.run(main())

pyplumio-0.6.0/docs/source/statistics.rst

@@ -0,0 +1,47 @@
+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())
+