Merge pull request #50 from malmeloo/feat/nearby-of-device-scanner

scanner: detect OF devices in Nearby state

examples/device_scanner.py

@@ -1,27 +1,67 @@
 import asyncio
 import logging
 
-from findmy.scanner import OfflineFindingScanner
+from findmy import KeyPair
+from findmy.scanner import (
+    NearbyOfflineFindingDevice,
+    OfflineFindingScanner,
+    SeparatedOfflineFindingDevice,
+)
 
 logging.basicConfig(level=logging.INFO)
 
+# Set if you want to check whether a specific key (or accessory!) is in the scan results.
+# Make sure to enter its private key!
+# Leave empty (= None) to not check.
+CHECK_KEY = KeyPair.from_b64("")
+
+
+def _print_nearby(device: NearbyOfflineFindingDevice) -> None:
+    print(f"NEARBY Device - {device.mac_address}")
+    print(f"  Status byte:  {device.status:x}")
+    print("  Extra data:")
+    for k, v in sorted(device.additional_data.items()):
+        print(f"    {k:20}: {v}")
+    print()
+
+
+def _print_separated(device: SeparatedOfflineFindingDevice) -> None:
+    print(f"SEPARATED Device - {device.mac_address}")
+    print(f"  Public key:   {device.adv_key_b64}")
+    print(f"  Lookup key:   {device.hashed_adv_key_b64}")
+    print(f"  Status byte:  {device.status:x}")
+    print(f"  Hint byte:    {device.hint:x}")
+    print("  Extra data:")
+    for k, v in sorted(device.additional_data.items()):
+        print(f"    {k:20}: {v}")
+    print()
+
 
 async def scan() -> None:
     scanner = await OfflineFindingScanner.create()
 
     print("Scanning for FindMy-devices...")
     print()
 
+    scan_device = None
+
     async for device in scanner.scan_for(10, extend_timeout=True):
-        print(f"Device - {device.mac_address}")
-        print(f"  Public key:   {device.adv_key_b64}")
-        print(f"  Lookup key:   {device.hashed_adv_key_b64}")
-        print(f"  Status byte:  {device.status:x}")
-        print(f"  Hint byte:    {device.hint:x}")
-        print("  Extra data:")
-        for k, v in sorted(device.additional_data.items()):
-            print(f"    {k:20}: {v}")
-        print()
+        if isinstance(device, NearbyOfflineFindingDevice):
+            _print_nearby(device)
+        elif isinstance(device, SeparatedOfflineFindingDevice):
+            _print_separated(device)
+        else:
+            print(f"Unknown device: {device}")
+            print()
+            continue
+
+        if CHECK_KEY and device.is_from(CHECK_KEY):
+            scan_device = device
+
+    if scan_device:
+        print("Key or accessory was found in scan results! :D")
+    elif CHECK_KEY:
+        print("Selected key or accessory was not found in scan results... :c")
 
 
 if __name__ == "__main__":

findmy/scanner/__init__.py

@@ -1,4 +1,12 @@
 """Utilities related to physically discoverable FindMy-devices."""
-from .scanner import OfflineFindingScanner
+from .scanner import (
+    NearbyOfflineFindingDevice,
+    OfflineFindingScanner,
+    SeparatedOfflineFindingDevice,
+)
 
-__all__ = ("OfflineFindingScanner",)
+__all__ = (
+    "OfflineFindingScanner",
+    "NearbyOfflineFindingDevice",
+    "SeparatedOfflineFindingDevice",
+)