mpflash 0.8.5__tar.gz → 0.8.8__tar.gz

{mpflash-0.8.5 → mpflash-0.8.8}/LICENSE

@@ -1,20 +1,20 @@
-Copyright (c) 2024 Jos Verlinde
-
-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.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-
+Copyright (c) 2024 Jos Verlinde
+
+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.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

{mpflash-0.8.5 → mpflash-0.8.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mpflash
-Version: 0.8.5
+Version: 0.8.8
 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.5 → mpflash-0.8.8}/README.md

@@ -1,184 +1,184 @@
-# MPFLASH
-  [![pypi version](https://badgen.net/pypi/v/mpflash)](https://pypi.org/project/mpflash/)
-  [![python versions](https://badgen.net/pypi/python/mpflash)](https://badgen.net/pypi/python/mpflash)
-[![Downloads](https://static.pepy.tech/badge/mpflash)](https://pepy.tech/project/mpflash)
-
-
-`mpflash` is a command-line tool for working with MicroPython firmware. It provides features to help you flash and update Micropython on one or more .
-
-This tool was initially created to be used in a CI/CD pipeline to automate the process of downloading and flashing MicroPython firmware to multiple boards, but it has been extend with a TUI to be used for manual downloadig, flashing and development.
-
-`mpflash` has been tested on:  
- - OS: Windows x64, Linux X64, but not (yet) macOS.
- - Micropython (hardware) ports: 
-    - `rp2`, using `.uf2`, using filecopy (macos not tested yet)
-    - `samd`, using ` .uf2`, using filecopy (macos not tested yet)
-    - `esp32`, using `.bin`, using esptool,
-    - `esp8266`, using `.bin`, using esptool
-    - `stm32`, using ` .dfu`, using pydfu
-
-Not yet implemented: `nrf`, `cc3200`, `mimxrt`
- 
-## Features
- 1. List the connected boards including their firmware details, in a tabular or json format
- 2. Download MicroPython firmware for versions, and matching a specified board or matches your current attached board.
- 3. Flash one or all connected MicroPython boards with a specific firmware or version.  
- 
-## Installation
-To install mpflash, you can use pip: `pip install mpflash`
-
-## Basic usage
-You can use mpflash to perform various operations on your MicroPython boards. Here is an example of basic usage:
-
-| Command | Description |
-|---------|-------------|
-| `mpflash list` | List the connected board(s) including their firmware details |
-| `mpflash download` | Download the MicroPython firmware(s) for the connected board(s) |
-| `mpflash flash` | Flash the latest stable firmware to the connected board(s) |
-
-
-## 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.
-On Windows this will not be an issue, but on Linux you can use  udev rules to give non-root users access to the USB devices.
-[See the stm32_permissions documentation](./stm32_udev_rules.md) for more information.
-
-
-## Detailed usage
-You can list the connected boards using the following command:
-```bash
-$> mpflash list
-                                               Connected boards
-┏━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━┓
-┃ Serial  ┃Family       ┃Port  ┃Board                                      ┃CPU     ┃Version          ┃build ┃
-┡━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━━┩
-│ COM21   │micropython  │rp2   │RPI_PICO                                   │RP2040  │v1.23.0-preview  │  236 │
-│         │             │      │Raspberry Pi Pico with RP2040              │        │                 │      │
-│ COM23   │micropython  │rp2   │RPI_PICO_W                                 │RP2040  │v1.23.0-preview  │  176 │
-│         │             │      │Raspberry Pi Pico W with RP2040            │        │                 │      │
-│ COM9    │micropython  │rp2   │ARDUINO_NANO_RP2040_CONNECT                │RP2040  │v1.23.0-preview  │  341 │
-│         │             │      │Arduino Nano RP2040 Connect with RP2040    │        │                 │      │
-└─────────┴─────────────┴──────┴───────────────────────────────────────────┴────────┴─────────────────┴──────┘
-```
-## Download the firmware
-
-To download the MicroPython firmware for some boards, use the following command: 
- - `mpflash download` download the latest stable firmware for all connected boards
- - `mpflash download --version preview` download the current preview for all connected boards
- - `mpflash download --board ESP8266_GENERIC --board SEEED_WIO_TERMINAL` download these specific boards
- - `mpflash download --version ? --board ?` prompt to select a specific version and board to download
-
-These will try to download the prebuilt MicroPython firmware for the boards from https://micropython.org/download/ and save it in your downloads folder in the  `firmware` directory.
-The stable version (default) is determined based on the most recent published release,
-other versions are `--version preview` and `--version x.y.z` to download the latest preview or version x.y.z respectively.
-
-By default the firmware will be downloaded to your OS's preferred `Downloads/firmware` folder, but you can speciy a different directory using the `--dir` option.
-
-The directory structure will be something like this:
-
-``` text
-Downloads/firmware
-|   firmware.jsonl
-+---esp8266
-|       ESP8266_GENERIC-FLASH_1M-v1.22.2.bin
-|       ESP8266_GENERIC-FLASH_512K-v1.22.2.bin
-|       ESP8266_GENERIC-OTA-v1.22.2.bin
-|       ESP8266_GENERIC-v1.22.2.bin
-\---samd
-        SEEED_WIO_TERMINAL-v1.22.2.uf2
-```
-
-## Flashing the firmware
-After you have downloaded a firmware you can  flash the firmware to a board using the following command: `mpflash flash`
-This will (try to) autodetect the connected boards, and determine the correct firmware to flash to each board.
-
-- `mpflash flash` will flash the latest stable firmware to all connected boards.
-- `mpflash flash --serial ? --board ?` will prompt to select a specific serial port and board to flash. (the firmware must be dowloaded earlier)
-
-
-### Flashing all connected boards with the latest stable firmware
-```bash
-> mpflash flash
-22:15:55 | ℹ️  - Using latest stable version: v1.22.2
-                                       Connected boards
-┏━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┳━━━━━━━┓
-┃ Serial ┃ Family      ┃ Port    ┃ Board              ┃ CPU         ┃ Version        ┃ build ┃
-┡━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━╇━━━━━━━┩
-│ COM11  │ micropython │ rp2     │ RPI_PICO_W         │ RP2040      │ 1.20.0         │       │
-│ COM12  │ micropython │ esp8266 │ ESP8266_GENERIC    │ ESP8266     │ 1.22.2         │       │
-│ COM18  │ micropython │ rp2     │ RPI_PICO_W         │ RP2040      │ 1.23.0-preview │ 155   │
-│ COM3   │ micropython │ samd    │ SEEED_WIO_TERMINAL │ SAMD51P19A  │ 1.23.0-preview │ 155   │
-│ COM5   │ micropython │ stm32   │ PYBV11             │ STM32F405RG │ 1.23.0-preview │ 166   │
-│ COM8   │ micropython │ esp32   │ ESP32_GENERIC_S3   │ ESP32S3     │ 1.23.0-preview │ 155   │
-└────────┴─────────────┴─────────┴────────────────────┴─────────────┴────────────────┴───────┘
-22:15:58 | ℹ️  - Found v1.22.2 firmware rp2\RPI_PICO_W-v1.22.2.uf2 for RPI_PICO_W on COM11.
-22:15:58 | ℹ️  - Found v1.22.2 firmware esp8266\ESP8266_GENERIC-v1.22.2.bin for ESP8266_GENERIC on COM12.
-22:15:58 | ℹ️  - Found v1.22.2 firmware rp2\RPI_PICO_W-v1.22.2.uf2 for RPI_PICO_W on COM18.
-22:15:58 | ℹ️  - Found v1.22.2 firmware samd\SEEED_WIO_TERMINAL-v1.22.2.uf2 for SEEED_WIO_TERMINAL on COM3.
-22:15:58 | ⚠️  - Trying to find a firmware for the board PYBV11
-22:15:58 | ❌  - No v1.22.2 firmware found for PYBV11 on COM5.
-22:15:58 | ⚠️  - Trying to find a firmware for the board ESP32-GENERIC-S3
-22:15:58 | ❌  - No v1.22.2 firmware found for ESP32_GENERIC_S3 on COM8.
-22:15:58 | ℹ️  - Updating RPI_PICO_W on COM11 to 1.22.2
-22:15:58 | ℹ️  - Erasing not yet implemented for UF2 flashing.
-22:15:58 | ℹ️  - Entering UF2 bootloader on RPI_PICO_W on COM11
-22:15:58 | ℹ️  - Waiting for mcu to mount as a drive : 10 seconds left
-22:15:59 | ℹ️  - Waiting for mcu to mount as a drive : 9 seconds left
-22:16:00 | ℹ️  - Board is in bootloader mode
-22:16:00 | ℹ️  - Copying firmware\rp2\RPI_PICO_W-v1.22.2.uf2 to F:
-22:16:13 | ✅  - Done copying, resetting the board and wait for it to restart
-22:16:23 | ℹ️  - Updating ESP8266_GENERIC on COM12 to 1.22.2
-22:16:23 | ℹ️  - Flashing firmware\esp8266\ESP8266_GENERIC-v1.22.2.bin on ESP8266_GENERIC on COM12
-22:16:23 | ℹ️  - Running esptool --chip ESP8266 --port COM12 erase_flash 
-esptool.py v4.7.0
-Serial port COM12
-Connecting....
-...
-Chip erase completed successfully in 6.5s
-Hard resetting via RTS pin...
-22:16:31 | ℹ️  - Running esptool --chip ESP8266 --port COM12 -b 460800 write_flash --flash_size=detect 0x0 firmware\esp8266\ESP8266_GENERIC-v1.22.2.bin 
-esptool.py v4.7.0
-Serial port COM12
-Connecting....
-...
-Leaving...
-Hard resetting via RTS pin...
-22:16:43 | ℹ️  - Done flashing, resetting the board and wait for it to restart
-22:16:49 | ✅  - Flashed 1.22.2 to ESP8266_GENERIC on COM12 done
-22:16:49 | ℹ️  - Updating RPI_PICO_W on COM18 to 1.22.2
-22:16:49 | ℹ️  - Erasing not yet implemented for UF2 flashing.
-22:16:49 | ℹ️  - Entering UF2 bootloader on RPI_PICO_W on COM18
-22:16:49 | ℹ️  - Waiting for mcu to mount as a drive : 10 seconds left
-22:16:50 | ℹ️  - Waiting for mcu to mount as a drive : 9 seconds left
-22:16:51 | ℹ️  - Board is in bootloader mode
-22:16:51 | ℹ️  - Copying firmware\rp2\RPI_PICO_W-v1.22.2.uf2 to F:[/bold]
-22:17:02 | ✅  - Done copying, resetting the board and wait for it to restart
-22:17:12 | ℹ️  - Updating SEEED_WIO_TERMINAL on COM3 to 1.22.2
-22:17:12 | ℹ️  - Erasing not yet implemented for UF2 flashing.
-22:17:12 | ℹ️  - Entering UF2 bootloader on SEEED_WIO_TERMINAL on COM3
-22:17:12 | ℹ️  - Waiting for mcu to mount as a drive : 10 seconds left
-22:17:13 | ℹ️  - Waiting for mcu to mount as a drive : 9 seconds left
-22:17:14 | ℹ️  - Board is in bootloader mode
-22:17:14 | ℹ️  - Copying firmware\samd\SEEED_WIO_TERMINAL-v1.22.2.uf2 to F:[/bold]
-22:17:17 | ✅  - Done copying, resetting the board and wait for it to restart
-22:17:27 | ℹ️  - Flashed 4 boards
-                               Connected boards after flashing
-┏━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┳━━━━━━━┓
-┃ Serial ┃ Family      ┃ Port    ┃ Board              ┃ CPU         ┃ Version        ┃ build ┃
-┡━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━╇━━━━━━━┩
-│ COM11  │ micropython │ rp2     │ RPI_PICO_W         │ RP2040      │ 1.22.2         │       │
-│ COM12  │ micropython │ esp8266 │ ESP8266_GENERIC    │ ESP8266     │ 1.22.2         │       │
-│ COM18  │ micropython │ rp2     │ RPI_PICO_W         │ RP2040      │ 1.22.2         │       │
-│ COM3   │ micropython │ samd    │ SEEED_WIO_TERMINAL │ SAMD51P19A  │ 1.22.2         │       │
-│ COM5   │ micropython │ stm32   │ PYBV11             │ STM32F405RG │ 1.23.0-preview │ 166   │
-│ COM8   │ micropython │ esp32   │ ESP32_GENERIC_S3   │ ESP32S3     │ 1.23.0-preview │ 155   │
-└────────┴─────────────┴─────────┴────────────────────┴─────────────┴────────────────┴───────┘
-```
-Note that if no matching firmware can be found for a board, it will be skipped.
-(For example, the PYBV11 and ESP32_GENERIC_S3 boards in the example above.)
-
-## Issues and bug reports
-mpflash is currently co-located in the [micropython-stubber](https://github.com/Josverl/micropython-stubber) repository.  
-Please report any issues or bugs in the [issue tracker](https://github.com/Josverl/micropython-stubber/issues) using the MPflash feedback template.
-
-## License
-mpflash is licensed under the MIT license. See the LICENSE file for more details.
+# MPFLASH
+  [![pypi version](https://badgen.net/pypi/v/mpflash)](https://pypi.org/project/mpflash/)
+  [![python versions](https://badgen.net/pypi/python/mpflash)](https://badgen.net/pypi/python/mpflash)
+[![Downloads](https://static.pepy.tech/badge/mpflash)](https://pepy.tech/project/mpflash)
+
+
+`mpflash` is a command-line tool for working with MicroPython firmware. It provides features to help you flash and update Micropython on one or more .
+
+This tool was initially created to be used in a CI/CD pipeline to automate the process of downloading and flashing MicroPython firmware to multiple boards, but it has been extend with a TUI to be used for manual downloadig, flashing and development.
+
+`mpflash` has been tested on:  
+ - OS: Windows x64, Linux X64, but not (yet) macOS.
+ - Micropython (hardware) ports: 
+    - `rp2`, using `.uf2`, using filecopy (macos not tested yet)
+    - `samd`, using ` .uf2`, using filecopy (macos not tested yet)
+    - `esp32`, using `.bin`, using esptool,
+    - `esp8266`, using `.bin`, using esptool
+    - `stm32`, using ` .dfu`, using pydfu
+
+Not yet implemented: `nrf`, `cc3200`, `mimxrt`
+ 
+## Features
+ 1. List the connected boards including their firmware details, in a tabular or json format
+ 2. Download MicroPython firmware for versions, and matching a specified board or matches your current attached board.
+ 3. Flash one or all connected MicroPython boards with a specific firmware or version.  
+ 
+## Installation
+To install mpflash, you can use pip: `pip install mpflash`
+
+## Basic usage
+You can use mpflash to perform various operations on your MicroPython boards. Here is an example of basic usage:
+
+| Command | Description |
+|---------|-------------|
+| `mpflash list` | List the connected board(s) including their firmware details |
+| `mpflash download` | Download the MicroPython firmware(s) for the connected board(s) |
+| `mpflash flash` | Flash the latest stable firmware to the connected board(s) |
+
+
+## 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.
+On Windows this will not be an issue, but on Linux you can use  udev rules to give non-root users access to the USB devices.
+[See the stm32_permissions documentation](./stm32_udev_rules.md) for more information.
+
+
+## Detailed usage
+You can list the connected boards using the following command:
+```bash
+$> mpflash list
+                                               Connected boards
+┏━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━┓
+┃ Serial  ┃Family       ┃Port  ┃Board                                      ┃CPU     ┃Version          ┃build ┃
+┡━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━━┩
+│ COM21   │micropython  │rp2   │RPI_PICO                                   │RP2040  │v1.23.0-preview  │  236 │
+│         │             │      │Raspberry Pi Pico with RP2040              │        │                 │      │
+│ COM23   │micropython  │rp2   │RPI_PICO_W                                 │RP2040  │v1.23.0-preview  │  176 │
+│         │             │      │Raspberry Pi Pico W with RP2040            │        │                 │      │
+│ COM9    │micropython  │rp2   │ARDUINO_NANO_RP2040_CONNECT                │RP2040  │v1.23.0-preview  │  341 │
+│         │             │      │Arduino Nano RP2040 Connect with RP2040    │        │                 │      │
+└─────────┴─────────────┴──────┴───────────────────────────────────────────┴────────┴─────────────────┴──────┘
+```
+## Download the firmware
+
+To download the MicroPython firmware for some boards, use the following command: 
+ - `mpflash download` download the latest stable firmware for all connected boards
+ - `mpflash download --version preview` download the current preview for all connected boards
+ - `mpflash download --board ESP8266_GENERIC --board SEEED_WIO_TERMINAL` download these specific boards
+ - `mpflash download --version ? --board ?` prompt to select a specific version and board to download
+
+These will try to download the prebuilt MicroPython firmware for the boards from https://micropython.org/download/ and save it in your downloads folder in the  `firmware` directory.
+The stable version (default) is determined based on the most recent published release,
+other versions are `--version preview` and `--version x.y.z` to download the latest preview or version x.y.z respectively.
+
+By default the firmware will be downloaded to your OS's preferred `Downloads/firmware` folder, but you can speciy a different directory using the `--dir` option.
+
+The directory structure will be something like this:
+
+``` text
+Downloads/firmware
+|   firmware.jsonl
++---esp8266
+|       ESP8266_GENERIC-FLASH_1M-v1.22.2.bin
+|       ESP8266_GENERIC-FLASH_512K-v1.22.2.bin
+|       ESP8266_GENERIC-OTA-v1.22.2.bin
+|       ESP8266_GENERIC-v1.22.2.bin
+\---samd
+        SEEED_WIO_TERMINAL-v1.22.2.uf2
+```
+
+## Flashing the firmware
+After you have downloaded a firmware you can  flash the firmware to a board using the following command: `mpflash flash`
+This will (try to) autodetect the connected boards, and determine the correct firmware to flash to each board.
+
+- `mpflash flash` will flash the latest stable firmware to all connected boards.
+- `mpflash flash --serial ? --board ?` will prompt to select a specific serial port and board to flash. (the firmware must be dowloaded earlier)
+
+
+### Flashing all connected boards with the latest stable firmware
+```bash
+> mpflash flash
+22:15:55 | ℹ️  - Using latest stable version: v1.22.2
+                                       Connected boards
+┏━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┳━━━━━━━┓
+┃ Serial ┃ Family      ┃ Port    ┃ Board              ┃ CPU         ┃ Version        ┃ build ┃
+┡━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━╇━━━━━━━┩
+│ COM11  │ micropython │ rp2     │ RPI_PICO_W         │ RP2040      │ 1.20.0         │       │
+│ COM12  │ micropython │ esp8266 │ ESP8266_GENERIC    │ ESP8266     │ 1.22.2         │       │
+│ COM18  │ micropython │ rp2     │ RPI_PICO_W         │ RP2040      │ 1.23.0-preview │ 155   │
+│ COM3   │ micropython │ samd    │ SEEED_WIO_TERMINAL │ SAMD51P19A  │ 1.23.0-preview │ 155   │
+│ COM5   │ micropython │ stm32   │ PYBV11             │ STM32F405RG │ 1.23.0-preview │ 166   │
+│ COM8   │ micropython │ esp32   │ ESP32_GENERIC_S3   │ ESP32S3     │ 1.23.0-preview │ 155   │
+└────────┴─────────────┴─────────┴────────────────────┴─────────────┴────────────────┴───────┘
+22:15:58 | ℹ️  - Found v1.22.2 firmware rp2\RPI_PICO_W-v1.22.2.uf2 for RPI_PICO_W on COM11.
+22:15:58 | ℹ️  - Found v1.22.2 firmware esp8266\ESP8266_GENERIC-v1.22.2.bin for ESP8266_GENERIC on COM12.
+22:15:58 | ℹ️  - Found v1.22.2 firmware rp2\RPI_PICO_W-v1.22.2.uf2 for RPI_PICO_W on COM18.
+22:15:58 | ℹ️  - Found v1.22.2 firmware samd\SEEED_WIO_TERMINAL-v1.22.2.uf2 for SEEED_WIO_TERMINAL on COM3.
+22:15:58 | ⚠️  - Trying to find a firmware for the board PYBV11
+22:15:58 | ❌  - No v1.22.2 firmware found for PYBV11 on COM5.
+22:15:58 | ⚠️  - Trying to find a firmware for the board ESP32-GENERIC-S3
+22:15:58 | ❌  - No v1.22.2 firmware found for ESP32_GENERIC_S3 on COM8.
+22:15:58 | ℹ️  - Updating RPI_PICO_W on COM11 to 1.22.2
+22:15:58 | ℹ️  - Erasing not yet implemented for UF2 flashing.
+22:15:58 | ℹ️  - Entering UF2 bootloader on RPI_PICO_W on COM11
+22:15:58 | ℹ️  - Waiting for mcu to mount as a drive : 10 seconds left
+22:15:59 | ℹ️  - Waiting for mcu to mount as a drive : 9 seconds left
+22:16:00 | ℹ️  - Board is in bootloader mode
+22:16:00 | ℹ️  - Copying firmware\rp2\RPI_PICO_W-v1.22.2.uf2 to F:
+22:16:13 | ✅  - Done copying, resetting the board and wait for it to restart
+22:16:23 | ℹ️  - Updating ESP8266_GENERIC on COM12 to 1.22.2
+22:16:23 | ℹ️  - Flashing firmware\esp8266\ESP8266_GENERIC-v1.22.2.bin on ESP8266_GENERIC on COM12
+22:16:23 | ℹ️  - Running esptool --chip ESP8266 --port COM12 erase_flash 
+esptool.py v4.7.0
+Serial port COM12
+Connecting....
+...
+Chip erase completed successfully in 6.5s
+Hard resetting via RTS pin...
+22:16:31 | ℹ️  - Running esptool --chip ESP8266 --port COM12 -b 460800 write_flash --flash_size=detect 0x0 firmware\esp8266\ESP8266_GENERIC-v1.22.2.bin 
+esptool.py v4.7.0
+Serial port COM12
+Connecting....
+...
+Leaving...
+Hard resetting via RTS pin...
+22:16:43 | ℹ️  - Done flashing, resetting the board and wait for it to restart
+22:16:49 | ✅  - Flashed 1.22.2 to ESP8266_GENERIC on COM12 done
+22:16:49 | ℹ️  - Updating RPI_PICO_W on COM18 to 1.22.2
+22:16:49 | ℹ️  - Erasing not yet implemented for UF2 flashing.
+22:16:49 | ℹ️  - Entering UF2 bootloader on RPI_PICO_W on COM18
+22:16:49 | ℹ️  - Waiting for mcu to mount as a drive : 10 seconds left
+22:16:50 | ℹ️  - Waiting for mcu to mount as a drive : 9 seconds left
+22:16:51 | ℹ️  - Board is in bootloader mode
+22:16:51 | ℹ️  - Copying firmware\rp2\RPI_PICO_W-v1.22.2.uf2 to F:[/bold]
+22:17:02 | ✅  - Done copying, resetting the board and wait for it to restart
+22:17:12 | ℹ️  - Updating SEEED_WIO_TERMINAL on COM3 to 1.22.2
+22:17:12 | ℹ️  - Erasing not yet implemented for UF2 flashing.
+22:17:12 | ℹ️  - Entering UF2 bootloader on SEEED_WIO_TERMINAL on COM3
+22:17:12 | ℹ️  - Waiting for mcu to mount as a drive : 10 seconds left
+22:17:13 | ℹ️  - Waiting for mcu to mount as a drive : 9 seconds left
+22:17:14 | ℹ️  - Board is in bootloader mode
+22:17:14 | ℹ️  - Copying firmware\samd\SEEED_WIO_TERMINAL-v1.22.2.uf2 to F:[/bold]
+22:17:17 | ✅  - Done copying, resetting the board and wait for it to restart
+22:17:27 | ℹ️  - Flashed 4 boards
+                               Connected boards after flashing
+┏━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┳━━━━━━━┓
+┃ Serial ┃ Family      ┃ Port    ┃ Board              ┃ CPU         ┃ Version        ┃ build ┃
+┡━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━╇━━━━━━━┩
+│ COM11  │ micropython │ rp2     │ RPI_PICO_W         │ RP2040      │ 1.22.2         │       │
+│ COM12  │ micropython │ esp8266 │ ESP8266_GENERIC    │ ESP8266     │ 1.22.2         │       │
+│ COM18  │ micropython │ rp2     │ RPI_PICO_W         │ RP2040      │ 1.22.2         │       │
+│ COM3   │ micropython │ samd    │ SEEED_WIO_TERMINAL │ SAMD51P19A  │ 1.22.2         │       │
+│ COM5   │ micropython │ stm32   │ PYBV11             │ STM32F405RG │ 1.23.0-preview │ 166   │
+│ COM8   │ micropython │ esp32   │ ESP32_GENERIC_S3   │ ESP32S3     │ 1.23.0-preview │ 155   │
+└────────┴─────────────┴─────────┴────────────────────┴─────────────┴────────────────┴───────┘
+```
+Note that if no matching firmware can be found for a board, it will be skipped.
+(For example, the PYBV11 and ESP32_GENERIC_S3 boards in the example above.)
+
+## Issues and bug reports
+mpflash is currently co-located in the [micropython-stubber](https://github.com/Josverl/micropython-stubber) repository.  
+Please report any issues or bugs in the [issue tracker](https://github.com/Josverl/micropython-stubber/issues) using the MPflash feedback template.
+
+## License
+mpflash is licensed under the MIT license. See the LICENSE file for more details.

{mpflash-0.8.5 → mpflash-0.8.8}/mpflash/add_firmware.py

@@ -1,98 +1,98 @@
-import shutil
-from pathlib import Path
-from typing import Union
-
-import jsonlines
-import requests
-from loguru import logger as log
-
-# re-use logic from mpremote
-from mpremote.mip import _rewrite_url as rewrite_url  # type: ignore
-
-from mpflash.common import FWInfo
-from mpflash.config import config
-from mpflash.vendor.versions import get_preview_mp_version, get_stable_mp_version
-
-
-def add_firmware(
-    source: Union[Path, str],
-    new_fw: FWInfo,
-    *,
-    force: bool = False,
-    custom: bool = False,
-    description: str = "",
-) -> bool:
-    """Add a firmware to the firmware folder.
-
-    stored in the port folder, with the same filename as the source.
-
-    """
-    # Check minimal info needed
-    if not new_fw.port or not new_fw.board:
-        log.error("Port and board are required")
-        return False
-    if not isinstance(source, Path) and not source.startswith("http"):
-        log.error(f"Invalid source {source}")
-        return False
-
-    # use sensible defaults
-    source_2 = Path(source)
-    new_fw.ext = new_fw.ext or source_2.suffix
-    new_fw.variant = new_fw.variant or new_fw.board
-    new_fw.custom = new_fw.custom or custom
-    new_fw.description = new_fw.description or description
-    if not new_fw.version:
-        # TODO: Get version from filename
-        # or use the last preview version
-        new_fw.version = get_preview_mp_version() if new_fw.preview else get_stable_mp_version()
-
-    config.firmware_folder.mkdir(exist_ok=True)
-
-    fw_filename = config.firmware_folder / new_fw.port / source_2.name
-
-    new_fw.filename = str(fw_filename.relative_to(config.firmware_folder))
-    new_fw.firmware = source.as_uri() if isinstance(source, Path) else source
-
-    if not copy_firmware(source, fw_filename, force):
-        log.error(f"Failed to copy {source} to {fw_filename}")
-        return False
-    # add to inventory
-    with jsonlines.open(config.firmware_folder / "firmware.jsonl", "a") as writer:
-        log.info(f"Adding {new_fw.port} {new_fw.board}")
-        log.info(f"    to {fw_filename}")
-
-        writer.write(new_fw.to_dict())
-    return True
-
-
-def copy_firmware(source: Union[Path, str], fw_filename: Path, force: bool = False):
-    """Add a firmware to the firmware folder.
-    stored in the port folder, with the same filename as the source.
-    """
-    if fw_filename.exists() and not force:
-        log.error(f" {fw_filename} already exists. Use --force to overwrite")
-        return False
-    fw_filename.parent.mkdir(exist_ok=True)
-    if isinstance(source, Path):
-        if not source.exists():
-            log.error(f"File {source} does not exist")
-            return False
-        # file copy
-        log.debug(f"Copy {source} to {fw_filename}")
-        shutil.copy(source, fw_filename)
-        return True
-    # handle github urls
-    url = rewrite_url(source)
-    if str(source).startswith("http://") or str(source).startswith("https://"):
-        log.debug(f"Download {url} to {fw_filename}")
-        response = requests.get(url)
-
-        if response.status_code == 200:
-            with open(fw_filename, "wb") as file:
-                file.write(response.content)
-                log.info("File downloaded and saved successfully.")
-                return True
-        else:
-            print("Failed to download the file.")
-            return False
-    return False
+import shutil
+from pathlib import Path
+from typing import Union
+
+import jsonlines
+import requests
+from loguru import logger as log
+
+# re-use logic from mpremote
+from mpremote.mip import _rewrite_url as rewrite_url  # type: ignore
+
+from mpflash.common import FWInfo
+from mpflash.config import config
+from mpflash.vendor.versions import get_preview_mp_version, get_stable_mp_version
+
+
+def add_firmware(
+    source: Union[Path, str],
+    new_fw: FWInfo,
+    *,
+    force: bool = False,
+    custom: bool = False,
+    description: str = "",
+) -> bool:
+    """Add a firmware to the firmware folder.
+
+    stored in the port folder, with the same filename as the source.
+
+    """
+    # Check minimal info needed
+    if not new_fw.port or not new_fw.board:
+        log.error("Port and board are required")
+        return False
+    if not isinstance(source, Path) and not source.startswith("http"):
+        log.error(f"Invalid source {source}")
+        return False
+
+    # use sensible defaults
+    source_2 = Path(source)
+    new_fw.ext = new_fw.ext or source_2.suffix
+    new_fw.variant = new_fw.variant or new_fw.board
+    new_fw.custom = new_fw.custom or custom
+    new_fw.description = new_fw.description or description
+    if not new_fw.version:
+        # TODO: Get version from filename
+        # or use the last preview version
+        new_fw.version = get_preview_mp_version() if new_fw.preview else get_stable_mp_version()
+
+    config.firmware_folder.mkdir(exist_ok=True)
+
+    fw_filename = config.firmware_folder / new_fw.port / source_2.name
+
+    new_fw.filename = str(fw_filename.relative_to(config.firmware_folder))
+    new_fw.firmware = source.as_uri() if isinstance(source, Path) else source
+
+    if not copy_firmware(source, fw_filename, force):
+        log.error(f"Failed to copy {source} to {fw_filename}")
+        return False
+    # add to inventory
+    with jsonlines.open(config.firmware_folder / "firmware.jsonl", "a") as writer:
+        log.info(f"Adding {new_fw.port} {new_fw.board}")
+        log.info(f"    to {fw_filename}")
+
+        writer.write(new_fw.to_dict())
+    return True
+
+
+def copy_firmware(source: Union[Path, str], fw_filename: Path, force: bool = False):
+    """Add a firmware to the firmware folder.
+    stored in the port folder, with the same filename as the source.
+    """
+    if fw_filename.exists() and not force:
+        log.error(f" {fw_filename} already exists. Use --force to overwrite")
+        return False
+    fw_filename.parent.mkdir(exist_ok=True)
+    if isinstance(source, Path):
+        if not source.exists():
+            log.error(f"File {source} does not exist")
+            return False
+        # file copy
+        log.debug(f"Copy {source} to {fw_filename}")
+        shutil.copy(source, fw_filename)
+        return True
+    # handle github urls
+    url = rewrite_url(source)
+    if str(source).startswith("http://") or str(source).startswith("https://"):
+        log.debug(f"Download {url} to {fw_filename}")
+        response = requests.get(url)
+
+        if response.status_code == 200:
+            with open(fw_filename, "wb") as file:
+                file.write(response.content)
+                log.info("File downloaded and saved successfully.")
+                return True
+        else:
+            print("Failed to download the file.")
+            return False
+    return False