ruuvitag-sensor 2.3.0__tar.gz → 2.3.1__tar.gz

{ruuvitag_sensor-2.3.0 → ruuvitag_sensor-2.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ruuvitag_sensor
-Version: 2.3.0
+Version: 2.3.1
 Summary: Find RuuviTag sensors and get decoded data from selected sensors
 Author-email: Tomi Tuhkanen <tomi.tuhkanen@iki.fi>
 License: MIT License
@@ -36,6 +36,7 @@ Classifier: Programming Language :: Python :: 3.8
 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: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Intended Audience :: Developers
@@ -57,7 +58,7 @@ Requires-Dist: flake8-pyproject; extra == "dev"
 Requires-Dist: pylint; extra == "dev"
 Requires-Dist: mypy; extra == "dev"
 Requires-Dist: isort; extra == "dev"
-Requires-Dist: black; extra == "dev"
+Requires-Dist: black==23.3.0; extra == "dev"
 
 RuuviTag Sensor Python Package
 ---------------------------------
@@ -66,7 +67,7 @@ RuuviTag Sensor Python Package
 [![License](https://img.shields.io/pypi/l/ruuvitag-sensor.svg)](https://pypi.python.org/pypi/ruuvitag-sensor/)
 [![PyPI version](https://img.shields.io/pypi/v/ruuvitag-sensor.svg)](https://pypi.python.org/pypi/ruuvitag_-sensor)
 [![PyPI downloads](https://img.shields.io/pypi/dm/ruuvitag-sensor.svg)](https://pypistats.org/packages/ruuvitag-sensor)
-[![Python versions](https://img.shields.io/pypi/pyversions/ruuvitag-sensor.svg)](https://pypi.python.org/pypi/ruuvitag-sensor/)
+[![Python versions](https://img.shields.io/badge/python-3.7+-blue.svg)](https://pypi.python.org/pypi/ruuvitag-sensor/)
 
 `ruuvitag-sensor` is a Python package for communicating with [RuuviTag BLE Sensor](https://ruuvi.com/) and for decoding measurement data from broadcasted BLE data.
 
@@ -78,18 +79,21 @@ RuuviTag Sensor Python Package
     * Setup [guide](https://ruuvi.com/quick-start/)
     * Supports [Data Format 2, 3, 4 and 5](https://docs.ruuvi.com/)
       * __NOTE:__ Data Formats 2, 3 and 4 are _deprecated_ and should not be used
-* Bluez (Linux-only)
-    * Default adapter for Linux
-    * Bluez supports
-      * [Sync-methods](#usage)
-      * [Observable streams](#usage)
-    * [Install guide](#BlueZ)
 * [Bleak](https://github.com/hbldh/bleak) communication module (Windows, macOS and Linux)
     * Default adapter for Windows and macOS
     * Bleak supports
       * [Async-methods](#usage)
       * [Observable streams](#usage)
     * [Install guide](#Bleak)
+* Bluez (Linux-only)
+    * Default adapter for Linux
+    * Bluez supports
+      * [Sync-methods](#usage)
+      * [Observable streams](#usage)
+    * [Install guide](#BlueZ)
+    * __NOTE:__ The BlueZ-adapter implementation uses deprecated BlueZ tools that are no longer supported.
+      * Even though BlueZ is still the default adapter, it is recommended to use the Bleak-communication adapter with Linux. Bleak will be the default adapter for Linux in the next major release.
+      * Bleson-adapter supports sync-methods, but please be aware that it is not fully supported due to the alpha release status of the Bleson communication module. See [Bleson](#Bleson) for more information.
 * Python 3.7+
     * For Python 2.x or <3.7 support, check [installation instructions](#python-2x-and-36-and-below) for an older version
 
@@ -118,8 +122,8 @@ Full installation guide for [Raspberry PI & Raspbian](https://github.com/ttu/ruu
 
 The package provides 3 ways to fetch data from sensors:
 
-1. Synchronously with callback
-2. Asynchronously with async/await
+1. Asynchronously with async/await
+2. Synchronously with callback
 3. Observable streams with ReactiveX
 
 RuuviTag sensors can be identified using MAC addresses. Methods return a tuple with MAC and sensor data payload.
@@ -128,56 +132,11 @@ RuuviTag sensors can be identified using MAC addresses. Methods return a tuple w
 ('D2:A3:6E:C8:E0:25', {'data_format': 5, 'humidity': 47.62, 'temperature': 23.58, 'pressure': 1023.68, 'acceleration': 993.2331045630729, 'acceleration_x': -48, 'acceleration_y': -12, 'acceleration_z': 992, 'tx_power': 4, 'battery': 2197, 'movement_counter': 0, 'measurement_sequence_number': 88, 'mac': 'd2a36ec8e025', 'rssi': -80})
 ```
 
-### 1. Get sensor data synchronously with callback
-
-`get_data` calls the callback whenever a RuuviTag sensor broadcasts data. This method is the preferred way to use the library with _BlueZ_.
-
-```python
-from ruuvitag_sensor.ruuvi import RuuviTagSensor
-
-
-def handle_data(found_data):
-    print(f"MAC {found_data[0]}")
-    print(f"Data {found_data[1]}")
-
-
-if __name__ == "__main__":
-    RuuviTagSensor.get_data(handle_data)
-```
-
-The line `if __name__ == "__main__":` is required on Windows and macOS due to the way the `multiprocessing` library works. It is not required on Linux, but it is recommended. It is omitted from the rest of the examples below.
-
-The optional list of MACs and run flag can be passed to the `get_data` function. The callback is called only for MACs in the list and setting the run flag to false will stop execution. If the run flag is not passed, the function will execute forever.
-
-```python
-from ruuvitag_sensor.ruuvi import RuuviTagSensor, RunFlag
-
-counter = 10
-# RunFlag for stopping execution at desired time
-run_flag = RunFlag()
-
-
-def handle_data(found_data):
-    print(f"MAC: {found_data[0]}")
-    print(f"Data: {found_data[1]}")
-
-    global counter
-    counter = counter - 1
-    if counter < 0:
-        run_flag.running = False
-
-
-# List of MACs of sensors which will execute callback function
-macs = ["AA:2C:6A:1E:59:3D", "CC:2C:6A:1E:59:3D"]
-
-RuuviTagSensor.get_data(handle_data, macs, run_flag)
-```
-
-### 2. Get sensor data asynchronously
+### 1. Get sensor data asynchronously with async/await
 
 __NOTE:__ Asynchronous functionality works only with `Bleak`-adapter.
 
-`get_data_async` returns the data whenever a RuuviTag sensor broadcasts data. `get_data_async` will exceute until iterator is exited. This method is the preferred way to use the library with _Bleak_.
+`get_data_async` returns the data whenever a RuuviTag sensor broadcasts data. `get_data_async` will execute until iterator is exited. This method is the preferred way to use the library with _Bleak_.
 
 ```py
 import asyncio
@@ -218,6 +177,53 @@ if __name__ == "__main__":
     asyncio.get_event_loop().run_until_complete(main())
 ```
 
+The line `if __name__ == "__main__":` is required on Windows and macOS due to the way the `multiprocessing` library works. It is not required on Linux, but it is recommended. It is omitted from the rest of the examples below.
+
+### 2. Get sensor data synchronously with callback
+
+__NOTE:__ Asynchronous functionality works only with `BlueZ`-adapter.
+
+`get_data` calls the callback whenever a RuuviTag sensor broadcasts data. This method is the preferred way to use the library with _BlueZ_.
+
+```python
+from ruuvitag_sensor.ruuvi import RuuviTagSensor
+
+
+def handle_data(found_data):
+    print(f"MAC {found_data[0]}")
+    print(f"Data {found_data[1]}")
+
+
+if __name__ == "__main__":
+    RuuviTagSensor.get_data(handle_data)
+```
+
+The optional list of MACs and run flag can be passed to the `get_data` function. The callback is called only for MACs in the list and setting the run flag to false will stop execution. If the run flag is not passed, the function will execute forever.
+
+```python
+from ruuvitag_sensor.ruuvi import RuuviTagSensor, RunFlag
+
+counter = 10
+# RunFlag for stopping execution at desired time
+run_flag = RunFlag()
+
+
+def handle_data(found_data):
+    print(f"MAC: {found_data[0]}")
+    print(f"Data: {found_data[1]}")
+
+    global counter
+    counter = counter - 1
+    if counter < 0:
+        run_flag.running = False
+
+
+# List of MACs of sensors which will execute callback function
+macs = ["AA:2C:6A:1E:59:3D", "CC:2C:6A:1E:59:3D"]
+
+RuuviTagSensor.get_data(handle_data, macs, run_flag)
+```
+
 ### 3. Get sensor data with observable streams (ReactiveX / RxPY)
 
 `RuuviTagReactive` is a reactive wrapper and background process for RuuviTagSensor `get_data`. An optional MAC address list can be passed on the initializer and execution can be stopped with the stop function.
@@ -245,7 +251,7 @@ ruuvi_rx.get_subject().pipe(
       ops.distinct_until_changed()
     ).subscribe(lambda x: print(f"Temperature changed: {x}"))
 
-# Close all connections and stop bluetooth communication
+# Close all connections and stop Bluetooth communication
 ruuvi_rx.stop()
 ```
 
@@ -311,7 +317,7 @@ RuuviTagSensor.find_ruuvitags()
 
 ### Using different Bluetooth device
 
-If you have multiple Bluetooth devices installed, a device to be used might not be the default (Linux: hci0). The device can be passed with a `bt_device`-parameter.
+If you have multiple Bluetooth devices installed, a device to be used might not be the default (Linux: `hci0`). The device can be passed with a `bt_device`-parameter.
 
 ```python
 from ruuvitag_sensor.ruuvi import RuuviTagSensor
@@ -481,6 +487,18 @@ $ sudo apt-get install bluez bluez-hcidump
 
 `ruuvitag-sensor` package uses internally _hciconfig_, _hcitool_ and _hcidump_. These tools are deprecated. In case tools are missing, an older version of BlueZ is required ([Issue](https://github.com/ttu/ruuvitag-sensor/issues/31))
 
+If you wish to test the library on Windows or macOS, enable it with `RUUVI_BLE_ADAPTER` environment variable.
+
+```sh
+$ export RUUVI_BLE_ADAPTER="bluez"
+```
+
+And install ptyprocess.
+
+```sh
+python -m pip install ptyprocess
+```
+
 #### BlueZ limitations
 
 `ruuvitag-sensor` package uses BlueZ to listen to broadcasted BL information (uses _hciconf_, _hcitool_, _hcidump_). Implementation does not handle well all unexpected errors or changes, e.g. when the adapter is busy, rebooted or powered down.
@@ -503,7 +521,7 @@ Add environment variable RUUVI_BLE_ADAPTER with value Bleak. E.g.
 $ export RUUVI_BLE_ADAPTER="bleak"
 ```
 
-Or use `os.environ`. NOTE: this must be set before importing `ruuvitag_sensor`.
+Or use `os.environ`. __NOTE:__ this must be set before importing `ruuvitag_sensor`.
 
 ```py
 import os
@@ -537,12 +555,12 @@ Bleak-adapter has a development-time generator for dummy data, which can be usef
 
 Current state and known bugs in [issue #78](https://github.com/ttu/ruuvitag-sensor/issues/78).
 
-Bleson works with Linux, macOS and partially with Windows.
+[Bleson](https://github.com/TheCellule/python-bleson) works with Linux, macOS and partially with Windows.
 
 Bleson is not installed automatically with `ruuvitag-sensor` package. Install it manually from GitHub.
 
 ```sh
-$ pip install git+https://github.com/TheCellule/python-bleson
+$ python -m pip install git+https://github.com/TheCellule/python-bleson
 ```
 
 Add environment variable `RUUVI_BLE_ADAPTER` with value `bleson`. E.g.

{ruuvitag_sensor-2.3.0 → ruuvitag_sensor-2.3.1}/README.md

@@ -5,7 +5,7 @@ RuuviTag Sensor Python Package
 [![License](https://img.shields.io/pypi/l/ruuvitag-sensor.svg)](https://pypi.python.org/pypi/ruuvitag-sensor/)
 [![PyPI version](https://img.shields.io/pypi/v/ruuvitag-sensor.svg)](https://pypi.python.org/pypi/ruuvitag_-sensor)
 [![PyPI downloads](https://img.shields.io/pypi/dm/ruuvitag-sensor.svg)](https://pypistats.org/packages/ruuvitag-sensor)
-[![Python versions](https://img.shields.io/pypi/pyversions/ruuvitag-sensor.svg)](https://pypi.python.org/pypi/ruuvitag-sensor/)
+[![Python versions](https://img.shields.io/badge/python-3.7+-blue.svg)](https://pypi.python.org/pypi/ruuvitag-sensor/)
 
 `ruuvitag-sensor` is a Python package for communicating with [RuuviTag BLE Sensor](https://ruuvi.com/) and for decoding measurement data from broadcasted BLE data.
 
@@ -17,18 +17,21 @@ RuuviTag Sensor Python Package
     * Setup [guide](https://ruuvi.com/quick-start/)
     * Supports [Data Format 2, 3, 4 and 5](https://docs.ruuvi.com/)
       * __NOTE:__ Data Formats 2, 3 and 4 are _deprecated_ and should not be used
-* Bluez (Linux-only)
-    * Default adapter for Linux
-    * Bluez supports
-      * [Sync-methods](#usage)
-      * [Observable streams](#usage)
-    * [Install guide](#BlueZ)
 * [Bleak](https://github.com/hbldh/bleak) communication module (Windows, macOS and Linux)
     * Default adapter for Windows and macOS
     * Bleak supports
       * [Async-methods](#usage)
       * [Observable streams](#usage)
     * [Install guide](#Bleak)
+* Bluez (Linux-only)
+    * Default adapter for Linux
+    * Bluez supports
+      * [Sync-methods](#usage)
+      * [Observable streams](#usage)
+    * [Install guide](#BlueZ)
+    * __NOTE:__ The BlueZ-adapter implementation uses deprecated BlueZ tools that are no longer supported.
+      * Even though BlueZ is still the default adapter, it is recommended to use the Bleak-communication adapter with Linux. Bleak will be the default adapter for Linux in the next major release.
+      * Bleson-adapter supports sync-methods, but please be aware that it is not fully supported due to the alpha release status of the Bleson communication module. See [Bleson](#Bleson) for more information.
 * Python 3.7+
     * For Python 2.x or <3.7 support, check [installation instructions](#python-2x-and-36-and-below) for an older version
 
@@ -57,8 +60,8 @@ Full installation guide for [Raspberry PI & Raspbian](https://github.com/ttu/ruu
 
 The package provides 3 ways to fetch data from sensors:
 
-1. Synchronously with callback
-2. Asynchronously with async/await
+1. Asynchronously with async/await
+2. Synchronously with callback
 3. Observable streams with ReactiveX
 
 RuuviTag sensors can be identified using MAC addresses. Methods return a tuple with MAC and sensor data payload.
@@ -67,56 +70,11 @@ RuuviTag sensors can be identified using MAC addresses. Methods return a tuple w
 ('D2:A3:6E:C8:E0:25', {'data_format': 5, 'humidity': 47.62, 'temperature': 23.58, 'pressure': 1023.68, 'acceleration': 993.2331045630729, 'acceleration_x': -48, 'acceleration_y': -12, 'acceleration_z': 992, 'tx_power': 4, 'battery': 2197, 'movement_counter': 0, 'measurement_sequence_number': 88, 'mac': 'd2a36ec8e025', 'rssi': -80})
 ```
 
-### 1. Get sensor data synchronously with callback
-
-`get_data` calls the callback whenever a RuuviTag sensor broadcasts data. This method is the preferred way to use the library with _BlueZ_.
-
-```python
-from ruuvitag_sensor.ruuvi import RuuviTagSensor
-
-
-def handle_data(found_data):
-    print(f"MAC {found_data[0]}")
-    print(f"Data {found_data[1]}")
-
-
-if __name__ == "__main__":
-    RuuviTagSensor.get_data(handle_data)
-```
-
-The line `if __name__ == "__main__":` is required on Windows and macOS due to the way the `multiprocessing` library works. It is not required on Linux, but it is recommended. It is omitted from the rest of the examples below.
-
-The optional list of MACs and run flag can be passed to the `get_data` function. The callback is called only for MACs in the list and setting the run flag to false will stop execution. If the run flag is not passed, the function will execute forever.
-
-```python
-from ruuvitag_sensor.ruuvi import RuuviTagSensor, RunFlag
-
-counter = 10
-# RunFlag for stopping execution at desired time
-run_flag = RunFlag()
-
-
-def handle_data(found_data):
-    print(f"MAC: {found_data[0]}")
-    print(f"Data: {found_data[1]}")
-
-    global counter
-    counter = counter - 1
-    if counter < 0:
-        run_flag.running = False
-
-
-# List of MACs of sensors which will execute callback function
-macs = ["AA:2C:6A:1E:59:3D", "CC:2C:6A:1E:59:3D"]
-
-RuuviTagSensor.get_data(handle_data, macs, run_flag)
-```
-
-### 2. Get sensor data asynchronously
+### 1. Get sensor data asynchronously with async/await
 
 __NOTE:__ Asynchronous functionality works only with `Bleak`-adapter.
 
-`get_data_async` returns the data whenever a RuuviTag sensor broadcasts data. `get_data_async` will exceute until iterator is exited. This method is the preferred way to use the library with _Bleak_.
+`get_data_async` returns the data whenever a RuuviTag sensor broadcasts data. `get_data_async` will execute until iterator is exited. This method is the preferred way to use the library with _Bleak_.
 
 ```py
 import asyncio
@@ -157,6 +115,53 @@ if __name__ == "__main__":
     asyncio.get_event_loop().run_until_complete(main())
 ```
 
+The line `if __name__ == "__main__":` is required on Windows and macOS due to the way the `multiprocessing` library works. It is not required on Linux, but it is recommended. It is omitted from the rest of the examples below.
+
+### 2. Get sensor data synchronously with callback
+
+__NOTE:__ Asynchronous functionality works only with `BlueZ`-adapter.
+
+`get_data` calls the callback whenever a RuuviTag sensor broadcasts data. This method is the preferred way to use the library with _BlueZ_.
+
+```python
+from ruuvitag_sensor.ruuvi import RuuviTagSensor
+
+
+def handle_data(found_data):
+    print(f"MAC {found_data[0]}")
+    print(f"Data {found_data[1]}")
+
+
+if __name__ == "__main__":
+    RuuviTagSensor.get_data(handle_data)
+```
+
+The optional list of MACs and run flag can be passed to the `get_data` function. The callback is called only for MACs in the list and setting the run flag to false will stop execution. If the run flag is not passed, the function will execute forever.
+
+```python
+from ruuvitag_sensor.ruuvi import RuuviTagSensor, RunFlag
+
+counter = 10
+# RunFlag for stopping execution at desired time
+run_flag = RunFlag()
+
+
+def handle_data(found_data):
+    print(f"MAC: {found_data[0]}")
+    print(f"Data: {found_data[1]}")
+
+    global counter
+    counter = counter - 1
+    if counter < 0:
+        run_flag.running = False
+
+
+# List of MACs of sensors which will execute callback function
+macs = ["AA:2C:6A:1E:59:3D", "CC:2C:6A:1E:59:3D"]
+
+RuuviTagSensor.get_data(handle_data, macs, run_flag)
+```
+
 ### 3. Get sensor data with observable streams (ReactiveX / RxPY)
 
 `RuuviTagReactive` is a reactive wrapper and background process for RuuviTagSensor `get_data`. An optional MAC address list can be passed on the initializer and execution can be stopped with the stop function.
@@ -184,7 +189,7 @@ ruuvi_rx.get_subject().pipe(
       ops.distinct_until_changed()
     ).subscribe(lambda x: print(f"Temperature changed: {x}"))
 
-# Close all connections and stop bluetooth communication
+# Close all connections and stop Bluetooth communication
 ruuvi_rx.stop()
 ```
 
@@ -250,7 +255,7 @@ RuuviTagSensor.find_ruuvitags()
 
 ### Using different Bluetooth device
 
-If you have multiple Bluetooth devices installed, a device to be used might not be the default (Linux: hci0). The device can be passed with a `bt_device`-parameter.
+If you have multiple Bluetooth devices installed, a device to be used might not be the default (Linux: `hci0`). The device can be passed with a `bt_device`-parameter.
 
 ```python
 from ruuvitag_sensor.ruuvi import RuuviTagSensor
@@ -420,6 +425,18 @@ $ sudo apt-get install bluez bluez-hcidump
 
 `ruuvitag-sensor` package uses internally _hciconfig_, _hcitool_ and _hcidump_. These tools are deprecated. In case tools are missing, an older version of BlueZ is required ([Issue](https://github.com/ttu/ruuvitag-sensor/issues/31))
 
+If you wish to test the library on Windows or macOS, enable it with `RUUVI_BLE_ADAPTER` environment variable.
+
+```sh
+$ export RUUVI_BLE_ADAPTER="bluez"
+```
+
+And install ptyprocess.
+
+```sh
+python -m pip install ptyprocess
+```
+
 #### BlueZ limitations
 
 `ruuvitag-sensor` package uses BlueZ to listen to broadcasted BL information (uses _hciconf_, _hcitool_, _hcidump_). Implementation does not handle well all unexpected errors or changes, e.g. when the adapter is busy, rebooted or powered down.
@@ -442,7 +459,7 @@ Add environment variable RUUVI_BLE_ADAPTER with value Bleak. E.g.
 $ export RUUVI_BLE_ADAPTER="bleak"
 ```
 
-Or use `os.environ`. NOTE: this must be set before importing `ruuvitag_sensor`.
+Or use `os.environ`. __NOTE:__ this must be set before importing `ruuvitag_sensor`.
 
 ```py
 import os
@@ -476,12 +493,12 @@ Bleak-adapter has a development-time generator for dummy data, which can be usef
 
 Current state and known bugs in [issue #78](https://github.com/ttu/ruuvitag-sensor/issues/78).
 
-Bleson works with Linux, macOS and partially with Windows.
+[Bleson](https://github.com/TheCellule/python-bleson) works with Linux, macOS and partially with Windows.
 
 Bleson is not installed automatically with `ruuvitag-sensor` package. Install it manually from GitHub.
 
 ```sh
-$ pip install git+https://github.com/TheCellule/python-bleson
+$ python -m pip install git+https://github.com/TheCellule/python-bleson
 ```
 
 Add environment variable `RUUVI_BLE_ADAPTER` with value `bleson`. E.g.

{ruuvitag_sensor-2.3.0 → ruuvitag_sensor-2.3.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ruuvitag_sensor"
-version = "2.3.0"
+version = "2.3.1"
 authors = [
   { name="Tomi Tuhkanen", email="tomi.tuhkanen@iki.fi" },
 ]
@@ -19,6 +19,7 @@ classifiers = [
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
     "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent",
     "Intended Audience :: Developers",
@@ -43,7 +44,7 @@ dev = [
     "pylint",
     "mypy",
     "isort",
-    "black"
+    "black==23.3.0"  # Lock black to the latest version that supports Python 3.7
 ]
 
 [project.urls]

{ruuvitag_sensor-2.3.0 → ruuvitag_sensor-2.3.1}/ruuvitag_sensor/adapters/__init__.py

@@ -5,28 +5,43 @@ from typing import AsyncGenerator, Generator, List
 
 from ruuvitag_sensor.ruuvi_types import MacAndRawData, RawData
 
-# pylint: disable=import-outside-toplevel, cyclic-import
+# pylint: disable=import-outside-toplevel, cyclic-import, too-many-return-statements
 
 
 def get_ble_adapter():
-    if "bleak" in os.environ.get("RUUVI_BLE_ADAPTER", "").lower():
-        from ruuvitag_sensor.adapters.bleak_ble import BleCommunicationBleak
+    forced_ble_adapter = os.environ.get("RUUVI_BLE_ADAPTER", "").lower()
+    use_ruuvi_nix_from_file = "RUUVI_NIX_FROMFILE" in os.environ
+    is_ci_env = "CI" in os.environ
 
-        return BleCommunicationBleak()
-    if "bleson" in os.environ.get("RUUVI_BLE_ADAPTER", "").lower():
-        from ruuvitag_sensor.adapters.bleson import BleCommunicationBleson
+    if forced_ble_adapter:
+        if "bleak" in forced_ble_adapter:
+            from ruuvitag_sensor.adapters.bleak_ble import BleCommunicationBleak
+
+            return BleCommunicationBleak()
+        if "bleson" in forced_ble_adapter:
+            from ruuvitag_sensor.adapters.bleson import BleCommunicationBleson
+
+            return BleCommunicationBleson()
+        if "bluez" in forced_ble_adapter:
+            from ruuvitag_sensor.adapters.nix_hci import BleCommunicationNix
 
-        return BleCommunicationBleson()
-    if "RUUVI_NIX_FROMFILE" in os.environ:
+            return BleCommunicationNix()
+
+        raise RuntimeError(f"Unknown BLE adapter: {forced_ble_adapter}")
+
+    if use_ruuvi_nix_from_file:
         # Emulate BleCommunicationNix by reading hcidump data from a file
         from ruuvitag_sensor.adapters.nix_hci_file import BleCommunicationNixFile
 
         return BleCommunicationNixFile()
-    if "CI" in os.environ:
-        # Use BleCommunicationDummy for CI as it can't use bluez
+
+    if is_ci_env:
+        # Use BleCommunicationDummy for CI as it can't use BlueZ
         from ruuvitag_sensor.adapters.dummy import BleCommunicationDummy
 
         return BleCommunicationDummy()
+
+    # Use default adapter for platform
     if sys.platform.startswith("win") or sys.platform.startswith("darwin"):
         from ruuvitag_sensor.adapters.bleak_ble import BleCommunicationBleak
 

{ruuvitag_sensor-2.3.0 → ruuvitag_sensor-2.3.1}/ruuvitag_sensor/adapters/bleak_ble.py

@@ -6,15 +6,16 @@ import sys
 from typing import AsyncGenerator, List, Tuple
 
 from bleak import BleakScanner
-from bleak.backends.scanner import AdvertisementData, BLEDevice
+from bleak.backends.scanner import AdvertisementData, AdvertisementDataCallback, BLEDevice
 
 from ruuvitag_sensor.adapters import BleCommunicationAsync
+from ruuvitag_sensor.adapters.utils import rssi_to_hex
 from ruuvitag_sensor.ruuvi_types import MacAndRawData, RawData
 
 MAC_REGEX = "[0-9a-f]{2}([:])[0-9a-f]{2}(\\1[0-9a-f]{2}){4}$"
 
 
-def _get_scanner(detection_callback):
+def _get_scanner(detection_callback: AdvertisementDataCallback, bt_device: str = ""):
     # NOTE: On Linux - bleak.exc.BleakError: passive scanning mode requires bluez or_patterns
     # NOTE: On macOS - bleak.exc.BleakError: macOS does not support passive scanning
     scanning_mode = "passive" if sys.platform.startswith("win") else "active"
@@ -25,7 +26,12 @@ def _get_scanner(detection_callback):
 
         return DevBleakScanner(detection_callback, scanning_mode)
 
-    return BleakScanner(detection_callback=detection_callback, scanning_mode=scanning_mode)
+    if bt_device:
+        return BleakScanner(
+            detection_callback=detection_callback, scanning_mode=scanning_mode, adapter=bt_device
+        )  # type: ignore[arg-type]
+
+    return BleakScanner(detection_callback=detection_callback, scanning_mode=scanning_mode)  # type: ignore[arg-type]
 
 
 # TODO: Python 3.7 - TypeError: 'type' object is not subscriptable
@@ -71,15 +77,19 @@ class BleCommunicationBleak(BleCommunicationAsync):
             if 1177 not in advertisement_data.manufacturer_data:
                 return
 
+            log.debug("Received data: %s", advertisement_data)
+
             data = BleCommunicationBleak._parse_data(advertisement_data.manufacturer_data[1177])
 
             # Add RSSI to encoded data as hex. All adapters use a common decoder.
-            data += hex((advertisement_data.rssi + (1 << 8)) % (1 << 8)).replace("0x", "")
+            data += rssi_to_hex(advertisement_data.rssi)
             await queue.put((mac, data))
 
-        scanner = _get_scanner(detection_callback)
+        scanner = _get_scanner(detection_callback, bt_device)
         await scanner.start()
 
+        log.debug("Bleak scanner started")
+
         try:
             while True:
                 next_item: Tuple[str, str] = await queue.get()
@@ -93,6 +103,8 @@ class BleCommunicationBleak(BleCommunicationAsync):
 
         await scanner.stop()
 
+        log.debug("Bleak scanner stopped")
+
     @staticmethod
     async def get_first_data(mac: str, bt_device: str = "") -> RawData:
         """

{ruuvitag_sensor-2.3.0 → ruuvitag_sensor-2.3.1}/ruuvitag_sensor/adapters/bleson.py

@@ -8,6 +8,7 @@ from typing import Generator, List
 from bleson import Observer, get_provider
 
 from ruuvitag_sensor.adapters import BleCommunication
+from ruuvitag_sensor.adapters.utils import rssi_to_hex
 from ruuvitag_sensor.ruuvi_types import MacAndRawData, RawData
 
 log = logging.getLogger(__name__)
@@ -56,6 +57,9 @@ class BleCommunicationBleson(BleCommunication):
                 data = f"FF{data.hex()}"
                 data = f"{(len(data) >> 1):02x}{data}"
                 data = f"{(len(data) >> 1):02x}{data}"
+
+                # Add RSSI to encoded data as hex. All adapters use a common decoder.
+                data += rssi_to_hex(advertisement.rssi)
                 queue.put((mac, data.upper()))
             except GeneratorExit:
                 break

ruuvitag_sensor-2.3.1/ruuvitag_sensor/adapters/utils.py

@@ -0,0 +1,2 @@
+def rssi_to_hex(rssi: int) -> str:
+    return f"{(rssi + (1 << 8)) % (1 << 8):x}"

{ruuvitag_sensor-2.3.0 → ruuvitag_sensor-2.3.1}/ruuvitag_sensor/data_formats.py

@@ -78,7 +78,7 @@ class DataFormats:
                     break
         except ShortDataError as ex:
             # Data might be from RuuviTag, but received data was invalid
-            # e.g. it's possile that bluetooth stack received only partial data
+            # e.g. it's possible that Bluetooth stack received only partial data
             # Set the format to None, and data to '', this allows the
             # caller to determine that we did indeed see a Ruuvitag.
             log.debug("Error parsing advertisement data: %s", ex)

{ruuvitag_sensor-2.3.0 → ruuvitag_sensor-2.3.1}/ruuvitag_sensor.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
-Name: ruuvitag-sensor
-Version: 2.3.0
+Name: ruuvitag_sensor
+Version: 2.3.1
 Summary: Find RuuviTag sensors and get decoded data from selected sensors
 Author-email: Tomi Tuhkanen <tomi.tuhkanen@iki.fi>
 License: MIT License
@@ -36,6 +36,7 @@ Classifier: Programming Language :: Python :: 3.8
 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: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Intended Audience :: Developers
@@ -57,7 +58,7 @@ Requires-Dist: flake8-pyproject; extra == "dev"
 Requires-Dist: pylint; extra == "dev"
 Requires-Dist: mypy; extra == "dev"
 Requires-Dist: isort; extra == "dev"
-Requires-Dist: black; extra == "dev"
+Requires-Dist: black==23.3.0; extra == "dev"
 
 RuuviTag Sensor Python Package
 ---------------------------------
@@ -66,7 +67,7 @@ RuuviTag Sensor Python Package
 [![License](https://img.shields.io/pypi/l/ruuvitag-sensor.svg)](https://pypi.python.org/pypi/ruuvitag-sensor/)
 [![PyPI version](https://img.shields.io/pypi/v/ruuvitag-sensor.svg)](https://pypi.python.org/pypi/ruuvitag_-sensor)
 [![PyPI downloads](https://img.shields.io/pypi/dm/ruuvitag-sensor.svg)](https://pypistats.org/packages/ruuvitag-sensor)
-[![Python versions](https://img.shields.io/pypi/pyversions/ruuvitag-sensor.svg)](https://pypi.python.org/pypi/ruuvitag-sensor/)
+[![Python versions](https://img.shields.io/badge/python-3.7+-blue.svg)](https://pypi.python.org/pypi/ruuvitag-sensor/)
 
 `ruuvitag-sensor` is a Python package for communicating with [RuuviTag BLE Sensor](https://ruuvi.com/) and for decoding measurement data from broadcasted BLE data.
 
@@ -78,18 +79,21 @@ RuuviTag Sensor Python Package
     * Setup [guide](https://ruuvi.com/quick-start/)
     * Supports [Data Format 2, 3, 4 and 5](https://docs.ruuvi.com/)
       * __NOTE:__ Data Formats 2, 3 and 4 are _deprecated_ and should not be used
-* Bluez (Linux-only)
-    * Default adapter for Linux
-    * Bluez supports
-      * [Sync-methods](#usage)
-      * [Observable streams](#usage)
-    * [Install guide](#BlueZ)
 * [Bleak](https://github.com/hbldh/bleak) communication module (Windows, macOS and Linux)
     * Default adapter for Windows and macOS
     * Bleak supports
       * [Async-methods](#usage)
       * [Observable streams](#usage)
     * [Install guide](#Bleak)
+* Bluez (Linux-only)
+    * Default adapter for Linux
+    * Bluez supports
+      * [Sync-methods](#usage)
+      * [Observable streams](#usage)
+    * [Install guide](#BlueZ)
+    * __NOTE:__ The BlueZ-adapter implementation uses deprecated BlueZ tools that are no longer supported.
+      * Even though BlueZ is still the default adapter, it is recommended to use the Bleak-communication adapter with Linux. Bleak will be the default adapter for Linux in the next major release.
+      * Bleson-adapter supports sync-methods, but please be aware that it is not fully supported due to the alpha release status of the Bleson communication module. See [Bleson](#Bleson) for more information.
 * Python 3.7+
     * For Python 2.x or <3.7 support, check [installation instructions](#python-2x-and-36-and-below) for an older version
 
@@ -118,8 +122,8 @@ Full installation guide for [Raspberry PI & Raspbian](https://github.com/ttu/ruu
 
 The package provides 3 ways to fetch data from sensors:
 
-1. Synchronously with callback
-2. Asynchronously with async/await
+1. Asynchronously with async/await
+2. Synchronously with callback
 3. Observable streams with ReactiveX
 
 RuuviTag sensors can be identified using MAC addresses. Methods return a tuple with MAC and sensor data payload.
@@ -128,56 +132,11 @@ RuuviTag sensors can be identified using MAC addresses. Methods return a tuple w
 ('D2:A3:6E:C8:E0:25', {'data_format': 5, 'humidity': 47.62, 'temperature': 23.58, 'pressure': 1023.68, 'acceleration': 993.2331045630729, 'acceleration_x': -48, 'acceleration_y': -12, 'acceleration_z': 992, 'tx_power': 4, 'battery': 2197, 'movement_counter': 0, 'measurement_sequence_number': 88, 'mac': 'd2a36ec8e025', 'rssi': -80})
 ```
 
-### 1. Get sensor data synchronously with callback
-
-`get_data` calls the callback whenever a RuuviTag sensor broadcasts data. This method is the preferred way to use the library with _BlueZ_.
-
-```python
-from ruuvitag_sensor.ruuvi import RuuviTagSensor
-
-
-def handle_data(found_data):
-    print(f"MAC {found_data[0]}")
-    print(f"Data {found_data[1]}")
-
-
-if __name__ == "__main__":
-    RuuviTagSensor.get_data(handle_data)
-```
-
-The line `if __name__ == "__main__":` is required on Windows and macOS due to the way the `multiprocessing` library works. It is not required on Linux, but it is recommended. It is omitted from the rest of the examples below.
-
-The optional list of MACs and run flag can be passed to the `get_data` function. The callback is called only for MACs in the list and setting the run flag to false will stop execution. If the run flag is not passed, the function will execute forever.
-
-```python
-from ruuvitag_sensor.ruuvi import RuuviTagSensor, RunFlag
-
-counter = 10
-# RunFlag for stopping execution at desired time
-run_flag = RunFlag()
-
-
-def handle_data(found_data):
-    print(f"MAC: {found_data[0]}")
-    print(f"Data: {found_data[1]}")
-
-    global counter
-    counter = counter - 1
-    if counter < 0:
-        run_flag.running = False
-
-
-# List of MACs of sensors which will execute callback function
-macs = ["AA:2C:6A:1E:59:3D", "CC:2C:6A:1E:59:3D"]
-
-RuuviTagSensor.get_data(handle_data, macs, run_flag)
-```
-
-### 2. Get sensor data asynchronously
+### 1. Get sensor data asynchronously with async/await
 
 __NOTE:__ Asynchronous functionality works only with `Bleak`-adapter.
 
-`get_data_async` returns the data whenever a RuuviTag sensor broadcasts data. `get_data_async` will exceute until iterator is exited. This method is the preferred way to use the library with _Bleak_.
+`get_data_async` returns the data whenever a RuuviTag sensor broadcasts data. `get_data_async` will execute until iterator is exited. This method is the preferred way to use the library with _Bleak_.
 
 ```py
 import asyncio
@@ -218,6 +177,53 @@ if __name__ == "__main__":
     asyncio.get_event_loop().run_until_complete(main())
 ```
 
+The line `if __name__ == "__main__":` is required on Windows and macOS due to the way the `multiprocessing` library works. It is not required on Linux, but it is recommended. It is omitted from the rest of the examples below.
+
+### 2. Get sensor data synchronously with callback
+
+__NOTE:__ Asynchronous functionality works only with `BlueZ`-adapter.
+
+`get_data` calls the callback whenever a RuuviTag sensor broadcasts data. This method is the preferred way to use the library with _BlueZ_.
+
+```python
+from ruuvitag_sensor.ruuvi import RuuviTagSensor
+
+
+def handle_data(found_data):
+    print(f"MAC {found_data[0]}")
+    print(f"Data {found_data[1]}")
+
+
+if __name__ == "__main__":
+    RuuviTagSensor.get_data(handle_data)
+```
+
+The optional list of MACs and run flag can be passed to the `get_data` function. The callback is called only for MACs in the list and setting the run flag to false will stop execution. If the run flag is not passed, the function will execute forever.
+
+```python
+from ruuvitag_sensor.ruuvi import RuuviTagSensor, RunFlag
+
+counter = 10
+# RunFlag for stopping execution at desired time
+run_flag = RunFlag()
+
+
+def handle_data(found_data):
+    print(f"MAC: {found_data[0]}")
+    print(f"Data: {found_data[1]}")
+
+    global counter
+    counter = counter - 1
+    if counter < 0:
+        run_flag.running = False
+
+
+# List of MACs of sensors which will execute callback function
+macs = ["AA:2C:6A:1E:59:3D", "CC:2C:6A:1E:59:3D"]
+
+RuuviTagSensor.get_data(handle_data, macs, run_flag)
+```
+
 ### 3. Get sensor data with observable streams (ReactiveX / RxPY)
 
 `RuuviTagReactive` is a reactive wrapper and background process for RuuviTagSensor `get_data`. An optional MAC address list can be passed on the initializer and execution can be stopped with the stop function.
@@ -245,7 +251,7 @@ ruuvi_rx.get_subject().pipe(
       ops.distinct_until_changed()
     ).subscribe(lambda x: print(f"Temperature changed: {x}"))
 
-# Close all connections and stop bluetooth communication
+# Close all connections and stop Bluetooth communication
 ruuvi_rx.stop()
 ```
 
@@ -311,7 +317,7 @@ RuuviTagSensor.find_ruuvitags()
 
 ### Using different Bluetooth device
 
-If you have multiple Bluetooth devices installed, a device to be used might not be the default (Linux: hci0). The device can be passed with a `bt_device`-parameter.
+If you have multiple Bluetooth devices installed, a device to be used might not be the default (Linux: `hci0`). The device can be passed with a `bt_device`-parameter.
 
 ```python
 from ruuvitag_sensor.ruuvi import RuuviTagSensor
@@ -481,6 +487,18 @@ $ sudo apt-get install bluez bluez-hcidump
 
 `ruuvitag-sensor` package uses internally _hciconfig_, _hcitool_ and _hcidump_. These tools are deprecated. In case tools are missing, an older version of BlueZ is required ([Issue](https://github.com/ttu/ruuvitag-sensor/issues/31))
 
+If you wish to test the library on Windows or macOS, enable it with `RUUVI_BLE_ADAPTER` environment variable.
+
+```sh
+$ export RUUVI_BLE_ADAPTER="bluez"
+```
+
+And install ptyprocess.
+
+```sh
+python -m pip install ptyprocess
+```
+
 #### BlueZ limitations
 
 `ruuvitag-sensor` package uses BlueZ to listen to broadcasted BL information (uses _hciconf_, _hcitool_, _hcidump_). Implementation does not handle well all unexpected errors or changes, e.g. when the adapter is busy, rebooted or powered down.
@@ -503,7 +521,7 @@ Add environment variable RUUVI_BLE_ADAPTER with value Bleak. E.g.
 $ export RUUVI_BLE_ADAPTER="bleak"
 ```
 
-Or use `os.environ`. NOTE: this must be set before importing `ruuvitag_sensor`.
+Or use `os.environ`. __NOTE:__ this must be set before importing `ruuvitag_sensor`.
 
 ```py
 import os
@@ -537,12 +555,12 @@ Bleak-adapter has a development-time generator for dummy data, which can be usef
 
 Current state and known bugs in [issue #78](https://github.com/ttu/ruuvitag-sensor/issues/78).
 
-Bleson works with Linux, macOS and partially with Windows.
+[Bleson](https://github.com/TheCellule/python-bleson) works with Linux, macOS and partially with Windows.
 
 Bleson is not installed automatically with `ruuvitag-sensor` package. Install it manually from GitHub.
 
 ```sh
-$ pip install git+https://github.com/TheCellule/python-bleson
+$ python -m pip install git+https://github.com/TheCellule/python-bleson
 ```
 
 Add environment variable `RUUVI_BLE_ADAPTER` with value `bleson`. E.g.

{ruuvitag_sensor-2.3.0 → ruuvitag_sensor-2.3.1}/ruuvitag_sensor.egg-info/SOURCES.txt

@@ -22,6 +22,7 @@ ruuvitag_sensor/adapters/bleson.py
 ruuvitag_sensor/adapters/dummy.py
 ruuvitag_sensor/adapters/nix_hci.py
 ruuvitag_sensor/adapters/nix_hci_file.py
+ruuvitag_sensor/adapters/utils.py
 ruuvitag_sensor/adapters/development/__init__.py
 ruuvitag_sensor/adapters/development/dev_bleak_scanner.py
 tests/test_data_formats.py

{ruuvitag_sensor-2.3.0 → ruuvitag_sensor-2.3.1}/ruuvitag_sensor.egg-info/requires.txt

@@ -17,4 +17,4 @@ flake8-pyproject
 pylint
 mypy
 isort
-black
+black==23.3.0