feat: add ble_device_has_changed helper (#13)

src/bleak_retry_connector/__init__.py

@@ -129,6 +129,19 @@ def set_cached_services(self, services: BleakGATTServiceCollection | None) -> No
         self._cached_services = services
 
 
+def ble_device_has_changed(original: BLEDevice, new: BLEDevice) -> bool:
+    """Check if the device has changed."""
+    if original.address != new.address:
+        return True
+    if (
+        isinstance(original.details, dict)
+        and "path" in original.details
+        and original.details["path"] != new.details["path"]
+    ):
+        return True
+    return False
+
+
 async def establish_connection(
     client_class: type[BleakClient],
     device: BLEDevice,

tests/test_init.py

@@ -3,6 +3,7 @@
 
 import pytest
 from bleak import BleakClient, BleakError
+from bleak.backends.device import BLEDevice
 from bleak.backends.service import BleakGATTServiceCollection
 
 import bleak_retry_connector
@@ -12,6 +13,7 @@
     BleakClientWithServiceCache,
     BleakConnectionError,
     BleakNotFoundError,
+    ble_device_has_changed,
     establish_connection,
 )
 
@@ -390,3 +392,19 @@ async def disconnect(self, *args, **kwargs):
         BleakNotFoundError
     ):
         await establish_connection(FakeBleakClient, MagicMock(), "test")
+
+
+def test_ble_device_has_changed():
+    """Test that the BLEDevice has changed when the underlying device has changed."""
+    assert not ble_device_has_changed(
+        BLEDevice("aa:bb:cc:dd:ee:ff", "name", {"path": "/dev/1"}),
+        BLEDevice("aa:bb:cc:dd:ee:ff", "name", {"path": "/dev/1"}),
+    )
+    assert ble_device_has_changed(
+        BLEDevice("aa:bb:cc:dd:ee:ff", "name", {"path": "/dev/1"}),
+        BLEDevice("ab:bb:cc:dd:ee:ff", "name", {"path": "/dev/1"}),
+    )
+    assert ble_device_has_changed(
+        BLEDevice("aa:bb:cc:dd:ee:ff", "name", {"path": "/dev/1"}),
+        BLEDevice("aa:bb:cc:dd:ee:ff", "name", {"path": "/dev/2"}),
+    )