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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: mpflash
-Version: 1.25.0
+Version: 1.25.0.post2
 Summary: Flash and download tool for MicroPython firmwares
 License: MIT
 Keywords: MicroPython,firmware,flash,download,UF2,esptool
@@ -29,13 +29,13 @@ Requires-Dist: loguru (>=0.7.2,<0.8.0)
 Requires-Dist: mpremote (>=1.22.0,<2.0.0)
 Requires-Dist: packaging (>=24.2,<25.0)
 Requires-Dist: platformdirs (>=4.2.0,<5.0.0)
-Requires-Dist: poetry (>=2.0.1,<3.0.0)
-Requires-Dist: psutil (>=5.9.8,<8.0.0)
+Requires-Dist: psutil (>=7.0.0,<8.0.0)
 Requires-Dist: pygithub (>=2.1.1,<3.0.0)
 Requires-Dist: pyusb (>=1.2.1,<2.0.0)
 Requires-Dist: pywin32 (>=310,<311) ; sys_platform == "win32"
 Requires-Dist: requests (>=2.31.0,<3.0.0)
 Requires-Dist: rich-click (>=1.8.1,<2.0.0)
+Requires-Dist: sqlalchemy (>=2.0.41,<3.0.0)
 Requires-Dist: tenacity (==9.0.0)
 Project-URL: Homepage, https://github.com/Josverl/mpflash/blob/main/README.md
 Project-URL: Repository, https://github.com/Josverl/mpflash
@@ -58,9 +58,15 @@ This tool was initially created to be used in a CI/CD pipeline to automate the p
     - `samd`, using ` .uf2`, using filecopy 
     - `esp32`, using `.bin`, using esptool,
     - `esp8266`, using `.bin`, using esptool
-    - `stm32`, using ` .dfu`, using pydfu
+    - `stm32`, using ` .dfu`, using pydfu (also in Windows) 
 
 Not yet implemented: `nrf`, `cc3200`, `mimxrt`, `renesas`
+
+## Release v1.25.0 - 🪲Yanked🪲
+I have yanked the release of 1.25.0 from PyPI. 
+It was missing a step to upgrade from a .json to a sqlite database to better identify connected boards, and I failed to identify that in testing.
+
+There is a preview release available on PyPI, that has the fix for this issue, and it is available as `mpflash==1.25.0rc2`.
  
 ## Features
  1. List the connected boards including their firmware details, in a tabular or json format
@@ -79,15 +85,46 @@ You can use mpflash to perform various operations on your MicroPython boards. He
 | Command | Description |
 |---------|-------------|
 | `mpflash list` | List the connected board(s) including their firmware details |
+| `mpflash flash` | Flash the latest stable firmware to the connected board(s), downloading the firmware if needed |
 | `mpflash download` | Download the MicroPython firmware(s) for the connected board(s) |
-| `mpflash flash` | Flash the latest stable firmware to the connected board(s) |
 
-## selecting or ignoring specific serial ports
+**Listing connected boards:**  
+`mpflash list` will list all connected boards in a table , including their serial port, family, board name, CPU, version and build number.
+Options are available to list the boards in a json format, or to filter the list by serial port or board type.
+
+
+**Flashing boards with new firmware:**  
+`mpflash flash` will flash the latest stable firmware to all connected boards, downloading the firmware if needed.
+It will try to determine the current micropython borad and variant, download the firmware if needed, and flash the correct firmware to each board.
+
+Common options are:
+
+ - `--version` to specify the version of the firmware to flash, defaults to the latest stable version.
+ - `--serial` to specify the serial port(s) to flash, defaults to all connected boards.
+ - `--board` to specify which firmware to flash to a single board
+ - `--variant` to specify a specific variant of the board
+
+**Downloading firmware:**
+`mpflash download` will download the latest stable firmware for all connected boards, or a specific board if specified. It will download the firmware from the official MicroPython website and save it in your `Downloads/firmware` directory.  
+When a board is specified for which multiple variants are available, all variants will be downloaded.
+
+Common options are:
 
-You can use the `--serial` option to select a specific serial port to flash, or the `--ignore` option to ignore a specific serial port.
-both options can be specified multiple times 
-Both can be globs (e.g. COM*) or exact port names (e.g. COM1)
-in addition there is a --bluetooth option to simplify ignoring bluetooth ports
+ - `--version` to specify the version of the firmware to download, defaults to the latest stable version. (e.g. `stable`, `preview`, `x.y.z`)
+ - `--serial` to specify the serial port(s) to flash, defaults to all connected boards.
+ - `--board` to specify which firmware to flash to a single board
+
+
+
+## Selecting or ignoring specific serial ports
+
+You can use the `--serial` option to select a specific serial port(s) to flash,  
+Or you can use the `--ignore` option to ignore a specific serial port(s).  
+
+Either option can be specified multiple times, can be globs (e.g. COM*) or exact port names (e.g. /dev/ttyUSB0).
+To permenently ignore a port, you can set the `MPFLASH_IGNORE` environment variable to a space-separated list of serial ports or globs.
+
+In addition there is a --bluetooth option to simplify ignoring bluetooth ports, where the default is to ignore bluetooth ports.
 
 ```
 --serial,--serial-port      -s      SERIALPORT  Serial port(s) (or globs) to list. [default: *]                                                                                                                                                                           > > --ignore                    -i      SERIALPORT  Serial port(s) (or globs) to ignore. Defaults to MPFLASH_IGNORE.                                                                                                                                                          │
@@ -102,9 +139,9 @@ This file can contain a description of the board, which will be shown in the lis
 description = "Blue Norwegian actuator"
 ```
 
-If you want the board to be ignored by mpflash, you can add the following to the board_info.toml file:
+If you want the board to be ignored by mpflash, no matter which serial port it is connected to, you can add the following to the `board_info.toml` file:
 ```toml
-description = "Blue Norwegian feeder"
+description = "Blue Norwegian actuator"
 [mpflash]
 ignore = true
 ```

mpflash-1.25.0.post2.dist-info/RECORD

@@ -0,0 +1,69 @@
+mpflash/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mpflash/add_firmware.py,sha256=P1yaNUdExfzC_qnhE-P5ALZg1Uh7XT6Xf7NYccJP7Rc,4317
+mpflash/ask_input.py,sha256=YUx65Xwj6dNPwWcbQiWG7U4wDW69zEdno2HcT1KwPBg,8886
+mpflash/basicgit.py,sha256=Aiz6rF6PVhQir-FU-T1NhbjsW803y39Js6xnWs8-yu4,9676
+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
+mpflash/bootloader/manual.py,sha256=WYC4x-dxrSwVUfgnKTlu34pCzckrWJKZnWsARDocycI,3169
+mpflash/bootloader/micropython.py,sha256=v_kZkvg0uWZDbMrT78gmiYHbD83QLdnrctvEClI8iRg,529
+mpflash/bootloader/touch1200.py,sha256=VND7_YniS9Vx6WEaAxjI72RZZ6WBOwmBTsKJkbuaAHk,1105
+mpflash/cli_download.py,sha256=sMMIVTE4P9O2GpWB9jcbOiKQX-XJ0nu2bBylRbWu0X8,3872
+mpflash/cli_flash.py,sha256=Is8UH1QZ33XuajrkVOIdjOubyvAb5CcZKONJgdmmZGk,7966
+mpflash/cli_group.py,sha256=Uf_1ZmeeSIsaGLuuKn3KPPPVi8fJVbIacJYFZx_oPHc,2684
+mpflash/cli_list.py,sha256=ZuRalXXjDGo6FhgMTv54BQD_PNss7eeopeZQ_uE1J90,2632
+mpflash/cli_main.py,sha256=NMhEtMtSe7ApE-210Q4p-g7ZgewgO-4z1Q-vNKLQ47Y,1277
+mpflash/common.py,sha256=iKDoc6Ut8XbZ8fYLEI2XsoU7GuG_pFG0KGcRWXPl1wE,5922
+mpflash/config.py,sha256=bmwNSJzk27iHcI-r3C6hm6-TeOat2ymzbbv-Q-xuO2o,3048
+mpflash/connected.py,sha256=oxZdk1o-AfNPhJsSxr3KrMH_gdYfrjqc_IpT6J8Ng9k,3496
+mpflash/db/__init__.py,sha256=wnIlO4nOXsPGXMbn2OCqHRsR-hUmtJsko8VdqjH3ZUE,45
+mpflash/db/core.py,sha256=hyzurZp8QMl8Q9B00Q-tOkOUp68T8XhM7tj3dm5cDHw,2283
+mpflash/db/gather_boards.py,sha256=8QS7NIt3n9ROqtgVAnoqU8YMeObLGaN2pvJL7d_kULA,3905
+mpflash/db/loader.py,sha256=0L4I3ySaGLFlzy9FlV7_nzbqzA6MHwi0FhgDG5FJ_9U,4848
+mpflash/db/meta.py,sha256=I7JycEx37MVVYowA0VFfUYFX9IURiTTsWQ1RhFgGqes,2251
+mpflash/db/micropython_boards.zip,sha256=cc4m7VSskj__rhabw3j5OZCiz1yEi6yCx7JGFn1QB0k,16647
+mpflash/db/models.py,sha256=Q4yjZPcNRIGWevoACeGDS1i31QX6jq1q5TsyPjmdmz4,3448
+mpflash/db/tools.py,sha256=6SEGfshNob4yRQ4h-Cj_xcWMRY28sbA8CWauNXV_uMI,814
+mpflash/download/__init__.py,sha256=zidXvsSFCfR-BZCZ6TiB7uEucEuUqXnZhKSfTs60lzU,7930
+mpflash/download/from_web.py,sha256=PVJDaFfYLJGXlPva5fExh4Yg2H7j3idyJEcfOiVVJBs,7608
+mpflash/download/fwinfo.py,sha256=gpa92PkysT1B7mxPAFJ-b_6y03QCNgHKm-J6T_RFNMI,1852
+mpflash/download/jid.py,sha256=503HW4jIB22fsb9vYphXqqO33LTMtvPdENG81wKDgMs,2334
+mpflash/downloaded.py,sha256=508sqROPf0Ymz7UxMzReXtK6mG1EcoXA-ysGdzV-VM0,4040
+mpflash/errors.py,sha256=IAidY3qkZsXy6Pm1rdmVFmGyg81ywHhse3itaPctA2w,247
+mpflash/flash/__init__.py,sha256=jif7-ifsXMabidjNdqUQyl1CwD5_USjCAZFhU5W-Aw8,2992
+mpflash/flash/esp.py,sha256=4977E1hDqJ4-EIkLzwrUtgZuc0ZTD7NvP1PQZgZ2DoU,3227
+mpflash/flash/stm32.py,sha256=jNgMpJaxUwtJ-v6VU1luD1t41AQprCUeNVCVEovxQe0,595
+mpflash/flash/stm32_dfu.py,sha256=W-3JsRQyf3DduoIRXDmGZ35RogqtjQgcJnk-GOtQoLE,3090
+mpflash/flash/uf2/__init__.py,sha256=haL84hP2p1ZjKF6dXJJHAB_NTf7jT91MuZvmvg9SpIA,3617
+mpflash/flash/uf2/boardid.py,sha256=U5wGM8VA3wEpUxQCMtuXpMZZomdVH8J_Zd5_GekUMuU,423
+mpflash/flash/uf2/linux.py,sha256=uTgqyS7C7xfQ25RrTcSUkt-m2u2Ks_o7bPLzIecPoC8,4355
+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=OEeskObPtpIE4a5NzYIcBqg3FkM5MGPGEa4lGGOfntY,1338
+mpflash/flash/worklist.py,sha256=ZqbgYChXFGEVLVlGKeS9eJJDToxBYqjrfWE2NIa7Cck,5622
+mpflash/list.py,sha256=NNhKpRh3ARZMdq56GLJgJ67GeuUf9SxjTzFhQjDsi9A,4008
+mpflash/logger.py,sha256=b2pNiAEXgpUDZKnMjtgBAGgMpPwTB3u030EhJiXyLZQ,2009
+mpflash/mpboard_id/__init__.py,sha256=Z6gDDWTCSKPp2fsuaUz80zgrklBR9XDlSLF9y_evR9A,391
+mpflash/mpboard_id/alternate.py,sha256=ZhqfdA9sLJmyOfJ6WwK9wrzzUn6JQdkAreiL0q5XEQg,1913
+mpflash/mpboard_id/board_id.py,sha256=dGbYnqaGHm6Z68P6aCq5bv95pyhi9KKhQleQXmlyO8Y,2046
+mpflash/mpboard_id/board_info.json,sha256=A3ZIt38KvAy2NMB5srHorSBd3Q3wOZIXufWiIs3XLrs,1019745
+mpflash/mpboard_id/board_info.zip,sha256=-2bnQGRsIQuJUfz-7_-GQ8pMWJ1evhCez6yfjhXocNw,23213
+mpflash/mpboard_id/known.py,sha256=GrNe4FtzVIdi9L9xuJ1gzorzXTvdfrugX1iVc_Nblb8,3325
+mpflash/mpboard_id/resolve.py,sha256=5KCZ0Tcg3FYZ3HK_zux5EguwoSC2E03kCpW2fh4rN2A,779
+mpflash/mpremoteboard/__init__.py,sha256=MvvJy6G32YQf8IqZR2AjMXcusI82Muy6JVvjVv7dZhw,12092
+mpflash/mpremoteboard/mpy_fw_info.py,sha256=ZDEPJN9XJnoG_oeWcLNiLJAD5bkVX2yI_j4K7msUxWM,5196
+mpflash/mpremoteboard/runner.py,sha256=auJuK7uBq_qdZOX9DgzRARyAsTyhT8c9ycP02VqhMf4,4943
+mpflash/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+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=KD1RHHuhvhWi-l1UB6GyggkxouDKtZgkG4ivRbIfwC4,21264
+mpflash/vendor/readme.md,sha256=BQ7Uxf8joeYMjTUuSLLBG49ob6a9MgFPIEwuc72-Mfw,415
+mpflash/versions.py,sha256=HuujLNdMKY_mQXyEqwXVHcU8nbuXeBiWP2TMA5JQhr4,4884
+mpflash-1.25.0.post2.dist-info/entry_points.txt,sha256=Jk_visOhYOsZIcSP2Ms9hKqfKy1iorR-6dYltSoWCpY,52
+mpflash-1.25.0.post2.dist-info/LICENSE,sha256=mWpNhsIxWzetYNnTpr4eb3HtgsxGIC8KcYWxXEcxQvE,1077
+mpflash-1.25.0.post2.dist-info/METADATA,sha256=bHmPpoBGN1AFCU0EeOA-fzkBeyKDzNoAvMj5JbpoJKY,26234
+mpflash-1.25.0.post2.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
+mpflash-1.25.0.post2.dist-info/RECORD,,

mpflash/db/boards.py

@@ -1,63 +0,0 @@
-
-from __future__ import annotations
-
-import sqlite3
-from pathlib import Path
-from typing import List
-
-from mpflash.common import FWInfo
-from mpflash.config import config
-from mpflash.logger import log
-
-
-def find_board_id(
-    db_path: Path | None = None, board_id: str = "", description: str = "", version: str = "%"
-) -> List[str]:
-    """Get a list of board IDs from the database based on the board ID or description"""
-    db_path = db_path or config.db_path
-    conn = sqlite3.connect(db_path)
-    conn.row_factory = sqlite3.Row
-    rows = []
-    with conn:
-        cursor = conn.cursor()
-        
-        query = """
-        SELECT DISTINCT board_id FROM board_downloaded
-        where board_id like ? and version like ?
-        ORDER BY `version` ASC
-        """
-        cursor.execute(query, (board_id,version))
-        rows = cursor.fetchall()
-        if len(rows) == 0:
-            cursor.execute(
-                """
-                SELECT DISTINCT description FROM board_downloaded
-                where description like ? and version like ?
-                ORDER BY `description` ASC
-                """,
-                (description,version),
-            )
-            rows = cursor.fetchall()
-        
-    return [row['board_id'] for row in rows]
-
-
-def find_board_info(
-    db_path: Path | None = None, board_id: str = "", version: str = "%"
-) -> List[sqlite3.Row]:
-    """get a list of board rows  from the database based on the board ID and version"""
-    db_path = db_path or config.db_path
-    conn = sqlite3.connect(db_path)
-    conn.row_factory = sqlite3.Row
-    rows = []
-    with conn:
-        cursor = conn.cursor()
-        query = """
-        SELECT * FROM board_downloaded
-        where board_id like ? and version like ?
-        ORDER BY board_id, version ASC
-        """
-        cursor.execute(query, (board_id,version,))
-        rows = cursor.fetchall()
-
-    return rows

mpflash/db/downloads.py

@@ -1,87 +0,0 @@
-from __future__ import annotations
-
-import sqlite3
-from pathlib import Path
-from typing import List
-
-from mpflash.common import FWInfo
-from mpflash.config import config
-from mpflash.logger import log
-
-
-def upsert_download(conn: sqlite3.Connection, board: FWInfo):
-    """
-    Adds a row to the downloaded firmware table in the database.
-      - downloads.board_id <-- FWInfo.variant
-      - downloads.source   <-- FWInfo.firmware
-
-    Args:
-        conn : The database connection to use.
-        board : The firmware information to add to the database.
-
-    """
-    with conn:
-        conn.execute(
-            """
-            INSERT INTO downloads 
-                (port, board, filename, source, board_id, version, build, ext, family, custom, description) 
-            VALUES 
-                (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
-            ON CONFLICT(filename) DO UPDATE SET
-                port=excluded.port,
-                board=excluded.board,
-                source=excluded.source,
-                board_id=excluded.board_id,
-                version=excluded.version,
-                build=excluded.build,
-                ext=excluded.ext,
-                family=excluded.family,
-                custom=excluded.custom,
-                description=excluded.description
-            """,
-            (
-                board.port,
-                board.board,
-                board.filename,
-                board.firmware,
-                board.variant,
-                board.version,
-                board.build,
-                board.ext,
-                board.family,
-                board.custom,
-                board.description,
-            ),
-        )
-        conn.commit()
-
-def downloaded(db_path: Path | None = None) -> List[FWInfo]:
-    """Load a list of locally downloaded firmwares from the database"""
-    db_path = db_path or config.db_path
-    with sqlite3.connect(db_path) as conn:
-        firmwares: List[FWInfo] = []
-        try:
-            conn.row_factory = sqlite3.Row
-            cursor = conn.cursor()
-            cursor.execute("SELECT * FROM downloads")
-            rows = cursor.fetchall()
-            for row in rows:
-                fw_info = FWInfo.from_dict(
-                    {
-                        "filename": row["filename"],
-                        "version": row["version"],
-                        "board": row["board"],
-                        "variant": row["board_id"],
-                        "port": row["port"],
-                        "firmware": row["source"],
-                        "build": row["build"],
-                        "preview": 1 if int(row["build"]) > 0 else 0,
-                    }
-                )
-                firmwares.append(fw_info)
-        except sqlite3.Error as e:
-            log.error(f"Database error: {e}")
-
-    # sort by filename
-    firmwares.sort(key=lambda x: x.filename)
-    return firmwares

mpflash/mpboard_id/add_boards.py

@@ -1,260 +0,0 @@
-"""
-Collects board name and description information from MicroPython and writes it to JSON and CSV files.
-"""
-
-import re
-from pathlib import Path
-from typing import List, Optional
-
-import inquirer
-import rich
-import rich.table
-from rich.console import Console
-from rich.progress import track
-
-import mpflash.basicgit as git
-from mpflash.logger import log
-from mpflash.mpboard_id import Board
-from mpflash.mpboard_id.store import write_boardinfo_json
-from mpflash.versions import get_preview_mp_version, micropython_versions
-
-# 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]*)\"")
-# TODO: normal make files
-
-
-def boards_from_repo(mpy_path: Path, version: str, family: Optional[str] = None) -> List[Board]:
-    """Collects board name and decriptions from mpconfigboard.h files.
-
-    Args:
-        mpy_path (Path): The path to the MicroPython repository.
-        version (str): The version of MicroPython.
-
-    Returns:
-        List[Board]: A list of Board objects containing the board information.
-    """
-    if not mpy_path.exists() or not mpy_path.is_dir():
-        raise FileNotFoundError(f"MicroPython path {mpy_path} does not exist.")
-    family = family or "micropython"
-    version = version or git.get_local_tag()  # type: ignore
-    if not version:
-        raise ValueError("No version provided and no local tag found.")
-    elif version in ["main", "master"]:
-        version = get_preview_mp_version()
-
-    board_list: List[Board] = []
-    # look in mpconfigboard.h files
-    board_list = boards_from_cmake(mpy_path, version, family)
-
-    # look for boards in the .cmake files
-    board_list.extend(boards_from_headers(mpy_path, version, family))
-
-    # TODO:? look for variants in the board.json files
-
-    return board_list
-
-
-def boards_from_cmake(mpy_path: Path, version: str, family: str):
-    """Get boards from the mpconfigboard.cmake files to the board_list."""
-    board_list = []
-    for path in mpy_path.glob("ports/**/mpconfigboard*.cmake"):
-        board = path.parent.name
-        port = path.parent.parent.parent.name
-        with open(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"]
-                    board_list.append(
-                        Board(
-                            board_id=board,
-                            port=port,
-                            board_name=board_name,
-                            mcu_name=mcu_name,
-                            description=description,
-                            path=path.relative_to(mpy_path),
-                            version=version,
-                            family=family,
-                        )
-                    )
-                elif match := RE_CMAKE_MICROPY_HW_MCU_NAME.match(line):
-                    description = match["variant"]
-                    board_list.append(
-                        Board(
-                            board_id=board,
-                            port=port,
-                            board_name=board_name,
-                            mcu_name=mcu_name,
-                            description=description,
-                            path=path.relative_to(mpy_path),
-                            version=version,
-                            family=family,
-                        )
-                    )
-    return board_list
-
-
-def boards_from_headers(mpy_path: Path, version: str, family: str):
-    """Get boards from the mpconfigboard.h files to the board_list."""
-    board_list = []
-    for path in mpy_path.glob("ports/**/mpconfigboard.h"):
-        board = path.parent.name
-        port = path.parent.parent.parent.name
-        with open(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:
-                    description = f"{board_name} with {mcu_name}" if mcu_name != "-" else board_name
-                    board_list.append(
-                        Board(
-                            board_id=board,
-                            port=port,
-                            board_name=board_name,
-                            mcu_name=mcu_name,
-                            description=description,
-                            path=path.relative_to(mpy_path),
-                            version=version,
-                            family=family,
-                        )
-                    )
-                    found = 0
-            if found == 1:
-                description = board_name
-                board_list.append(
-                    Board(
-                        board_id=board,
-                        port=port,
-                        board_name=board_name,
-                        mcu_name=mcu_name,
-                        description=description,
-                        path=path.relative_to(mpy_path),
-                        version=version,
-                        family=family,
-                    )
-                )
-    return board_list
-
-
-def boards_for_versions(versions: List[str], mpy_path: Path):
-    """Gets the list of boards for multiple versions of MicroPython.
-
-    Args:
-        versions (List[str]): The list of MicroPython versions.
-        mpy_path (Path): The path to the MicroPython repository.
-
-    Returns:
-        List[Board]: The list of Board objects.
-    """
-    board_list: List[Board] = []
-    # first fetch all tags from the repository
-    git.fetch(mpy_path)
-    for version in track(versions, description="Searching MicroPython versions"):
-        if git.checkout_tag(tag=version, repo=mpy_path):
-            new_ones = boards_from_repo(mpy_path, version, family="micropython")
-            print(f"Found {len(new_ones)} board definitions for {version}.")
-            board_list += new_ones
-        else:
-            print(f"Could not checkout version {version}.")
-
-    # sort the board_list by description and board
-    print("Total number of boards found:", len(board_list))
-
-    board_list = unique_boards(board_list)
-    print("Unique board descriptions found:", len(board_list))
-    return board_list
-
-
-def unique_boards(board_list: List[Board], *, key_version: bool = True):
-    """Remove duplicate boards by 'BOARD_ID description' from the list."""
-    seen = set()
-    result = []
-    for x in board_list:
-        if key_version:
-            key = f"{x.board_id}|{x.version}|{x.description}"
-        else:
-            key = f"{x.board_id}|{x.description}"
-        if key not in seen:
-            result.append(x)
-            seen.add(key)
-    result.sort(key=lambda x: x.description.lower())
-    return result
-
-
-def make_table(board_list: List[Board]) -> rich.table.Table:
-    """Creates a rich table with board information."""
-    is_wide = True
-
-    table = rich.table.Table(title="MicroPython Board Information")
-    table.add_column("Port", justify="left", style="magenta")
-    table.add_column("BOARD_ID", justify="left", style="green")
-    table.add_column("Variant(s)", justify="left", style="blue")
-    table.add_column("Description", justify="left", style="cyan")
-    table.add_column("Board Name", justify="left", style="blue")
-    if is_wide:
-        table.add_column("MCU Name", justify="left", style="blue")
-    table.add_column("Detection", justify="left", style="yellow")
-    table.add_column("Version", justify="left", style="blue")
-    if is_wide:
-        table.add_column("Family", justify="left", style="blue")
-
-    for board in board_list:
-        row = [board.port, board.board_id, board.variant, board.description, board.board_name]
-        if is_wide:
-            row.append(board.mcu_name)
-        row.extend((str(Path(board.path).suffix), board.version))
-        if is_wide:
-            row.append(board.family)
-        table.add_row(*row)
-
-    return table
-
-
-def ask_mpy_path():
-    """Ask the user for the path to the MicroPython repository."""
-    questions = [
-        inquirer.Text(
-            "mpy_path",
-            message="Enter the path to the MicroPython repository",
-            default="./repos/micropython",
-        )
-    ]
-    if answers := inquirer.prompt(questions):
-        return Path(answers["mpy_path"])
-    else:
-        raise ValueError("No path provided.")
-
-
-def main():
-    """Main function to collect and write board information."""
-
-    console = Console()
-
-    mpy_path = ask_mpy_path()
-    versions = micropython_versions(minver="v1.10") + ["master"]
-    board_list = boards_for_versions(versions, mpy_path)
-
-    here = Path(__file__).parent
-    log.info(write_boardinfo_json(board_list, folder=here))
-    # write_files(board_list, folder=CONFIG.board_path)
-
-    # table of when the board was added
-    table = make_table(unique_boards(board_list, key_version=False))
-    console.print(table)
-
-
-if __name__ == "__main__":
-    main()

mpflash/mpboard_id/board.py

@@ -1,40 +0,0 @@
-from dataclasses import dataclass, field
-from pathlib import Path
-from typing import Union
-
-
-# - source : get_boardnames.py
-@dataclass
-class Board:
-    """
-    MicroPython Board definitions, parsed from the make and header files
-    """
-
-    port: str  # micropython port
-    board_id: str  # BOARD_ID (Foldername) as used in the make files
-    board_name: str  # Short board description
-    description: str  # Long board description
-    path: Union[Path, str]
-    version: str = field(default="")  # version of MicroPython""
-    # versions: List[str] = field(default=[])  # version of MicroPython""
-    family: str = field(default="micropython")
-    mcu_name: str = field(default="")
-    cpu: str = field(default="")
-    variant: str = field(default="")
-    mcu: str = field(default="")
-
-    def __post_init__(self):
-        if not self.cpu:
-            if " with " in self.description:
-                self.cpu = self.description.rsplit(" with ")[-1]
-            else:
-                self.cpu = self.port
-
-    @staticmethod
-    def from_dict(data: dict) -> "Board":
-        valid_keys = {field.name for field in Board.__dataclass_fields__.values()}
-        filtered_data = {k: v for k, v in data.items() if k in valid_keys}
-        return Board(**filtered_data)
-
-    def to_dict(self) -> dict:
-        return self.__dict__

mpflash/mpboard_id/store.py

@@ -1,47 +0,0 @@
-import functools
-import zipfile
-from pathlib import Path
-from typing import Final, List, Optional
-from mpflash.logger import log
-
-import jsons
-
-from mpflash.mpboard_id.board import Board
-
-###############################################################################################
-HERE: Final = Path(__file__).parent
-###############################################################################################
-
-
-def write_boardinfo_json(board_list: List[Board], *, folder: Optional[Path] = None):
-    """Writes the board information to a JSON file.
-
-    Args:
-        board_list (List[Board]): The list of Board objects.
-        folder (Path): The folder where the compressed JSON file will be saved.
-    """
-
-    if not folder:
-        folder = HERE
-    # create a zip file with the json file
-    with zipfile.ZipFile(folder / "board_info.zip", "w", compression=zipfile.ZIP_DEFLATED) as zipf:
-        # write the list to json file inside the zip
-        with zipf.open("board_info.json", "w") as fp:
-            fp.write(jsons.dumps(board_list, jdkwargs={"indent": 4}).encode())
-
-
-@functools.lru_cache(maxsize=20)
-def read_known_boardinfo(board_info: Optional[Path] = None) -> List[Board]:
-    """Reads the board information from a JSON file in a zip file."""
-    log.warning("read_known_boardinfo() is deprecated")
-
-    if not board_info:
-        board_info = HERE / "board_info.zip"
-    if not board_info.exists():
-        raise FileNotFoundError(f"Board info file not found: {board_info}")
-
-    with zipfile.ZipFile(board_info, "r") as zf:
-        with zf.open("board_info.json", "r") as file:
-            info = jsons.loads(file.read().decode(encoding="utf-8"), List[Board])
-
-    return info