mpflash 1.0.0__py3-none-any.whl → 1.0.2__py3-none-any.whl

mpflash/flash/stm32_dfu.py

@@ -1,104 +1,104 @@
-import platform
-from pathlib import Path
-from typing import Optional
-
-from loguru import logger as log
-
-from mpflash.mpremoteboard import MPRemoteBoard
-
-
-def init_libusb_windows() -> bool:
-    """
-    Initializes the libusb backend on Windows.
-
-    Returns:
-        bool: True if the initialization is successful, False otherwise.
-    """
-    import libusb  # type: ignore
-    import usb.backend.libusb1 as libusb1
-
-    arch = "x64" if platform.architecture()[0] == "64bit" else "x86"
-    libusb1_dll = Path(libusb.__file__).parent / f"_platform\\_windows\\{arch}\\libusb-1.0.dll"
-    if not libusb1_dll.exists():
-        raise FileNotFoundError(f"libusb1.dll not found at {libusb1_dll}")
-    backend = libusb1.get_backend(find_library=lambda x: libusb1_dll.as_posix())
-    return backend is not None
-
-
-try:
-    from ..vendor import pydfu as pydfu
-except ImportError:
-    pydfu = None
-
-
-def dfu_init():
-    """
-    Initializes the DFU (Device Firmware Upgrade) process.
-    """
-    if not pydfu:
-        log.error("pydfu not found")
-        return None
-    if platform.system() == "Windows":
-        log.debug("Initializing libusb backend on Windows...")
-        init_libusb_windows()
-
-
-def flash_stm32_dfu(
-    mcu: MPRemoteBoard,
-    fw_file: Path,
-    *,
-    erase: bool = True,
-) -> Optional[MPRemoteBoard]:
-    """
-    Flashes the STM32 microcontroller using DFU (Device Firmware Upgrade).
-
-    Args:
-        mcu (MPRemoteBoard): The remote board to flash.
-        fw_file (Path): The path to the firmware file (.dfu).
-        erase (bool, optional): Whether to erase the memory before flashing. Defaults to True.
-
-    Returns:
-        Optional[MPRemoteBoard]: The flashed remote board if successful, None otherwise.
-    """
-    log.info("Using pydfu to flash STM32 boards")
-
-    if not pydfu:
-        log.error("pydfu not found, please install it with 'pip install pydfu' if supported")
-        return None
-
-    if not fw_file.exists():
-        log.error(f"File {fw_file} not found")
-        return None
-
-    if fw_file.suffix != ".dfu":
-        log.error(f"File {fw_file} is not a .dfu file")
-        return None
-
-    kwargs = {"idVendor": 0x0483, "idProduct": 0xDF11}
-    log.debug("List SPECIFIED DFU devices...")
-    try:
-        pydfu.list_dfu_devices(**kwargs)
-    except ValueError as e:
-        log.error(f"Insuffient permissions to access usb DFU devices: {e}")
-        return None
-
-    # Needs to be a list of serial ports
-    log.debug("Inititialize pydfu...")
-    pydfu.init(**kwargs)
-
-    if erase:
-        log.info("Mass erase...")
-        pydfu.mass_erase()
-
-    log.debug("Read DFU file...")
-    elements = pydfu.read_dfu_file(fw_file)
-    if not elements:
-        print("No data in dfu file")
-        return
-    log.info("Writing memory...")
-    pydfu.write_elements(elements, False, progress=pydfu.cli_progress)
-
-    log.debug("Exiting DFU...")
-    pydfu.exit_dfu()
-    log.success("Done flashing, resetting the board and wait for it to restart")
-    return mcu
+import platform
+from pathlib import Path
+from typing import Optional
+
+from loguru import logger as log
+
+from mpflash.mpremoteboard import MPRemoteBoard
+
+
+def init_libusb_windows() -> bool:
+    """
+    Initializes the libusb backend on Windows.
+
+    Returns:
+        bool: True if the initialization is successful, False otherwise.
+    """
+    import libusb  # type: ignore
+    import usb.backend.libusb1 as libusb1
+
+    arch = "x64" if platform.architecture()[0] == "64bit" else "x86"
+    libusb1_dll = Path(libusb.__file__).parent / f"_platform\\_windows\\{arch}\\libusb-1.0.dll"
+    if not libusb1_dll.exists():
+        raise FileNotFoundError(f"libusb1.dll not found at {libusb1_dll}")
+    backend = libusb1.get_backend(find_library=lambda x: libusb1_dll.as_posix())
+    return backend is not None
+
+
+try:
+    from ..vendor import pydfu as pydfu
+except ImportError:
+    pydfu = None
+
+
+def dfu_init():
+    """
+    Initializes the DFU (Device Firmware Upgrade) process.
+    """
+    if not pydfu:
+        log.error("pydfu not found")
+        return None
+    if platform.system() == "Windows":
+        log.debug("Initializing libusb backend on Windows...")
+        init_libusb_windows()
+
+
+def flash_stm32_dfu(
+    mcu: MPRemoteBoard,
+    fw_file: Path,
+    *,
+    erase: bool = True,
+) -> Optional[MPRemoteBoard]:
+    """
+    Flashes the STM32 microcontroller using DFU (Device Firmware Upgrade).
+
+    Args:
+        mcu (MPRemoteBoard): The remote board to flash.
+        fw_file (Path): The path to the firmware file (.dfu).
+        erase (bool, optional): Whether to erase the memory before flashing. Defaults to True.
+
+    Returns:
+        Optional[MPRemoteBoard]: The flashed remote board if successful, None otherwise.
+    """
+    log.info("Using pydfu to flash STM32 boards")
+
+    if not pydfu:
+        log.error("pydfu not found, please install it with 'pip install pydfu' if supported")
+        return None
+
+    if not fw_file.exists():
+        log.error(f"File {fw_file} not found")
+        return None
+
+    if fw_file.suffix != ".dfu":
+        log.error(f"File {fw_file} is not a .dfu file")
+        return None
+
+    kwargs = {"idVendor": 0x0483, "idProduct": 0xDF11}
+    log.debug("List SPECIFIED DFU devices...")
+    try:
+        pydfu.list_dfu_devices(**kwargs)
+    except ValueError as e:
+        log.error(f"Insuffient permissions to access usb DFU devices: {e}")
+        return None
+
+    # Needs to be a list of serial ports
+    log.debug("Inititialize pydfu...")
+    pydfu.init(**kwargs)
+
+    if erase:
+        log.info("Mass erase...")
+        pydfu.mass_erase()
+
+    log.debug("Read DFU file...")
+    elements = pydfu.read_dfu_file(fw_file)
+    if not elements:
+        print("No data in dfu file")
+        return
+    log.info("Writing memory...")
+    pydfu.write_elements(elements, False, progress=pydfu.cli_progress)
+
+    log.debug("Exiting DFU...")
+    pydfu.exit_dfu()
+    log.success("Done flashing, resetting the board and wait for it to restart")
+    return mcu

mpflash/flash/uf2/__init__.py

@@ -1,88 +1,88 @@
-"""
-Flash SAMD and RP2 via UF2
-"""
-
-import shutil
-import sys
-from pathlib import Path
-from typing import Optional
-
-import tenacity
-from loguru import logger as log
-
-from tenacity import stop_after_attempt, wait_fixed
-
-from mpflash.mpremoteboard import MPRemoteBoard
-
-from mpflash.common import PORT_FWTYPES
-from .boardid import get_board_id
-from .linux import dismount_uf2_linux, wait_for_UF2_linux
-from .macos import wait_for_UF2_macos
-from .windows import wait_for_UF2_windows
-
-
-def flash_uf2(mcu: MPRemoteBoard, fw_file: Path, erase: bool) -> Optional[MPRemoteBoard]:
-    """
-    Flash .UF2 devices via bootloader and filecopy
-    - mpremote bootloader
-    - Wait for the device to mount as a drive (up to 5s)
-    - detect new drive with INFO_UF2.TXT
-    - copy the firmware file to the drive
-    - wait for the device to restart (5s)
-
-    for Linux - to support headless operation ( GH Actions ) :
-        pmount and pumount are used to mount and unmount the drive
-        as this is not done automatically by the OS in headless mode.
-    """
-    if ".uf2" not in PORT_FWTYPES[mcu.port]:
-        log.error(f"UF2 not supported on {mcu.board} on {mcu.serialport}")
-        return None
-    if erase:
-        log.warning("Erase not (yet) supported on .UF2, skipping erase.")
-
-    destination = waitfor_uf2(board_id=mcu.port.upper())
-
-    if not destination or not destination.exists() or not (destination / "INFO_UF2.TXT").exists():
-        log.error("Board is not in bootloader mode")
-        return None
-
-    log.info("Board is in bootloader mode")
-    board_id = get_board_id(destination)  # type: ignore
-    log.info(f"Board ID: {board_id}")
-    try:
-        copy_firmware_to_uf2(fw_file, destination)
-        log.success("Done copying, resetting the board.")
-    except tenacity.RetryError:
-        log.error("Failed to copy the firmware file to the board.")
-        return None
-
-    if sys.platform in ["linux"]:
-        dismount_uf2_linux()
-
-    mcu.wait_for_restart()
-    return mcu
-
-
-def waitfor_uf2(board_id: str):
-    """
-    Wait for the UF2 drive to mount
-    """
-    if sys.platform == "linux":
-        return wait_for_UF2_linux(board_id=board_id)
-    elif sys.platform == "win32":
-        return wait_for_UF2_windows(board_id=board_id)
-    elif sys.platform == "darwin":
-        return wait_for_UF2_macos(board_id=board_id)
-    else:
-        log.warning(f"OS {sys.platform} not tested/supported")
-        return None
-
-
-@tenacity.retry(stop=stop_after_attempt(3), wait=wait_fixed(1), reraise=False)
-def copy_firmware_to_uf2(fw_file: Path, destination: Path):
-    """
-    Copy the firmware file to the destination,
-    Retry 3 times with 1s delay
-    """
-    log.info(f"Copying {fw_file} to {destination}.")
-    return shutil.copy(fw_file, destination)
+"""
+Flash SAMD and RP2 via UF2
+"""
+
+import shutil
+import sys
+from pathlib import Path
+from typing import Optional
+
+import tenacity
+from loguru import logger as log
+
+from tenacity import stop_after_attempt, wait_fixed
+
+from mpflash.mpremoteboard import MPRemoteBoard
+
+from mpflash.common import PORT_FWTYPES
+from .boardid import get_board_id
+from .linux import dismount_uf2_linux, wait_for_UF2_linux
+from .macos import wait_for_UF2_macos
+from .windows import wait_for_UF2_windows
+
+
+def flash_uf2(mcu: MPRemoteBoard, fw_file: Path, erase: bool) -> Optional[MPRemoteBoard]:
+    """
+    Flash .UF2 devices via bootloader and filecopy
+    - mpremote bootloader
+    - Wait for the device to mount as a drive (up to 5s)
+    - detect new drive with INFO_UF2.TXT
+    - copy the firmware file to the drive
+    - wait for the device to restart (5s)
+
+    for Linux - to support headless operation ( GH Actions ) :
+        pmount and pumount are used to mount and unmount the drive
+        as this is not done automatically by the OS in headless mode.
+    """
+    if ".uf2" not in PORT_FWTYPES[mcu.port]:
+        log.error(f"UF2 not supported on {mcu.board} on {mcu.serialport}")
+        return None
+    if erase:
+        log.warning("Erase not (yet) supported on .UF2, skipping erase.")
+
+    destination = waitfor_uf2(board_id=mcu.port.upper())
+
+    if not destination or not destination.exists() or not (destination / "INFO_UF2.TXT").exists():
+        log.error("Board is not in bootloader mode")
+        return None
+
+    log.info("Board is in bootloader mode")
+    board_id = get_board_id(destination)  # type: ignore
+    log.info(f"Board ID: {board_id}")
+    try:
+        copy_firmware_to_uf2(fw_file, destination)
+        log.success("Done copying, resetting the board.")
+    except tenacity.RetryError:
+        log.error("Failed to copy the firmware file to the board.")
+        return None
+
+    if sys.platform in ["linux"]:
+        dismount_uf2_linux()
+
+    mcu.wait_for_restart()
+    return mcu
+
+
+def waitfor_uf2(board_id: str):
+    """
+    Wait for the UF2 drive to mount
+    """
+    if sys.platform == "linux":
+        return wait_for_UF2_linux(board_id=board_id)
+    elif sys.platform == "win32":
+        return wait_for_UF2_windows(board_id=board_id)
+    elif sys.platform == "darwin":
+        return wait_for_UF2_macos(board_id=board_id)
+    else:
+        log.warning(f"OS {sys.platform} not tested/supported")
+        return None
+
+
+@tenacity.retry(stop=stop_after_attempt(3), wait=wait_fixed(1), reraise=False)
+def copy_firmware_to_uf2(fw_file: Path, destination: Path):
+    """
+    Copy the firmware file to the destination,
+    Retry 3 times with 1s delay
+    """
+    log.info(f"Copying {fw_file} to {destination}.")
+    return shutil.copy(fw_file, destination)

mpflash/flash/uf2/boardid.py

@@ -1,15 +1,15 @@
-from pathlib import Path
-
-from loguru import logger as log
-
-
-def get_board_id(path: Path):
-    # Option : read Board-ID from INFO_UF2.TXT
-    board_id = "Unknown"
-    with open(path / "INFO_UF2.TXT") as f:
-        data = f.readlines()
-    for line in data:
-        if line.startswith("Board-ID"):
-            board_id = line[9:].strip()
-    log.debug(f"INFO_UF2.TXT Board-ID={board_id}")
-    return board_id
+from pathlib import Path
+
+from loguru import logger as log
+
+
+def get_board_id(path: Path):
+    # Option : read Board-ID from INFO_UF2.TXT
+    board_id = "Unknown"
+    with open(path / "INFO_UF2.TXT") as f:
+        data = f.readlines()
+    for line in data:
+        if line.startswith("Board-ID"):
+            board_id = line[9:].strip()
+    log.debug(f"INFO_UF2.TXT Board-ID={board_id}")
+    return board_id