bleak: use backend-specific key for seen_devices

Replace use of address with backend-specific key for the seen_devices
dictionary.

As we found out, in the BlueZ backend, the address may not match the
D-Bus path in the case of private resolvable addresses. So to avoid
problems with converting the address to a D-Bus path, we need to use
the D-Bus path as the key in the seen_devices dictionary.

For good measure, we also use the macOS UUID for the device even when
using the use_bdaddr hack to get the actual address.

Other backends continue to use the address as the key, as there doesn't
appear to be any better alternative.

Author: dlech

bleak/__init__.py

@@ -292,7 +292,7 @@ def discovered_devices_and_advertisement_data(
 
         .. versionadded:: 0.19
         """
-        return self._backend.seen_devices
+        return {d[0].address: d for d in self._backend.seen_devices.values()}
 
     @classmethod
     async def find_device_by_address(

bleak/backends/bluezdbus/scanner.py

@@ -19,7 +19,6 @@
 from bleak.args.bluez import BlueZScannerArgs
 from bleak.backends.bluezdbus.defs import Device1
 from bleak.backends.bluezdbus.manager import get_global_bluez_manager
-from bleak.backends.bluezdbus.utils import bdaddr_from_device_path
 from bleak.backends.scanner import (
     AdvertisementData,
     AdvertisementDataCallback,
@@ -199,6 +198,7 @@ def _handle_advertising_data(self, path: str, props: Device1) -> None:
         )
 
         device = self.create_or_update_device(
+            path,
             props["Address"],
             # BlueZ generates a name based on the address if no name is available.
             # To match other backends, we replace this with None.
@@ -218,8 +218,7 @@ def _handle_device_removed(self, device_path: str) -> None:
         Handles a device being removed from BlueZ.
         """
         try:
-            bdaddr = bdaddr_from_device_path(device_path)
-            del self.seen_devices[bdaddr]
+            del self.seen_devices[device_path]
         except KeyError:
             # The device will not have been added to self.seen_devices if no
             # advertising data was received, so this is expected to happen

bleak/backends/bluezdbus/utils.py

@@ -35,19 +35,6 @@ def extract_service_handle_from_path(path: str) -> int:
         raise BleakError(f"Could not parse service handle from path: {path}") from e
 
 
-def bdaddr_from_device_path(device_path: str) -> str:
-    """
-    Scrape the Bluetooth address from a D-Bus device path.
-
-    Args:
-        device_path: The D-Bus object path of the device.
-
-    Returns:
-        A Bluetooth address as a string.
-    """
-    return ":".join(device_path[-17:].split("_"))
-
-
 def device_path_from_characteristic_path(characteristic_path: str) -> str:
     """
     Scrape the device path from a D-Bus characteristic path.

bleak/backends/corebluetooth/scanner.py

@@ -148,6 +148,7 @@ def callback(p: CBPeripheral, a: NSDictionary, r: int) -> None:
                 address = p.identifier().UUIDString()
 
             device = self.create_or_update_device(
+                p.identifier().UUIDString(),
                 address,
                 p.name(),
                 (p, self._manager.central_manager.delegate()),

bleak/backends/p4android/scanner.py

@@ -267,6 +267,7 @@ def _handle_scan_result(self, result) -> None:
         )
 
         device = self.create_or_update_device(
+            native_device.getAddress(),
             native_device.getAddress(),
             native_device.getName(),
             native_device,

bleak/backends/scanner.py

@@ -115,6 +115,8 @@ class BaseBleakScanner(abc.ABC):
     """
     Map of device identifier to BLEDevice and most recent advertisement data.
 
+    The key is a backend-specific identifier for the device.
+
     This map must be cleared when scanning starts.
     """
 
@@ -236,12 +238,18 @@ def call_detection_callbacks(
             callback(device, advertisement_data)
 
     def create_or_update_device(
-        self, address: str, name: Optional[str], details: Any, adv: AdvertisementData
+        self,
+        key: str,
+        address: str,
+        name: Optional[str],
+        details: Any,
+        adv: AdvertisementData,
     ) -> BLEDevice:
         """
         Creates or updates a device in :attr:`seen_devices`.
 
         Args:
+            key: A backend-specific identifier for the device.
             address: The Bluetooth address of the device (UUID on macOS).
             name: The OS display name for the device.
             details: The platform-specific handle for the device.
@@ -252,13 +260,13 @@ def create_or_update_device(
         """
 
         try:
-            device, _ = self.seen_devices[address]
+            device, _ = self.seen_devices[key]
 
             device.name = name
         except KeyError:
             device = BLEDevice(address, name, details)
 
-        self.seen_devices[address] = (device, adv)
+        self.seen_devices[key] = (device, adv)
 
         return device
 

bleak/backends/winrt/scanner.py

@@ -212,7 +212,7 @@ def _received_handler(
         )
 
         device = self.create_or_update_device(
-            bdaddr, local_name, raw_data, advertisement_data
+            bdaddr, bdaddr, local_name, raw_data, advertisement_data
         )
 
         self.call_detection_callbacks(device, advertisement_data)