fix: MacOS UF2 drive detection

The `wait_for_UF2_macos` function in `flash_uf2_macos.py` has been modified to improve the detection of the macOS UF2 drive.

Author: Josverl

src/mpflash/mpflash/flash_uf2.py

@@ -14,7 +14,7 @@
 from mpflash.mpremoteboard import MPRemoteBoard
 
 from .common import PORT_FWTYPES
-from .config import config
+from .flash_uf2_boardid import get_board_id
 from .flash_uf2_linux import dismount_uf2_linux, wait_for_UF2_linux
 from .flash_uf2_macos import wait_for_UF2_macos
 from .flash_uf2_windows import wait_for_UF2_windows
@@ -45,11 +45,7 @@ def flash_uf2(mcu: MPRemoteBoard, fw_file: Path, erase: bool) -> Optional[MPRemo
         destination = wait_for_UF2_windows()
     elif sys.platform == "darwin":
         log.warning(f"OS {sys.platform} not tested/supported")
-        # TODO: test which of the options is best
-        if "macos_uf2" in config.tests:
-            destination = wait_for_UF2_macos()
-        else:
-            destination = wait_for_UF2_linux()
+        destination = wait_for_UF2_macos()
     else:
         log.warning(f"OS {sys.platform} not tested/supported")
         return None
@@ -59,6 +55,8 @@ def flash_uf2(mcu: MPRemoteBoard, fw_file: Path, erase: bool) -> Optional[MPRemo
         return None
 
     log.info("Board is in bootloader mode")
+    board_id = get_board_id(destination)  # type: ignore
+    log.info(f"Board ID: {board_id}")
     log.info(f"Copying {fw_file} to {destination}.")
     shutil.copy(fw_file, destination)
     log.success("Done copying, resetting the board and wait for it to restart")

src/mpflash/mpflash/flash_uf2_macos.py

@@ -6,73 +6,32 @@
 import sys
 import time
 from pathlib import Path
+from typing import Optional
 
 from loguru import logger as log
 from rich.progress import track
 
 from .flash_uf2_boardid import get_board_id
-from .uf2disk import UF2Disk
 
 
-def get_uf2_drives():
-    """
-    Get a list of all the (un)mounted UF2 drives
-    """
-    if sys.platform != "linux":
-        log.error("pumount only works on Linux")
-        return
-    # import blkinfo only on linux
-    from blkinfo import BlkDiskInfo
-
-    myblkd = BlkDiskInfo()
-    filters = {
-        "tran": "usb",
-    }
-    usb_disks = myblkd.get_disks(filters)
-    for disk in usb_disks:
-        if disk["fstype"] == "vfat":
-            uf2_part = disk
-            # unpartioned usb disk or partition (e.g. /dev/sdb )
-            # SEEED WIO Terminal is unpartioned
-            # print( json.dumps(uf2_part, indent=4))
-            uf2 = UF2Disk()
-            uf2.device_path = "/dev/" + uf2_part["name"]
-            uf2.label = uf2_part["label"]
-            uf2.mountpoint = uf2_part["mountpoint"]
-            yield uf2
-        elif disk["type"] == "disk" and disk.get("children") and len(disk.get("children")) > 0:
-            if disk.get("children")[0]["type"] == "part" and disk.get("children")[0]["fstype"] == "vfat":
-                uf2_part = disk.get("children")[0]
-                # print( json.dumps(uf2_part, indent=4))
-                uf2 = UF2Disk()
-                uf2.device_path = "/dev/" + uf2_part["name"]
-                uf2.label = uf2_part["label"]
-                uf2.mountpoint = uf2_part["mountpoint"]
-                yield uf2
-
-
-def wait_for_UF2_macos(s_max: int = 10):
-    destination = ""
-    wait = 10
-    uf2_drives = []
-    # while not destination and wait > 0:
+def wait_for_UF2_macos(s_max: int = 10) -> Optional[Path]:
+    """Wait for the MCU to mount as a drive"""
+    if s_max < 1:
+        s_max = 10
+    destination = None
     for _ in track(
         range(s_max), description="Waiting for mcu to mount as a drive", transient=True, refresh_per_second=2
     ):
-        # log.info(f"Waiting for mcu to mount as a drive : {wait} seconds left")
-        uf2_drives += list(get_uf2_drives())
-        for drive in get_uf2_drives():
-            time.sleep(1)
+        # log.info(f"Waiting for mcu to mount as a drive : {n} seconds left")
+        vol_mounts = Path("/Volumes").iterdir()
+        for vol in vol_mounts:
             try:
-                if Path(drive.mountpoint, "INFO_UF2.TXT").exists():
-                    board_id = get_board_id(Path(drive.mountpoint))  # type: ignore
-                    destination = Path(drive.mountpoint)
+                if Path(vol, "INFO_UF2.TXT").exists():
+                    destination = Path(vol)
                     break
-            except PermissionError:
-                log.debug(f"Permission error on {drive.mountpoint}")
-                continue
+            except OSError:
+                pass
         if destination:
             break
         time.sleep(1)
-        wait -= 1
     return destination

src/mpflash/mpflash/flash_uf2_windows.py

@@ -5,25 +5,25 @@
 
 import time
 from pathlib import Path
+from typing import Optional
 
 import psutil
 from rich.progress import track
 
-from .flash_uf2_boardid import get_board_id
 
 
-def wait_for_UF2_windows(s_max: int = 10):
+
+def wait_for_UF2_windows(s_max: int = 10) -> Optional[Path]:
     """Wait for the MCU to mount as a drive"""
     if s_max < 1:
         s_max = 10
-    destination = ""
+    destination = None
     for _ in track(range(s_max), description="Waiting for mcu to mount as a drive", transient=True,refresh_per_second=2):
         # log.info(f"Waiting for mcu to mount as a drive : {n} seconds left")
         drives = [drive.device for drive in psutil.disk_partitions()]
         for drive in drives:
             try:
                 if Path(drive, "INFO_UF2.TXT").exists():
-                    board_id = get_board_id(Path(drive))  # type: ignore
                     destination = Path(drive)
                     break
             except OSError:

src/mpflash/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "mpflash"
-version = "0.8.0"
+version = "0.8.1b1"
 description = "Flash and download tool for MicroPython firmwares"
 authors = ["Jos Verlinde <[email protected]>"]
 license = "MIT"