Add option to access Bluetooth addresses on macOS (#51)

Author: koenvervloesem

.pre-commit-config.yaml

@@ -93,7 +93,7 @@ repos:
     entry: env MYPYPATH=src mypy
     args: []
     additional_dependencies:
-    - bleak
+    - bleak>=0.20.0
     - bluetooth-numbers
     - rich
     - textual>=0.14.0

docs/requirements.txt

@@ -1,7 +1,7 @@
 # Requirements file for ReadTheDocs, check .readthedocs.yml.
 # To build the module reference correctly, make sure every external package
 # under `install_requires` in `setup.cfg` is also listed here!
-bleak>=0.19.0
+bleak>=0.20.0
 bluetooth-numbers>=1.0.0,<2.0
 furo
 sphinx>=3.2.1

docs/usage.rst

@@ -30,11 +30,15 @@ You can find all command-line arguments by running HumBLE Explorer with the ``--
                           Bluetooth adapter (e.g. hci1 on Linux)
     -s {active,passive}, --scanning-mode {active,passive}
                           Scanning mode (default: active)
+    -m, --macos-use-address
+                          Use Bluetooth address instead of UUID on macOS
 
 By default, HumBLE Explorer scans for BLE advertisements using your operating system's default Bluetooth adapter. You can change this with the ``-a ADAPTER`` option.
 
 Also, by default HumBLE Explorer does *active scanning*. For every device the program finds, it requests extra information, with a ``SCAN_REQ`` packet directed at that device. The addressed device responds with a ``SCAN_RSP`` advertisement, which is also called *scan response data*. What data is returned for a ``SCAN_RSP`` packet depends on the type of device. It could be its device name, or manufacturer-specific data, or something else. If you want HumBLE Explorer to use *passive scanning*, use the ``-s passive`` option. The program then doesn't send ``SCAN_REQ`` packets, so devices don't respond with scan response data.
 
+On macOS, users normally don't get access to the Bluetooth addresses of devices, but to a UUID. With the `-m` option, you get the actual Bluetooth address.
+
 User interface
 --------------
 

setup.cfg

@@ -56,7 +56,7 @@ package_dir =
 # For more information, check out https://semver.org/.
 install_requires =
     bluetooth-numbers>=1.0.0,<2.0
-    bleak>=0.19.0
+    bleak>=0.20.0
     importlib-metadata; python_version<"3.8"
     textual>=0.14.0
 

src/humble_explorer/__main__.py

@@ -68,6 +68,13 @@ def parse_args(args: list[str]) -> Namespace:
         default="active",
         choices=("active", "passive"),
     )
+    parser.add_argument(
+        "-m",
+        "--macos-use-address",
+        action="store_true",
+        help="Use Bluetooth address instead of UUID on macOS",
+    )
+
     return parser.parse_args(args)
 
 

src/humble_explorer/app.py

@@ -67,6 +67,8 @@ def __init__(self, cli_args: Namespace) -> None:
                 self.scanner_kwargs["bluez"] = BlueZScannerArgs(
                     filters={"DuplicateData": True}
                 )
+        elif system() == "Darwin":
+            self.scanner_kwargs["cb"] = {"use_bdaddr": cli_args.macos_use_address}
 
         # Configure Bluetooth adapter
         self.scanner_kwargs["adapter"] = cli_args.adapter