FT017TH.receive: now async, quits after timeout_seconds without valid packet, limit waiting for edge on GDO0 to timeout_seconds (blocks thread), no longer yield None; command wireless-sensor-receive: timeout after one hour without valid packet

Author: fphammerle

CHANGELOG.md

@@ -9,6 +9,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - added attribute type hints to `Measurement` class
 - declare compatibility with `python3.11`
 
+### Changed
+- method `FT017TH.receive`
+  - now async
+  - quits after `timeout_seconds` without valid packet
+  - `gpiod_line_request_rising_edge_events` (within `cc1101` library) blocks
+    thread for up to `timeout_seconds`
+  - no longer yields `None`
+- command `wireless-sensor-receive`: timeout after one hour without valid packet
+
 ### Removed
 - compatibility with `python3.5`, `python3.6`, `python3.7` & `python3.8`
 

Pipfile

@@ -11,6 +11,7 @@ black = "*"
 mypy = "*"
 pylint = "*"
 pytest = "*"
+pytest-asyncio = "*"
 pytest-cov = "*"
 
 # python<3.11 compatibility

Pipfile.lock

@@ -37,16 +37,18 @@ $ wireless-sensor-receive
 ### Python Library
 
 ```python
+import asyncio
+
 import wireless_sensor
 
-sensor = wireless_sensor.FT017TH(gdo0_gpio_line_name=b'GPIO24')
-for measurement in sensor.receive(timeout_seconds=600):
-    if not measurement:
-        print("invalid packet or timeout")
-        continue
-    print(
-        measurement.decoding_timestamp,
-        measurement.temperature_degrees_celsius,
-        measurement.relative_humidity,
-    )
+async def _main():
+    sensor = wireless_sensor.FT017TH(gdo0_gpio_line_name=b'GPIO24')
+    async for measurement in sensor.receive(timeout_seconds=600):
+        print(
+            measurement.decoding_timestamp,
+            measurement.temperature_degrees_celsius,
+            measurement.relative_humidity,
+        )
+
+asyncio.run(_main())
 ```

README.md

@@ -73,5 +73,5 @@
         "cc1101==2.7.3",
     ],
     setup_requires=["setuptools_scm"],
-    tests_require=["pytest"],
+    tests_require=["pytest", "pytest-asyncio"],
 )

setup.py

@@ -17,6 +17,7 @@
 
 import datetime
 import logging
+import typing
 import unittest.mock
 
 import pytest
@@ -27,6 +28,28 @@
 # pylint: disable=protected-access
 
 
+async def _receive_mock(
+    sensor: wireless_sensor.FT017TH, timeout_seconds: int
+) -> typing.AsyncIterator[wireless_sensor.Measurement]:
+    assert isinstance(sensor, wireless_sensor.FT017TH)
+    assert timeout_seconds == 3600
+    yield wireless_sensor.Measurement(
+        decoding_timestamp=datetime.datetime(2020, 12, 7, 10, 0, 0),
+        temperature_degrees_celsius=24.1234,
+        relative_humidity=0.51234,
+    )
+    yield wireless_sensor.Measurement(
+        decoding_timestamp=datetime.datetime(2020, 12, 7, 10, 0, 50),
+        temperature_degrees_celsius=22.42,
+        relative_humidity=0.55123,
+    )
+    yield wireless_sensor.Measurement(
+        decoding_timestamp=datetime.datetime(2020, 12, 7, 10, 1, 41),
+        temperature_degrees_celsius=21.1234,
+        relative_humidity=0.61234,
+    )
+
+
 @pytest.mark.parametrize(
     ("argv", "root_log_level", "unlock_spi_device", "gdo0_gpio_line_name"),
     [
@@ -41,25 +64,7 @@ def test__receive(capsys, argv, root_log_level, unlock_spi_device, gdo0_gpio_lin
     with unittest.mock.patch(
         "wireless_sensor.FT017TH.__init__", return_value=None
     ) as init_mock, unittest.mock.patch(
-        "wireless_sensor.FT017TH.receive",
-        return_value=[
-            wireless_sensor.Measurement(
-                decoding_timestamp=datetime.datetime(2020, 12, 7, 10, 0, 0),
-                temperature_degrees_celsius=24.1234,
-                relative_humidity=0.51234,
-            ),
-            wireless_sensor.Measurement(
-                decoding_timestamp=datetime.datetime(2020, 12, 7, 10, 0, 50),
-                temperature_degrees_celsius=22.42,
-                relative_humidity=0.55123,
-            ),
-            None,  # timeout or error
-            wireless_sensor.Measurement(
-                decoding_timestamp=datetime.datetime(2020, 12, 7, 10, 1, 41),
-                temperature_degrees_celsius=21.1234,
-                relative_humidity=0.61234,
-            ),
-        ],
+        "wireless_sensor.FT017TH.receive", _receive_mock
     ):
         with unittest.mock.patch("sys.argv", argv), unittest.mock.patch(
             "logging.basicConfig"
@@ -78,4 +83,5 @@ def test__receive(capsys, argv, root_log_level, unlock_spi_device, gdo0_gpio_lin
         "2020-12-07T10:00:00\t24.1°C\t51.2%\n"
         "2020-12-07T10:00:50\t22.4°C\t55.1%\n"
         "2020-12-07T10:01:41\t21.1°C\t61.2%\n"
+        "timeout\n"
     )