Reorganize scan module

to closer match the main tool

Author: Jakeler

ble_serial/scan/__init__.py

@@ -1,78 +0,0 @@
-from bleak import BleakScanner, BleakClient
-from bleak.backends.service import BleakGATTServiceCollection
-from bleak.backends.device import BLEDevice
-from bleak.exc import BleakError
-import argparse, asyncio
-
-
-async def scan(args):
-    print("Started BLE scan\n")
-
-    base_kwargs = dict(adapter=args.adapter, timeout=args.sec)
-
-    if args.service_uuid:
-        devices = await BleakScanner.discover(**base_kwargs, service_uuids=[args.service_uuid])
-    else:
-        devices = await BleakScanner.discover(**base_kwargs)
-
-    await general_scan(devices)
-
-    if args.addr:
-        await deep_scan(args.addr, devices)
-
-    print("\nFinished BLE scan")
-
-async def general_scan(devices: [BLEDevice]):
-    sorted_devices = sorted(devices, key=lambda dev: dev.rssi, reverse=True)
-
-    for d in sorted_devices:
-        print(f'{d.address} (RSSI={d.rssi}): {d.name}')
-
-
-async def deep_scan(addr: str, devices: [BLEDevice]):
-    print(f"\nStarted deep scan of {addr}\n")
-
-    devices = filter(lambda dev: dev.address == addr, devices)
-    devices_list = list(devices)
-    if len(devices_list) > 0:
-        device = devices_list[0]
-        print(f'Found device {device} (out of {len(devices_list)})')
-    else:
-        print('Found no device with matching address')
-        return
-
-    async with BleakClient(device) as client:
-        print_details(await client.get_services())
-
-    print(f"\nCompleted deep scan of {addr}")
-
-def print_details(serv: BleakGATTServiceCollection):
-    INDENT = '    '
-    for s in serv:
-        print('SERVICE', s)
-        for char in s.characteristics:
-            print(INDENT, 'CHARACTERISTIC', char, char.properties)
-            for desc in char.descriptors:
-                print(INDENT*2, 'DESCRIPTOR', desc)
-
-
-# Extra function for console scripts
-def main():
-    parser = argparse.ArgumentParser(
-        description='Scanner for BLE devices and service/characteristics.',
-        formatter_class=argparse.ArgumentDefaultsHelpFormatter)
-    parser.add_argument('-t', '--scan-time', dest='sec', default=5.0, type=float, 
-        help='Duration of the scan in seconds')
-    parser.add_argument('-i', '--interface', dest='adapter', required=False, default='hci0',
-        help='BLE host adapter number to use')
-    parser.add_argument('-d', '--deep-scan', dest='addr', type=str,
-        help='Try to connect to device and read out service/characteristic UUIDs')
-    parser.add_argument('-s', '--service-uuid', dest='service_uuid', required=False,
-        help='The service used for scanning of potential devices')
-    args = parser.parse_args()
-
-    try:
-        asyncio.run(scan(args))
-    except BleakError as be:
-        print('ERROR:', be)
-

ble_serial/scan/__main__.py

@@ -1,4 +1,4 @@
-from ble_serial.scan import main
+from ble_serial.scan.main import launch
 
 if __name__ == '__main__':
-    main()
+    launch()

ble_serial/scan/main.py

@@ -0,0 +1,78 @@
+from bleak import BleakScanner, BleakClient
+from bleak.backends.service import BleakGATTServiceCollection
+from bleak.backends.device import BLEDevice
+from bleak.exc import BleakError
+import argparse, asyncio
+
+
+async def scan(args):
+    print("Started BLE scan\n")
+
+    base_kwargs = dict(adapter=args.adapter, timeout=args.sec)
+
+    if args.service_uuid:
+        devices = await BleakScanner.discover(**base_kwargs, service_uuids=[args.service_uuid])
+    else:
+        devices = await BleakScanner.discover(**base_kwargs)
+
+    await general_scan(devices)
+
+    if args.addr:
+        await deep_scan(args.addr, devices)
+
+    print("\nFinished BLE scan")
+
+async def general_scan(devices: [BLEDevice]):
+    sorted_devices = sorted(devices, key=lambda dev: dev.rssi, reverse=True)
+
+    for d in sorted_devices:
+        print(f'{d.address} (RSSI={d.rssi}): {d.name}')
+
+
+async def deep_scan(addr: str, devices: [BLEDevice]):
+    print(f"\nStarted deep scan of {addr}\n")
+
+    devices = filter(lambda dev: dev.address == addr, devices)
+    devices_list = list(devices)
+    if len(devices_list) > 0:
+        device = devices_list[0]
+        print(f'Found device {device} (out of {len(devices_list)})')
+    else:
+        print('Found no device with matching address')
+        return
+
+    async with BleakClient(device) as client:
+        print_details(await client.get_services())
+
+    print(f"\nCompleted deep scan of {addr}")
+
+def print_details(serv: BleakGATTServiceCollection):
+    INDENT = '    '
+    for s in serv:
+        print('SERVICE', s)
+        for char in s.characteristics:
+            print(INDENT, 'CHARACTERISTIC', char, char.properties)
+            for desc in char.descriptors:
+                print(INDENT*2, 'DESCRIPTOR', desc)
+
+
+# Extra function for console scripts
+def launch():
+    parser = argparse.ArgumentParser(
+        description='Scanner for BLE devices and service/characteristics.',
+        formatter_class=argparse.ArgumentDefaultsHelpFormatter)
+    parser.add_argument('-t', '--scan-time', dest='sec', default=5.0, type=float, 
+        help='Duration of the scan in seconds')
+    parser.add_argument('-i', '--interface', dest='adapter', required=False, default='hci0',
+        help='BLE host adapter number to use')
+    parser.add_argument('-d', '--deep-scan', dest='addr', type=str,
+        help='Try to connect to device and read out service/characteristic UUIDs')
+    parser.add_argument('-s', '--service-uuid', dest='service_uuid', required=False,
+        help='The service used for scanning of potential devices')
+    args = parser.parse_args()
+
+    try:
+        asyncio.run(scan(args))
+    except BleakError as be:
+        print('ERROR:', be)
+

setup.py

@@ -43,7 +43,7 @@
     install_requires=REQUIRES,
     entry_points={
         'console_scripts': [
-            'ble-scan=ble_serial.scan:main',
+            'ble-scan=ble_serial.scan.main:launch',
             'ble-serial=ble_serial.main:launch',
         ] + (
             ['ble-com-setup=ble_serial.setup_com0com:main'] if platform.system() == "Windows"