mpflash 0.8.7__tar.gz → 0.9.0__tar.gz

{mpflash-0.8.7 → mpflash-0.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mpflash
-Version: 0.8.7
+Version: 0.9.0
 Summary: Flash and download tool for MicroPython firmwares
 Home-page: https://github.com/Josverl/micropython-stubber/blob/main/src/mpflash/README.md
 License: MIT

{mpflash-0.8.7 → mpflash-0.9.0}/mpflash/cli_flash.py

@@ -103,7 +103,7 @@ from .worklist import (WorkList, full_auto_worklist, manual_worklist,
 )
 @click.option(
     "--bootloader",
-    "-b",
+    "-bl",
     "bootloader",
     type=click.Choice([e.value for e in BootloaderMethod]),
     default="mpy",

{mpflash-0.8.7 → mpflash-0.9.0}/mpflash/config.py

@@ -4,18 +4,15 @@ import os
 from pathlib import Path
 from typing import List
 
-import pkg_resources
 import platformdirs
+from importlib.metadata import version
 
 from mpflash.logger import log
 
 
 def get_version():
     name = __package__ or "mpflash"
-    try:
-        return pkg_resources.get_distribution(name).version
-    except pkg_resources.DistributionNotFound:
-        return "Package not found"
+    return version(name)
 
 
 class MPtoolConfig:
@@ -32,16 +29,15 @@ class MPtoolConfig:
     @property
     def interactive(self):
         # No interactions in CI
-        if os.getenv('GITHUB_ACTIONS') == 'true':
+        if os.getenv("GITHUB_ACTIONS") == "true":
             log.warning("Disabling interactive mode in CI")
             return False
         return self._interactive
-    
+
     @interactive.setter
-    def interactive(self, value:bool):
+    def interactive(self, value: bool):
         self._interactive = value
 
 
-
 config = MPtoolConfig()
 __version__ = get_version()

{mpflash-0.8.7 → mpflash-0.9.0}/mpflash/downloaded.py

@@ -4,7 +4,7 @@ from typing import Dict, List, Optional
 import jsonlines
 from loguru import logger as log
 
-from mpflash.common import FWInfo
+from mpflash.common import PORT_FWTYPES, FWInfo
 from mpflash.vendor.versions import clean_version
 
 from .config import config
@@ -109,7 +109,7 @@ def filter_downloaded_fwlist(
     log.trace(f"Filtering firmware for {version} : {len(fw_list)} found.")
     # filter by port
     if port:
-        fw_list = [fw for fw in fw_list if fw.port == port]
+        fw_list = [fw for fw in fw_list if fw.port == port and Path(fw.firmware).suffix in PORT_FWTYPES[port]]
         log.trace(f"Filtering firmware for {port} : {len(fw_list)} found.")
 
     if board_id:
@@ -120,6 +120,7 @@ def filter_downloaded_fwlist(
             # the firmware variant should match exactly the board_id
             fw_list = [fw for fw in fw_list if fw.variant == board_id]
         log.trace(f"Filtering firmware for {board_id} : {len(fw_list)} found.")
+        
     if selector and port in selector:
         fw_list = [fw for fw in fw_list if fw.filename.endswith(selector[port])]
     return fw_list

{mpflash-0.8.7 → mpflash-0.9.0}/mpflash/flash.py

@@ -30,20 +30,23 @@ def flash_list(
             continue
         log.info(f"Updating {mcu.board} on {mcu.serialport} to {fw_info.version}")
         updated = None
-        # try:
-        if mcu.port in UF2_PORTS and fw_file.suffix == ".uf2":
-            if not enter_bootloader(mcu, bootloader):
-                continue
-            updated = flash_uf2(mcu, fw_file=fw_file, erase=erase)
-        elif mcu.port in ["stm32"]:
-            if not enter_bootloader(mcu, bootloader):
-                continue
-            updated = flash_stm32(mcu, fw_file, erase=erase)
-        elif mcu.port in ["esp32", "esp8266"]:
-            #  bootloader is handled by esptool for esp32/esp8266
-            updated = flash_esp(mcu, fw_file=fw_file, erase=erase)
-        else:
-            log.error(f"Don't (yet) know how to flash {mcu.port}-{mcu.board} on {mcu.serialport}")
+        try:
+            if mcu.port in UF2_PORTS and fw_file.suffix == ".uf2":
+                if not enter_bootloader(mcu, bootloader):
+                    continue
+                updated = flash_uf2(mcu, fw_file=fw_file, erase=erase)
+            elif mcu.port in ["stm32"]:
+                if not enter_bootloader(mcu, bootloader):
+                    continue
+                updated = flash_stm32(mcu, fw_file, erase=erase)
+            elif mcu.port in ["esp32", "esp8266"]:
+                #  bootloader is handled by esptool for esp32/esp8266
+                updated = flash_esp(mcu, fw_file=fw_file, erase=erase)
+            else:
+                log.error(f"Don't (yet) know how to flash {mcu.port}-{mcu.board} on {mcu.serialport}")
+        except Exception as e:
+            log.error(f"Failed to flash {mcu.board} on {mcu.serialport}")
+            log.exception(e)
 
         if updated:
             flashed.append(updated)

mpflash-0.9.0/mpflash/flash_stm32.py

@@ -0,0 +1,18 @@
+"""Flash STM32 boards using pydfu"""
+
+from pathlib import Path
+
+from loguru import logger as log
+
+# from .flash_stm32_cube import flash_stm32_cubecli
+from .flash_stm32_dfu import dfu_init, flash_stm32_dfu
+from mpflash.mpremoteboard import MPRemoteBoard
+
+
+def flash_stm32(mcu: MPRemoteBoard, fw_file: Path, *, erase: bool, stm32_dfu: bool = True):
+    # sourcery skip: lift-return-into-if
+    dfu_init()
+    if updated := flash_stm32_dfu(mcu, fw_file=fw_file, erase=erase):
+        mcu.wait_for_restart()
+        log.success(f"Flashed {mcu.version} to {mcu.board}")
+    return updated

{mpflash-0.8.7 → mpflash-0.9.0}/mpflash/flash_stm32_dfu.py

@@ -39,6 +39,7 @@ def dfu_init():
         log.error("pydfu not found")
         return None
     if platform.system() == "Windows":
+        log.debug("Initializing libusb backend on Windows...")
         init_libusb_windows()
 
 
@@ -59,6 +60,8 @@ def flash_stm32_dfu(
     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

{mpflash-0.8.7 → mpflash-0.9.0}/mpflash/flash_uf2.py

@@ -12,6 +12,8 @@ from loguru import logger as log
 from rich.progress import track
 
 from mpflash.mpremoteboard import MPRemoteBoard
+import tenacity
+from tenacity import stop_after_attempt, wait_fixed
 
 from .common import PORT_FWTYPES
 from .flash_uf2_boardid import get_board_id
@@ -37,31 +39,51 @@ def flash_uf2(mcu: MPRemoteBoard, fw_file: Path, erase: bool) -> Optional[MPRemo
         log.error(f"UF2 not supported on {mcu.board} on {mcu.serialport}")
         return None
     if erase:
-        log.info("Erasing not yet implemented for UF2 flashing.")
+        destination = waitfor_uf2()
 
+    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:
+        cp_firmware_to_uf2(fw_file, destination)
+        log.success("Done copying, resetting the board and wait for it to restart")
+    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()
+    # time.sleep(1)  # 5 secs to short on linux
+    return mcu
+
+
+def waitfor_uf2():
+    """
+    Wait for the UF2 drive to mount
+    """
     if sys.platform == "linux":
-        destination = wait_for_UF2_linux()
+        return wait_for_UF2_linux()
     elif sys.platform == "win32":
-        destination = wait_for_UF2_windows()
+        return wait_for_UF2_windows()
     elif sys.platform == "darwin":
         log.warning(f"OS {sys.platform} not tested/supported")
-        destination = wait_for_UF2_macos()
+        return wait_for_UF2_macos()
     else:
         log.warning(f"OS {sys.platform} not tested/supported")
         return None
 
-    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}")
+@tenacity.retry(stop=stop_after_attempt(3), wait=wait_fixed(1), reraise=False)
+def cp_firmware_to_uf2(fw_file, destination):
+    """
+    Copy the firmware file to the destination,
+    Retry 3 times with 1s delay
+    """
     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")
-    if sys.platform in ["linux"]:
-        dismount_uf2_linux()
-    for _ in track(range(5 + 2), description="Waiting for the board to restart", transient=True, refresh_per_second=2):
-        time.sleep(1)  # 5 secs to short on linux
-    return mcu

{mpflash-0.8.7 → mpflash-0.9.0}/mpflash/flash_uf2_linux.py

@@ -42,7 +42,10 @@ def get_uf2_drives():
             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":
+            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()
@@ -70,7 +73,7 @@ def pmount(disk: UF2Disk):
         log.debug(f"Mounted {disk.label} at {disk.mountpoint}")
         glb_dismount_me.append(disk)
     else:
-        log.debug(f"\n{disk.label} already mounted at {disk.mountpoint}")
+        log.trace(f"\n{disk.label} already mounted at {disk.mountpoint}")
 
 
 def pumount(disk: UF2Disk):
@@ -101,9 +104,12 @@ def wait_for_UF2_linux(s_max: int = 10):
     uf2_drives = []
     # while not destination and wait > 0:
     for _ in track(
-        range(s_max), description="Waiting for mcu to mount as a drive", transient=True, refresh_per_second=2
+        range(s_max),
+        description="Waiting for mcu to mount as a drive",
+        transient=True,
+        refresh_per_second=2,
+        total=s_max,
     ):
-        # 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():
             pmount(drive)

{mpflash-0.8.7 → mpflash-0.9.0}/mpflash/flash_uf2_macos.py

@@ -10,14 +10,17 @@ from typing import Optional
 from rich.progress import track
 
 
-
 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
+        range(s_max),
+        description="Waiting for mcu to mount as a drive",
+        transient=True,
+        refresh_per_second=2,
+        total=s_max,
     ):
         # log.info(f"Waiting for mcu to mount as a drive : {n} seconds left")
         vol_mounts = Path("/Volumes").iterdir()

{mpflash-0.8.7 → mpflash-0.9.0}/mpflash/flash_uf2_windows.py

@@ -11,14 +11,18 @@ import psutil
 from rich.progress import track
 
 
-
-
 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 = None
-    for _ in track(range(s_max), description="Waiting for mcu to mount as a drive", transient=True,refresh_per_second=2):
+    for _ in track(
+        range(s_max),
+        description="Waiting for mcu to mount as a drive",
+        transient=True,
+        refresh_per_second=2,
+        total=s_max,
+    ):
         # 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:

{mpflash-0.8.7 → mpflash-0.9.0}/mpflash/mpremoteboard/__init__.py

@@ -91,7 +91,9 @@ class MPRemoteBoard:
 
         if sys.platform == "win32":
             # Windows sort of comports by number - but fallback to device name
-            return sorted(output, key=lambda x: int(x.split()[0][3:]) if x.split()[0][3:].isdigit() else x)
+            return sorted(
+                output, key=lambda x: int(x.split()[0][3:]) if x.split()[0][3:].isdigit() else x
+            )
         # sort by device name
         return sorted(output)
 
@@ -127,7 +129,9 @@ class MPRemoteBoard:
             self.description = descr = info["board"]
             pos = descr.rfind(" with")
             short_descr = descr[:pos].strip() if pos != -1 else ""
-            if board_name := find_board_id_by_description(descr, short_descr, version=self.version):
+            if board_name := find_board_id_by_description(
+                descr, short_descr, version=self.version
+            ):
                 self.board = board_name
             else:
                 self.board = "UNKNOWN_BOARD"
@@ -211,7 +215,8 @@ class MPRemoteBoard:
             transient=True,
             get_time=lambda: time.time(),
             show_speed=False,
-            refresh_per_second=1,
+            refresh_per_second=2,
+            total=timeout,
         ):
             time.sleep(1)
             try:

{mpflash-0.8.7 → mpflash-0.9.0}/mpflash/worklist.py

@@ -3,7 +3,7 @@ from typing import Dict, List, Optional, Tuple
 
 from loguru import logger as log
 
-from mpflash.common import FWInfo, filtered_comports
+from mpflash.common import FWInfo, filtered_comports, PORT_FWTYPES
 from mpflash.errors import MPFlashError
 
 from .downloaded import find_downloaded_firmware
@@ -54,8 +54,9 @@ def auto_update(
         if not board_firmwares:
             log.error(f"No {target_version} firmware found for {mcu.board} on {mcu.serialport}.")
             continue
+
         if len(board_firmwares) > 1:
-            log.debug(f"Multiple {target_version} firmwares found for {mcu.board} on {mcu.serialport}.")
+            log.warning(f"Multiple {target_version} firmwares found for {mcu.board} on {mcu.serialport}.")
 
         # just use the last firmware
         fw_info = board_firmwares[-1]

{mpflash-0.8.7 → mpflash-0.9.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "mpflash"
-version = "0.8.7"
+version = "0.9.0"
 description = "Flash and download tool for MicroPython firmwares"
 authors = ["Jos Verlinde <jos_verlinde@hotmail.com>"]
 license = "MIT"
@@ -40,6 +40,10 @@ rich-click = "^1.8.1"
 tenacity = "8.2.3"
 
 
+[tool.poetry.group.dev]
+optional = true
+[tool.poetry.group.dev.dependencies]
+
 [tool.poetry.group.test]
 optional = true
 [tool.poetry.group.test.dependencies]

mpflash-0.8.7/mpflash/flash_stm32.py

@@ -1,24 +0,0 @@
-"""Flash STM32 boards using either STM32CubeProgrammer CLI or dfu-util"""
-
-from pathlib import Path
-
-from loguru import logger as log
-
-# from .flash_stm32_cube import flash_stm32_cubecli
-from .flash_stm32_dfu import dfu_init, flash_stm32_dfu
-from mpflash.mpremoteboard import MPRemoteBoard
-
-
-def flash_stm32(mcu: MPRemoteBoard, fw_file: Path, *, erase: bool, stm32_dfu: bool = True):
-    # sourcery skip: lift-return-into-if
-    log.info("Using dfu-util")
-    dfu_init()
-    updated = flash_stm32_dfu(mcu, fw_file=fw_file, erase=erase)
-    # if stm32_dfu:
-    # else:
-    #     log.info("Using STM32CubeProgrammer CLI")
-    #     updated = flash_stm32_cubecli(mcu, fw_file=fw_file, erase=erase)
-
-    mcu.wait_for_restart()
-    log.success(f"Flashed {mcu.version} to {mcu.board}")
-    return updated