micropython-stubber 1.20.4__py3-none-any.whl → 1.20.6__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (152) hide show
  1. {micropython_stubber-1.20.4.dist-info → micropython_stubber-1.20.6.dist-info}/LICENSE +30 -30
  2. {micropython_stubber-1.20.4.dist-info → micropython_stubber-1.20.6.dist-info}/METADATA +4 -4
  3. micropython_stubber-1.20.6.dist-info/RECORD +159 -0
  4. mpflash/README.md +184 -184
  5. mpflash/libusb_flash.ipynb +203 -203
  6. mpflash/mpflash/add_firmware.py +98 -98
  7. mpflash/mpflash/ask_input.py +236 -226
  8. mpflash/mpflash/bootloader/__init__.py +37 -0
  9. mpflash/mpflash/bootloader/manual.py +102 -0
  10. mpflash/mpflash/bootloader/micropython.py +10 -0
  11. mpflash/mpflash/bootloader/touch1200.py +45 -0
  12. mpflash/mpflash/cli_download.py +129 -128
  13. mpflash/mpflash/cli_flash.py +219 -212
  14. mpflash/mpflash/cli_group.py +98 -92
  15. mpflash/mpflash/cli_list.py +81 -77
  16. mpflash/mpflash/cli_main.py +41 -38
  17. mpflash/mpflash/common.py +164 -151
  18. mpflash/mpflash/config.py +47 -31
  19. mpflash/mpflash/connected.py +74 -74
  20. mpflash/mpflash/download.py +360 -361
  21. mpflash/mpflash/downloaded.py +129 -129
  22. mpflash/mpflash/errors.py +9 -5
  23. mpflash/mpflash/flash.py +52 -69
  24. mpflash/mpflash/flash_esp.py +59 -59
  25. mpflash/mpflash/flash_stm32.py +24 -24
  26. mpflash/mpflash/flash_stm32_cube.py +111 -111
  27. mpflash/mpflash/flash_stm32_dfu.py +101 -101
  28. mpflash/mpflash/flash_uf2.py +67 -67
  29. mpflash/mpflash/flash_uf2_boardid.py +15 -15
  30. mpflash/mpflash/flash_uf2_linux.py +123 -123
  31. mpflash/mpflash/flash_uf2_macos.py +34 -37
  32. mpflash/mpflash/flash_uf2_windows.py +34 -34
  33. mpflash/mpflash/list.py +89 -89
  34. mpflash/mpflash/logger.py +41 -41
  35. mpflash/mpflash/mpboard_id/__init__.py +93 -93
  36. mpflash/mpflash/mpboard_id/add_boards.py +255 -255
  37. mpflash/mpflash/mpboard_id/board.py +37 -37
  38. mpflash/mpflash/mpboard_id/board_id.py +86 -86
  39. mpflash/mpflash/mpboard_id/store.py +43 -43
  40. mpflash/mpflash/mpremoteboard/__init__.py +221 -221
  41. mpflash/mpflash/mpremoteboard/mpy_fw_info.py +141 -141
  42. mpflash/mpflash/mpremoteboard/runner.py +140 -140
  43. mpflash/mpflash/uf2disk.py +12 -12
  44. mpflash/mpflash/vendor/basicgit.py +288 -288
  45. mpflash/mpflash/vendor/click_aliases.py +91 -0
  46. mpflash/mpflash/vendor/dfu.py +165 -165
  47. mpflash/mpflash/vendor/pydfu.py +605 -605
  48. mpflash/mpflash/vendor/readme.md +2 -2
  49. mpflash/mpflash/vendor/versions.py +119 -117
  50. mpflash/mpflash/worklist.py +170 -170
  51. mpflash/poetry.lock +1588 -1623
  52. mpflash/pyproject.toml +60 -60
  53. mpflash/stm32_udev_rules.md +62 -62
  54. stubber/__init__.py +3 -3
  55. stubber/basicgit.py +294 -288
  56. stubber/board/board_info.csv +193 -193
  57. stubber/board/boot.py +34 -34
  58. stubber/board/createstubs.py +986 -987
  59. stubber/board/createstubs_db.py +825 -826
  60. stubber/board/createstubs_db_min.py +331 -331
  61. stubber/board/createstubs_db_mpy.mpy +0 -0
  62. stubber/board/createstubs_lvgl.py +741 -741
  63. stubber/board/createstubs_lvgl_min.py +741 -741
  64. stubber/board/createstubs_mem.py +766 -767
  65. stubber/board/createstubs_mem_min.py +306 -306
  66. stubber/board/createstubs_mem_mpy.mpy +0 -0
  67. stubber/board/createstubs_min.py +294 -294
  68. stubber/board/createstubs_mpy.mpy +0 -0
  69. stubber/board/fw_info.py +141 -141
  70. stubber/board/info.py +183 -183
  71. stubber/board/main.py +19 -19
  72. stubber/board/modulelist.txt +247 -247
  73. stubber/board/pyrightconfig.json +34 -34
  74. stubber/bulk/mcu_stubber.py +454 -455
  75. stubber/codemod/_partials/__init__.py +48 -50
  76. stubber/codemod/_partials/db_main.py +147 -147
  77. stubber/codemod/_partials/lvgl_main.py +77 -77
  78. stubber/codemod/_partials/modules_reader.py +80 -80
  79. stubber/codemod/add_comment.py +53 -53
  80. stubber/codemod/add_method.py +65 -65
  81. stubber/codemod/board.py +317 -317
  82. stubber/codemod/enrich.py +145 -145
  83. stubber/codemod/merge_docstub.py +284 -284
  84. stubber/codemod/modify_list.py +54 -54
  85. stubber/codemod/utils.py +57 -57
  86. stubber/commands/build_cmd.py +94 -94
  87. stubber/commands/cli.py +51 -51
  88. stubber/commands/clone_cmd.py +66 -66
  89. stubber/commands/config_cmd.py +29 -29
  90. stubber/commands/enrich_folder_cmd.py +70 -70
  91. stubber/commands/get_core_cmd.py +69 -69
  92. stubber/commands/get_docstubs_cmd.py +87 -87
  93. stubber/commands/get_frozen_cmd.py +112 -112
  94. stubber/commands/get_mcu_cmd.py +56 -56
  95. stubber/commands/merge_cmd.py +66 -66
  96. stubber/commands/publish_cmd.py +119 -119
  97. stubber/commands/stub_cmd.py +30 -30
  98. stubber/commands/switch_cmd.py +54 -54
  99. stubber/commands/variants_cmd.py +48 -48
  100. stubber/cst_transformer.py +178 -178
  101. stubber/data/board_info.csv +193 -193
  102. stubber/data/board_info.json +1729 -1729
  103. stubber/data/micropython_tags.csv +15 -15
  104. stubber/data/requirements-core-micropython.txt +38 -38
  105. stubber/data/requirements-core-pycopy.txt +39 -39
  106. stubber/downloader.py +36 -36
  107. stubber/freeze/common.py +68 -68
  108. stubber/freeze/freeze_folder.py +69 -69
  109. stubber/freeze/freeze_manifest_2.py +113 -113
  110. stubber/freeze/get_frozen.py +127 -127
  111. stubber/get_cpython.py +101 -101
  112. stubber/get_lobo.py +59 -59
  113. stubber/minify.py +418 -418
  114. stubber/publish/bump.py +86 -86
  115. stubber/publish/candidates.py +262 -283
  116. stubber/publish/database.py +18 -18
  117. stubber/publish/defaults.py +45 -45
  118. stubber/publish/enums.py +24 -30
  119. stubber/publish/helpers.py +29 -29
  120. stubber/publish/merge_docstubs.py +130 -130
  121. stubber/publish/missing_class_methods.py +49 -49
  122. stubber/publish/package.py +146 -177
  123. stubber/publish/pathnames.py +51 -51
  124. stubber/publish/publish.py +120 -121
  125. stubber/publish/pypi.py +38 -38
  126. stubber/publish/stubpackage.py +1029 -1029
  127. stubber/rst/__init__.py +9 -9
  128. stubber/rst/classsort.py +77 -77
  129. stubber/rst/lookup.py +530 -530
  130. stubber/rst/output_dict.py +401 -401
  131. stubber/rst/reader.py +822 -823
  132. stubber/rst/report_return.py +69 -69
  133. stubber/rst/rst_utils.py +540 -540
  134. stubber/stubber.py +38 -38
  135. stubber/stubs_from_docs.py +90 -90
  136. stubber/tools/manifestfile.py +610 -610
  137. stubber/tools/readme.md +5 -5
  138. stubber/update_fallback.py +117 -117
  139. stubber/update_module_list.py +123 -125
  140. stubber/utils/__init__.py +5 -5
  141. stubber/utils/config.py +127 -127
  142. stubber/utils/makeversionhdr.py +54 -54
  143. stubber/utils/manifest.py +92 -92
  144. stubber/utils/post.py +79 -79
  145. stubber/utils/repos.py +157 -154
  146. stubber/utils/stubmaker.py +139 -139
  147. stubber/utils/typed_config_toml.py +77 -77
  148. stubber/utils/versions.py +128 -120
  149. stubber/variants.py +106 -106
  150. micropython_stubber-1.20.4.dist-info/RECORD +0 -154
  151. {micropython_stubber-1.20.4.dist-info → micropython_stubber-1.20.6.dist-info}/WHEEL +0 -0
  152. {micropython_stubber-1.20.4.dist-info → micropython_stubber-1.20.6.dist-info}/entry_points.txt +0 -0
mpflash/README.md CHANGED
@@ -1,184 +1,184 @@
1
- # MPFLASH
2
- [![pypi version](https://badgen.net/pypi/v/mpflash)](https://pypi.org/project/mpflash/)
3
- [![python versions](https://badgen.net/pypi/python/mpflash)](https://badgen.net/pypi/python/mpflash)
4
- [![Downloads](https://static.pepy.tech/badge/mpflash)](https://pepy.tech/project/mpflash)
5
-
6
-
7
- `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 .
8
-
9
- 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.
10
-
11
- `mpflash` has been tested on:
12
- - OS: Windows x64, Linux X64, but not (yet) macOS.
13
- - Micropython (hardware) ports:
14
- - `rp2`, using `.uf2`, using filecopy (macos not tested yet)
15
- - `samd`, using ` .uf2`, using filecopy (macos not tested yet)
16
- - `esp32`, using `.bin`, using esptool,
17
- - `esp8266`, using `.bin`, using esptool
18
- - `stm32`, using ` .dfu`, using pydfu
19
-
20
- Not yet implemented: `nrf`, `cc3200`, `mimxrt`
21
-
22
- ## Features
23
- 1. List the connected boards including their firmware details, in a tabular or json format
24
- 2. Download MicroPython firmware for versions, and matching a specified board or matches your current attached board.
25
- 3. Flash one or all connected MicroPython boards with a specific firmware or version.
26
-
27
- ## Installation
28
- To install mpflash, you can use pip: `pip install mpflash`
29
-
30
- ## Basic usage
31
- You can use mpflash to perform various operations on your MicroPython boards. Here is an example of basic usage:
32
-
33
- | Command | Description |
34
- |---------|-------------|
35
- | `mpflash list` | List the connected board(s) including their firmware details |
36
- | `mpflash download` | Download the MicroPython firmware(s) for the connected board(s) |
37
- | `mpflash flash` | Flash the latest stable firmware to the connected board(s) |
38
-
39
-
40
- ## Linux permissions to access usb devices
41
- In order to flash the firmware to the board, you need to have the correct permissions to access the USB devices.
42
- 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.
43
- [See the stm32_permissions documentation](./stm32_udev_rules.md) for more information.
44
-
45
-
46
- ## Detailed usage
47
- You can list the connected boards using the following command:
48
- ```bash
49
- $> mpflash list
50
- Connected boards
51
- ┏━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━┓
52
- ┃ Serial ┃Family ┃Port ┃Board ┃CPU ┃Version ┃build ┃
53
- ┡━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━━┩
54
- │ COM21 │micropython │rp2 │RPI_PICO │RP2040 │v1.23.0-preview │ 236 │
55
- │ │ │ │Raspberry Pi Pico with RP2040 │ │ │ │
56
- │ COM23 │micropython │rp2 │RPI_PICO_W │RP2040 │v1.23.0-preview │ 176 │
57
- │ │ │ │Raspberry Pi Pico W with RP2040 │ │ │ │
58
- │ COM9 │micropython │rp2 │ARDUINO_NANO_RP2040_CONNECT │RP2040 │v1.23.0-preview │ 341 │
59
- │ │ │ │Arduino Nano RP2040 Connect with RP2040 │ │ │ │
60
- └─────────┴─────────────┴──────┴───────────────────────────────────────────┴────────┴─────────────────┴──────┘
61
- ```
62
- ## Download the firmware
63
-
64
- To download the MicroPython firmware for some boards, use the following command:
65
- - `mpflash download` download the latest stable firmware for all connected boards
66
- - `mpflash download --version preview` download the current preview for all connected boards
67
- - `mpflash download --board ESP8266_GENERIC --board SEEED_WIO_TERMINAL` download these specific boards
68
- - `mpflash download --version ? --board ?` prompt to select a specific version and board to download
69
-
70
- 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.
71
- The stable version (default) is determined based on the most recent published release,
72
- other versions are `--version preview` and `--version x.y.z` to download the latest preview or version x.y.z respectively.
73
-
74
- 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.
75
-
76
- The directory structure will be something like this:
77
-
78
- ``` text
79
- Downloads/firmware
80
- | firmware.jsonl
81
- +---esp8266
82
- | ESP8266_GENERIC-FLASH_1M-v1.22.2.bin
83
- | ESP8266_GENERIC-FLASH_512K-v1.22.2.bin
84
- | ESP8266_GENERIC-OTA-v1.22.2.bin
85
- | ESP8266_GENERIC-v1.22.2.bin
86
- \---samd
87
- SEEED_WIO_TERMINAL-v1.22.2.uf2
88
- ```
89
-
90
- ## Flashing the firmware
91
- After you have downloaded a firmware you can flash the firmware to a board using the following command: `mpflash flash`
92
- This will (try to) autodetect the connected boards, and determine the correct firmware to flash to each board.
93
-
94
- - `mpflash flash` will flash the latest stable firmware to all connected boards.
95
- - `mpflash flash --serial ? --board ?` will prompt to select a specific serial port and board to flash. (the firmware must be dowloaded earlier)
96
-
97
-
98
- ### Flashing all connected boards with the latest stable firmware
99
- ```bash
100
- > mpflash flash
101
- 22:15:55 | ℹ️ - Using latest stable version: v1.22.2
102
- Connected boards
103
- ┏━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┳━━━━━━━┓
104
- ┃ Serial ┃ Family ┃ Port ┃ Board ┃ CPU ┃ Version ┃ build ┃
105
- ┡━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━╇━━━━━━━┩
106
- │ COM11 │ micropython │ rp2 │ RPI_PICO_W │ RP2040 │ 1.20.0 │ │
107
- │ COM12 │ micropython │ esp8266 │ ESP8266_GENERIC │ ESP8266 │ 1.22.2 │ │
108
- │ COM18 │ micropython │ rp2 │ RPI_PICO_W │ RP2040 │ 1.23.0-preview │ 155 │
109
- │ COM3 │ micropython │ samd │ SEEED_WIO_TERMINAL │ SAMD51P19A │ 1.23.0-preview │ 155 │
110
- │ COM5 │ micropython │ stm32 │ PYBV11 │ STM32F405RG │ 1.23.0-preview │ 166 │
111
- │ COM8 │ micropython │ esp32 │ ESP32_GENERIC_S3 │ ESP32S3 │ 1.23.0-preview │ 155 │
112
- └────────┴─────────────┴─────────┴────────────────────┴─────────────┴────────────────┴───────┘
113
- 22:15:58 | ℹ️ - Found v1.22.2 firmware rp2\RPI_PICO_W-v1.22.2.uf2 for RPI_PICO_W on COM11.
114
- 22:15:58 | ℹ️ - Found v1.22.2 firmware esp8266\ESP8266_GENERIC-v1.22.2.bin for ESP8266_GENERIC on COM12.
115
- 22:15:58 | ℹ️ - Found v1.22.2 firmware rp2\RPI_PICO_W-v1.22.2.uf2 for RPI_PICO_W on COM18.
116
- 22:15:58 | ℹ️ - Found v1.22.2 firmware samd\SEEED_WIO_TERMINAL-v1.22.2.uf2 for SEEED_WIO_TERMINAL on COM3.
117
- 22:15:58 | ⚠️ - Trying to find a firmware for the board PYBV11
118
- 22:15:58 | ❌ - No v1.22.2 firmware found for PYBV11 on COM5.
119
- 22:15:58 | ⚠️ - Trying to find a firmware for the board ESP32-GENERIC-S3
120
- 22:15:58 | ❌ - No v1.22.2 firmware found for ESP32_GENERIC_S3 on COM8.
121
- 22:15:58 | ℹ️ - Updating RPI_PICO_W on COM11 to 1.22.2
122
- 22:15:58 | ℹ️ - Erasing not yet implemented for UF2 flashing.
123
- 22:15:58 | ℹ️ - Entering UF2 bootloader on RPI_PICO_W on COM11
124
- 22:15:58 | ℹ️ - Waiting for mcu to mount as a drive : 10 seconds left
125
- 22:15:59 | ℹ️ - Waiting for mcu to mount as a drive : 9 seconds left
126
- 22:16:00 | ℹ️ - Board is in bootloader mode
127
- 22:16:00 | ℹ️ - Copying firmware\rp2\RPI_PICO_W-v1.22.2.uf2 to F:
128
- 22:16:13 | ✅ - Done copying, resetting the board and wait for it to restart
129
- 22:16:23 | ℹ️ - Updating ESP8266_GENERIC on COM12 to 1.22.2
130
- 22:16:23 | ℹ️ - Flashing firmware\esp8266\ESP8266_GENERIC-v1.22.2.bin on ESP8266_GENERIC on COM12
131
- 22:16:23 | ℹ️ - Running esptool --chip ESP8266 --port COM12 erase_flash
132
- esptool.py v4.7.0
133
- Serial port COM12
134
- Connecting....
135
- ...
136
- Chip erase completed successfully in 6.5s
137
- Hard resetting via RTS pin...
138
- 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
139
- esptool.py v4.7.0
140
- Serial port COM12
141
- Connecting....
142
- ...
143
- Leaving...
144
- Hard resetting via RTS pin...
145
- 22:16:43 | ℹ️ - Done flashing, resetting the board and wait for it to restart
146
- 22:16:49 | ✅ - Flashed 1.22.2 to ESP8266_GENERIC on COM12 done
147
- 22:16:49 | ℹ️ - Updating RPI_PICO_W on COM18 to 1.22.2
148
- 22:16:49 | ℹ️ - Erasing not yet implemented for UF2 flashing.
149
- 22:16:49 | ℹ️ - Entering UF2 bootloader on RPI_PICO_W on COM18
150
- 22:16:49 | ℹ️ - Waiting for mcu to mount as a drive : 10 seconds left
151
- 22:16:50 | ℹ️ - Waiting for mcu to mount as a drive : 9 seconds left
152
- 22:16:51 | ℹ️ - Board is in bootloader mode
153
- 22:16:51 | ℹ️ - Copying firmware\rp2\RPI_PICO_W-v1.22.2.uf2 to F:[/bold]
154
- 22:17:02 | ✅ - Done copying, resetting the board and wait for it to restart
155
- 22:17:12 | ℹ️ - Updating SEEED_WIO_TERMINAL on COM3 to 1.22.2
156
- 22:17:12 | ℹ️ - Erasing not yet implemented for UF2 flashing.
157
- 22:17:12 | ℹ️ - Entering UF2 bootloader on SEEED_WIO_TERMINAL on COM3
158
- 22:17:12 | ℹ️ - Waiting for mcu to mount as a drive : 10 seconds left
159
- 22:17:13 | ℹ️ - Waiting for mcu to mount as a drive : 9 seconds left
160
- 22:17:14 | ℹ️ - Board is in bootloader mode
161
- 22:17:14 | ℹ️ - Copying firmware\samd\SEEED_WIO_TERMINAL-v1.22.2.uf2 to F:[/bold]
162
- 22:17:17 | ✅ - Done copying, resetting the board and wait for it to restart
163
- 22:17:27 | ℹ️ - Flashed 4 boards
164
- Connected boards after flashing
165
- ┏━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┳━━━━━━━┓
166
- ┃ Serial ┃ Family ┃ Port ┃ Board ┃ CPU ┃ Version ┃ build ┃
167
- ┡━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━╇━━━━━━━┩
168
- │ COM11 │ micropython │ rp2 │ RPI_PICO_W │ RP2040 │ 1.22.2 │ │
169
- │ COM12 │ micropython │ esp8266 │ ESP8266_GENERIC │ ESP8266 │ 1.22.2 │ │
170
- │ COM18 │ micropython │ rp2 │ RPI_PICO_W │ RP2040 │ 1.22.2 │ │
171
- │ COM3 │ micropython │ samd │ SEEED_WIO_TERMINAL │ SAMD51P19A │ 1.22.2 │ │
172
- │ COM5 │ micropython │ stm32 │ PYBV11 │ STM32F405RG │ 1.23.0-preview │ 166 │
173
- │ COM8 │ micropython │ esp32 │ ESP32_GENERIC_S3 │ ESP32S3 │ 1.23.0-preview │ 155 │
174
- └────────┴─────────────┴─────────┴────────────────────┴─────────────┴────────────────┴───────┘
175
- ```
176
- Note that if no matching firmware can be found for a board, it will be skipped.
177
- (For example, the PYBV11 and ESP32_GENERIC_S3 boards in the example above.)
178
-
179
- ## Issues and bug reports
180
- mpflash is currently co-located in the [micropython-stubber](https://github.com/Josverl/micropython-stubber) repository.
181
- Please report any issues or bugs in the [issue tracker](https://github.com/Josverl/micropython-stubber/issues) using the MPflash feedback template.
182
-
183
- ## License
184
- mpflash is licensed under the MIT license. See the LICENSE file for more details.
1
+ # MPFLASH
2
+ [![pypi version](https://badgen.net/pypi/v/mpflash)](https://pypi.org/project/mpflash/)
3
+ [![python versions](https://badgen.net/pypi/python/mpflash)](https://badgen.net/pypi/python/mpflash)
4
+ [![Downloads](https://static.pepy.tech/badge/mpflash)](https://pepy.tech/project/mpflash)
5
+
6
+
7
+ `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 .
8
+
9
+ 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.
10
+
11
+ `mpflash` has been tested on:
12
+ - OS: Windows x64, Linux X64, but not (yet) macOS.
13
+ - Micropython (hardware) ports:
14
+ - `rp2`, using `.uf2`, using filecopy (macos not tested yet)
15
+ - `samd`, using ` .uf2`, using filecopy (macos not tested yet)
16
+ - `esp32`, using `.bin`, using esptool,
17
+ - `esp8266`, using `.bin`, using esptool
18
+ - `stm32`, using ` .dfu`, using pydfu
19
+
20
+ Not yet implemented: `nrf`, `cc3200`, `mimxrt`
21
+
22
+ ## Features
23
+ 1. List the connected boards including their firmware details, in a tabular or json format
24
+ 2. Download MicroPython firmware for versions, and matching a specified board or matches your current attached board.
25
+ 3. Flash one or all connected MicroPython boards with a specific firmware or version.
26
+
27
+ ## Installation
28
+ To install mpflash, you can use pip: `pip install mpflash`
29
+
30
+ ## Basic usage
31
+ You can use mpflash to perform various operations on your MicroPython boards. Here is an example of basic usage:
32
+
33
+ | Command | Description |
34
+ |---------|-------------|
35
+ | `mpflash list` | List the connected board(s) including their firmware details |
36
+ | `mpflash download` | Download the MicroPython firmware(s) for the connected board(s) |
37
+ | `mpflash flash` | Flash the latest stable firmware to the connected board(s) |
38
+
39
+
40
+ ## Linux permissions to access usb devices
41
+ In order to flash the firmware to the board, you need to have the correct permissions to access the USB devices.
42
+ 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.
43
+ [See the stm32_permissions documentation](./stm32_udev_rules.md) for more information.
44
+
45
+
46
+ ## Detailed usage
47
+ You can list the connected boards using the following command:
48
+ ```bash
49
+ $> mpflash list
50
+ Connected boards
51
+ ┏━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━┓
52
+ ┃ Serial ┃Family ┃Port ┃Board ┃CPU ┃Version ┃build ┃
53
+ ┡━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━━┩
54
+ │ COM21 │micropython │rp2 │RPI_PICO │RP2040 │v1.23.0-preview │ 236 │
55
+ │ │ │ │Raspberry Pi Pico with RP2040 │ │ │ │
56
+ │ COM23 │micropython │rp2 │RPI_PICO_W │RP2040 │v1.23.0-preview │ 176 │
57
+ │ │ │ │Raspberry Pi Pico W with RP2040 │ │ │ │
58
+ │ COM9 │micropython │rp2 │ARDUINO_NANO_RP2040_CONNECT │RP2040 │v1.23.0-preview │ 341 │
59
+ │ │ │ │Arduino Nano RP2040 Connect with RP2040 │ │ │ │
60
+ └─────────┴─────────────┴──────┴───────────────────────────────────────────┴────────┴─────────────────┴──────┘
61
+ ```
62
+ ## Download the firmware
63
+
64
+ To download the MicroPython firmware for some boards, use the following command:
65
+ - `mpflash download` download the latest stable firmware for all connected boards
66
+ - `mpflash download --version preview` download the current preview for all connected boards
67
+ - `mpflash download --board ESP8266_GENERIC --board SEEED_WIO_TERMINAL` download these specific boards
68
+ - `mpflash download --version ? --board ?` prompt to select a specific version and board to download
69
+
70
+ 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.
71
+ The stable version (default) is determined based on the most recent published release,
72
+ other versions are `--version preview` and `--version x.y.z` to download the latest preview or version x.y.z respectively.
73
+
74
+ 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.
75
+
76
+ The directory structure will be something like this:
77
+
78
+ ``` text
79
+ Downloads/firmware
80
+ | firmware.jsonl
81
+ +---esp8266
82
+ | ESP8266_GENERIC-FLASH_1M-v1.22.2.bin
83
+ | ESP8266_GENERIC-FLASH_512K-v1.22.2.bin
84
+ | ESP8266_GENERIC-OTA-v1.22.2.bin
85
+ | ESP8266_GENERIC-v1.22.2.bin
86
+ \---samd
87
+ SEEED_WIO_TERMINAL-v1.22.2.uf2
88
+ ```
89
+
90
+ ## Flashing the firmware
91
+ After you have downloaded a firmware you can flash the firmware to a board using the following command: `mpflash flash`
92
+ This will (try to) autodetect the connected boards, and determine the correct firmware to flash to each board.
93
+
94
+ - `mpflash flash` will flash the latest stable firmware to all connected boards.
95
+ - `mpflash flash --serial ? --board ?` will prompt to select a specific serial port and board to flash. (the firmware must be dowloaded earlier)
96
+
97
+
98
+ ### Flashing all connected boards with the latest stable firmware
99
+ ```bash
100
+ > mpflash flash
101
+ 22:15:55 | ℹ️ - Using latest stable version: v1.22.2
102
+ Connected boards
103
+ ┏━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┳━━━━━━━┓
104
+ ┃ Serial ┃ Family ┃ Port ┃ Board ┃ CPU ┃ Version ┃ build ┃
105
+ ┡━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━╇━━━━━━━┩
106
+ │ COM11 │ micropython │ rp2 │ RPI_PICO_W │ RP2040 │ 1.20.0 │ │
107
+ │ COM12 │ micropython │ esp8266 │ ESP8266_GENERIC │ ESP8266 │ 1.22.2 │ │
108
+ │ COM18 │ micropython │ rp2 │ RPI_PICO_W │ RP2040 │ 1.23.0-preview │ 155 │
109
+ │ COM3 │ micropython │ samd │ SEEED_WIO_TERMINAL │ SAMD51P19A │ 1.23.0-preview │ 155 │
110
+ │ COM5 │ micropython │ stm32 │ PYBV11 │ STM32F405RG │ 1.23.0-preview │ 166 │
111
+ │ COM8 │ micropython │ esp32 │ ESP32_GENERIC_S3 │ ESP32S3 │ 1.23.0-preview │ 155 │
112
+ └────────┴─────────────┴─────────┴────────────────────┴─────────────┴────────────────┴───────┘
113
+ 22:15:58 | ℹ️ - Found v1.22.2 firmware rp2\RPI_PICO_W-v1.22.2.uf2 for RPI_PICO_W on COM11.
114
+ 22:15:58 | ℹ️ - Found v1.22.2 firmware esp8266\ESP8266_GENERIC-v1.22.2.bin for ESP8266_GENERIC on COM12.
115
+ 22:15:58 | ℹ️ - Found v1.22.2 firmware rp2\RPI_PICO_W-v1.22.2.uf2 for RPI_PICO_W on COM18.
116
+ 22:15:58 | ℹ️ - Found v1.22.2 firmware samd\SEEED_WIO_TERMINAL-v1.22.2.uf2 for SEEED_WIO_TERMINAL on COM3.
117
+ 22:15:58 | ⚠️ - Trying to find a firmware for the board PYBV11
118
+ 22:15:58 | ❌ - No v1.22.2 firmware found for PYBV11 on COM5.
119
+ 22:15:58 | ⚠️ - Trying to find a firmware for the board ESP32-GENERIC-S3
120
+ 22:15:58 | ❌ - No v1.22.2 firmware found for ESP32_GENERIC_S3 on COM8.
121
+ 22:15:58 | ℹ️ - Updating RPI_PICO_W on COM11 to 1.22.2
122
+ 22:15:58 | ℹ️ - Erasing not yet implemented for UF2 flashing.
123
+ 22:15:58 | ℹ️ - Entering UF2 bootloader on RPI_PICO_W on COM11
124
+ 22:15:58 | ℹ️ - Waiting for mcu to mount as a drive : 10 seconds left
125
+ 22:15:59 | ℹ️ - Waiting for mcu to mount as a drive : 9 seconds left
126
+ 22:16:00 | ℹ️ - Board is in bootloader mode
127
+ 22:16:00 | ℹ️ - Copying firmware\rp2\RPI_PICO_W-v1.22.2.uf2 to F:
128
+ 22:16:13 | ✅ - Done copying, resetting the board and wait for it to restart
129
+ 22:16:23 | ℹ️ - Updating ESP8266_GENERIC on COM12 to 1.22.2
130
+ 22:16:23 | ℹ️ - Flashing firmware\esp8266\ESP8266_GENERIC-v1.22.2.bin on ESP8266_GENERIC on COM12
131
+ 22:16:23 | ℹ️ - Running esptool --chip ESP8266 --port COM12 erase_flash
132
+ esptool.py v4.7.0
133
+ Serial port COM12
134
+ Connecting....
135
+ ...
136
+ Chip erase completed successfully in 6.5s
137
+ Hard resetting via RTS pin...
138
+ 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
139
+ esptool.py v4.7.0
140
+ Serial port COM12
141
+ Connecting....
142
+ ...
143
+ Leaving...
144
+ Hard resetting via RTS pin...
145
+ 22:16:43 | ℹ️ - Done flashing, resetting the board and wait for it to restart
146
+ 22:16:49 | ✅ - Flashed 1.22.2 to ESP8266_GENERIC on COM12 done
147
+ 22:16:49 | ℹ️ - Updating RPI_PICO_W on COM18 to 1.22.2
148
+ 22:16:49 | ℹ️ - Erasing not yet implemented for UF2 flashing.
149
+ 22:16:49 | ℹ️ - Entering UF2 bootloader on RPI_PICO_W on COM18
150
+ 22:16:49 | ℹ️ - Waiting for mcu to mount as a drive : 10 seconds left
151
+ 22:16:50 | ℹ️ - Waiting for mcu to mount as a drive : 9 seconds left
152
+ 22:16:51 | ℹ️ - Board is in bootloader mode
153
+ 22:16:51 | ℹ️ - Copying firmware\rp2\RPI_PICO_W-v1.22.2.uf2 to F:[/bold]
154
+ 22:17:02 | ✅ - Done copying, resetting the board and wait for it to restart
155
+ 22:17:12 | ℹ️ - Updating SEEED_WIO_TERMINAL on COM3 to 1.22.2
156
+ 22:17:12 | ℹ️ - Erasing not yet implemented for UF2 flashing.
157
+ 22:17:12 | ℹ️ - Entering UF2 bootloader on SEEED_WIO_TERMINAL on COM3
158
+ 22:17:12 | ℹ️ - Waiting for mcu to mount as a drive : 10 seconds left
159
+ 22:17:13 | ℹ️ - Waiting for mcu to mount as a drive : 9 seconds left
160
+ 22:17:14 | ℹ️ - Board is in bootloader mode
161
+ 22:17:14 | ℹ️ - Copying firmware\samd\SEEED_WIO_TERMINAL-v1.22.2.uf2 to F:[/bold]
162
+ 22:17:17 | ✅ - Done copying, resetting the board and wait for it to restart
163
+ 22:17:27 | ℹ️ - Flashed 4 boards
164
+ Connected boards after flashing
165
+ ┏━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┳━━━━━━━┓
166
+ ┃ Serial ┃ Family ┃ Port ┃ Board ┃ CPU ┃ Version ┃ build ┃
167
+ ┡━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━╇━━━━━━━┩
168
+ │ COM11 │ micropython │ rp2 │ RPI_PICO_W │ RP2040 │ 1.22.2 │ │
169
+ │ COM12 │ micropython │ esp8266 │ ESP8266_GENERIC │ ESP8266 │ 1.22.2 │ │
170
+ │ COM18 │ micropython │ rp2 │ RPI_PICO_W │ RP2040 │ 1.22.2 │ │
171
+ │ COM3 │ micropython │ samd │ SEEED_WIO_TERMINAL │ SAMD51P19A │ 1.22.2 │ │
172
+ │ COM5 │ micropython │ stm32 │ PYBV11 │ STM32F405RG │ 1.23.0-preview │ 166 │
173
+ │ COM8 │ micropython │ esp32 │ ESP32_GENERIC_S3 │ ESP32S3 │ 1.23.0-preview │ 155 │
174
+ └────────┴─────────────┴─────────┴────────────────────┴─────────────┴────────────────┴───────┘
175
+ ```
176
+ Note that if no matching firmware can be found for a board, it will be skipped.
177
+ (For example, the PYBV11 and ESP32_GENERIC_S3 boards in the example above.)
178
+
179
+ ## Issues and bug reports
180
+ mpflash is currently co-located in the [micropython-stubber](https://github.com/Josverl/micropython-stubber) repository.
181
+ Please report any issues or bugs in the [issue tracker](https://github.com/Josverl/micropython-stubber/issues) using the MPflash feedback template.
182
+
183
+ ## License
184
+ mpflash is licensed under the MIT license. See the LICENSE file for more details.