mpflash 0.7.5__py3-none-any.whl → 0.7.7__py3-none-any.whl

mpflash/ask_input.py

@@ -45,7 +45,7 @@ ParamType = Union[DownloadParams, FlashParams]
 
 def ask_missing_params(
     params: ParamType,
-    action: str = "download",
+    # action: str = "download",
 ) -> ParamType:
     """
     Asks the user for parameters that have not been supplied on the commandline and returns the updated params.
@@ -57,6 +57,10 @@ def ask_missing_params(
     Returns:
         ParamType: The updated parameters.
     """
+    # if action flash,  single input
+    # if action download, multiple input
+    multi_select = isinstance(params, DownloadParams)
+    action = "download" if isinstance(params, DownloadParams) else "flash"
     if not config.interactive:
         # no interactivity allowed
         return params
@@ -64,21 +68,21 @@ def ask_missing_params(
     import inquirer
 
     questions = []
-    answers = {"action": action}
-    if isinstance(params, FlashParams):
+    answers = {"action": "download" if isinstance(params, DownloadParams) else "flash"}
+    if not multi_select:
         if not params.serial or "?" in params.serial:
-            ask_serialport(questions, action=action)
+            ask_serialport(questions)
         else:
             answers["serial"] = params.serial
 
     if not params.versions or "?" in params.versions:
-        ask_versions(questions, action=action)
+        ask_versions(questions, multi_select=multi_select, action=action)
     else:
         # versions is used to show only the boards for the selected versions
         answers["versions"] = params.versions  # type: ignore
 
     if not params.boards or "?" in params.boards:
-        ask_port_board(questions, action=action)
+        ask_port_board(questions, multi_select=multi_select, action=action)
     if questions:
         answers = inquirer.prompt(questions, answers=answers)
     if not answers:
@@ -86,10 +90,10 @@ def ask_missing_params(
         return []  # type: ignore
     # print(repr(answers))
     if isinstance(params, FlashParams) and "serial" in answers:
-        params.serial = answers["serial"]
+        params.serial = answers["serial"].split()[0]  # split to remove the description
     if "port" in answers:
         params.ports = [p for p in params.ports if p != "?"]  # remove the "?" if present
-        params.ports.extend(answers["port"])
+        params.ports.append(answers["port"])
     if "boards" in answers:
         params.boards = [b for b in params.boards if b != "?"]  # remove the "?" if present
         params.boards.extend(answers["boards"] if isinstance(answers["boards"], list) else [answers["boards"]])
@@ -144,7 +148,7 @@ def filter_matching_boards(answers: dict) -> Sequence[Tuple[str, str]]:
     return some_boards
 
 
-def ask_port_board(questions: list, *, action: str):
+def ask_port_board(questions: list, *, multi_select: bool, action: str):
     """
     Asks the user for the port and board selection.
 
@@ -160,7 +164,7 @@ def ask_port_board(questions: list, *, action: str):
 
     # if action flash,  single input
     # if action download, multiple input
-    inquirer_ux = inquirer.Checkbox if action == "download" else inquirer.List
+    inquirer_ux = inquirer.Checkbox if multi_select else inquirer.List
     questions.extend(
         (
             inquirer.List(
@@ -183,7 +187,7 @@ def ask_port_board(questions: list, *, action: str):
     )
 
 
-def ask_versions(questions: list, *, action: str):
+def ask_versions(questions: list, *, multi_select: bool, action: str):
     """
     Asks the user for the version selection.
 
@@ -198,7 +202,7 @@ def ask_versions(questions: list, *, action: str):
     import inquirer
     import inquirer.errors
 
-    input_ux = inquirer.Checkbox if action == "download" else inquirer.List
+    input_ux = inquirer.Checkbox if multi_select else inquirer.List
     mp_versions: List[str] = micropython_versions()
     mp_versions = [v for v in mp_versions if "preview" not in v]
 
@@ -226,12 +230,12 @@ def ask_versions(questions: list, *, action: str):
             # hints=["Use space to select multiple options"],
             choices=mp_versions,
             autocomplete=True,
-            validate=at_least_one_validation,
+            validate=at_least_one_validation,  # type: ignore
         )
     )
 
 
-def ask_serialport(questions: list, *, action: str):
+def ask_serialport(questions: list, *, multi_select: bool = False, bluetooth: bool = False):
     """
     Asks the user for the serial port selection.
 
@@ -245,12 +249,12 @@ def ask_serialport(questions: list, *, action: str):
     # import only when needed to reduce load time
     import inquirer
 
-    serialports = MPRemoteBoard.connected_boards()
+    comports = MPRemoteBoard.connected_boards(bluetooth=bluetooth, description=True)
     questions.append(
         inquirer.List(
             "serial",
             message="Which serial port do you want to {action} ?",
-            choices=serialports,
+            choices=comports,
             other=True,
             validate=lambda _, x: True if x else "Please select or enter a serial port",  # type: ignore
         )

mpflash/cli_download.py

@@ -81,7 +81,7 @@ def cli_download(**kwargs) -> int:
         # no boards specified - detect connected ports and boards
         params.ports, params.boards = connected_ports_boards()
 
-    params = ask_missing_params(params, action="download")
+    params = ask_missing_params(params)
     if not params:  # Cancelled by user
         return 2
     params.versions = [clean_version(v, drop_v=True) for v in params.versions]

mpflash/cli_flash.py

@@ -101,6 +101,14 @@ def cli_flash_board(**kwargs) -> int:
         kwargs["boards"] = [kwargs.pop("board")]
 
     params = FlashParams(**kwargs)
+
+    # make it simple for the user to flash one board
+    # by asking for the serial port if not specified
+    if params.boards == ["?"] and params.serial == "auto":
+        params.serial = "?"
+
+    # Detect connected boards if not specified,
+    # and ask for input if boards cannot be detected
     if not params.boards or params.boards == []:
         # nothing specified - detect connected boards
         params.ports, params.boards = connected_ports_boards()
@@ -125,7 +133,7 @@ def cli_flash_board(**kwargs) -> int:
                     log.warning(f"unable to resolve board description: {e}")
 
     # Ask for missing input if needed
-    params = ask_missing_params(params, action="flash")
+    params = ask_missing_params(params)
     if not params:  # Cancelled by user
         return 2
     # TODO: Just in time Download of firmware

mpflash/cli_group.py

@@ -3,6 +3,8 @@ Main entry point for the CLI group.
 Additional comands are added in the submodules.
 """
 
+import sys
+
 import rich_click as click
 
 from .config import config
@@ -23,6 +25,8 @@ def cb_verbose(ctx, param, value):
 def cb_ignore(ctx, param, value):
     if value:
         config.ignore_ports = list(value)
+        if sys.platform == "win32":
+            config.ignore_ports = [port.upper() for port in config.ignore_ports]
     return value
 
 
@@ -32,6 +36,12 @@ def cb_interactive(ctx, param, value):
     return value
 
 
+def cb_test(ctx, param, value):
+    if value:
+        config.tests = value
+    return value
+
+
 def cb_quiet(ctx, param, value):
     if value:
         make_quiet()
@@ -80,6 +90,17 @@ def cb_quiet(ctx, param, value):
     show_default=True,
     metavar="SERIALPORT",
 )
+@click.option(
+    "--test",
+    is_eager=True,
+    help="test a specific feature",
+    callback=cb_test,
+    multiple=True,
+    default=[],
+    envvar="MPFLASH_TEST",
+    show_default=True,
+    metavar="TEST",
+)
 def cli(**kwargs):
     """mpflash - MicroPython Tool.
 

mpflash/cli_main.py

@@ -3,6 +3,7 @@
 # import rich_click as click
 
 import click
+from loguru import logger as log
 
 from .cli_download import cli_download
 from .cli_flash import cli_flash_board
@@ -19,8 +20,11 @@ def mpflash():
         result = cli(standalone_mode=False)
         exit(result)
     except AttributeError as e:
-        print(f"Error: {e}")
+        log.error(f"Error: {e}")
         exit(-1)
+    except click.exceptions.ClickException as e:
+        log.error(f"Error: {e}")
+        exit(-2)
 
 
 if __name__ == "__main__":

mpflash/config.py

@@ -14,6 +14,8 @@ class MPtoolConfig:
     ignore_ports: List[str] = []
     interactive: bool = True
     firmware_folder: Path = platformdirs.user_downloads_path() / "firmware"
+    # test options specified on the commandline
+    tests: List[str] = []
 
 
 config = MPtoolConfig()

mpflash/flash_uf2.py

@@ -14,7 +14,9 @@ from rich.progress import track
 from mpflash.mpremoteboard import MPRemoteBoard
 
 from .common import PORT_FWTYPES
+from .config import config
 from .flash_uf2_linux import dismount_uf2, wait_for_UF2_linux
+from .flash_uf2_macos import wait_for_UF2_macos
 from .flash_uf2_windows import wait_for_UF2_windows
 
 
@@ -41,9 +43,15 @@ def flash_uf2(mcu: MPRemoteBoard, fw_file: Path, erase: bool) -> Optional[MPRemo
         destination = wait_for_UF2_linux()
     elif sys.platform == "win32":
         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()
     else:
         log.warning(f"OS {sys.platform} not tested/supported")
-        destination = wait_for_UF2_linux()
         return None
 
     if not destination or not destination.exists() or not (destination / "INFO_UF2.TXT").exists():
@@ -54,7 +62,7 @@ def flash_uf2(mcu: MPRemoteBoard, fw_file: Path, erase: bool) -> Optional[MPRemo
     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", "darwin"]:
+    if sys.platform in ["linux"]:
         dismount_uf2()
     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

mpflash/flash_uf2_linux.py

@@ -13,28 +13,15 @@ from loguru import logger as log
 from rich.progress import track
 
 from .flash_uf2_boardid import get_board_id
+from .uf2disk import UF2Disk
 
 glb_dismount_me: List[UF2Disk] = []
 
 
-class UF2Disk:
-    """Info to support mounting and unmounting of UF2 drives on linux"""
-
-    device_path: str
-    label: str
-    mountpoint: str
-
-    def __repr__(self):
-        return repr(self.__dict__)
-
-
 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
 
@@ -113,7 +100,9 @@ def wait_for_UF2_linux(s_max: int = 10):
     wait = 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):
+    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():

mpflash/flash_uf2_macos.py

@@ -0,0 +1,80 @@
+""" Flashing UF2 based MCU on macos"""
+
+# sourcery skip: snake-case-functions
+from __future__ import annotations
+
+import subprocess
+import sys
+import time
+from pathlib import Path
+from typing import List
+
+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:
+    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)
+            try:
+                if Path(drive.mountpoint, "INFO_UF2.TXT").exists():
+                    board_id = get_board_id(Path(drive.mountpoint))  # type: ignore
+                    destination = Path(drive.mountpoint)
+                    break
+            except PermissionError:
+                log.debug(f"Permission error on {drive.mountpoint}")
+                continue
+        if destination:
+            break
+        time.sleep(1)
+        wait -= 1
+    return destination

mpflash/mpboard_id/Untitled-1.ipynb

@@ -0,0 +1,406 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/html": [
+       "<div>\n",
+       "<style scoped>\n",
+       "    .dataframe tbody tr th:only-of-type {\n",
+       "        vertical-align: middle;\n",
+       "    }\n",
+       "\n",
+       "    .dataframe tbody tr th {\n",
+       "        vertical-align: top;\n",
+       "    }\n",
+       "\n",
+       "    .dataframe thead th {\n",
+       "        text-align: right;\n",
+       "    }\n",
+       "</style>\n",
+       "<table border=\"1\" class=\"dataframe\">\n",
+       "  <thead>\n",
+       "    <tr style=\"text-align: right;\">\n",
+       "      <th></th>\n",
+       "      <th>description</th>\n",
+       "      <th>port</th>\n",
+       "      <th>board</th>\n",
+       "      <th>board_name</th>\n",
+       "      <th>mcu_name</th>\n",
+       "      <th>path</th>\n",
+       "      <th>version</th>\n",
+       "    </tr>\n",
+       "  </thead>\n",
+       "  <tbody>\n",
+       "    <tr>\n",
+       "      <th>0</th>\n",
+       "      <td>4MB/OTA module with ESP32</td>\n",
+       "      <td>esp32</td>\n",
+       "      <td>GENERIC_OTA</td>\n",
+       "      <td>4MB/OTA module</td>\n",
+       "      <td>ESP32</td>\n",
+       "      <td>ports/esp32/boards/GENERIC_OTA/mpconfigboard.h</td>\n",
+       "      <td>v1.20.0</td>\n",
+       "    </tr>\n",
+       "    <tr>\n",
+       "      <th>1</th>\n",
+       "      <td>4MB/OTA module with ESP32</td>\n",
+       "      <td>esp32</td>\n",
+       "      <td>GENERIC_OTA</td>\n",
+       "      <td>4MB/OTA module</td>\n",
+       "      <td>ESP32</td>\n",
+       "      <td>ports/esp32/boards/GENERIC_OTA/mpconfigboard.h</td>\n",
+       "      <td>v1.19.1</td>\n",
+       "    </tr>\n",
+       "    <tr>\n",
+       "      <th>2</th>\n",
+       "      <td>4MB/OTA module with ESP32</td>\n",
+       "      <td>esp32</td>\n",
+       "      <td>GENERIC_OTA</td>\n",
+       "      <td>4MB/OTA module</td>\n",
+       "      <td>ESP32</td>\n",
+       "      <td>ports/esp32/boards/GENERIC_OTA/mpconfigboard.h</td>\n",
+       "      <td>v1.19</td>\n",
+       "    </tr>\n",
+       "    <tr>\n",
+       "      <th>3</th>\n",
+       "      <td>4MB/OTA module with ESP32</td>\n",
+       "      <td>esp32</td>\n",
+       "      <td>GENERIC_OTA</td>\n",
+       "      <td>4MB/OTA module</td>\n",
+       "      <td>ESP32</td>\n",
+       "      <td>ports/esp32/boards/GENERIC_OTA/mpconfigboard.h</td>\n",
+       "      <td>v1.18</td>\n",
+       "    </tr>\n",
+       "    <tr>\n",
+       "      <th>4</th>\n",
+       "      <td>4MB/OTA module with ESP32</td>\n",
+       "      <td>esp32</td>\n",
+       "      <td>GENERIC_OTA</td>\n",
+       "      <td>4MB/OTA module</td>\n",
+       "      <td>ESP32</td>\n",
+       "      <td>ports/esp32/boards/GENERIC_OTA/mpconfigboard.h</td>\n",
+       "      <td>v1.17</td>\n",
+       "    </tr>\n",
+       "    <tr>\n",
+       "      <th>...</th>\n",
+       "      <td>...</td>\n",
+       "      <td>...</td>\n",
+       "      <td>...</td>\n",
+       "      <td>...</td>\n",
+       "      <td>...</td>\n",
+       "      <td>...</td>\n",
+       "      <td>...</td>\n",
+       "    </tr>\n",
+       "    <tr>\n",
+       "      <th>2207</th>\n",
+       "      <td>XIAO nRF52840 Sense with NRF52840</td>\n",
+       "      <td>nrf</td>\n",
+       "      <td>SEEED_XIAO_NRF52</td>\n",
+       "      <td>XIAO nRF52840 Sense</td>\n",
+       "      <td>NRF52840</td>\n",
+       "      <td>ports/nrf/boards/SEEED_XIAO_NRF52/mpconfigboard.h</td>\n",
+       "      <td>v1.22.1</td>\n",
+       "    </tr>\n",
+       "    <tr>\n",
+       "      <th>2208</th>\n",
+       "      <td>XIAO nRF52840 Sense with NRF52840</td>\n",
+       "      <td>nrf</td>\n",
+       "      <td>SEEED_XIAO_NRF52</td>\n",
+       "      <td>XIAO nRF52840 Sense</td>\n",
+       "      <td>NRF52840</td>\n",
+       "      <td>ports/nrf/boards/SEEED_XIAO_NRF52/mpconfigboard.h</td>\n",
+       "      <td>v1.22.0-preview</td>\n",
+       "    </tr>\n",
+       "    <tr>\n",
+       "      <th>2209</th>\n",
+       "      <td>XIAO nRF52840 Sense with NRF52840</td>\n",
+       "      <td>nrf</td>\n",
+       "      <td>SEEED_XIAO_NRF52</td>\n",
+       "      <td>XIAO nRF52840 Sense</td>\n",
+       "      <td>NRF52840</td>\n",
+       "      <td>ports/nrf/boards/SEEED_XIAO_NRF52/mpconfigboard.h</td>\n",
+       "      <td>v1.22.0</td>\n",
+       "    </tr>\n",
+       "    <tr>\n",
+       "      <th>2210</th>\n",
+       "      <td>XIAO nRF52840 Sense with NRF52840</td>\n",
+       "      <td>nrf</td>\n",
+       "      <td>SEEED_XIAO_NRF52</td>\n",
+       "      <td>XIAO nRF52840 Sense</td>\n",
+       "      <td>NRF52840</td>\n",
+       "      <td>ports/nrf/boards/SEEED_XIAO_NRF52/mpconfigboard.h</td>\n",
+       "      <td>v1.21.0</td>\n",
+       "    </tr>\n",
+       "    <tr>\n",
+       "      <th>2211</th>\n",
+       "      <td>XIAO nRF52840 Sense with NRF52840</td>\n",
+       "      <td>nrf</td>\n",
+       "      <td>seeed_xiao_nrf52</td>\n",
+       "      <td>XIAO nRF52840 Sense</td>\n",
+       "      <td>NRF52840</td>\n",
+       "      <td>ports/nrf/boards/seeed_xiao_nrf52/mpconfigboard.h</td>\n",
+       "      <td>v1.20.0</td>\n",
+       "    </tr>\n",
+       "  </tbody>\n",
+       "</table>\n",
+       "<p>2212 rows × 7 columns</p>\n",
+       "</div>"
+      ],
+      "text/plain": [
+       "                            description   port             board  \\\n",
+       "0             4MB/OTA module with ESP32  esp32       GENERIC_OTA   \n",
+       "1             4MB/OTA module with ESP32  esp32       GENERIC_OTA   \n",
+       "2             4MB/OTA module with ESP32  esp32       GENERIC_OTA   \n",
+       "3             4MB/OTA module with ESP32  esp32       GENERIC_OTA   \n",
+       "4             4MB/OTA module with ESP32  esp32       GENERIC_OTA   \n",
+       "...                                 ...    ...               ...   \n",
+       "2207  XIAO nRF52840 Sense with NRF52840    nrf  SEEED_XIAO_NRF52   \n",
+       "2208  XIAO nRF52840 Sense with NRF52840    nrf  SEEED_XIAO_NRF52   \n",
+       "2209  XIAO nRF52840 Sense with NRF52840    nrf  SEEED_XIAO_NRF52   \n",
+       "2210  XIAO nRF52840 Sense with NRF52840    nrf  SEEED_XIAO_NRF52   \n",
+       "2211  XIAO nRF52840 Sense with NRF52840    nrf  seeed_xiao_nrf52   \n",
+       "\n",
+       "               board_name  mcu_name  \\\n",
+       "0          4MB/OTA module     ESP32   \n",
+       "1          4MB/OTA module     ESP32   \n",
+       "2          4MB/OTA module     ESP32   \n",
+       "3          4MB/OTA module     ESP32   \n",
+       "4          4MB/OTA module     ESP32   \n",
+       "...                   ...       ...   \n",
+       "2207  XIAO nRF52840 Sense  NRF52840   \n",
+       "2208  XIAO nRF52840 Sense  NRF52840   \n",
+       "2209  XIAO nRF52840 Sense  NRF52840   \n",
+       "2210  XIAO nRF52840 Sense  NRF52840   \n",
+       "2211  XIAO nRF52840 Sense  NRF52840   \n",
+       "\n",
+       "                                                   path          version  \n",
+       "0        ports/esp32/boards/GENERIC_OTA/mpconfigboard.h          v1.20.0  \n",
+       "1        ports/esp32/boards/GENERIC_OTA/mpconfigboard.h          v1.19.1  \n",
+       "2        ports/esp32/boards/GENERIC_OTA/mpconfigboard.h            v1.19  \n",
+       "3        ports/esp32/boards/GENERIC_OTA/mpconfigboard.h            v1.18  \n",
+       "4        ports/esp32/boards/GENERIC_OTA/mpconfigboard.h            v1.17  \n",
+       "...                                                 ...              ...  \n",
+       "2207  ports/nrf/boards/SEEED_XIAO_NRF52/mpconfigboard.h          v1.22.1  \n",
+       "2208  ports/nrf/boards/SEEED_XIAO_NRF52/mpconfigboard.h  v1.22.0-preview  \n",
+       "2209  ports/nrf/boards/SEEED_XIAO_NRF52/mpconfigboard.h          v1.22.0  \n",
+       "2210  ports/nrf/boards/SEEED_XIAO_NRF52/mpconfigboard.h          v1.21.0  \n",
+       "2211  ports/nrf/boards/seeed_xiao_nrf52/mpconfigboard.h          v1.20.0  \n",
+       "\n",
+       "[2212 rows x 7 columns]"
+      ]
+     },
+     "execution_count": 1,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "import pandas as pd\n",
+    "\n",
+    "# Specify the file path\n",
+    "file_path = \"src/mpflash/mpflash/mpboard_id/board_info.json\"\n",
+    "\n",
+    "# Load the JSON file into a dataframe\n",
+    "df = pd.read_json(file_path)\n",
+    "\n",
+    "# Display the dataframe\n",
+    "df\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 12,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/html": [
+       "<div>\n",
+       "<style scoped>\n",
+       "    .dataframe tbody tr th:only-of-type {\n",
+       "        vertical-align: middle;\n",
+       "    }\n",
+       "\n",
+       "    .dataframe tbody tr th {\n",
+       "        vertical-align: top;\n",
+       "    }\n",
+       "\n",
+       "    .dataframe thead th {\n",
+       "        text-align: right;\n",
+       "    }\n",
+       "</style>\n",
+       "<table border=\"1\" class=\"dataframe\">\n",
+       "  <thead>\n",
+       "    <tr style=\"text-align: right;\">\n",
+       "      <th></th>\n",
+       "      <th>description</th>\n",
+       "      <th>port</th>\n",
+       "      <th>board</th>\n",
+       "      <th>board_name</th>\n",
+       "      <th>mcu_name</th>\n",
+       "      <th>path</th>\n",
+       "      <th>version</th>\n",
+       "    </tr>\n",
+       "  </thead>\n",
+       "  <tbody>\n",
+       "    <tr>\n",
+       "      <th>354</th>\n",
+       "      <td>ESP32-D2WD</td>\n",
+       "      <td>esp32</td>\n",
+       "      <td>ESP32_GENERIC</td>\n",
+       "      <td>-</td>\n",
+       "      <td>-</td>\n",
+       "      <td>ports/esp32/boards/ESP32_GENERIC/mpconfigboard...</td>\n",
+       "      <td>v1.22.2</td>\n",
+       "    </tr>\n",
+       "    <tr>\n",
+       "      <th>364</th>\n",
+       "      <td>ESP32-UNICORE</td>\n",
+       "      <td>esp32</td>\n",
+       "      <td>ESP32_GENERIC</td>\n",
+       "      <td>-</td>\n",
+       "      <td>-</td>\n",
+       "      <td>ports/esp32/boards/ESP32_GENERIC/mpconfigboard...</td>\n",
+       "      <td>v1.22.2</td>\n",
+       "    </tr>\n",
+       "    <tr>\n",
+       "      <th>370</th>\n",
+       "      <td>ESP32C3 module with ESP32C3</td>\n",
+       "      <td>esp32</td>\n",
+       "      <td>ESP32_GENERIC_C3</td>\n",
+       "      <td>ESP32C3 module</td>\n",
+       "      <td>ESP32C3</td>\n",
+       "      <td>ports/esp32/boards/ESP32_GENERIC_C3/mpconfigbo...</td>\n",
+       "      <td>v1.22.2</td>\n",
+       "    </tr>\n",
+       "    <tr>\n",
+       "      <th>602</th>\n",
+       "      <td>Generic ESP32 module with ESP32</td>\n",
+       "      <td>esp32</td>\n",
+       "      <td>ESP32_GENERIC</td>\n",
+       "      <td>Generic ESP32 module</td>\n",
+       "      <td>ESP32</td>\n",
+       "      <td>ports/esp32/boards/ESP32_GENERIC/mpconfigboard.h</td>\n",
+       "      <td>v1.22.2</td>\n",
+       "    </tr>\n",
+       "    <tr>\n",
+       "      <th>608</th>\n",
+       "      <td>Generic ESP32 module with OTA</td>\n",
+       "      <td>esp32</td>\n",
+       "      <td>ESP32_GENERIC</td>\n",
+       "      <td>-</td>\n",
+       "      <td>-</td>\n",
+       "      <td>ports/esp32/boards/ESP32_GENERIC/mpconfigboard...</td>\n",
+       "      <td>v1.22.2</td>\n",
+       "    </tr>\n",
+       "    <tr>\n",
+       "      <th>614</th>\n",
+       "      <td>Generic ESP32 module with SPIRAM</td>\n",
+       "      <td>esp32</td>\n",
+       "      <td>ESP32_GENERIC</td>\n",
+       "      <td>-</td>\n",
+       "      <td>-</td>\n",
+       "      <td>ports/esp32/boards/ESP32_GENERIC/mpconfigboard...</td>\n",
+       "      <td>v1.22.2</td>\n",
+       "    </tr>\n",
+       "    <tr>\n",
+       "      <th>630</th>\n",
+       "      <td>Generic ESP32S2 module with ESP32S2</td>\n",
+       "      <td>esp32</td>\n",
+       "      <td>ESP32_GENERIC_S2</td>\n",
+       "      <td>Generic ESP32S2 module</td>\n",
+       "      <td>ESP32S2</td>\n",
+       "      <td>ports/esp32/boards/ESP32_GENERIC_S2/mpconfigbo...</td>\n",
+       "      <td>v1.22.2</td>\n",
+       "    </tr>\n",
+       "    <tr>\n",
+       "      <th>636</th>\n",
+       "      <td>Generic ESP32S3 module with ESP32S3</td>\n",
+       "      <td>esp32</td>\n",
+       "      <td>ESP32_GENERIC_S3</td>\n",
+       "      <td>Generic ESP32S3 module</td>\n",
+       "      <td>ESP32S3</td>\n",
+       "      <td>ports/esp32/boards/ESP32_GENERIC_S3/mpconfigbo...</td>\n",
+       "      <td>v1.22.2</td>\n",
+       "    </tr>\n",
+       "    <tr>\n",
+       "      <th>642</th>\n",
+       "      <td>Generic ESP32S3 module with Octal-SPIRAM</td>\n",
+       "      <td>esp32</td>\n",
+       "      <td>ESP32_GENERIC_S3</td>\n",
+       "      <td>-</td>\n",
+       "      <td>-</td>\n",
+       "      <td>ports/esp32/boards/ESP32_GENERIC_S3/mpconfigbo...</td>\n",
+       "      <td>v1.22.2</td>\n",
+       "    </tr>\n",
+       "  </tbody>\n",
+       "</table>\n",
+       "</div>"
+      ],
+      "text/plain": [
+       "                                  description   port             board  \\\n",
+       "354                                ESP32-D2WD  esp32     ESP32_GENERIC   \n",
+       "364                             ESP32-UNICORE  esp32     ESP32_GENERIC   \n",
+       "370               ESP32C3 module with ESP32C3  esp32  ESP32_GENERIC_C3   \n",
+       "602           Generic ESP32 module with ESP32  esp32     ESP32_GENERIC   \n",
+       "608             Generic ESP32 module with OTA  esp32     ESP32_GENERIC   \n",
+       "614          Generic ESP32 module with SPIRAM  esp32     ESP32_GENERIC   \n",
+       "630       Generic ESP32S2 module with ESP32S2  esp32  ESP32_GENERIC_S2   \n",
+       "636       Generic ESP32S3 module with ESP32S3  esp32  ESP32_GENERIC_S3   \n",
+       "642  Generic ESP32S3 module with Octal-SPIRAM  esp32  ESP32_GENERIC_S3   \n",
+       "\n",
+       "                 board_name mcu_name  \\\n",
+       "354                       -        -   \n",
+       "364                       -        -   \n",
+       "370          ESP32C3 module  ESP32C3   \n",
+       "602    Generic ESP32 module    ESP32   \n",
+       "608                       -        -   \n",
+       "614                       -        -   \n",
+       "630  Generic ESP32S2 module  ESP32S2   \n",
+       "636  Generic ESP32S3 module  ESP32S3   \n",
+       "642                       -        -   \n",
+       "\n",
+       "                                                  path  version  \n",
+       "354  ports/esp32/boards/ESP32_GENERIC/mpconfigboard...  v1.22.2  \n",
+       "364  ports/esp32/boards/ESP32_GENERIC/mpconfigboard...  v1.22.2  \n",
+       "370  ports/esp32/boards/ESP32_GENERIC_C3/mpconfigbo...  v1.22.2  \n",
+       "602   ports/esp32/boards/ESP32_GENERIC/mpconfigboard.h  v1.22.2  \n",
+       "608  ports/esp32/boards/ESP32_GENERIC/mpconfigboard...  v1.22.2  \n",
+       "614  ports/esp32/boards/ESP32_GENERIC/mpconfigboard...  v1.22.2  \n",
+       "630  ports/esp32/boards/ESP32_GENERIC_S2/mpconfigbo...  v1.22.2  \n",
+       "636  ports/esp32/boards/ESP32_GENERIC_S3/mpconfigbo...  v1.22.2  \n",
+       "642  ports/esp32/boards/ESP32_GENERIC_S3/mpconfigbo...  v1.22.2  "
+      ]
+     },
+     "execution_count": 12,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "generics = df[(df[\"board\"].str.contains(\"GENERIC\")) & (df[\"version\"] == \"v1.22.2\") & (df[\"port\"] == \"esp32\")]\n",
+    "\n",
+    "generics\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "language_info": {
+   "name": "python"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

mpflash/mpremoteboard/__init__.py

@@ -64,7 +64,7 @@ class MPRemoteBoard:
         return f"MPRemoteBoard({self.serialport}, {self.family} {self.port}, {self.board}, {self.version})"
 
     @staticmethod
-    def connected_boards(bluetooth: bool = False) -> List[str]:
+    def connected_boards(bluetooth: bool = False, description: bool = False) -> List[str]:
         # TODO: rename to connected_comports
         """
         Get a list of connected comports.
@@ -81,8 +81,19 @@ class MPRemoteBoard:
             # filter out bluetooth ports
             comports = [p for p in comports if "bluetooth" not in p.description.lower()]
             comports = [p for p in comports if "BTHENUM" not in p.hwid]
-
-        return sorted([p.device for p in comports])
+        if description:
+            output = [
+                f"{p.device} {(p.manufacturer + ' ') if p.manufacturer and not p.description.startswith(p.manufacturer) else ''}{p.description}"
+                for p in comports
+            ]
+        else:
+            output = [p.device for p in comports]
+
+        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)
+        # sort by device name
+        return sorted(output)
 
     @retry(stop=stop_after_attempt(RETRIES), wait=wait_fixed(1), reraise=True)  # type: ignore ## retry_error_cls=ConnectionError,
     def get_mcu_info(self, timeout: int = 2):

mpflash/uf2disk.py

@@ -0,0 +1,12 @@
+"""Info to support mounting and unmounting of UF2 drives on linux and macos"""
+
+
+class UF2Disk:
+    """Info to support mounting and unmounting of UF2 drives on linux"""
+
+    device_path: str
+    label: str
+    mountpoint: str
+
+    def __repr__(self):
+        return repr(self.__dict__)

{mpflash-0.7.5.dist-info → mpflash-0.7.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mpflash
-Version: 0.7.5
+Version: 0.7.7
 Summary: Flash and download tool for MicroPython firmwares
 Home-page: https://github.com/Josverl/micropython-stubber/blob/main/src/mpflash/README.md
 License: MIT
@@ -22,6 +22,7 @@ Requires-Dist: blkinfo (>=0.2.0,<0.3.0)
 Requires-Dist: esptool (>=4.7.0,<5.0.0)
 Requires-Dist: inquirer (>=3.2.4,<4.0.0)
 Requires-Dist: jsonlines (>=4.0.0,<5.0.0)
+Requires-Dist: jsons (>=1.6.3,<2.0.0)
 Requires-Dist: libusb (>=1.0.27,<2.0.0) ; sys_platform == "win32"
 Requires-Dist: loguru (>=0.7.2,<0.8.0)
 Requires-Dist: mpremote (>=1.22.0,<2.0.0)

{mpflash-0.7.5.dist-info → mpflash-0.7.7.dist-info}/RECORD

@@ -1,12 +1,12 @@
 mpflash/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mpflash/ask_input.py,sha256=vK0G6q-Spd-m34bdBQVzERFjDib6Wen9eJ-mPqImCr8,9010
-mpflash/cli_download.py,sha256=0mG2c5SJxe53m_hVbne_jzrq9gm0jAFnvAhiIEtA1GA,3642
-mpflash/cli_flash.py,sha256=9wUdD17VISJ4vkgYfCbG_loDkkWkG-HOUHzumZwMGGw,5845
-mpflash/cli_group.py,sha256=nL3H06PHm_XUDlMuRyjgmTYeLnkrLa9mKDdahYw-KRo,1967
+mpflash/ask_input.py,sha256=XxYbO2DwB59pyv1uec9fN7nDxQcHLPnp55LSU8eOMg8,9459
+mpflash/cli_download.py,sha256=YHoQOaY5Cg0-jKkEHNa9jvlTr9AfVw9xNm33eWahfdI,3623
+mpflash/cli_flash.py,sha256=yh8JH88LduSRW0gUvCpTUVmY6PaojciPZeEdHqtxq6M,6133
+mpflash/cli_group.py,sha256=g1lk8uEqisaIaWwJMxw_oOaB1twodrgGPmt6qcCEDDA,2424
 mpflash/cli_list.py,sha256=KIlEeqcIIBf0g-emS43fzKspUy6fn9TUuFl0u00XaK8,1024
-mpflash/cli_main.py,sha256=BgqkDeEV0LBdT_Xn_Ay3zQOVJ-73pWSA4ngRf9KxGpw,656
+mpflash/cli_main.py,sha256=GJzA4_WTiwAzQP0b2tCXwfyNId1TeBnrzU1GP5xZans,796
 mpflash/common.py,sha256=lucFGMLl03qz-5Ic2XVv4g5XVt6hloUU6N5v0tSaUYE,1049
-mpflash/config.py,sha256=G6TxliEGxoYXy1SHQYBKgywnKccz9QzD3mGq_Vv1frg,419
+mpflash/config.py,sha256=hBc1Hf4XQ0YIoeiPBbannnqDg0C7226Y7Vu8o4jUkBQ,495
 mpflash/download.py,sha256=HMYpLVIcy_FaZGHIuucsmJ4fceYhf5DFJgG8f7r-mcA,11120
 mpflash/downloaded.py,sha256=ADMJqZn7WVcU-Rm2X6RqA8ejtBNBYXcpwxVyT3v7r6s,3803
 mpflash/errors.py,sha256=Q5LR12Wo8iUCg5n_qq4GjdBdBflbvCOdKsRJ5InYRfI,96
@@ -15,9 +15,10 @@ mpflash/flash_esp.py,sha256=1_jtZnmJl_aGznJZR1X9N2sK7ys8s_3N21LWllRB-lI,2314
 mpflash/flash_stm32.py,sha256=d4BoQl3a9Tchnvn2ZTuq2MpYBB4MTaRukwtEncI95k0,823
 mpflash/flash_stm32_cube.py,sha256=w7aGWjReeWUKl0Q3ZjXH8BRqNO1Tk9AO7gtRNUg1c9Y,3970
 mpflash/flash_stm32_dfu.py,sha256=G70EZodWb-aRi507Jxbys-VEwbBGU1oZacow3_nq-d4,2972
-mpflash/flash_uf2.py,sha256=ps2gUXZ4bdsgMqQzveYLLoXOmSC-aCmIG9L_tJjQ7Sk,2115
+mpflash/flash_uf2.py,sha256=JiAHiXHL5QkvS-qNeehKJW9PaTQI9IsfsqrED7jwmAA,2441
 mpflash/flash_uf2_boardid.py,sha256=WZKucGu_hJ8ymb236uuZbiR6pD6AA_l4LA-7LwtQhq8,414
-mpflash/flash_uf2_linux.py,sha256=jMnoW-Mmj33RJFQkqQMs9iKmAAtH4QoD7gYGztkvhH8,4319
+mpflash/flash_uf2_linux.py,sha256=T4TaA7vqEXz3_RdAWrgQ2IBpWYPF4FW-I2eCiKoTqHI,4049
+mpflash/flash_uf2_macos.py,sha256=kX9uMZM6uLFWvRM7p8Qzqp-2MPBJTUFNgdPVwn81fLA,2740
 mpflash/flash_uf2_windows.py,sha256=94YoO2UIzfyJs4CPJ9sjG_WY26SX8aUPl9mf9R9W5xk,1093
 mpflash/list.py,sha256=IpDhYrr5dXWY88PiKkvhqt3ioNF9tlsakTZVD05YBfQ,4713
 mpflash/logger.py,sha256=dI_H_a7EOdQJyvoeRHQuYeZuTKYVUS3DUPTLhE9rkdM,1098
@@ -25,16 +26,18 @@ mpflash/mpboard_id/__init__.py,sha256=LT52MV3tIHgBu_bFdvae2csahzonsCwno2ardU5ivs
 mpflash/mpboard_id/board_id.py,sha256=vGPfxMVmQCBRlsZJAhsbhZStlDl21zLC0sqXcaBrSXc,2592
 mpflash/mpboard_id/board_info.csv,sha256=KPWDo-zHWfrPGQn9oInsDH-5IdCzhBCs6K_YAmqqSpQ,96983
 mpflash/mpboard_id/board_info.json,sha256=JtVyOMIO1O7vLKzJ0hyXQ4JSxXiQBJyay2hjdNLnZM0,674442
-mpflash/mpremoteboard/__init__.py,sha256=FAVt8eEqNzEvVCDsEMZEarusJR6Rs-Y_N5kR5gUIeCM,7110
+mpflash/mpboard_id/Untitled-1.ipynb,sha256=Zph4q5abgn4CbhMr_n-rQLXskqsbqpAKHApJdoklCCc,15759
+mpflash/mpremoteboard/__init__.py,sha256=fJ_N1F6R3CfP9F7pmocb5l8yRvzmSmtHi4u_uTQHR1w,7683
 mpflash/mpremoteboard/mpy_fw_info.py,sha256=6AQbN3jtQgllqWQYl4e-63KeEtV08EXk8_JnM6XBkvo,4554
 mpflash/mpremoteboard/runner.py,sha256=-PgzAeBGbyXaAUlwyiw4mcINsP2U1XRRjP1_QdBrxpg,4786
+mpflash/uf2disk.py,sha256=4_P2l-kedM7VSliA2u706LQLxvu3xWSod1-lj-xjZis,298
 mpflash/vendor/dfu.py,sha256=oK_MRSOyDJrUuS6D24IMIsfL7oLcrvUq0yp_h4WIY2U,5739
 mpflash/vendor/pydfu.py,sha256=_MdBRo1EeNeKDqFPSTB5tNL1jGSBJgsVeVjE5e7Pb8s,20542
 mpflash/vendor/readme.md,sha256=iIIZxuLUIGHQ0KODzYVtMezsztvyxCXcNJp_AzwTIPk,86
 mpflash/vendor/versions.py,sha256=ooRZjeeYepQHwp12hMu2m0p8nZXQ5s942w5mGkKmgeI,3629
 mpflash/worklist.py,sha256=izHCPR39OYMXydXpLjtjsgaYlNAfrlQz0_joDPmhDJM,5297
-mpflash-0.7.5.dist-info/entry_points.txt,sha256=Jk_visOhYOsZIcSP2Ms9hKqfKy1iorR-6dYltSoWCpY,52
-mpflash-0.7.5.dist-info/LICENSE,sha256=mWpNhsIxWzetYNnTpr4eb3HtgsxGIC8KcYWxXEcxQvE,1077
-mpflash-0.7.5.dist-info/METADATA,sha256=vPNDK5oPA8PBmyrBnxn_gO6oFS1js4ks6qOCfOfWpIM,14633
-mpflash-0.7.5.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
-mpflash-0.7.5.dist-info/RECORD,,
+mpflash-0.7.7.dist-info/entry_points.txt,sha256=Jk_visOhYOsZIcSP2Ms9hKqfKy1iorR-6dYltSoWCpY,52
+mpflash-0.7.7.dist-info/LICENSE,sha256=mWpNhsIxWzetYNnTpr4eb3HtgsxGIC8KcYWxXEcxQvE,1077
+mpflash-0.7.7.dist-info/METADATA,sha256=p-95ad85tmmiUz9d3pK-rCifY1mIVV6BAks4YcgmuaE,14671
+mpflash-0.7.7.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
+mpflash-0.7.7.dist-info/RECORD,,