mpflash 1.0.1__py3-none-any.whl → 1.0.2__py3-none-any.whl

mpflash/bootloader/activate.py

@@ -1,60 +1,60 @@
-import time
-
-from mpflash.bootloader.detect import in_bootloader
-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_touch_1200bps
-
-BL_OPTIONS = {
-    "stm32": [BootloaderMethod.TOUCH_1200, BootloaderMethod.MPY, BootloaderMethod.MANUAL],
-    "rp2": [BootloaderMethod.TOUCH_1200, BootloaderMethod.MPY, BootloaderMethod.MANUAL],
-    "samd": [BootloaderMethod.TOUCH_1200, BootloaderMethod.MPY, BootloaderMethod.MANUAL],
-    "esp32": [BootloaderMethod.NONE],
-    "esp8266": [BootloaderMethod.NONE],
-}
-
-
-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
-    elif method == BootloaderMethod.AUTO:
-        # build a list of options to try for this board
-        bl_list = BL_OPTIONS.get(mcu.port, [BootloaderMethod.MPY, BootloaderMethod.MANUAL])
-    else:
-        bl_list = [method, BootloaderMethod.MANUAL]
-    log.info(f"Entering bootloader on {mcu.serialport} using methods {[bl.value for bl in bl_list]}")
-    for method in bl_list:
-        try:
-            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_touch_1200bps(mcu, timeout=timeout)
-        except MPFlashError as e:
-            log.warning(f"Failed to enter bootloader on {mcu.serialport} using {method.value}")
-            log.exception(e)
-            result = False
-        if not result:
-            # try a next method
-            continue
-
-        # todo - check every second or so for up to max wait time
-        time.sleep(wait_after)
-        # check if bootloader was entered
-        if in_bootloader(mcu):
-            return True
-
-    return result
+import time
+
+from mpflash.bootloader.detect import in_bootloader
+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_touch_1200bps
+
+BL_OPTIONS = {
+    "stm32": [BootloaderMethod.TOUCH_1200, BootloaderMethod.MPY, BootloaderMethod.MANUAL],
+    "rp2": [BootloaderMethod.TOUCH_1200, BootloaderMethod.MPY, BootloaderMethod.MANUAL],
+    "samd": [BootloaderMethod.TOUCH_1200, BootloaderMethod.MPY, BootloaderMethod.MANUAL],
+    "esp32": [BootloaderMethod.NONE],
+    "esp8266": [BootloaderMethod.NONE],
+}
+
+
+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
+    elif method == BootloaderMethod.AUTO:
+        # build a list of options to try for this board
+        bl_list = BL_OPTIONS.get(mcu.port, [BootloaderMethod.MPY, BootloaderMethod.MANUAL])
+    else:
+        bl_list = [method, BootloaderMethod.MANUAL]
+    log.info(f"Entering bootloader on {mcu.serialport} using methods {[bl.value for bl in bl_list]}")
+    for method in bl_list:
+        try:
+            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_touch_1200bps(mcu, timeout=timeout)
+        except MPFlashError as e:
+            log.warning(f"Failed to enter bootloader on {mcu.serialport} using {method.value}")
+            log.exception(e)
+            result = False
+        if not result:
+            # try a next method
+            continue
+
+        # todo - check every second or so for up to max wait time
+        time.sleep(wait_after)
+        # check if bootloader was entered
+        if in_bootloader(mcu):
+            return True
+
+    return result

mpflash/bootloader/detect.py

@@ -1,82 +1,82 @@
-""" Detect if a board is in bootloader mode 
-"""
-
-import os
-
-from mpflash.common import PORT_FWTYPES
-from mpflash.flash.uf2 import waitfor_uf2
-from mpflash.logger import log
-from mpflash.mpremoteboard import MPRemoteBoard
-
-
-def in_bootloader(mcu: MPRemoteBoard) -> bool:
-    """Check if the board is in bootloader mode"""
-    if ".uf2" in PORT_FWTYPES[mcu.port]:
-        return in_uf2_bootloader(mcu.port.upper())
-    elif mcu.port in ["stm32"]:
-        return in_stm32_bootloader()
-    elif mcu.port in ["esp32", "esp8266"]:
-        log.debug("esp32/esp8266 does not have a bootloader mode, Assume OK to flash")
-        return True
-
-    log.error(f"Bootloader mode not supported on {mcu.board} on {mcu.serialport}")
-    return False
-
-
-def in_uf2_bootloader(board_id: str) -> bool:
-    """
-    Check if the board is in UF2 bootloader mode.
-
-    :param board_id: The board ID to check for (SAMD or RP2)
-    """
-    return bool(waitfor_uf2(board_id=board_id))
-
-
-def in_stm32_bootloader() -> bool:
-    """Check if the board is in STM32 bootloader mode"""
-    if os.name == "nt":
-        driver_installed, status = check_for_stm32_bootloader_device()
-        if not driver_installed:
-            log.warning("STM32  BOOTLOADER device not found.")
-            return False
-        print()
-        if status != "OK":
-            log.warning(f"STM32 BOOTLOADER device found, Device status: {status}")
-            log.error("Please use Zadig to install a WinUSB (libusb)  driver.\nhttps://github.com/pbatard/libwdi/wiki/Zadig")
-            return False
-    return check_dfu_devices()
-
-
-def check_dfu_devices():
-    """Check if there are any DFU devices connected"""
-    # JIT import
-    from mpflash.flash.stm32_dfu import dfu_init
-    from mpflash.vendor.pydfu import get_dfu_devices
-
-    # need to init on windows to get the right usb backend
-    dfu_init()
-    devices = get_dfu_devices()
-    return len(devices) > 0
-
-
-def check_for_stm32_bootloader_device():
-    import win32com.client
-
-    # Windows only
-    # Create a WMI interface object
-    wmi = win32com.client.GetObject("winmgmts:")
-
-    # Query for USB devices
-    for usb_device in wmi.InstancesOf("Win32_PnPEntity"):
-        try:
-            # Check if device name or description contains "STM32 BOOTLOADER"
-            if str(usb_device.Name).strip() in {
-                "STM32  BOOTLOADER",
-                "STM BOOTLOADER",
-            }:
-                # Just the first match is enough
-                return True, usb_device.Status
-        except Exception:
-            pass
-    # If no matching device was found
-    return False, "Not found."
+""" Detect if a board is in bootloader mode 
+"""
+
+import os
+
+from mpflash.common import PORT_FWTYPES
+from mpflash.flash.uf2 import waitfor_uf2
+from mpflash.logger import log
+from mpflash.mpremoteboard import MPRemoteBoard
+
+
+def in_bootloader(mcu: MPRemoteBoard) -> bool:
+    """Check if the board is in bootloader mode"""
+    if ".uf2" in PORT_FWTYPES[mcu.port]:
+        return in_uf2_bootloader(mcu.port.upper())
+    elif mcu.port in ["stm32"]:
+        return in_stm32_bootloader()
+    elif mcu.port in ["esp32", "esp8266"]:
+        log.debug("esp32/esp8266 does not have a bootloader mode, Assume OK to flash")
+        return True
+
+    log.error(f"Bootloader mode not supported on {mcu.board} on {mcu.serialport}")
+    return False
+
+
+def in_uf2_bootloader(board_id: str) -> bool:
+    """
+    Check if the board is in UF2 bootloader mode.
+
+    :param board_id: The board ID to check for (SAMD or RP2)
+    """
+    return bool(waitfor_uf2(board_id=board_id))
+
+
+def in_stm32_bootloader() -> bool:
+    """Check if the board is in STM32 bootloader mode"""
+    if os.name == "nt":
+        driver_installed, status = check_for_stm32_bootloader_device()
+        if not driver_installed:
+            log.warning("STM32  BOOTLOADER device not found.")
+            return False
+        print()
+        if status != "OK":
+            log.warning(f"STM32 BOOTLOADER device found, Device status: {status}")
+            log.error("Please use Zadig to install a WinUSB (libusb)  driver.\nhttps://github.com/pbatard/libwdi/wiki/Zadig")
+            return False
+    return check_dfu_devices()
+
+
+def check_dfu_devices():
+    """Check if there are any DFU devices connected"""
+    # JIT import
+    from mpflash.flash.stm32_dfu import dfu_init
+    from mpflash.vendor.pydfu import get_dfu_devices
+
+    # need to init on windows to get the right usb backend
+    dfu_init()
+    devices = get_dfu_devices()
+    return len(devices) > 0
+
+
+def check_for_stm32_bootloader_device():
+    import win32com.client
+
+    # Windows only
+    # Create a WMI interface object
+    wmi = win32com.client.GetObject("winmgmts:")
+
+    # Query for USB devices
+    for usb_device in wmi.InstancesOf("Win32_PnPEntity"):
+        try:
+            # Check if device name or description contains "STM32 BOOTLOADER"
+            if str(usb_device.Name).strip() in {
+                "STM32  BOOTLOADER",
+                "STM BOOTLOADER",
+            }:
+                # Just the first match is enough
+                return True, usb_device.Status
+        except Exception:
+            pass
+    # If no matching device was found
+    return False, "Not found."

mpflash/bootloader/manual.py

@@ -1,101 +1,101 @@
-"""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 things that should stand out."""
-
-    base_style = "mcu."
-    highlights = [
-        r"(?P<bold>Method[\s\d\:]*)",
-        r"(?P<bold> \d.)",  # numbered items
-        r"(?P<bold> - )",  # bullets
-        # mcu things
-        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<cable>USB-C)",
-        r"(?P<cable>Serial)",
-    ]
-
-
-# https://rich.readthedocs.io/en/stable/appendix/colors.html?highlight=colors#standard-colors
-# use 3 colors to keep things simple but clear
-mcu_theme = Theme(
-    {
-        "mcu.bold": "orange3",  # readers guidance
-        "mcu.button": "bold green",  # things to press
-        "mcu.pad": "dodger_blue2",  # things to connect
-        "mcu.cable": "dodger_blue2",  # things to connect
-    }
-)
-
-
-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)  # type: ignore
-    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 things that should stand out."""
+
+    base_style = "mcu."
+    highlights = [
+        r"(?P<bold>Method[\s\d\:]*)",
+        r"(?P<bold> \d.)",  # numbered items
+        r"(?P<bold> - )",  # bullets
+        # mcu things
+        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<cable>USB-C)",
+        r"(?P<cable>Serial)",
+    ]
+
+
+# https://rich.readthedocs.io/en/stable/appendix/colors.html?highlight=colors#standard-colors
+# use 3 colors to keep things simple but clear
+mcu_theme = Theme(
+    {
+        "mcu.bold": "orange3",  # readers guidance
+        "mcu.button": "bold green",  # things to press
+        "mcu.pad": "dodger_blue2",  # things to connect
+        "mcu.cable": "dodger_blue2",  # things to connect
+    }
+)
+
+
+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)  # type: ignore
+    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,12 +1,12 @@
-"""Module for handling the bootloader mode for micropython boards"""
-
-from mpflash.logger import log
-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"""
-    log.info(f"Attempting bootloader on {mcu.serialport} using 'mpremote bootloader'")
-    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.logger import log
+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"""
+    log.info(f"Attempting bootloader on {mcu.serialport} using 'mpremote bootloader'")
+    mcu.run_command("bootloader", timeout=timeout)
+    # todo: check if mpremote command was successful
+    return True

mpflash/bootloader/touch1200.py

@@ -1,36 +1,36 @@
-"""
-Enter bootloader using Touch 1200Bd for boards with bootloaders that support this.
-
-"""
-
-import time
-
-import serial
-
-from mpflash.errors import MPFlashError
-from mpflash.logger import log
-from mpflash.mpremoteboard import MPRemoteBoard
-
-
-def enter_bootloader_touch_1200bps(mcu: MPRemoteBoard, timeout: int = 10):
-    if not mcu.serialport:
-        raise MPFlashError("No serial port specified")
-    log.info(f"Attempting bootloader on {mcu.serialport} using 'Touch 1200Bd'")
-    # if port argument is present perform soft reset
-    # try to initiate serial port connection on PORT with 1200 baudrate
-    try:
-        com = serial.Serial(mcu.serialport, 1200, dsrdtr=True)
-        com.rts = False  # required
-        com.dtr = False  # might as well
-        time.sleep(0.2)
-        com.close()
-
-    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
+"""
+Enter bootloader using Touch 1200Bd for boards with bootloaders that support this.
+
+"""
+
+import time
+
+import serial
+
+from mpflash.errors import MPFlashError
+from mpflash.logger import log
+from mpflash.mpremoteboard import MPRemoteBoard
+
+
+def enter_bootloader_touch_1200bps(mcu: MPRemoteBoard, timeout: int = 10):
+    if not mcu.serialport:
+        raise MPFlashError("No serial port specified")
+    log.info(f"Attempting bootloader on {mcu.serialport} using 'Touch 1200Bd'")
+    # if port argument is present perform soft reset
+    # try to initiate serial port connection on PORT with 1200 baudrate
+    try:
+        com = serial.Serial(mcu.serialport, 1200, dsrdtr=True)
+        com.rts = False  # required
+        com.dtr = False  # might as well
+        time.sleep(0.2)
+        com.close()
+
+    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