mpflash 0.9.1.post2__py3-none-any.whl → 1.0.1__py3-none-any.whl

mpflash/cli_download.py

@@ -58,7 +58,7 @@ from .download import download
     default=["*"],
     show_default=True,
     multiple=True,
-    help="Which serial port(s) to flash",
+    help="Which serial port(s) (or globs) to flash",
     metavar="SERIALPORT",
 )
 @click.option(

mpflash/cli_flash.py

@@ -4,22 +4,19 @@ from typing import List
 import rich_click as click
 from loguru import logger as log
 
-from mpflash.common import BootloaderMethod
+from mpflash.ask_input import ask_missing_params
+from mpflash.cli_download import connected_ports_boards
+from mpflash.cli_group import cli
+from mpflash.cli_list import show_mcus
+from mpflash.common import BootloaderMethod, FlashParams, Params
+from mpflash.config import config
 from mpflash.errors import MPFlashError
+from mpflash.flash import flash_list
+from mpflash.flash.worklist import WorkList, full_auto_worklist, manual_worklist, single_auto_worklist
 from mpflash.mpboard_id import find_known_board
 from mpflash.mpremoteboard import MPRemoteBoard
 from mpflash.versions import clean_version
 
-from .ask_input import ask_missing_params
-from .cli_download import connected_ports_boards
-from .cli_group import cli
-from .cli_list import show_mcus
-from .common import FlashParams
-from .config import config
-from .flash import flash_list
-from .flash.worklist import (WorkList, full_auto_worklist, manual_worklist,
-                       single_auto_worklist)
-
 # #########################################################################################################
 # CLI
 # #########################################################################################################
@@ -56,7 +53,7 @@ from .flash.worklist import (WorkList, full_auto_worklist, manual_worklist,
     default=["*"],
     multiple=True,
     show_default=True,
-    help="Which serial port(s) to flash",
+    help="Which serial port(s) (or globs) to flash",
     metavar="SERIALPORT",
 )
 @click.option(
@@ -122,7 +119,7 @@ def cli_flash_board(**kwargs) -> int:
     params = FlashParams(**kwargs)
     params.versions = list(params.versions)
     params.ports = list(params.ports)
-    params.boards = list(params.boards) 
+    params.boards = list(params.boards)
     params.serial = list(params.serial)
     params.ignore = list(params.ignore)
     params.bootloader = BootloaderMethod(params.bootloader)
@@ -203,7 +200,7 @@ def cli_flash_board(**kwargs) -> int:
         return 1
 
 
-def resolve_board_ids(params):
+def resolve_board_ids(params: Params):
     """Resolve board descriptions to board_id, and remove empty strings from list of boards"""
     for board_id in params.boards:
         if board_id == "":

mpflash/cli_list.py

@@ -32,14 +32,14 @@ from .logger import make_quiet
     default=["*"],
     multiple=True,
     show_default=True,
-    help="Which serial port(s) to list. ",
+    help="Serial port(s) (or globs) to list. ",
     metavar="SERIALPORT",
 )
 @click.option(
     "--ignore",
     "-i",
     is_eager=True,
-    help="Serial port(s) to ignore. Defaults to MPFLASH_IGNORE.",
+    help="Serial port(s) (or globs) to ignore. Defaults to MPFLASH_IGNORE.",
     multiple=True,
     default=[],
     envvar="MPFLASH_IGNORE",
@@ -73,7 +73,13 @@ def cli_list_mcus(serial: List[str], ignore: List[str], bluetooth: bool, as_json
     # TODO? Ask user to select a serialport if [?] is given ?
 
     conn_mcus = list_mcus(ignore=ignore, include=serial, bluetooth=bluetooth)
+    # ignore boards that have the [micropython-stubber] ignore flag set
+    conn_mcus = [item for item in conn_mcus if not (item.toml.get("mpflash", {}).get("ignore", False))]    
     if as_json:
+        # remove the path and firmware attibutes from the json output as they are always empty
+        for mcu in conn_mcus:
+            del mcu.path
+            del mcu.firmware
         print(json.dumps([mcu.__dict__ for mcu in conn_mcus], indent=4))
         progress = False
     if progress:

mpflash/common.py

@@ -29,7 +29,9 @@ PORT_FWTYPES = {
 # Token with no permissions to avoid throttling
 # https://docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api?apiVersion=2022-11-28#getting-a-higher-rate-limit
 PAT_NO_ACCESS = (
-    "github_pat" + "_11AAHPVFQ0qAkDnSUaMKSp" + "_ZkDl5NRRwBsUN6EYg9ahp1Dvj4FDDONnXVgimxC2EtpY7Q7BUKBoQ0Jq72X"
+    "github_pat"
+    + "_11AAHPVFQ0qAkDnSUaMKSp"
+    + "_ZkDl5NRRwBsUN6EYg9ahp1Dvj4FDDONnXVgimxC2EtpY7Q7BUKBoQ0Jq72X"
 )
 PAT = os.environ.get("GITHUB_TOKEN") or PAT_NO_ACCESS
 GH_CLIENT = Github(auth=Auth.Token(PAT))
@@ -99,7 +101,6 @@ class BootloaderMethod(Enum):
     NONE = "none"
 
 
-
 @dataclass
 class FlashParams(Params):
     """Parameters for flashing a board"""
@@ -122,7 +123,8 @@ def filtered_comports(
     bluetooth: bool = False,
 ) -> List[ListPortInfo]:  # sourcery skip: assign-if-exp
     """
-    Get a list of filtered comports.
+    Get a list of filtered comports using the include and ignore lists.
+    both can be globs (e.g. COM*) or exact port names (e.g. COM1)
     """
     if not ignore:
         ignore = []
@@ -135,13 +137,20 @@ def filtered_comports(
 
     # remove ports that are to be ignored
     log.trace(f"{include=}, {ignore=}, {bluetooth=}")
-    comports = [p for p in list_ports.comports() if not any(fnmatch.fnmatch(p.device, i) for i in ignore)]
+    # use p.location to filter out the bogus ports on newer Linux kernels
+    comports = [
+        p
+        for p in list_ports.comports()
+        if p.location and not any(fnmatch.fnmatch(p.device, i) for i in ignore)
+    ]
     log.trace(f"comports: {[p.device for p in comports]}")
     # remove bluetooth ports
 
     if include != ["*"]:
         # if there are explicit ports to include, add them to the list
-        explicit = [p for p in list_ports.comports() if any(fnmatch.fnmatch(p.device, i) for i in include)]
+        explicit = [
+            p for p in list_ports.comports() if any(fnmatch.fnmatch(p.device, i) for i in include)
+        ]
         log.trace(f"explicit: {[p.device for p in explicit]}")
         if ignore == []:
             # if nothing to ignore, just use the explicit list as a sinple sane default
@@ -160,6 +169,9 @@ def filtered_comports(
     # sort
     if sys.platform == "win32":
         # Windows sort of comports by number - but fallback to device name
-        return sorted(comports, key=lambda x: int(x.device.split()[0][3:]) if x.device.split()[0][3:].isdigit() else x)
+        return sorted(
+            comports,
+            key=lambda x: int(x.device.split()[0][3:]) if x.device.split()[0][3:].isdigit() else x,
+        )
     # sort by device name
     return sorted(comports, key=lambda x: x.device)

mpflash/connected.py

@@ -4,10 +4,9 @@ from rich import print
 from rich.progress import BarColumn, Progress, SpinnerColumn, TextColumn, TimeElapsedColumn
 from rich.table import Column
 
+from mpflash.common import filtered_comports
 from mpflash.mpremoteboard import MPRemoteBoard
 
-from .common import filtered_comports
-
 
 def connected_ports_boards(*, include: List[str], ignore: List[str]) -> Tuple[List[str], List[str], List[MPRemoteBoard]]:
     """
@@ -32,7 +31,7 @@ rp_text = TextColumn("{task.description} {task.fields[device]}", table_column=Co
 rp_bar = BarColumn(bar_width=None, table_column=Column())
 
 
-def list_mcus(*, ignore: List[str], include: List[str], bluetooth: bool = False):
+def list_mcus(*, ignore: List[str], include: List[str], bluetooth: bool = False) -> List[MPRemoteBoard]:
     """
     Retrieves information about connected microcontroller boards.
 

mpflash/list.py

@@ -38,11 +38,25 @@ def mcu_table(
     - Serial    Yes         Yes
     - Family    abbrv.      Yes
     - Port      -           yes
-    - Board     Yes         Yes     BOARD_ID and Description
+    - Board     Yes         Yes     BOARD_ID and Description, and the description from board_info.toml
     - CPU       -           Yes
     - Version   Yes         Yes
     - Build     *           *       only if any of the mcus have a build
+    - Location  -           -       only if --usb is given
     """
+    # refresh if requested
+    if refresh:
+        for mcu in track(
+            conn_mcus,
+            description="Updating board info",
+            transient=True,
+            show_speed=False,
+            refresh_per_second=1,
+        ):
+            try:
+                mcu.get_mcu_info()
+            except ConnectionError:
+                continue
     table = Table(
         title=title,
         title_style="magenta",
@@ -50,6 +64,7 @@ def mcu_table(
         collapse_padding=True,
         padding=(0, 0),
     )
+    # Build the table
     # check if the terminal is wide enough to show all columns or if we need to collapse some
     is_wide = console.width > 99
     needs_build = any(mcu.build for mcu in conn_mcus)
@@ -67,19 +82,11 @@ def mcu_table(
         table.add_column("Build" if is_wide else "Bld", justify="right")
     if config.usb:
         table.add_column("Location", overflow="fold", max_width=40)
-    for mcu in track(
-        conn_mcus,
-        description="Updating board info",
-        transient=True,
-        show_speed=False,
-        refresh_per_second=1,
-    ):
-        if refresh:
-            try:
-                mcu.get_mcu_info()
-            except ConnectionError:
-                continue
+    # fill the table with the data
+    for mcu in conn_mcus:
         description = f"[italic bright_cyan]{mcu.description}" if mcu.description else ""
+        if "description" in mcu.toml:
+            description += f"\n[italic bright_green]{mcu.toml['description']}"
         row = [
             mcu.serialport.replace("/dev/", ""),
             abbrv_family(mcu.family, is_wide),

mpflash/mpremoteboard/__init__.py

@@ -8,16 +8,20 @@ from pathlib import Path
 from typing import List, Optional, Union
 
 import serial.tools.list_ports
-from loguru import logger as log
 from rich.progress import track
 from tenacity import retry, stop_after_attempt, wait_fixed
 
 from mpflash.errors import MPFlashError
+from mpflash.logger import log
 from mpflash.mpboard_id.board_id import find_board_id_by_description
 from mpflash.mpremoteboard.runner import run
 
+if sys.version_info >= (3, 11):
+    import tomllib  # type: ignore
+else:
+    import tomli as tomllib  # type: ignore
+
 ###############################################################################################
-# TODO : make this a bit nicer
 HERE = Path(__file__).parent
 
 OK = 0
@@ -52,6 +56,7 @@ class MPRemoteBoard:
         self.mpy = ""
         self.build = ""
         self.location = location
+        self.toml = {}
         if update:
             self.get_mcu_info()
 
@@ -111,13 +116,14 @@ class MPRemoteBoard:
             ["run", str(HERE / "mpy_fw_info.py")],
             no_info=True,
             timeout=timeout,
+            resume=True,  # Avoid restarts
         )
         if rc != OK:
             raise ConnectionError(f"Failed to get mcu_info for {self.serialport}")
         # Ok we have the info, now parse it
-        s = result[0].strip()
-        if s.startswith("{") and s.endswith("}"):
-            info = eval(s)
+        raw_info = result[0].strip()
+        if raw_info.startswith("{") and raw_info.endswith("}"):
+            info = eval(raw_info)
             self.family = info["family"]
             self.version = info["version"]
             self.build = info["build"]
@@ -132,6 +138,43 @@ class MPRemoteBoard:
                 self.board = board_name
             else:
                 self.board = "UNKNOWN_BOARD"
+            # get the board_info.toml
+            self.get_board_info_toml()
+        # now we know the board is connected
+        self.connected = True
+
+    @retry(stop=stop_after_attempt(RETRIES), wait=wait_fixed(0.2), reraise=True)  # type: ignore ## retry_error_cls=ConnectionError,
+    def get_board_info_toml(self, timeout: int = 1):
+        """
+        Reads the content of the board_info.toml file from the connected board,
+        and adds that to the board object.
+
+        Parameters:
+        - timeout (int): The timeout value in seconds.
+
+        Raises:
+        - ConnectionError: If failed to communicate with the serial port.
+        """
+        try:
+            rc, result = self.run_command(
+                ["cat", ":board_info.toml"],
+                no_info=True,
+                timeout=timeout,
+                log_errors=False,
+            )
+        except Exception as e:
+            raise ConnectionError(f"Failed to get board_info.toml for {self.serialport}: {e}")
+        # this is optional - so only parse if we got the file
+        self.toml = {}
+        if rc in [OK]:  # sometimes we get an -9 ???
+            try:
+                # Ok we have the info, now parse it
+                self.toml = tomllib.loads("".join(result))
+                log.debug(f"board_info.toml: {self.toml}")
+            except Exception as e:
+                log.error(f"Failed to parse board_info.toml: {e}")
+        else:
+            log.trace(f"Failed to read board_info.toml: {result}")
 
     def disconnect(self) -> bool:
         """
@@ -159,6 +202,7 @@ class MPRemoteBoard:
         log_errors: bool = True,
         no_info: bool = False,
         timeout: int = 60,
+        resume: bool = False,
         **kwargs,
     ):
         """
@@ -179,7 +223,7 @@ class MPRemoteBoard:
         if self.serialport:
             prefix += ["connect", self.serialport]
         # if connected add resume to keep state between commands
-        if self.connected:
+        if self.connected or resume:
             prefix += ["resume"]
         cmd = prefix + cmd
         log.debug(" ".join(cmd))

{mpflash-0.9.1.post2.dist-info → mpflash-1.0.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mpflash
-Version: 0.9.1.post2
+Version: 1.0.1
 Summary: Flash and download tool for MicroPython firmwares
 Home-page: https://github.com/Josverl/micropython-stubber/blob/main/src/mpflash/README.md
 License: MIT
@@ -78,6 +78,32 @@ You can use mpflash to perform various operations on your MicroPython boards. He
 | `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
+
+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
+
+```
+--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.                                                                                                                                                          │
+--bluetooth/--no-bluetooth  -b/-nb              Include bluetooth ports in the list [default: no-bluetooth] 
+```
+
+## Distinguishing similar boards 
+The `mpflash list` command will list all connected boards, but sometimes you have multiple boards of the same type connected.
+To help you identify the boards, you can add a board_info.toml file to the top/default folder for the board.
+This file can contain a description of the board, which will be shown in the list and json output.
+```toml
+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:
+```toml
+[mpflash]
+ignore = true
+```
+
 
 ## Linux permissions to access usb devices 
 In order to flash the firmware to the board, you need to have the correct permissions to access the USB devices.

{mpflash-0.9.1.post2.dist-info → mpflash-1.0.1.dist-info}/RECORD

@@ -8,14 +8,14 @@ mpflash/bootloader/detect.py,sha256=eXL_JPcowb8g0tpZmj9DQXYbpfZFoSrzq86lScKhkT4,
 mpflash/bootloader/manual.py,sha256=qGInguhYil4v8EkUxPFlxzvs3m__KraPAj3LAKbV1Ts,3069
 mpflash/bootloader/micropython.py,sha256=0KDrfdZPtK7fLaxh-_4VxSO-u4IUj7qCyNVw9-LQ74M,517
 mpflash/bootloader/touch1200.py,sha256=tL2H4ERh0-YSdR8_v6aK_pDRPMjMevHWUGq4-TTFcWo,1083
-mpflash/cli_download.py,sha256=Ip5HViXCVAiG88XgJ3Lg_hhBGIF5DKFTNpL-_gQkdV0,3520
-mpflash/cli_flash.py,sha256=KFuJRNgOZ62m70I_KqxqLfLE69b4bOCj69MOfIWdZRo,7136
+mpflash/cli_download.py,sha256=_9JGBZ0zXtHe3W61rZmsrKRLQQaF58yLsnHYarejyuM,3531
+mpflash/cli_flash.py,sha256=U64IAqwTVeYubXTUO6UXY9SiS_e5NsQwyPYxf1juX8s,7166
 mpflash/cli_group.py,sha256=JFBtp4qhakJeQkuupEoObHeSFke8eWIU1HjnOZ-JfH0,2504
-mpflash/cli_list.py,sha256=AvYq5_Z7l0Z4rkbr23TwFNzstuZsQgopFpdcrTLwUvs,1965
+mpflash/cli_list.py,sha256=51iLSehG9vWOvgeovJ8UYBjKkdnZStG1gAgYa0Cheog,2340
 mpflash/cli_main.py,sha256=cElgh8Soq3U5TEAvrrD1sj7NDi-Eb-pei3QcMI0tlwE,1094
-mpflash/common.py,sha256=h4pVuOpopn5oIy5NQdbggtOOktTL_c92cS_oUfPG4v8,5783
+mpflash/common.py,sha256=P5Pt_Cjr6e5P8J5SB7Uhy6H-ARZSRTL2pApZ1rJOX_M,6067
 mpflash/config.py,sha256=h2Oq7kSe40tOnglpo02wkpaPHxHNVqyB3uGxreIu57U,1029
-mpflash/connected.py,sha256=p6RMix-tFr0pfT9TErh0LD1nm24ApTr3CqVGcrnDHk8,3024
+mpflash/connected.py,sha256=LtyNWloEtEOKvmnTCSSNOADT0KeVbtjHpDQwu4dot2o,3053
 mpflash/download.py,sha256=mckR3pdMFQMYBKNmKBEJm9bJnTtQEnkuQ1vWYXcRRv8,13941
 mpflash/downloaded.py,sha256=YPN0LDf8DSDvdB9gbVny61bvaJHIDbUs81XUwftTb1c,4808
 mpflash/errors.py,sha256=6lUhVtECY3syV2bBGKzegGH4pPKXhevvhYQZd74sy6o,238
@@ -30,7 +30,7 @@ mpflash/flash/uf2/macos.py,sha256=sncXJsc2FVfm9rvLDjcEu7ZIyrDeHmazHiNQTUaf1Y0,11
 mpflash/flash/uf2/uf2disk.py,sha256=dQ8_U6e3qkFOyfXZDpWAsvEBIlMr-ZzLkzTDD8SADqM,286
 mpflash/flash/uf2/windows.py,sha256=k9Yv71YswPnLx-Z5rf4KjhtVkEWr8SU8EXpeRv87h3A,1290
 mpflash/flash/worklist.py,sha256=1uBvn-T35Oey04g6xxNxo5t68q5_tp18eZcRAamF0tY,5828
-mpflash/list.py,sha256=O0tX4BvclmDMnnjMxCN9Zh8hdL6vnuvS9pLNxYLBya8,3112
+mpflash/list.py,sha256=Qt_3AUgA6LqejfGETgaa49fzqlI-m_OvsPosr6xMBMY,3464
 mpflash/logger.py,sha256=BAVrSXMGZLfSDRFbtVBtvb7Rl0sTJxooCgBS5t-6bXo,1057
 mpflash/mpboard_id/__init__.py,sha256=rQrPCN30GP-lfB2a2deA-lQ6iKvaKPK_xbtBoIavGsM,3716
 mpflash/mpboard_id/add_boards.py,sha256=ehQn560S0XxAD3nsUMo4o_f6w8XTVAfO0GCnfTKa6-4,9379
@@ -38,7 +38,7 @@ mpflash/mpboard_id/board.py,sha256=yQ8IDHQS09AelvTvmPhpmsL4oX3L7IXGqHorkxDOkoE,1
 mpflash/mpboard_id/board_id.py,sha256=wzGrxJu_ciOVT7n2861lhoKmPAjh1QjWnAdfcqNUUqc,2871
 mpflash/mpboard_id/board_info.zip,sha256=F6YowS96DAqjten4ySe4MXgZwPtE-saZOUfY5OQkqKk,19759
 mpflash/mpboard_id/store.py,sha256=lQQgHSxcaM_ZURcfZNSUv3-ZJjUKMC_xEOOSdpzVvBU,1493
-mpflash/mpremoteboard/__init__.py,sha256=7uI-5HJgNsQz_EOCW3cRy2xtqXKt9kX51gDSx6HC0Kc,7522
+mpflash/mpremoteboard/__init__.py,sha256=oB0HwQOBhTtI4KR46_FvXZ_I6V5xuuxQ3MPeR6lVGVk,9240
 mpflash/mpremoteboard/mpy_fw_info.py,sha256=BTupe4rZDTs3UHRqvs429XqWHCchSpwa05yACOiOt5U,4413
 mpflash/mpremoteboard/runner.py,sha256=YUmo5Y0aOgMaww8CXSdNdgXD-wRKncILuMZ0OB_2qRU,4646
 mpflash/vendor/click_aliases.py,sha256=K98inhtze8td1dw312kexJS7OX_0ojlptPQ5Z0SHxJY,3065
@@ -46,8 +46,8 @@ mpflash/vendor/dfu.py,sha256=jGsiD3lbSV1Ar9qJubhoY_hy-L8FI-K55aow8vgwoYQ,5590
 mpflash/vendor/pydfu.py,sha256=1ObubGsPFrQ7T9M3JRlIPNIG2xx8uYffaEe0Y6bdf_g,19937
 mpflash/vendor/readme.md,sha256=ZVg7kuUYyXcWcrWkaSJ0CunwebCqu2SiS2sqDadwrT8,84
 mpflash/versions.py,sha256=x5VrdVfWhZJfH7tZmwu2vVx-mPrK1iunYSpSce9VUXU,4492
-mpflash-0.9.1.post2.dist-info/LICENSE,sha256=xHwgxGNkI0R2iN4KNfbPbQSzRomWyRz7bJnR1O2mln8,1057
-mpflash-0.9.1.post2.dist-info/METADATA,sha256=SFrk166YQmHI5NcNGZYbOmSx9O2D1r9zvG-DxKs26EM,16064
-mpflash-0.9.1.post2.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-mpflash-0.9.1.post2.dist-info/entry_points.txt,sha256=Jk_visOhYOsZIcSP2Ms9hKqfKy1iorR-6dYltSoWCpY,52
-mpflash-0.9.1.post2.dist-info/RECORD,,
+mpflash-1.0.1.dist-info/LICENSE,sha256=xHwgxGNkI0R2iN4KNfbPbQSzRomWyRz7bJnR1O2mln8,1057
+mpflash-1.0.1.dist-info/METADATA,sha256=b5hg5kCyvR3IBzo03N7SiqzesIDbTMkV9QiIjbLbZVE,17649
+mpflash-1.0.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+mpflash-1.0.1.dist-info/entry_points.txt,sha256=Jk_visOhYOsZIcSP2Ms9hKqfKy1iorR-6dYltSoWCpY,52
+mpflash-1.0.1.dist-info/RECORD,,