MicroPython
🎺Introducing mpflash: Your Ultimate MicroPython Flashing Companion #14395
Replies: 12 comments 42 replies
-
|
Nice! Is there a way to select and flash a custom built firmware from a local file system? |
Beta Was this translation helpful? Give feedback.
-
|
I've been thinking about it, but its not there yet, but the setup allows for it to be added without too much effort. |
Beta Was this translation helpful? Give feedback.
-
|
Looks really impressive, great job. I look forward to testing it more when I've got a supported board connected :-D |
Beta Was this translation helpful? Give feedback.
-
|
very interested in results of boards that i've not been able to test |
Beta Was this translation helpful? Give feedback.
-
|
Looks great @Josverl! Just installed (on WSL2/Win10) using I put it through a very tough test case: Traceback (most recent call last):
[snip]
File "/root/.local/pipx/venvs/mpflash/lib/python3.10/site-packages/mpflash/mpremoteboard/__init__.py", line 119, in get_mcu_info
if board_name := find_board_id(descr, short_descr):
File "/root/.local/pipx/venvs/mpflash/lib/python3.10/site-packages/mpflash/mpboard_id/board_id.py", line 22, in find_board_id
boards = find_board_by_description(
File "/root/.local/pipx/venvs/mpflash/lib/python3.10/site-packages/mpflash/mpboard_id/board_id.py", line 55, in find_board_by_description
raise MPFlashError(f"No board info found for description {descr}")
mpflash.errors.MPFlashError: No board info found for description ESP32C6 module with ESP32C6Message could be friendlier but the raised exception is correct. :) I'll continue trying it out... |
Beta Was this translation helpful? Give feedback.
-
|
Hehe @mattytrentini I tried the exact same thing earlier today, had the same conclusion about the message and raised a new issue on @Josverl repo tracker :-D |
Beta Was this translation helpful? Give feedback.
-
|
This issue is fixed, boards for which the description cannot be resolved are reported as UNKNOWN_BOARD in the output table or Json. |
Beta Was this translation helpful? Give feedback.
-
|
Yep, can confirm! Nice work. > mpflash list
Connected boards
┏━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━┓
┃ Serial ┃Family ┃Port ┃Board ┃CPU ┃Version ┃build ┃
┡━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━━━┩
│ ttyACM0 │micropython │esp32 │UNKNOWN_BOARD │ESP32C6 │v1.23.0-preview │ 643 │
│ │ │ │M5Stack NanoC6 with ESP32C6 │ │ │ │
└───────────┴───────────────┴────────┴─────────────────────────────────┴──────────┴───────────────────┴──────┘ |
Beta Was this translation helpful? Give feedback.
-
|
Also a particularly nasty test case: mpflash list
Error: Failed to get mcu_info for /dev/ttyACM4
Connected boards
┏━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┳━━━━━━┓
┃ Serial ┃Family ┃Port ┃Board ┃CPU ┃Version ┃build ┃
┡━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━╇━━━━━━┩
│ ttyACM0 │micropython │esp32 │UNKNOWN_BOARD │ESP32C6 │v1.23.0-preview │ 643 │
│ │ │ │M5Stack NanoC6 with ESP32C6 │ │ │ │
│ ttyACM1 │micropython │rp2 │UNKNOWN_BOARD │RP2040 │v1.23.0-preview │ 634 │
│ │ │ │Seeed Studio XIAO RP2040 with RP2040 │ │ │ │
│ ttyACM2 │micropython │esp32 │UNKNOWN_BOARD │ESP32-S3 │v1.23.0-preview │ 637 │
│ │ │ │M5Stack Dial with ESP32-S3 │ │ │ │
│ ttyACM3 │micropython │stm32 │UNKNOWN_BOARD │STM32WB55RGV6 │v1.22.0-preview │ │
│ │ │ │XXXXXX-NUCLEO-WB55 with STM32WB55RGV6 │ │ │ │
│ ttyACM4 │unknown │ │ │ │ │ │
│ ttyUSB0 │micropython │esp32 │M5STACK_ATOM │ESP32-PICO-D4 │v1.23.0-preview │ 334 │
│ │ │ │M5Stack ATOM with ESP32-PICO-D4 │ │ │ │
└──────────┴────────────┴──────┴──────────────────────────────────────┴──────────────┴────────────────┴──────┘Correctly extracted all of the USB information for each board (even a custom board for work) and correctly identified the M5Stack ATOM as the only board where there was downloadable firmware. The only part that confused it a little is with |
Beta Was this translation helpful? Give feedback.
-
|
you can add There are quite a few UNKNOWN_BOARDS, do you have all these defined in a local micropython repo ? |
Beta Was this translation helpful? Give feedback.
-
|
I like it! It doesn't seem to be able to download Pico W firmware, though: |
Beta Was this translation helpful? Give feedback.
-
|
the recent rename of the board_id aka folder names for the rp2 and esp32 / esp8266 have caused me more than a little headaches in matching the same boards before and after the rename occurred. especially as the rename has been done retrospectivly for micropython.org/downloads I'll look into it - and start by improving the tests |
Beta Was this translation helpful? Give feedback.
-
|
@scruss , the issue was not what I initially suspected. When specifying a --board , but no --port for download, there was no code to lookup the missing port(s) from the board. |
Beta Was this translation helpful? Give feedback.
-
|
Has anyone been able to test this on MacOS ? |
Beta Was this translation helpful? Give feedback.
-
|
Thanks for sharing, seems like some work is needed here. What is the output of |
Beta Was this translation helpful? Give feedback.
-
|
mpremote devs shows: The esp32 board, as far as I remember, has not been used before and has sat in my drawer for several years :) Just in case its relevent just mpremote shows: rst:0x1 (POWERON_RESET),boot:0x13 (SPI_FAST_FLASH_BOOT) |
Beta Was this translation helpful? Give feedback.
-
|
Hi again, I connected up an old rpi pico board and tried an mpflash list and things look more promising. So maybe just something to do with my ESP32 in the previous test. For the pico I get the following: 
|
Beta Was this translation helpful? Give feedback.
-
|
To round off the test on the rpi pico, no luck so far. I had done a mpflash download and it downloaded the appropriate mp. I then did a mpflash flash and got a choice of port / board to select but got some errors about something would only run on linux when appropriate choices were made. I did not take a note of this as to start with I wanted to get rid of some of those ports I no longer use as your program took some while to examine them. Now, whilst I can see the pico in the mpflash list, a mpflash download reports already downloaded, but a mpflash flash now never gets to the point of providing a list of what to flash. I always just get the following: |
Beta Was this translation helpful? Give feedback.
-
|
Thanks for the test and logs so far On the extra serialports, there is an - - ignore switch to avoid wasting time on them. I already try to filter out serial over Bluetooth, but that did not work in this case. On the esp32 board, it appears that it did not have micropython on it. I need to find a way to make that discoverable somehow. For the rp2 I'll open an issue, lest continue the conversation there. |
Beta Was this translation helpful? Give feedback.
-
|
Interesting tool. It doesn't exactly match my usecase (I grab a custom image from a specific URL and flash it) so I started some tinkering. I extended both the download and flash commands with a --raw option. Worked fine for my rp2040. Weeding through the code is a bit frustrating, it is very much tuned to the specific usecase of first downloading and then flashing multiple boards of multiple types. After the rp2040 I tried an esp32, but the tool doesn't recognise the particular board "ESP32_UNKNOWN_BOARD". Correcting that seems to require a deeper dive that I want to commit to today. For now, I give up. |
Beta Was this translation helpful? Give feedback.
-
|
The board options all seem to be for specific boards. I don't think you will ever get those lists complete. In most cases I don't care for a particular board. Could you (for each port) add a generic board? (and for the esp32's for which this is relevant: with and without spiram) You call 'esp32' a port, but I think its should be esp32, esp32c2, esp32c3, esp32s2, esp32s3, etc. Otherwise you'd need generic boards for each of those chips. |
Beta Was this translation helpful? Give feedback.
-
|
The Total number of boards found: 2217 Currently the table is used to do a reverse lookup from description to ID - so not all boards have to be stored. Details``` Found 43 board definitions for v1.10. Found 47 board definitions for v1.11. Found 74 board definitions for v1.12. Found 83 board definitions for v1.13. Found 84 board definitions for v1.14. Found 88 board definitions for v1.15. Found 97 board definitions for v1.16. Found 110 board definitions for v1.17. Found 125 board definitions for v1.18. Found 142 board definitions for v1.19. Found 142 board definitions for v1.19.1. Found 161 board definitions for v1.20.0. Found 166 board definitions for v1.21.0. Found 171 board definitions for v1.22.0. Found 171 board definitions for v1.22.1. Found 171 board definitions for v1.22.2. Found 171 board definitions for v1.23.0-preview. Found 171 board definitions for master. 0:00:17 Total number of boards found: 2217 Unique board descriptions found: 225 ``` |
Beta Was this translation helpful? Give feedback.
-
|
OK. The MicroPython repo has 'generic' targets. Could you include those? |
Beta Was this translation helpful? Give feedback.
-
|
AFAIK Only the ESPxx have GENERIC targets -and they are already included - but variants may be missing. A quick few samples:
Details
and |
Beta Was this translation helpful? Give feedback.
-
|
I'll try (probably in the weekend) |
Beta Was this translation helpful? Give feedback.
-
|
Not sure if this is of any help. I'm quite new to Micropython. This is a cut / paste from the Command Prompt: C:\Users\Owner>mpflash list ┏━━━━━━┳━━━━━━━━━━━┳━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━┓ C:\Users\Owner>mpflash download Traceback (most recent call last): The above exception was the direct cause of the following exception: Traceback (most recent call last): The above exception was the direct cause of the following exception: Traceback (most recent call last): During handling of the above exception, another exception occurred: Traceback (most recent call last): C:\Users\Owner> |
Beta Was this translation helpful? Give feedback.
-
|
@garryp4 - thanks for the feelback.
Lets continue on : Josverl/micropython-stubber#562 |
Beta Was this translation helpful? Give feedback.
-
|
Interesting utility. I gave it a quick try to see what it could provide me. |
Beta Was this translation helpful? Give feedback.
-
|
Yep.. that can work. I didn't know aobut the --serial param. it doesn't show when you run mpflash --help |
Beta Was this translation helpful? Give feedback.
-
currently --serial is used to specify which board to flash, but I can add it for list as well |
Beta Was this translation helpful? Give feedback.
-
|
About SAMD: A fresh SAMD board with the uf2 bootloader installed only switches to .UF2 mode by pushing reset twice at the proper pace, whatever it is. Once MicroPython is installed, one can use the touch1200 method: switch USB serial speed to 1200 boad and back to 115200. |
Beta Was this translation helpful? Give feedback.
-
And indeed I'll need to add a way to pause for a human to press a button for some scenarios |
Beta Was this translation helpful? Give feedback.
-
|
The 1200-bps-touch reset can be enabled in most ports I think, though it's not on by default on many boards. I think it's a usage pattern common on Arduino and/or Adafruit gear? Do a global search for |
Beta Was this translation helpful? Give feedback.
-
|
Thanks for talking about this at the meetup! I'm on a Mac and have a bunch of ports that I don't want it to scan... so I set |
Beta Was this translation helpful? Give feedback.
-
|
looking back up the thread it seems like this may be another case of macOS and Bluetooth serial ports not being known about. It would be great to have a "known to never have a MPY board on it" list of ports to skip, it would make things much quicker 🙂 |
Beta Was this translation helpful? Give feedback.
-
|
This behaviour is not expected: It does not make sense (to me) that it is scanning those ports when I've explicitly told it which serial port to target? Additionally, I actually would like to flash a Pimoroni build of MicroPython onto |
Beta Was this translation helpful? Give feedback.
-
|
@andypiper , I have been working on a revamp of the
Sure , just set MPFLASH_IGNORE in your environment Flashing .uf2 on Macos |
Beta Was this translation helpful? Give feedback.
-
|
If you want to test the flashing of .UF2 devices on MacOS, |
Beta Was this translation helpful? Give feedback.
-
|
Update : |
Beta Was this translation helpful? Give feedback.
-
|
A note on downloading the new v1.23.0 release. In v0.8.1 I have improved the version regex used to extract the version and build from the downloadable firmware filenames, |
Beta Was this translation helpful? Give feedback.
-
|
There was an issue with the build server that has since been resolved - hopefully it's no longer a problem for mpflash? |
Beta Was this translation helpful? Give feedback.
-
|
Has anyone tried mpflash with a pyboard? I suppose it is a problem of the pyboard, but would like to get feedback before inquiring how |
Beta Was this translation helpful? Give feedback.
-
|
I have tested mpflash against a Pybv11 on Windows and Ubuntu. The script I test in CI D on a significant range of micropython versions as well.. Are you able to access your board using mpremote? If so can you run this script https://github.com/Josverl/micropython-stubber/blob/main/src%2Fmpflash%2Fmpflash%2Fmpremoteboard%2Fmpy_fw_info.py ? |
Beta Was this translation helpful? Give feedback.
-
|
|
Beta Was this translation helpful? Give feedback.
-
|
I retested on Windows 11 and Ubuntu 22.04 with just a PyB and other boards attached and found no issues with mpflash. |
Beta Was this translation helpful? Give feedback.
-
|
Wow! This really takes the pain out of the firmware flashing process. Nice work! Tested successfully on Raspberry Pi Bookworm (64-bit) with an ESP32C3, if you're keeping track. |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
Hello fellow MicroPythonista
Are you tired of juggling different boards and struggling to remember the exact flashing procedures for each one? I feel your pain. That's why I created mpflash, a simple but powerful tool designed to simplify the entire process.
What is mpflash?
Features:
Tested and Approved:
Your Mission:
Can you help by testing and providing feedback?
Let's make mpflash even better!
Installation:
To get started, simply install mpflash using pip(x):
pipx install mpflash #or pip install mpflashBasic Usage:
Here's how you can use mpflash:
Dive Deeper:
For detailed documentation, visit our [GitHub page](https://github.com/Josverl/micropython-stubber/tree/main/src/mpflash).
https://pypi.org/project/mpflash/ ""
Got Issues?
mpflash resides in the [micropython-stubber repository](https://github.com/Josverl/micropython-stubber/issues%29). If you encounter any bugs or issues, report them in the [issue tracker](https://github.com/Josverl/micropython-stubber/issues) (select MPFlash feedback).
Let's make MicroPython flashing a breeze! 💡🚀
Beta Was this translation helpful? Give feedback.
All reactions