mpflash 0.8.3__py3-none-any.whl → 0.8.5__py3-none-any.whl

mpflash/ask_input.py

@@ -11,7 +11,8 @@ from loguru import logger as log
 
 from .common import DownloadParams, FlashParams, ParamType
 from .config import config
-from .mpboard_id import get_known_boards_for_port, get_known_ports, known_stored_boards
+from .mpboard_id import (get_known_boards_for_port, get_known_ports,
+                         known_stored_boards)
 from .mpremoteboard import MPRemoteBoard
 from .vendor.versions import micropython_versions
 
@@ -28,6 +29,11 @@ def ask_missing_params(
     Returns:
         ParamType: The updated parameters.
     """
+    if not config.interactive:
+        # no interactivity allowed
+        log.info("Interactive mode disabled. Skipping ask for user input.")
+        return params
+
     import inquirer
 
     log.trace(f"ask_missing_params: {params}")
@@ -36,9 +42,6 @@ def ask_missing_params(
     # 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
 
     questions = []
     answers: dict[str, Union[str, List]] = {"action": action}
@@ -67,8 +70,14 @@ def ask_missing_params(
             answers["serial"] = [answers["serial"]]
         params.serial = [s.split()[0] for s in answers["serial"]]  # 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 = [p for p in params.ports if p != "?"]  # remove the "?" if present
+        if isinstance(answers["port"], str):
+            params.ports.append(answers["port"])
+        elif isinstance(answers["port"], list): # type: ignore
+            params.ports.extend(answers["port"])
+        else:
+            raise ValueError(f"Unexpected type for answers['port']: {type(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"]])
@@ -152,10 +161,18 @@ def ask_port_board(*, multi_select: bool, action: str):
                 "Which {port} board firmware do you want to {action} " + "to {serial} ?" if action == "flash" else "?"
             ),
             choices=filter_matching_boards,
-            validate=lambda _, x: True if x else "Please select at least one board",  # type: ignore
+            validate=at_least_one_validation,  # type: ignore
+            # validate=lambda _, x: True if x else "Please select at least one board",  # type: ignore
         ),
     ]
 
+def at_least_one_validation(answers, current) -> bool:
+    import inquirer.errors
+    if not current:
+        raise inquirer.errors.ValidationError("", reason="Please select at least one item.")
+    if isinstance(current, list) and not any(current):
+        raise inquirer.errors.ValidationError("", reason="Please select at least one item.")
+    return True
 
 def ask_mp_version(multi_select: bool, action: str):
     """
@@ -181,13 +198,6 @@ def ask_mp_version(multi_select: bool, action: str):
     # todo: this may be a little slow
     mp_versions = [v for v in mp_versions if "preview" in v or get_known_boards_for_port("stm32", [v])]
 
-    def at_least_one_validation(answers, current) -> bool:
-        if not current:
-            raise inquirer.errors.ValidationError("", reason="Please select at least one version")
-        if isinstance(current, list) and not any(current):
-            raise inquirer.errors.ValidationError("", reason="Please select at least one version")
-        return True
-
     message = "Which version(s) do you want to {action} " + ("to {serial} ?" if action == "flash" else "?")
     q = input_ux(
         # inquirer.List(

mpflash/bootloader/__init__.py

@@ -0,0 +1,36 @@
+import time
+
+from mpflash.common import BootloaderMethod
+from mpflash.errors import MPFlashError
+from mpflash.logger import log
+from mpflash.mpremoteboard import MPRemoteBoard
+
+from .manual import enter_bootloader_manual
+from .micropython import enter_bootloader_mpy
+from .touch1200 import enter_bootloader_cdc_1200bps
+
+
+def enter_bootloader(
+    mcu: MPRemoteBoard,
+    method: BootloaderMethod = BootloaderMethod.MPY,
+    timeout: int = 10,
+    wait_after: int = 2,
+):
+    """Enter the bootloader mode for the board"""
+    if method == BootloaderMethod.NONE:
+        # NO bootloader requested, so must be OK to flash
+        return True
+
+    log.info(f"Entering bootloader on {mcu.board} on {mcu.serialport} using method: {method.value}")
+    if method == BootloaderMethod.MPY:
+        result = enter_bootloader_mpy(mcu, timeout=timeout)
+    elif method == BootloaderMethod.MANUAL:
+        result = enter_bootloader_manual(mcu, timeout=timeout)
+    elif method == BootloaderMethod.TOUCH_1200:
+        result = enter_bootloader_cdc_1200bps(mcu, timeout=timeout)
+    else:
+        raise MPFlashError(f"Unknown bootloader method {method}")
+    if result:
+        time.sleep(wait_after)
+        log.error(f"Failed to enter bootloader on {mcu.serialport}")
+    return result

mpflash/bootloader/manual.py

@@ -0,0 +1,102 @@
+"""Manual bootloader mode entry for various MCUs."""
+
+from click.exceptions import Abort
+from rich.console import Console
+from rich.highlighter import RegexHighlighter
+from rich.panel import Panel
+from rich.prompt import Confirm
+from rich.theme import Theme
+
+# from mpflash.logger import console, log
+from mpflash.mpremoteboard import MPRemoteBoard
+
+
+class MCUHighlighter(RegexHighlighter):
+    """Apply style to anything that looks like an email."""
+
+    base_style = "mcu."
+    highlights = [
+        r"(?P<bold>Method[\s\d\:]*)",
+        r"(?P<bold> \d.)",  # numbered items
+        r"(?P<bold> - )",  # bullets
+        r"(?P<pad>GPIO[\d]*)",
+        r"(?P<pad>GPI[\d]*)",
+        r"(?P<pad>IO[\d]*)",
+        r"(?P<pad>RUN)",
+        r"(?P<pad>GND)",
+        r"(?P<pad>VCC)",
+        r"(?P<pad>3.3V)",
+        r"(?P<pad>5V)",
+        # buttons
+        r"(?P<button>BOOTSEL)",
+        r"(?P<button>RESET)",
+        r"(?P<button>reset)",
+        # other
+        r"(?P<cable>USB)",
+        # r"(?P<mcu>SAMD[\d]*)",
+        # r"(?P<mcu>ESP[\d]*)",
+        # r"(?P<mcu>rp2)",
+        # r"(?P<mcu>rp2040)",
+    ]
+
+
+# https://rich.readthedocs.io/en/stable/appendix/colors.html?highlight=colors#standard-colors
+mcu_theme = Theme(
+    {
+        "mcu.bold": "orange3",
+        "mcu.mcu": "orange3",
+        "mcu.button": "bold green",
+        "mcu.pad": "dodger_blue2",
+        "mcu.cable": "dodger_blue2",
+    }
+)
+
+
+def enter_bootloader_manual(mcu: MPRemoteBoard, timeout: int = 10):
+
+    message: str
+    if mcu.port == "rp2":
+        message = f"""\
+Please put your {" ".join([mcu.port,mcu.board])} device into bootloader mode by either:
+Method 1:
+  1. Unplug the USB cable, 
+  2. Press and hold the BOOTSEL button on the device, 
+  3. Plug the USB cable back in.
+  4. Release the BOOTSEL button.
+    
+Method 2:
+  1. Press and hold the BOOTSEL button on the device, 
+  2. Reset the device by either: 
+    - pressing the RESET button on the device 
+    - by power-cycling the device,
+    - by briefly connecting the RUN pin to GND
+  3. Release the BOOTSEL button.
+"""
+    elif mcu.port == "samd":
+        message = f"""\
+Please put your {mcu.port.upper()} device into bootloader mode by:
+  - Pressing or sliding the RESET button twice in fast succession
+"""
+    else:
+        message = f"""\
+Please put your {mcu.port.upper()} device into bootloader mode by:
+  - Pressing the RESET button on the device
+"""
+
+    # todo: would be nice to re-use the console instance from logger
+    console = Console(highlighter=MCUHighlighter(), theme=mcu_theme)
+    message += "\nIf you are unsure how to enter bootloader mode, please refer to the device documentation."
+    console.print(
+        Panel(
+            message,
+            highlight=True,
+            title="Manual Bootloader",
+            title_align="left",
+            expand=False,
+        )
+    )
+    try:
+        answer = Confirm.ask("Press Enter to continue", default="y")
+    except Abort:
+        return False
+    return answer in ["y", "Y", True]

mpflash/bootloader/micropython.py

@@ -0,0 +1,10 @@
+"""Module for handling the bootloader mode for micropython boards"""
+
+from mpflash.mpremoteboard import MPRemoteBoard
+
+
+def enter_bootloader_mpy(mcu: MPRemoteBoard, timeout: int = 10):
+    """Enter the bootloader mode for the board using mpremote and micropython on the board"""
+    mcu.run_command("bootloader", timeout=timeout)
+    # todo: check if mpremote command was successful
+    return True

mpflash/bootloader/touch1200.py

@@ -0,0 +1,45 @@
+import sys
+import time
+
+import serial
+
+from mpflash.errors import MPFlashError
+from mpflash.logger import log
+from mpflash.mpremoteboard import MPRemoteBoard
+
+from .manual import enter_bootloader_manual
+
+
+def enter_bootloader_cdc_1200bps(mcu: MPRemoteBoard, timeout: int = 10):
+    if sys.platform == "win32":
+        log.warning("Touch 1200bps method is currently not supported on Windows, switching to manual")
+        return enter_bootloader_manual(mcu, timeout=timeout)
+
+    log.info(f"Entering bootloader on {mcu.board} on {mcu.serialport} using CDC 1200bps")
+    # if port argument is present perform soft reset
+    if not mcu.serialport:
+        raise MPFlashError("No serial port specified")
+    # try to initiate serial port connection on PORT with 1200 baudrate
+    try:
+        with serial.Serial(
+            port=mcu.serialport,
+            baudrate=1200,
+            parity=serial.PARITY_NONE,
+            stopbits=serial.STOPBITS_ONE,
+            bytesize=serial.EIGHTBITS,
+            rtscts=True,
+        ) as connection:
+            print("Connection established")
+            connection.rts = True
+            connection.dtr = False
+            time.sleep(0.4)
+
+    except serial.SerialException as e:
+        log.exception(e)
+        raise MPFlashError("pySerial error: " + str(e) + "\n") from e
+    except Exception as e:
+        log.exception(e)
+        raise MPFlashError("Error: " + str(e) + "\n") from e
+
+    # be optimistic
+    return True

mpflash/cli_download.py

@@ -80,6 +80,7 @@ from .download import download
 )
 @click.option(
     "--force",
+    "-f",
     default=False,
     is_flag=True,
     show_default=True,

mpflash/cli_flash.py

@@ -4,7 +4,7 @@ from typing import List
 import rich_click as click
 from loguru import logger as log
 
-# from mpflash.common import filtered_comports
+from mpflash.common import BootloaderMethod
 from mpflash.errors import MPFlashError
 from mpflash.mpboard_id import find_known_board
 from mpflash.mpremoteboard import MPRemoteBoard
@@ -17,7 +17,8 @@ from .cli_list import show_mcus
 from .common import FlashParams
 from .config import config
 from .flash import flash_list
-from .worklist import WorkList, full_auto_worklist, manual_worklist, single_auto_worklist
+from .worklist import (WorkList, full_auto_worklist, manual_worklist,
+                       single_auto_worklist)
 
 # #########################################################################################################
 # CLI
@@ -101,11 +102,13 @@ from .worklist import WorkList, full_auto_worklist, manual_worklist, single_auto
     help="""Erase flash before writing new firmware. (Not supported on UF2 boards)""",
 )
 @click.option(
-    "--bootloader/--no-bootloader",
-    default=True,
-    is_flag=True,
+    "--bootloader",
+    "-b",
+    "bootloader",
+    type=click.Choice([e.value for e in BootloaderMethod]),
+    default="mpy",
     show_default=True,
-    help="""Enter micropython bootloader mode before flashing.""",
+    help="""How to enter the (MicroPython) bootloader before flashing.""",
 )
 def cli_flash_board(**kwargs) -> int:
     # version to versions, board to boards
@@ -118,9 +121,11 @@ def cli_flash_board(**kwargs) -> int:
 
     params = FlashParams(**kwargs)
     params.versions = list(params.versions)
-    params.boards = list(params.boards)
+    params.ports = list(params.ports)
+    params.boards = list(params.boards) 
     params.serial = list(params.serial)
     params.ignore = list(params.ignore)
+    params.bootloader = BootloaderMethod(params.bootloader)
 
     # 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 == "*":
@@ -129,14 +134,16 @@ def cli_flash_board(**kwargs) -> int:
     # Detect connected boards if not specified,
     # and ask for input if boards cannot be detected
     all_boards: List[MPRemoteBoard] = []
-    if not params.boards or params.boards == []:
+    if not params.boards:
         # nothing specified - detect connected boards
         params.ports, params.boards, all_boards = connected_ports_boards(include=params.ports, ignore=params.ignore)
         if params.boards == []:
-            # No MicroPython boards detected, but it could be unflashed or not in bootloader mode
+            # No MicroPython boards detected, but it could be unflashed or in bootloader mode
             # Ask for serial port and board_id to flash
             params.serial = ["?"]
             params.boards = ["?"]
+            # assume manual mode if no board is detected
+            params.bootloader = BootloaderMethod("manual")
     else:
         resolve_board_ids(params)
 

mpflash/cli_group.py

@@ -5,6 +5,8 @@ Additional comands are added in the submodules.
 
 import rich_click as click
 
+from mpflash.vendor.click_aliases import ClickAliasedGroup
+
 from .config import __version__, config
 from .logger import log, make_quiet, set_loglevel
 
@@ -12,6 +14,7 @@ from .logger import log, make_quiet, set_loglevel
 def cb_verbose(ctx, param, value):
     """Callback to set the log level to DEBUG if verbose is set"""
     if value and not config.quiet:
+        # log.debug(f"Setting verbose mode to {value}")
         config.verbose = True
         if value > 1:
             set_loglevel("TRACE")
@@ -24,25 +27,28 @@ def cb_verbose(ctx, param, value):
     return value
 
 
-def cb_interactive(ctx, param, value):
-    if value:
-        config.interactive = value
+def cb_interactive(ctx, param, value:bool):
+    log.trace(f"Setting interactive mode to {value}")
+    config.interactive = value
     return value
 
 
 def cb_test(ctx, param, value):
     if value:
+        log.trace(f"Setting tests to {value}")
         config.tests = value
     return value
 
 
 def cb_quiet(ctx, param, value):
+    log.trace(f"Setting quiet mode to {value}")
     if value:
         make_quiet()
     return value
 
 
-@click.group()
+@click.group(cls=ClickAliasedGroup)
+# @click.group()
 @click.version_option(package_name="mpflash")
 @click.option(
     "--quiet",

mpflash/cli_list.py

@@ -5,12 +5,16 @@ import rich_click as click
 from rich import print
 
 from .cli_group import cli
+from .connected import list_mcus
 from .list import show_mcus
 from .logger import make_quiet
-from .connected import list_mcus
 
 
-@cli.command("list", help="List the connected MCU boards.")
+@cli.command(
+    "list",
+    help="List the connected MCU boards. alias: devs",
+    aliases=["devs"],
+)
 @click.option(
     "--json",
     "-j",

mpflash/cli_main.py

@@ -19,12 +19,12 @@ def mpflash():
     cli.add_command(cli_flash_board)
 
     # cli(auto_envvar_prefix="MPFLASH")
-    if False and os.environ.get("COMPUTERNAME") == "JOSVERL-S4":
+    if False and os.environ.get("COMPUTERNAME").startswith("JOSVERL"):
         # intentional less error suppression on dev machine
         result = cli(standalone_mode=False)
     else:
         try:
-            result = cli(standalone_mode=False)
+            result = cli(standalone_mode=True)
             exit(result)
         except AttributeError as e:
             log.error(f"Error: {e}")
@@ -32,6 +32,9 @@ def mpflash():
         except click.exceptions.ClickException as e:
             log.error(f"Error: {e}")
             exit(-2)
+        except click.exceptions.Abort as e:
+            # Aborted - Ctrl-C
+            exit(-3)
 
 
 if __name__ == "__main__":

mpflash/common.py

@@ -2,6 +2,7 @@ import fnmatch
 import os
 import sys
 from dataclasses import dataclass, field
+from enum import Enum
 from pathlib import Path
 from typing import List, Optional, Union
 
@@ -90,14 +91,26 @@ class DownloadParams(Params):
     force: bool = False
 
 
+class BootloaderMethod(Enum):
+    MANUAL = "manual"
+    MPY = "mpy"
+    TOUCH_1200 = "touch1200"
+    NONE = "none"
+
+
+
 @dataclass
 class FlashParams(Params):
     """Parameters for flashing a board"""
 
     erase: bool = True
-    bootloader: bool = True
+    bootloader: BootloaderMethod = BootloaderMethod.NONE
     cpu: str = ""
 
+    def __post_init__(self):
+        if isinstance(self.bootloader, str):
+            self.bootloader = BootloaderMethod(self.bootloader)
+
 
 ParamType = Union[DownloadParams, FlashParams]
 

mpflash/config.py

@@ -1,11 +1,14 @@
 """centralized configuration for mpflash"""
 
+import os
 from pathlib import Path
 from typing import List
 
 import pkg_resources
 import platformdirs
 
+from mpflash.logger import log
+
 
 def get_version():
     name = __package__ or "mpflash"
@@ -21,10 +24,23 @@ class MPtoolConfig:
     quiet: bool = False
     verbose: bool = False
     ignore_ports: List[str] = []
-    interactive: bool = True
     firmware_folder: Path = platformdirs.user_downloads_path() / "firmware"
     # test options specified on the commandline
     tests: List[str] = []
+    _interactive: bool = True
+
+    @property
+    def interactive(self):
+        # No interactions in CI
+        if os.getenv('GITHUB_ACTIONS') == 'true':
+            log.warning("Disabling interactive mode in CI")
+            return False
+        return self._interactive
+    
+    @interactive.setter
+    def interactive(self, value:bool):
+        self._interactive = value
+
 
 
 config = MPtoolConfig()

mpflash/download.py

@@ -19,7 +19,6 @@ 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.vendor.versions import clean_version
@@ -246,8 +245,8 @@ def download_firmwares(
                 continue
             writer.write(board.to_dict())
             downloaded += 1
-    if downloaded > 0:
-        clean_downloaded_firmwares(firmware_folder)
+    # if downloaded > 0:
+    #     clean_downloaded_firmwares(firmware_folder)
     log.success(f"Downloaded {downloaded} firmwares, skipped {skipped} existing files.")
     return downloaded + skipped
 

mpflash/downloaded.py

@@ -103,9 +103,9 @@ def filter_downloaded_fwlist(
         # never get a preview for an older version
         fw_list = [fw for fw in fw_list if fw.preview]
     else:
-        # FWInfo version has no v1.2.3 prefix
-        _version = {clean_version(version, drop_v=True), clean_version(version, drop_v=False)}
-        fw_list = [fw for fw in fw_list if fw.version in _version]
+        # older FWInfo version has no v1.2.3 prefix
+        either = [clean_version(version, drop_v=False), clean_version(version, drop_v=True)]
+        fw_list = [fw for fw in fw_list if fw.version in either]
     log.trace(f"Filtering firmware for {version} : {len(fw_list)} found.")
     # filter by port
     if port:

mpflash/errors.py

@@ -2,4 +2,8 @@
 
 
 class MPFlashError(Exception):
-    pass
+    """Base class for exceptions in this module."""
+
+    def __init__(self, message: str):
+        self.message = message
+        super().__init__(message)

mpflash/flash.py

@@ -1,10 +1,9 @@
-import time
 from pathlib import Path
 
 from loguru import logger as log
 
-from mpflash.common import PORT_FWTYPES
-from mpflash.mpremoteboard import MPRemoteBoard
+from mpflash.bootloader import enter_bootloader
+from mpflash.common import PORT_FWTYPES, BootloaderMethod
 
 from .flash_esp import flash_esp
 from .flash_stm32 import flash_stm32
@@ -14,13 +13,15 @@ from .worklist import WorkList
 # #########################################################################################################
 
 
+
 def flash_list(
     todo: WorkList,
     fw_folder: Path,
     erase: bool,
-    bootloader: bool,
+    bootloader: BootloaderMethod,
 ):
     """Flash a list of boards with the specified firmware."""
+    UF2_PORTS = [port for port, exts in PORT_FWTYPES.items() if ".uf2" in exts]
     flashed = []
     for mcu, fw_info in todo:
         fw_file = fw_folder / fw_info.filename
@@ -30,14 +31,13 @@ def flash_list(
         log.info(f"Updating {mcu.board} on {mcu.serialport} to {fw_info.version}")
         updated = None
         # try:
-        if mcu.port in [port for port, exts in PORT_FWTYPES.items() if ".uf2" in exts] and fw_file.suffix == ".uf2":
-            # any .uf2 port ["samd", "rp2", "nrf"]:
-            if bootloader:
-                enter_bootloader(mcu)
+        if mcu.port in UF2_PORTS and fw_file.suffix == ".uf2":
+            if not enter_bootloader(mcu, bootloader):
+                continue
             updated = flash_uf2(mcu, fw_file=fw_file, erase=erase)
         elif mcu.port in ["stm32"]:
-            if bootloader:
-                enter_bootloader(mcu)
+            if not enter_bootloader(mcu, bootloader):
+                continue
             updated = flash_stm32(mcu, fw_file, erase=erase)
         elif mcu.port in ["esp32", "esp8266"]:
             #  bootloader is handled by esptool for esp32/esp8266
@@ -50,20 +50,3 @@ def flash_list(
         else:
             log.error(f"Failed to flash {mcu.board} on {mcu.serialport}")
     return flashed
-
-
-def enter_bootloader(mcu: MPRemoteBoard, timeout: int = 10, wait_after: int = 2):
-    """Enter the bootloader mode for the board"""
-    log.info(f"Entering bootloader on {mcu.board} on {mcu.serialport}")
-    mcu.run_command("bootloader", timeout=timeout)
-    time.sleep(wait_after)
-
-
-# TODO:
-# flash from some sort of queue to allow different images to be flashed to the same board
-#  - flash variant 1
-#  - stub variant 1
-#  - flash variant 2
-#  - stub variant 2
-#
-# JIT download / download any missing firmwares based on the detected boards

mpflash/flash_uf2_macos.py

@@ -3,15 +3,12 @@
 # sourcery skip: snake-case-functions
 from __future__ import annotations
 
-import sys
 import time
 from pathlib import Path
 from typing import Optional
 
-from loguru import logger as log
 from rich.progress import track
 
-from .flash_uf2_boardid import get_board_id
 
 
 def wait_for_UF2_macos(s_max: int = 10) -> Optional[Path]:

mpflash/vendor/click_aliases.py

@@ -0,0 +1,91 @@
+# Copyright (c) 2016 Robbin Bonthond
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+# ------------------------------------------------------------------------------------
+# modified to avoid conflcts with rich_click
+
+# sourcery skip: assign-if-exp, use-named-expression
+
+import rich_click as click
+
+_click7 = click.__version__[0] >= "7"
+
+
+class ClickAliasedGroup(click.RichGroup):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self._commands = {}
+        self._aliases = {}
+
+    def add_command(self, *args, **kwargs):
+        aliases = kwargs.pop("aliases", [])
+        super().add_command(*args, **kwargs)
+        if aliases:
+            cmd = args[0]
+            name = args[1] if len(args) > 1 else None
+            name = name or cmd.name
+            if name is None:
+                raise TypeError("Command has no name.")
+
+            self._commands[name] = aliases
+            for alias in aliases:
+                self._aliases[alias] = cmd.name
+
+    def command(self, *args, **kwargs):
+        aliases = kwargs.pop("aliases", [])
+        decorator = super().command(*args, **kwargs)
+        if not aliases:
+            return decorator
+
+        def _decorator(f):
+            cmd = decorator(f)
+            if aliases:
+                self._commands[cmd.name] = aliases
+                for alias in aliases:
+                    self._aliases[alias] = cmd.name
+            return cmd
+
+        return _decorator
+
+    def group(self, *args, **kwargs):
+        aliases = kwargs.pop("aliases", [])
+        decorator = super().group(*args, **kwargs)
+        if not aliases:
+            return decorator
+
+        def _decorator(f):
+            cmd = decorator(f)
+            if aliases:
+                self._commands[cmd.name] = aliases
+                for alias in aliases:
+                    self._aliases[alias] = cmd.name
+            return cmd
+
+        return _decorator
+
+    def resolve_alias(self, cmd_name):
+        if cmd_name in self._aliases:
+            return self._aliases[cmd_name]
+        return cmd_name
+
+    def get_command(self, ctx, cmd_name):
+        cmd_name = self.resolve_alias(cmd_name)
+        command = super().get_command(ctx, cmd_name)
+        if command:
+            return command
+        return None
+
+    # def format_commands(self, ctx, formatter):
+    # TODO: output alias with commands - but that is a significant re-write
+    # for now add alias to help text
+
+
+# ------------------------------------------------------------------------------------

{mpflash-0.8.3.dist-info → mpflash-0.8.5.dist-info}/METADATA

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

{mpflash-0.8.3.dist-info → mpflash-0.8.5.dist-info}/RECORD

@@ -1,18 +1,22 @@
 mpflash/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mpflash/add_firmware.py,sha256=u_g9mID557fptLEJ1Nld9n27V1R1og8uEkadm0O3YTw,3435
-mpflash/ask_input.py,sha256=e54WfgktG7Ff8dBUknXioROq3lPNZ-eacUjfmUvFfS0,8496
-mpflash/cli_download.py,sha256=6ctC4ga6q2LcpHUHMrz1trbePziQpuIFPbjcJnc3K7E,3645
-mpflash/cli_flash.py,sha256=QHEb-e2ABjISfuGCWpTxOM7kkcTZSQxBXmVaWh3WVnE,7074
-mpflash/cli_group.py,sha256=nrihkm74X8pX1jPM72W8ljoc5rYL6ggGOQFRaOldhLo,2038
-mpflash/cli_list.py,sha256=Mdaf13gKZCoLp8Y2ja0L5rYMzkE_t3d4r62bF7isI3E,1997
-mpflash/cli_main.py,sha256=yABFFf45TpPMcC1qEVARAWe4EI9zui2pUXjoPms0mq8,1030
-mpflash/common.py,sha256=MmyLadb_z7bhVy6U8jb4f3pnBK8n7x28smFBcA9ZfGg,5608
-mpflash/config.py,sha256=R7PomStIFHSTnLhpWhw9P2DL_b-8a8Wrja3aY-dPm6A,762
+mpflash/ask_input.py,sha256=ipkRIMb_kl4j9o8f_LtpX8jL8dZnTeGiTvE87fA8LBw,8953
+mpflash/bootloader/__init__.py,sha256=-izynXMMvv-6PLFf3wjvDj_E4dCwdTrKqhrcYYfsGQc,1308
+mpflash/bootloader/manual.py,sha256=4FNQg0JpyRmfISrDDfZ5j9iQBK-Jyrnz8nLqKf1ZEuc,3104
+mpflash/bootloader/micropython.py,sha256=QQJlXUnyVA4cRS2O4GbrQhpKhFFvxtQC5G6WQcSCbp8,409
+mpflash/bootloader/touch1200.py,sha256=AJ4GPLtvCR5LDDe5Uu_5Rg8OI2JHxEB-blzCcO5x9Tc,1511
+mpflash/cli_download.py,sha256=zufBC0xNPZCq28mG_fepupziizbm86wTpfNEszkei9Q,3656
+mpflash/cli_flash.py,sha256=KOn1T9lThFs5pkhWZY_QCEdyB66xk6eJjS3n995hwPk,7354
+mpflash/cli_group.py,sha256=MsySUNipL8xkQAu4yuQPkFLoZNtQ5RPWtX3diHHrPdE,2334
+mpflash/cli_list.py,sha256=_3XzR8RyjlojbOqGKm_TLwcQojCb4OgCYi7mcjjoflI,2046
+mpflash/cli_main.py,sha256=MHhU1cAYEhwOpHG2p3OEfwpSrn9-J2foGVZqby_HO8k,1134
+mpflash/common.py,sha256=gkj71hGibMEcmThJ5LSrAV5vp6SpJAJNLHWO4GjB040,5929
+mpflash/config.py,sha256=VqaS6dT1UFigVmYRtVVBTi7cNQ6UKReaN4VUj3D5Ip4,1166
 mpflash/connected.py,sha256=CBG_DJ33OPWAPbX-ICQpL1LcFOhNYpLUSB0Q5v7gi9s,3029
-mpflash/download.py,sha256=NErA2SJEhXnTElvq6z4BJl-L-5M_ETJpqX6pM0oubsg,14290
-mpflash/downloaded.py,sha256=FQuVl21bx4JotfnXufoihexKeJt3gDMqhSWUvVKBSDk,4868
-mpflash/errors.py,sha256=Q5LR12Wo8iUCg5n_qq4GjdBdBflbvCOdKsRJ5InYRfI,96
-mpflash/flash.py,sha256=JoskuwaHVYqeG4YW8kgbv26vPFnqDmkTz1VRs-pTRiY,2468
+mpflash/download.py,sha256=VFV0XP8mTnBXOeo_JbyHBjIQJ0PUUiXu8hoO0lAxid8,14235
+mpflash/downloaded.py,sha256=cHq_fWUuZ0sXOCs5d3NIf3etUDsAXtnwnO7tkRqJE9A,4870
+mpflash/errors.py,sha256=IAidY3qkZsXy6Pm1rdmVFmGyg81ywHhse3itaPctA2w,247
+mpflash/flash.py,sha256=U17kp3ftG-noqhgA1HSYxK945sLhIR-Rh3xZgckT4H8,1927
 mpflash/flash_esp.py,sha256=dEc_B7-f1BMUGBMrwIm83ulcCqaS5MlrPAp3FCNgNfk,2311
 mpflash/flash_stm32.py,sha256=d4BoQl3a9Tchnvn2ZTuq2MpYBB4MTaRukwtEncI95k0,823
 mpflash/flash_stm32_cube.py,sha256=w7aGWjReeWUKl0Q3ZjXH8BRqNO1Tk9AO7gtRNUg1c9Y,3970
@@ -20,7 +24,7 @@ mpflash/flash_stm32_dfu.py,sha256=G70EZodWb-aRi507Jxbys-VEwbBGU1oZacow3_nq-d4,29
 mpflash/flash_uf2.py,sha256=2IKgEOnlsB9bILJWHILMKbGo9b39NKazBWp1-T_eKKs,2463
 mpflash/flash_uf2_boardid.py,sha256=U5wGM8VA3wEpUxQCMtuXpMZZomdVH8J_Zd5_GekUMuU,423
 mpflash/flash_uf2_linux.py,sha256=Oy9V4g7JSuks2hHFeO_OHdBKSGktbqZOtsivuxfl-xg,4055
-mpflash/flash_uf2_macos.py,sha256=HGUg2HSw4qalfSP7npLYgos2WlVRxtOVTDcAnBL7qPY,1078
+mpflash/flash_uf2_macos.py,sha256=fGz-LGoYKX772sqJb4pAvcMw-2Orlc83ecOIk0-1GYc,987
 mpflash/flash_uf2_windows.py,sha256=a-iIGPkwIoUXA7atCz0_uZp-kipSL24P-IE5ka1B1Mk,1025
 mpflash/list.py,sha256=0TawTkwhjKPPj7nTHoDn8nQ54WOkGRurP1BJVeg956g,2963
 mpflash/logger.py,sha256=dI_H_a7EOdQJyvoeRHQuYeZuTKYVUS3DUPTLhE9rkdM,1098
@@ -35,13 +39,14 @@ mpflash/mpremoteboard/mpy_fw_info.py,sha256=6AQbN3jtQgllqWQYl4e-63KeEtV08EXk8_Jn
 mpflash/mpremoteboard/runner.py,sha256=-PgzAeBGbyXaAUlwyiw4mcINsP2U1XRRjP1_QdBrxpg,4786
 mpflash/uf2disk.py,sha256=4_P2l-kedM7VSliA2u706LQLxvu3xWSod1-lj-xjZis,298
 mpflash/vendor/basicgit.py,sha256=sflgCv7apLbV2w8F6gmhc-3kuqDnnS4tdGol6JT2uTM,9545
+mpflash/vendor/click_aliases.py,sha256=c853EHSlkE2DvFqeFvFpwXKuJj3_jsXDP7iotVOKaAw,3156
 mpflash/vendor/dfu.py,sha256=ZXMcE6aH4-43Wh4tbQT4U-q-BU3RUiL3JAxmP_QAK2s,5755
 mpflash/vendor/pydfu.py,sha256=_MdBRo1EeNeKDqFPSTB5tNL1jGSBJgsVeVjE5e7Pb8s,20542
 mpflash/vendor/readme.md,sha256=iIIZxuLUIGHQ0KODzYVtMezsztvyxCXcNJp_AzwTIPk,86
 mpflash/vendor/versions.py,sha256=thk1a5wEEhXIQoL0zZ7oooeFyQeSoI00CIUbZF0b3rI,3783
 mpflash/worklist.py,sha256=MKHDynttVP3lsHSfb7DEqeQ2mRV0da96lD4lIcS_zQY,5962
-mpflash-0.8.3.dist-info/entry_points.txt,sha256=Jk_visOhYOsZIcSP2Ms9hKqfKy1iorR-6dYltSoWCpY,52
-mpflash-0.8.3.dist-info/LICENSE,sha256=mWpNhsIxWzetYNnTpr4eb3HtgsxGIC8KcYWxXEcxQvE,1077
-mpflash-0.8.3.dist-info/METADATA,sha256=m_L6esjRSJk_xjDafV9in_boKNX2c4wmQ8P-rl9xzL4,15275
-mpflash-0.8.3.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-mpflash-0.8.3.dist-info/RECORD,,
+mpflash-0.8.5.dist-info/entry_points.txt,sha256=Jk_visOhYOsZIcSP2Ms9hKqfKy1iorR-6dYltSoWCpY,52
+mpflash-0.8.5.dist-info/LICENSE,sha256=mWpNhsIxWzetYNnTpr4eb3HtgsxGIC8KcYWxXEcxQvE,1077
+mpflash-0.8.5.dist-info/METADATA,sha256=C5-dboiJYVyYngX9wl_B_uv2faJmj2nxXXQcoGfzdJU,15275
+mpflash-0.8.5.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+mpflash-0.8.5.dist-info/RECORD,,