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

mpflash/bootloader/__init__.py

@@ -1,36 +1,37 @@
-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
+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)
+    else:
+        log.error(f"Failed to enter bootloader on {mcu.serialport}")
+    return result

mpflash/bootloader/manual.py

@@ -1,102 +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]
+"""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

@@ -1,10 +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
+"""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

@@ -1,45 +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
+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

@@ -1,129 +1,129 @@
-"""CLI to Download MicroPython firmware for specific ports, boards and versions."""
-
-from pathlib import Path
-
-import rich_click as click
-from loguru import logger as log
-
-from mpflash.connected import connected_ports_boards
-from mpflash.errors import MPFlashError
-from mpflash.mpboard_id import find_known_board
-from mpflash.vendor.versions import clean_version
-
-from .ask_input import ask_missing_params
-from .cli_group import cli
-from .common import DownloadParams
-from .config import config
-from .download import download
-
-
-@cli.command(
-    "download",
-    help="Download MicroPython firmware for specific ports, boards and versions.",
-)
-@click.option(
-    "--destination",
-    "-d",
-    "fw_folder",
-    type=click.Path(file_okay=False, dir_okay=True, path_type=Path),
-    default=config.firmware_folder,
-    show_default=True,
-    help="The folder to download the firmware to.",
-)
-@click.option(
-    "--version",
-    "-v",
-    "versions",
-    default=["stable"],
-    multiple=True,
-    show_default=True,
-    help="The version of MicroPython to to download.",
-    metavar="SEMVER, 'stable', 'preview' or '?'",
-)
-@click.option(
-    "--board",
-    "-b",
-    "boards",
-    multiple=True,
-    default=[],
-    show_default=True,
-    help="The board(s) to download the firmware for.",
-    metavar="BOARD_ID or ?",
-)
-@click.option(
-    "--serial",
-    "--serial-port",
-    "-s",
-    "serial",
-    default=["*"],
-    show_default=True,
-    multiple=True,
-    help="Which serial port(s) to flash",
-    metavar="SERIALPORT",
-)
-@click.option(
-    "--ignore",
-    "-i",
-    is_eager=True,
-    help="Serial port(s) to ignore. Defaults to MPFLASH_IGNORE.",
-    multiple=True,
-    default=[],
-    envvar="MPFLASH_IGNORE",
-    show_default=True,
-    metavar="SERIALPORT",
-)
-@click.option(
-    "--clean/--no-clean",
-    default=True,
-    show_default=True,
-    help="""Remove dates and hashes from the downloaded firmware filenames.""",
-)
-@click.option(
-    "--force",
-    "-f",
-    default=False,
-    is_flag=True,
-    show_default=True,
-    help="""Force download of firmware even if it already exists.""",
-)
-def cli_download(**kwargs) -> int:
-    params = DownloadParams(**kwargs)
-    params.versions = list(params.versions)
-    params.boards = list(params.boards)
-    params.serial = list(params.serial)
-    params.ignore = list(params.ignore)
-
-    # all_boards: List[MPRemoteBoard] = []
-    if params.boards:
-        if not params.ports:
-            # no ports specified - resolve ports from specified boards by resolving board IDs
-            for board in params.boards:
-                if board != "?":
-                    try:
-                        board_ = find_known_board(board)
-                        params.ports.append(board_.port)
-                    except MPFlashError as e:
-                        log.error(f"{e}")
-    else:
-        # no boards specified - detect connected ports and boards
-        params.ports, params.boards, _ = connected_ports_boards(include=params.serial, ignore=params.ignore)
-
-    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]
-    assert isinstance(params, DownloadParams)
-
-    try:
-        download(
-            params.fw_folder,
-            params.ports,
-            params.boards,
-            params.versions,
-            params.force,
-            params.clean,
-        )
-        return 0
-    except MPFlashError as e:
-        log.error(f"{e}")
-        return 1
+"""CLI to Download MicroPython firmware for specific ports, boards and versions."""
+
+from pathlib import Path
+
+import rich_click as click
+from loguru import logger as log
+
+from mpflash.connected import connected_ports_boards
+from mpflash.errors import MPFlashError
+from mpflash.mpboard_id import find_known_board
+from mpflash.vendor.versions import clean_version
+
+from .ask_input import ask_missing_params
+from .cli_group import cli
+from .common import DownloadParams
+from .config import config
+from .download import download
+
+
+@cli.command(
+    "download",
+    help="Download MicroPython firmware for specific ports, boards and versions.",
+)
+@click.option(
+    "--destination",
+    "-d",
+    "fw_folder",
+    type=click.Path(file_okay=False, dir_okay=True, path_type=Path),
+    default=config.firmware_folder,
+    show_default=True,
+    help="The folder to download the firmware to.",
+)
+@click.option(
+    "--version",
+    "-v",
+    "versions",
+    default=["stable"],
+    multiple=True,
+    show_default=True,
+    help="The version of MicroPython to to download.",
+    metavar="SEMVER, 'stable', 'preview' or '?'",
+)
+@click.option(
+    "--board",
+    "-b",
+    "boards",
+    multiple=True,
+    default=[],
+    show_default=True,
+    help="The board(s) to download the firmware for.",
+    metavar="BOARD_ID or ?",
+)
+@click.option(
+    "--serial",
+    "--serial-port",
+    "-s",
+    "serial",
+    default=["*"],
+    show_default=True,
+    multiple=True,
+    help="Which serial port(s) to flash",
+    metavar="SERIALPORT",
+)
+@click.option(
+    "--ignore",
+    "-i",
+    is_eager=True,
+    help="Serial port(s) to ignore. Defaults to MPFLASH_IGNORE.",
+    multiple=True,
+    default=[],
+    envvar="MPFLASH_IGNORE",
+    show_default=True,
+    metavar="SERIALPORT",
+)
+@click.option(
+    "--clean/--no-clean",
+    default=True,
+    show_default=True,
+    help="""Remove dates and hashes from the downloaded firmware filenames.""",
+)
+@click.option(
+    "--force",
+    "-f",
+    default=False,
+    is_flag=True,
+    show_default=True,
+    help="""Force download of firmware even if it already exists.""",
+)
+def cli_download(**kwargs) -> int:
+    params = DownloadParams(**kwargs)
+    params.versions = list(params.versions)
+    params.boards = list(params.boards)
+    params.serial = list(params.serial)
+    params.ignore = list(params.ignore)
+
+    # all_boards: List[MPRemoteBoard] = []
+    if params.boards:
+        if not params.ports:
+            # no ports specified - resolve ports from specified boards by resolving board IDs
+            for board in params.boards:
+                if board != "?":
+                    try:
+                        board_ = find_known_board(board)
+                        params.ports.append(board_.port)
+                    except MPFlashError as e:
+                        log.error(f"{e}")
+    else:
+        # no boards specified - detect connected ports and boards
+        params.ports, params.boards, _ = connected_ports_boards(include=params.serial, ignore=params.ignore)
+
+    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]
+    assert isinstance(params, DownloadParams)
+
+    try:
+        download(
+            params.fw_folder,
+            params.ports,
+            params.boards,
+            params.versions,
+            params.force,
+            params.clean,
+        )
+        return 0
+    except MPFlashError as e:
+        log.error(f"{e}")
+        return 1