mpflash 1.24.8__py3-none-any.whl → 1.25.0__py3-none-any.whl

mpflash/vendor/board_database.py

@@ -37,7 +37,9 @@ from __future__ import annotations
 import json
 from dataclasses import dataclass, field
 from glob import glob
+from os import path
 from pathlib import Path
+import re
 
 
 @dataclass(order=True)
@@ -52,6 +54,15 @@ class Variant:
     """
     board: Board = field(repr=False)
 
+    @property
+    def description(self) -> str:
+        """
+        Description of the board, if available.
+        Example: "Pyboard v1.1 with STM32F4"
+        """
+        return description_from_source(self.board.path, self.name) or self.board.description
+        # f"{self.board.description}-{self.name}"
+
 
 @dataclass(order=True)
 class Board:
@@ -93,6 +104,12 @@ class Board:
     """
     port: Port | None = field(default=None, compare=False)
 
+    path: str = ""
+    """
+    the relative path to the boards files.
+    Example: "ports/stm32/boards/PYBV11"
+    """
+
     @staticmethod
     def factory(filename_json: Path) -> Board:
         with filename_json.open() as f:
@@ -101,18 +118,27 @@ class Board:
         board = Board(
             name=filename_json.parent.name,
             variants=[],
-            url=board_json["url"],
+            url=board_json["url"] if "url" in board_json else "",  # fix missing url
             mcu=board_json["mcu"],
             product=board_json["product"],
             vendor=board_json["vendor"],
             images=board_json["images"],
             deploy=board_json["deploy"],
+            path=filename_json.parent.as_posix(),
         )
         board.variants.extend(
             sorted([Variant(*v, board) for v in board_json.get("variants", {}).items()])  # type: ignore
         )
         return board
 
+    @property
+    def description(self) -> str:
+        """
+        Description of the board, if available.
+        Example: "Pyboard v1.1 with STM32F4"
+        """
+        return description_from_source(self.path, "") or self.name
+
 
 @dataclass(order=True)
 class Port:
@@ -140,6 +166,8 @@ class Database:
 
     def __post_init__(self) -> None:
         mpy_dir = self.mpy_root_directory
+        if not mpy_dir.is_dir():
+            raise ValueError(f"Invalid path to micropython directory: {mpy_dir}")
         # Take care to avoid using Path.glob! Performance was 15x slower.
         for p in glob(f"{mpy_dir}/ports/**/boards/**/board.json"):
             filename_json = Path(p)
@@ -176,6 +204,7 @@ class Database:
                 "",
                 [],
                 [],
+                path=path.as_posix(),
             )
             board.variants = [Variant(v, "", board) for v in variant_names]
             port = Port(special_port_name, {special_port_name: board})
@@ -183,3 +212,59 @@ class Database:
 
             self.ports[special_port_name] = port
             self.boards[board.name] = board
+
+
+# look for all mpconfigboard.h files and extract the board name
+# from the #define MICROPY_HW_BOARD_NAME "PYBD_SF6"
+# and the #define MICROPY_HW_MCU_NAME "STM32F767xx"
+RE_H_MICROPY_HW_BOARD_NAME = re.compile(r"#define\s+MICROPY_HW_BOARD_NAME\s+\"(.+)\"")
+RE_H_MICROPY_HW_MCU_NAME = re.compile(r"#define\s+MICROPY_HW_MCU_NAME\s+\"(.+)\"")
+# find boards and variants in the mpconfigboard*.cmake files
+RE_CMAKE_MICROPY_HW_BOARD_NAME = re.compile(r"MICROPY_HW_BOARD_NAME\s?=\s?\"(?P<variant>[\w\s\S]*)\"")
+RE_CMAKE_MICROPY_HW_MCU_NAME = re.compile(r"MICROPY_HW_MCU_NAME\s?=\s?\"(?P<variant>[\w\s\S]*)\"")
+
+
+def description_from_source(board_path: str | Path, variant: str = "") -> str:
+    """Get the board's description from the header or make files."""
+    return description_from_header(board_path, variant) or description_from_cmake(board_path, variant)
+
+
+def description_from_header(board_path: str | Path, variant: str = "") -> str:
+    """Get the board's description from the mpconfigboard.h file."""
+
+    mpconfig_path = path.join(board_path, f"mpconfigboard_{variant}.h" if variant else "mpconfigboard.h")
+    if not path.exists(mpconfig_path):
+        return f""
+
+    with open(mpconfig_path, "r") as f:
+        board_name = mcu_name = "-"
+        found = 0
+        for line in f:
+            if match := RE_H_MICROPY_HW_BOARD_NAME.match(line):
+                board_name = match[1]
+                found += 1
+            elif match := RE_H_MICROPY_HW_MCU_NAME.match(line):
+                mcu_name = match[1]
+                found += 1
+            if found == 2:
+                return f"{board_name} with {mcu_name}" if mcu_name != "-" else board_name
+    return board_name if found == 1 else ""
+
+
+def description_from_cmake(board_path: str | Path, variant: str = "") -> str:
+    """Get the board's description from the mpconfig[board|variant].cmake file."""
+
+    cmake_path = path.join(board_path, f"mpconfigvariant_{variant}.cmake" if variant else "mpconfigboard.cmake")
+    if not path.exists(cmake_path):
+        return f""
+    with open(cmake_path, "r") as f:
+        board_name = mcu_name = "-"
+        for line in f:
+            line = line.strip()
+            if match := RE_CMAKE_MICROPY_HW_BOARD_NAME.match(line):
+                description = match["variant"]
+                return description
+            elif match := RE_CMAKE_MICROPY_HW_MCU_NAME.match(line):
+                description = match["variant"]
+                return description
+    return ""

mpflash/versions.py

@@ -38,6 +38,13 @@ def clean_version(
             return "stable"
         version = _v
         log.trace(f"Using latest stable version: {version}")
+    elif version.lower() in ["preview", "latest"]:
+        _v = get_preview_mp_version()
+        if not _v:
+            log.warning("Could not determine the preview version")
+            return "preview"
+        version = _v
+        log.trace(f"Using latest preview version: {version}")
     is_preview = "-preview" in version
     nibbles = version.split("-")
     ver_ = nibbles[0].lower().lstrip("v")

{mpflash-1.24.8.dist-info → mpflash-1.25.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: mpflash
-Version: 1.24.8
+Version: 1.25.0
 Summary: Flash and download tool for MicroPython firmwares
 License: MIT
 Keywords: MicroPython,firmware,flash,download,UF2,esptool

{mpflash-1.24.8.dist-info → mpflash-1.25.0.dist-info}/RECORD

@@ -1,7 +1,7 @@
 mpflash/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mpflash/add_firmware.py,sha256=1h0HsA-EVi3HXLmoEvzwY_a-GuWYzPwulTYHHBB8THg,3428
 mpflash/ask_input.py,sha256=piwMuW7QlYsIvDdJFN1lVCkCGsmsSyyMaUOtvf_S330,8885
-mpflash/basicgit.py,sha256=K2pf8p59-tnQgbmP94yveCKHLm7sOLGdF4OLPI6vvKg,9599
+mpflash/basicgit.py,sha256=e5utBpTObVl5fbSZ-dpiZuVi0touiFppS8NuKRKcxII,9670
 mpflash/bootloader/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mpflash/bootloader/activate.py,sha256=orQOw4XTkXVZI-rMInRb0T5Wp3qA_BlzbJUA2gyBToU,2361
 mpflash/bootloader/detect.py,sha256=OagP2QVWeLLWkZt2paqEF6r4_x3QDcBGNCPOWfMy9NQ,2686
@@ -9,15 +9,18 @@ mpflash/bootloader/manual.py,sha256=C3PVLW3lwz66zG2mOekAJdwXD8PZcIyI3VuLEkusMpI,
 mpflash/bootloader/micropython.py,sha256=v_kZkvg0uWZDbMrT78gmiYHbD83QLdnrctvEClI8iRg,529
 mpflash/bootloader/touch1200.py,sha256=VND7_YniS9Vx6WEaAxjI72RZZ6WBOwmBTsKJkbuaAHk,1105
 mpflash/cli_download.py,sha256=6p83u0Iqyq-V6zS_zQbngSgnCnE0thNPR02r_12_d_Y,3660
-mpflash/cli_flash.py,sha256=2D4OYkuJbq6hSQ7sP2r33ILLahtwAvmnNKqjsZ6-8nY,8316
+mpflash/cli_flash.py,sha256=6ZOHChF1cUyQEDzUpgJKko8EX__55Ol-fQkZNfTJpB8,8337
 mpflash/cli_group.py,sha256=_Wj4EvRkmPri6wyJWT8cQ0WRMwrj9xtCDLaxFJs7ssM,2617
-mpflash/cli_list.py,sha256=jwnfHN-RE-8x37YhPrnQs10SHfD1kVwESkJsXyqLBIo,2411
-mpflash/cli_main.py,sha256=3zUiWBRCdOHTXZ7BPuBcafsOW7GClUvGBH1OhIs76js,1128
+mpflash/cli_list.py,sha256=U4lrlE7O6o1BamHD0K_cJhuINanKNgXkg-WTU5RetF4,2354
+mpflash/cli_main.py,sha256=aVlsA-ZHBKJyuGwSCbpO2Ky0X52wPeOOGumvuPPTFzQ,1136
 mpflash/common.py,sha256=1mEsilJd3HpL7wFPsJ0EScYoJj7JqGFWDjSFEKJdjeU,7488
-mpflash/config.py,sha256=X7nufiMA3rKTFBiZkJY_WHtRv8U_x19QrAb49xsszRM,2024
+mpflash/config.py,sha256=GMuqhrof3lkG7x_CxitYRkm4mxHEYZ_uPFNO3QxSJCY,2166
 mpflash/connected.py,sha256=oxZdk1o-AfNPhJsSxr3KrMH_gdYfrjqc_IpT6J8Ng9k,3496
-mpflash/download.py,sha256=IFPK3lj5BZpL9ylwjiLFn1ZNQ3mCibAYRq836hnquD0,15550
-mpflash/downloaded.py,sha256=5kmbap2SumCpxYvI8QVZm87u9Ns3dIsZ7Mds2quiuQk,5110
+mpflash/db/boards.py,sha256=KvpJ45oPwoxuXCzNpAPIyMOiXOpO72LBJowQ4QBJPiU,1960
+mpflash/db/downloads.py,sha256=sHJzKLf5cYFftIcweoBfCqMY0MPJMmFYVRT7mprspvU,2975
+mpflash/download/__init__.py,sha256=kI9zYSjFUO2vVbRofJmQw44ftlM5r1HnjmkdZenzo2c,8451
+mpflash/download/from_web.py,sha256=ddUd7MZJj19e_nR9Iw79v3UuCPwvkWwQtuBEyu-XsbY,7860
+mpflash/downloaded.py,sha256=kfUt07vDARZYw64TToXLxA-UlP7zFTGRjnBzIEDL5cU,4163
 mpflash/errors.py,sha256=IAidY3qkZsXy6Pm1rdmVFmGyg81ywHhse3itaPctA2w,247
 mpflash/flash/__init__.py,sha256=V--YRwDGtCCLVfCe9p9SGV1Cbi0FNd9zenKlIb-HFw0,2820
 mpflash/flash/esp.py,sha256=N71fPMYhYexEF3YeJGJ74B3GtceXa-FdGqiBpa2qboI,3225
@@ -29,31 +32,31 @@ mpflash/flash/uf2/linux.py,sha256=uTgqyS7C7xfQ25RrTcSUkt-m2u2Ks_o7bPLzIecPoC8,43
 mpflash/flash/uf2/macos.py,sha256=JTaIpqnR_0k4oSEvzs9amhmK-PMxUJyZLnZ_wZwxa-0,1228
 mpflash/flash/uf2/uf2disk.py,sha256=4_P2l-kedM7VSliA2u706LQLxvu3xWSod1-lj-xjZis,298
 mpflash/flash/uf2/windows.py,sha256=S---sVjVrC00ZcnpOewtJIBfSCj2cr7FGQwEm_ZEDnY,1334
-mpflash/flash/worklist.py,sha256=lNCzi_Hyr4xNWmCsUMcH4T589nIfN00Xcpoa56mDNOE,6087
+mpflash/flash/worklist.py,sha256=eOD7BigUEshwcc5p7SaSeegpSpIOX1zE_6HuOzssrqM,6083
 mpflash/list.py,sha256=AjsVTWWTcfUhoT2lYJf2KvcOgMen9MgXY6fDYJvd0Mc,4014
 mpflash/logger.py,sha256=D6S-KDhXTLl7bYMKfu71iVO1YlpGSd0BcHvkVFOCW5c,1080
 mpflash/mpboard_id/__init__.py,sha256=i-HxDi4UPvQu2zFhWK5HENr_HmTdsnaqkLfNyxjOelg,515
 mpflash/mpboard_id/add_boards.py,sha256=XCSyZC9v-B5gzW4dIWdqQVIiE8JviKx0GpyGEQ64dm8,9949
-mpflash/mpboard_id/board.py,sha256=JKb4T67HmK7widW-4c1PgilvywMbZYToLk9Fyokm-6Q,1163
-mpflash/mpboard_id/board_id.py,sha256=8MDExMMDL8mR1kioXMgRQzJ02GMxzYUQarLsKtY6DAw,3372
+mpflash/mpboard_id/board.py,sha256=hzP_SNyigjRQsP3FmTCvuCDtPPalfkL5IfjrnATlVS0,1367
+mpflash/mpboard_id/board_id.py,sha256=mJqVW_D8uHnuON7xpKBRRs2e3ExQGNYC2bSA2ItZBKY,5439
 mpflash/mpboard_id/board_info.json,sha256=A3ZIt38KvAy2NMB5srHorSBd3Q3wOZIXufWiIs3XLrs,1019745
-mpflash/mpboard_id/board_info.zip,sha256=0rQkVLOBRg5dwvkLmJtRdCXwKiA9arkWYVH7N8dYuNw,21720
-mpflash/mpboard_id/known.py,sha256=7aJ0_RPsNipGQGKk3Y7FN5J4Stu33yOxc7j9hXHNd98,3852
-mpflash/mpboard_id/store.py,sha256=oxk84RI8y1AMXtVz_lW9iY5wWJBN_71mo8VUp6vOGBE,1663
-mpflash/mpremoteboard/__init__.py,sha256=h7AgDt9IVHn31cM5a_Ux7vB2P91Mz__u1-32dlayu8Y,9936
-mpflash/mpremoteboard/mpy_fw_info.py,sha256=gGuEYLJJbIix7sXM8PNnT4rY4TMyEFcIh_nkZ3K_JjU,4943
+mpflash/mpboard_id/board_info.zip,sha256=-2bnQGRsIQuJUfz-7_-GQ8pMWJ1evhCez6yfjhXocNw,23213
+mpflash/mpboard_id/known.py,sha256=pYw2z5w_PZC9BG6uqo4jFIoSpiacRxL9oj7pHKv-qjo,4521
+mpflash/mpboard_id/store.py,sha256=UR5nWwywqSPY_2DBP2w8td3b7N6iS-B5rMcyh-s2JOQ,1750
+mpflash/mpremoteboard/__init__.py,sha256=jj4FVK237BmQ1-N4ANePWEJFY7yyhbb0XvJx8n00vuc,11993
+mpflash/mpremoteboard/mpy_fw_info.py,sha256=xhEjifU7pAUpey5T23k6x_1bhuS2XcVbSM21ZynWDdM,5148
 mpflash/mpremoteboard/runner.py,sha256=-PgzAeBGbyXaAUlwyiw4mcINsP2U1XRRjP1_QdBrxpg,4786
 mpflash/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mpflash/vendor/board_database.py,sha256=QE3oXj96oTAsx94gNfHMYWu_RgBTHW1v9Wp5dq_Dt-Q,5253
+mpflash/vendor/board_database.py,sha256=Cb8fEhJaZ2siMkLPW5rPwV9yzBsTtKGOqWUd9TxNgFM,8763
 mpflash/vendor/click_aliases.py,sha256=adLhqLxNpJEPjSCIRSTkR-QzSgavGFKT0cwRbjxpzRU,5395
 mpflash/vendor/dfu.py,sha256=6rqGCBS8mTxxaLtkdzJ8O6nc74kFk8jrkmKvxw-x-u8,5693
 mpflash/vendor/pico-universal-flash-nuke/LICENSE.txt,sha256=Zkc2iTNbib2NCMwtLjMEz0vFCPglgvaw6Mj7QiWldpQ,1484
 mpflash/vendor/pico-universal-flash-nuke/universal_flash_nuke.uf2,sha256=QuPMppqHMVOt3vDVU0bikHRLsTiDRQYNUcGQ_OLRFGI,28160
 mpflash/vendor/pydfu.py,sha256=uD0esm1iPHap7T93M_fli1LlXwn8RxKDFRnt8inxJu8,20389
 mpflash/vendor/readme.md,sha256=BQ7Uxf8joeYMjTUuSLLBG49ob6a9MgFPIEwuc72-Mfw,415
-mpflash/versions.py,sha256=ax7DBbBwqmJTdm1fkrQVe9zi3cdU3jv_-mwEz0-SydI,4584
-mpflash-1.24.8.dist-info/entry_points.txt,sha256=Jk_visOhYOsZIcSP2Ms9hKqfKy1iorR-6dYltSoWCpY,52
-mpflash-1.24.8.dist-info/LICENSE,sha256=mWpNhsIxWzetYNnTpr4eb3HtgsxGIC8KcYWxXEcxQvE,1077
-mpflash-1.24.8.dist-info/METADATA,sha256=ZEWCmCHX7tawk9vvh6SyOA-NVZOIf6q-Vv5a69HBKjM,23930
-mpflash-1.24.8.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
-mpflash-1.24.8.dist-info/RECORD,,
+mpflash/versions.py,sha256=zDAUEMae0hvB8CFmVnf_VWtnVIpAiMGXKpvk2FgnWcg,4878
+mpflash-1.25.0.dist-info/entry_points.txt,sha256=Jk_visOhYOsZIcSP2Ms9hKqfKy1iorR-6dYltSoWCpY,52
+mpflash-1.25.0.dist-info/LICENSE,sha256=mWpNhsIxWzetYNnTpr4eb3HtgsxGIC8KcYWxXEcxQvE,1077
+mpflash-1.25.0.dist-info/METADATA,sha256=lBovhakb7WQMmZ7n6KGv6bnUIYq_rVmZ_9rU1ZAwgJU,23930
+mpflash-1.25.0.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
+mpflash-1.25.0.dist-info/RECORD,,

mpflash/download.py

@@ -1,397 +0,0 @@
-"""
-Module to download MicroPython firmware for specific boards and versions.
-Uses the micropython.org website to get the available versions and locations to download firmware files.
-"""
-
-import functools
-import itertools
-import re
-from pathlib import Path
-from typing import Dict, List, Optional
-from urllib.parse import urljoin
-
-# #########################################################################################################
-# make sure that jsonlines does not mistake the MicroPython ujson for the CPython ujson
-import jsonlines
-from loguru import logger as log
-from rich.progress import track
-
-from mpflash.common import PORT_FWTYPES, FWInfo
-from mpflash.downloaded import clean_downloaded_firmwares
-from mpflash.errors import MPFlashError
-from mpflash.mpboard_id import get_known_ports
-from mpflash.versions import clean_version
-
-# avoid conflict with the ujson used by MicroPython
-jsonlines.ujson = None  # type: ignore
-# #########################################################################################################
-
-
-MICROPYTHON_ORG_URL = "https://micropython.org/"
-
-# Regexes to remove dates and hashes in the filename that just get in the way
-RE_DATE = r"(-\d{8}-)"
-RE_HASH = r"(.g[0-9a-f]+\.)"
-# regex to extract the version and the build from the firmware filename
-# group 1 is the version, group 2 is the build
-RE_VERSION_PREVIEW = r"v([\d\.]+)-?(?:preview\.)?(\d+)?\."
-# 'RPI_PICO_W-v1.23.uf2'
-# 'RPI_PICO_W-v1.23.0.uf2'
-# 'RPI_PICO_W-v1.23.0-406.uf2'
-# 'RPI_PICO_W-v1.23.0-preview.406.uf2'
-# 'RPI_PICO_W-v1.23.0-preview.4.uf2'
-# 'RPI_PICO_W-v1.23.0.uf2'
-# 'https://micropython.org/resources/firmware/RPI_PICO_W-20240531-v1.24.0-preview.10.gc1a6b95bf.uf2'
-# 'https://micropython.org/resources/firmware/RPI_PICO_W-20240531-v1.24.0-preview.10.uf2'
-# 'RPI_PICO_W-v1.24.0-preview.10.gc1a6b95bf.uf2'
-
-
-# use functools.lru_cache to avoid needing to download pages multiple times
-@functools.lru_cache(maxsize=500)
-def get_page(page_url: str) -> str:
-    """Get the HTML of a page and return it as a string."""
-    # Just in time import
-    import requests
-    response = requests.get(page_url)
-    return response.content.decode()
-
-
-@functools.lru_cache(maxsize=500)
-def get_board_urls(page_url: str) -> List[Dict[str, str]]:
-    """
-    Get the urls to all the board pages listed on this page.
-    Assumes that all links to firmware  have "class": "board-card"
-
-    Args:
-        page_url (str): The url of the page to get the board urls from.
-
-    Returns:
-        List[Dict[str, str]]: A list of dictionaries containing the board name and url.
-
-    """
-    # Just in time import
-    from bs4 import BeautifulSoup
-
-    downloads_html = get_page(page_url)
-    soup = BeautifulSoup(downloads_html, "html.parser")
-    tags = soup.find_all("a", recursive=True, attrs={"class": "board-card"})
-    # assumes that all links are relative to the page url
-    boards = [tag.get("href") for tag in tags]  # type: ignore
-    if "?" in page_url:
-        page_url = page_url.split("?")[0]
-    return [{"board": board, "url": page_url + board} for board in boards]  # type: ignore
-
-
-def board_firmware_urls(board_url: str, base_url: str, ext: str) -> List[str]:
-    """
-    Get the urls to all the firmware files for a board.
-    Args:
-        page_url (str): The url of the page to get the board urls from.
-    ??? base_url (str): The base url to join the relative urls to.
-        ext (str): The extension of the firmware files to get. (with or withouth leading .)
-
-    the urls are relative urls to the site root
-
-    """
-    # Just in time import
-    from bs4 import BeautifulSoup
-
-    html = get_page(board_url)
-    soup = BeautifulSoup(html, "html.parser")
-    # get all the a tags:
-    #  1. that have a url that starts with `/resources/firmware/`
-    #  2. end with a matching extension for this port.
-    tags = soup.find_all(
-        "a",
-        recursive=True,
-        attrs={"href": re.compile(r"^/resources/firmware/.*\." + ext.lstrip(".") + "$")},
-    )
-    if "?" in base_url:
-        base_url = base_url.split("?")[0]
-    links: List = [urljoin(base_url, tag.get("href")) for tag in tags]  # type: ignore
-    return links
-
-
-# boards we are interested in ( this avoids getting a lot of boards we don't care about)
-# The first run takes ~60 seconds to run for 4 ports , all boards
-# so it makes sense to cache the results and skip boards as soon as possible
-def get_boards(ports: List[str], boards: List[str], clean: bool) -> List[FWInfo]:
-    # sourcery skip: use-getitem-for-re-match-groups
-    """
-    Retrieves a list of firmware information for the specified ports and boards.
-
-    Args:
-        ports (List[str]): The list of ports to check for firmware.
-        boards (List[str]): The list of boards to retrieve firmware information for.
-        clean (bool): A flag indicating whether to perform a clean retrieval.
-
-    Returns:
-        List[FWInfo]: A list of firmware information for the specified ports and boards.
-
-    """
-    board_urls: List[FWInfo] = []
-    if ports is None:
-        ports = get_known_ports()
-    for port in ports:
-        download_page_url = f"{MICROPYTHON_ORG_URL}download/?port={port}"
-        urls = get_board_urls(download_page_url)
-        # filter out boards we don't care about
-        urls = [board for board in urls if board["board"] in boards]
-        # add the port to the board urls
-        for board in urls:
-            board["port"] = port
-
-        for board in track(
-            urls,
-            description=f"Checking {port} download pages",
-            transient=True,
-            refresh_per_second=1,
-            show_speed=False,
-        ):
-            # add a board to the list for each firmware found
-            firmware_urls: List[str] = []
-            for ext in PORT_FWTYPES[port]:
-                firmware_urls += board_firmware_urls(board["url"], MICROPYTHON_ORG_URL, ext)
-            for _url in firmware_urls:
-                board["firmware"] = _url
-                fname = Path(board["firmware"]).name
-                if clean:
-                    # remove date from firmware name
-                    fname = re.sub(RE_DATE, "-", fname)
-                    # remove hash from firmware name
-                    fname = re.sub(RE_HASH, ".", fname)
-                fw_info = FWInfo(
-                    filename=fname,
-                    port=port,
-                    board=board["board"],
-                    preview="preview" in _url,
-                    firmware=_url,
-                    version="",
-                )
-                # board["firmware"] = _url
-                # board["preview"] = "preview" in _url  # type: ignore
-                if ver_match := re.search(RE_VERSION_PREVIEW, _url):
-                    fw_info.version = clean_version(ver_match.group(1))
-                    fw_info.build = ver_match.group(2) or "0"
-                fw_info.preview = fw_info.build != "0"
-                # # else:
-                # #     board.$1= ""
-                # if "preview." in fw_info.version:
-                #     fw_info.build = fw_info.version.split("preview.")[-1]
-                # else:
-                #     fw_info.build = "0"
-
-                fw_info.ext = Path(fw_info.firmware).suffix
-                fw_info.variant = fw_info.filename.split("-v")[0] if "-v" in fw_info.filename else ""
-
-                board_urls.append(fw_info)
-    return board_urls
-
-
-def key_fw_ver_pre_ext_bld(x: FWInfo):
-    "sorting key for the retrieved board urls"
-    return x.variant, x.version, x.preview, x.ext, x.build
-
-
-def key_fw_var_pre_ext(x: FWInfo):
-    "Grouping key for the retrieved board urls"
-    return x.variant, x.preview, x.ext
-
-
-def download_firmwares(
-    firmware_folder: Path,
-    ports: List[str],
-    boards: List[str],
-    versions: Optional[List[str]] = None,
-    *,
-    force: bool = False,
-    clean: bool = True,
-) -> int:
-    """
-    Downloads firmware files based on the specified firmware folder, ports, boards, versions, force flag, and clean flag.
-
-    Args:
-        firmware_folder : The folder to save the downloaded firmware files.
-        ports : The list of ports to check for firmware.
-        boards : The list of boards to download firmware for.
-        versions : The list of versions to download firmware for.
-        force : A flag indicating whether to force the download even if the firmware file already exists.
-        clean : A flag indicating to clean the date from the firmware filename.
-    """
-
-
-    skipped = downloaded = 0
-    versions = [] if versions is None else [clean_version(v) for v in versions]
-    # handle renamed boards
-    boards = add_renamed_boards(boards)
-
-    available_firmwares = get_firmware_list(ports, boards, versions, clean)
-
-    for b in available_firmwares:
-        log.debug(b.filename)
-    # relevant
-
-    log.info(f"Found {len(available_firmwares)} relevant unique firmwares")
-    if not available_firmwares:
-        log.error("No relevant firmwares could be found on https://micropython.org/download")
-        log.info(f"{versions=} {ports=} {boards=}")
-        log.info("Please check the website for the latest firmware files or try the preview version.")
-        return 0
-
-    firmware_folder.mkdir(exist_ok=True)
-
-    downloaded, skipped = download_firmware_files(available_firmwares, firmware_folder, force  )
-    log.success(
-        f"Downloaded {downloaded} firmware images{f', skipped {str(skipped)} existing' if skipped else ''}."
-    )
-    return downloaded + skipped
-
-def download_firmware_files(available_firmwares :List[FWInfo],firmware_folder:Path, force:bool ):
-    """
-    Downloads the firmware files to the specified folder.
-    Args:
-        firmware_folder : The folder to save the downloaded firmware files.
-        force : A flag indicating whether to force the download even if the firmware file already exists.
-        requests : The requests module to use for downloading the firmware files.
-        unique_boards : The list of unique firmware information to download.
-    """
-    # Just in time import
-    import requests
-
-    with jsonlines.open(firmware_folder / "firmware.jsonl", "a") as writer:
-        downloaded = skipped = 0
-        for board in available_firmwares:
-            filename = firmware_folder / board.port / board.filename
-            filename.parent.mkdir(exist_ok=True)
-            if filename.exists() and not force:
-                skipped += 1
-                log.debug(f" {filename} already exists, skip download")
-                continue
-            log.info(f"Downloading {board.firmware}")
-            log.info(f"         to {filename}")
-            try:
-                r = requests.get(board.firmware, allow_redirects=True)
-                with open(filename, "wb") as fw:
-                    fw.write(r.content)
-                board.filename = str(filename.relative_to(firmware_folder))
-            except requests.RequestException as e:
-                log.exception(e)
-                continue
-            writer.write(board.to_dict())  #  type: ignore
-            downloaded += 1
-    if downloaded > 0:
-        clean_downloaded_firmwares(firmware_folder)
-    return downloaded,skipped
-
-
-def get_firmware_list(ports: List[str], boards: List[str], versions: List[str], clean: bool = True):
-    """
-    Retrieves a list of unique firmware files available om micropython.org > downloads
-    based on the specified ports, boards, versions, and clean flag.
-
-    Args:
-        ports : One or more ports to check for firmware.
-        boards : One or more boards to filter the firmware by.
-        versions : One or more versions to filter the firmware by.
-        clean : Remove date-stamp and Git Hash from the firmware name.
-
-    Returns:
-        List[FWInfo]: A list of unique firmware information.
-
-    """
-
-    log.trace("Checking MicroPython download pages")
-    versions = [clean_version(v, drop_v=False) for v in versions]
-    preview = "preview" in versions
-
-    board_urls = sorted(get_boards(ports, boards, clean), key=key_fw_ver_pre_ext_bld)
-
-    log.debug(f"Total {len(board_urls)} firmwares")
-
-    relevant = [
-        board for board in board_urls if board.version in versions and board.build == "0" and board.board in boards and not board.preview
-    ]
-
-    if preview:
-        relevant.extend([board for board in board_urls if board.board in boards and board.preview])
-    log.debug(f"Matching firmwares: {len(relevant)}")
-    # select the unique boards
-    unique_boards: List[FWInfo] = []
-    for _, g in itertools.groupby(relevant, key=key_fw_var_pre_ext):
-        # list is aleady sorted by build so we can just get the last item
-        sub_list = list(g)
-        unique_boards.append(sub_list[-1])
-    log.debug(f"Last preview only: {len(unique_boards)}")
-    return unique_boards
-
-
-def download(
-    destination: Path,
-    ports: List[str],
-    boards: List[str],
-    versions: List[str],
-    force: bool,
-    clean: bool,
-) -> int:
-    """
-    Downloads firmware files based on the specified destination, ports, boards, versions, force flag, and clean flag.
-
-    Args:
-        destination : The destination folder to save the downloaded firmware files.
-        ports : The list of ports to check for firmware.
-        boards : The list of boards to download firmware for.
-        versions : The list of versions to download firmware for.
-        force : A flag indicating whether to force the download even if the firmware file already exists.
-        clean : A flag indicating whether to clean the date from the firmware filename.
-
-    Returns:
-        int: The number of downloaded firmware files.
-
-    Raises:
-        MPFlashError : If no boards are found or specified.
-
-    """
-    # Just in time import
-    import requests
-
-    if not boards:
-        log.critical("No boards found, please connect a board or specify boards to download firmware for.")
-        raise MPFlashError("No boards found")
-
-    try:
-        destination.mkdir(exist_ok=True, parents=True)
-    except (PermissionError, FileNotFoundError) as e:
-        log.critical(f"Could not create folder {destination}")
-        raise MPFlashError(f"Could not create folder {destination}") from e
-    try:
-        result = download_firmwares(destination, ports, boards, versions, force=force, clean=clean)
-    except requests.exceptions.RequestException as e:
-        log.exception(e)
-        raise MPFlashError("Could not connect to micropython.org") from e
-
-    return result
-
-
-def add_renamed_boards(boards: List[str]) -> List[str]:
-    """
-    Adds the renamed boards to the list of boards.
-
-    Args:
-        boards : The list of boards to add the renamed boards to.
-
-    Returns:
-        List[str]: The list of boards with the renamed boards added.
-
-    """
-    renamed = {
-        "PICO": ["RPI_PICO"],
-        "PICO_W": ["RPI_PICO_W"],
-        "GENERIC": ["ESP32_GENERIC", "ESP8266_GENERIC"],  # just add both of them
-    }
-    _boards = boards.copy()
-    for board in boards:
-        if board in renamed and renamed[board] not in boards:
-            _boards.extend(renamed[board])
-        if board != board.upper() and board.upper() not in boards:
-            _boards.append(board.upper())
-    return _boards