docs: bleak specific updates

README.md

@@ -215,7 +215,7 @@ __NOTE:__ These methods shouldn't be used for a long duration with a short timeo
 
 #### Get data from a sensor
 
-__NOTE:__ For a single sensor it is recommended to use `RuuviTagSensor.get_data` or `RuuviTagSensor.get_data_async` methods instead of `RuuviTag`- or `RuuviTagAsync`-class.
+__NOTE:__ For a single sensor it is recommended to use `RuuviTagSensor.get_data` or `RuuviTagSensor.get_data_async` methods instead of `RuuviTag`- or `RuuviTagAsync`-class. `RuuviTagAsync`-class doesn't work with macOS, due to the way how macOS returns MAC address.
 
 ```python
 from ruuvitag_sensor.ruuvitag import RuuviTag
@@ -433,7 +433,7 @@ $ python -m pip install bleak
 Add environment variable RUUVI_BLE_ADAPTER with value Bleak. E.g.
 
 ```sh
-$ export RUUVI_BLE_ADAPTER="Bleak"
+$ export RUUVI_BLE_ADAPTER="bleak"
 ```
 Or use `os.environ`. NOTE: this must be set before importing `ruuvitag_sensor`.
 
@@ -477,10 +477,10 @@ Bleson is not installed automatically with `ruuvitag-sensor` package. Install it
 $ pip install git+https://github.com/TheCellule/python-bleson
 ```
 
-Add environment variable `RUUVI_BLE_ADAPTER` with value `Bleson`. E.g.
+Add environment variable `RUUVI_BLE_ADAPTER` with value `bleson`. E.g.
 
 ```sh
-$ export RUUVI_BLE_ADAPTER="Bleson"
+$ export RUUVI_BLE_ADAPTER="bleson"
 ```
 
 __NOTE:__ On macOS, only Data Format 5 works, as macOS doesn't advertise MAC address and only DF5 has MAC in sensor payload. `RuuviTag`-class doesn't work with macOS.

developer_notes.md

@@ -36,6 +36,8 @@ Upgrade pip as recommended.
 Install required dependencies
 ```sh
 $ python -m pip install -e .[dev]
+# on zsh, escape square brackets
+$ python -m pip install -e .\[dev\]
 ```
 
 Flake8

ruuvitag_sensor/adapters/bleak_ble.py

@@ -95,6 +95,11 @@ async def detection_callback(device: BLEDevice, advertisement_data: Advertisemen
 
     @staticmethod
     async def get_first_data(mac: str, bt_device: str = "") -> RawData:
+        """
+        NOTE: get_first_data does not work on macOS.
+
+        macOS doesn't return MAC address, as it uses system specific IDs
+        """
         data = None
         data_iter = BleCommunicationBleak.get_data([], bt_device)
         async for d in data_iter:

ruuvitag_sensor/ruuvi.py

@@ -50,8 +50,9 @@ def get_first_raw_data(mac: str, bt_device: str = "") -> DataFormatAndRawSensorD
     async def get_first_raw_data_async(mac: str, bt_device: str = "") -> DataFormatAndRawSensorData:
         """
         Get raw data for selected RuuviTag. This method is intended to be used only by
-        RuuviTag-class.
-        It doesn't have asynchronous implementation.
+        RuuviTagAsync-class.
+
+        NOTE: This method is not working on macOS
 
         Args:
             mac (string): MAC address

ruuvitag_sensor/ruuvitag.py

@@ -60,6 +60,10 @@ def update(self) -> Union[Dict, SensorData]:
 
 
 class RuuviTagAsync(RuuviTagBase):
+    """
+    NOTE: This class is not working on macOS
+    """
+
     async def update(self) -> Union[Dict, SensorData]:
         """
         Get latest data from the sensor and update own state.