Skip to content

Commit d89e71e

Browse files
projectgusdpgeorge
projectgus
authored and
dpgeorge
committed
tools/autobuild,esp32: Template the generation of esp32 port deploy.md.
Allows two source files (ports/esp32/boards/deploy.md and deploy_nativeusb.md for boards with only native USB) for all esp32 installation steps, with templated chip name and flash offset inserted via string formatting. The new files add more text to explain the esptool.py port auto-detection, remove the unnecessary -z feature (already enabled by default), and add a bit of troubleshooting and port detection info. This work was funded through GitHub Sponsors. Signed-off-by: Angus Gratton <[email protected]>
1 parent b6649b9 commit d89e71e

File tree

57 files changed

+267
-755
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+267
-755
lines changed

‎ports/esp32/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,15 @@ files that configure ESP-IDF settings. Some standard `sdkconfig` files are
229229
provided in the `boards/` directory, like `boards/sdkconfig.ble`. You can
230230
also define custom ones in your board directory.
231231

232+
Deployment instructions usually invoke the `boards/deploy.md` file (for boards
233+
with a USB/Serial converter connection), or the `boards/deploy_nativeusb.md`
234+
file (for boards with only a native USB port connection). These files are
235+
formatted for each board using template strings found in the `boards.json`
236+
files. You can also include the common `boards/deploy_flashmode.md` file if you
237+
have a board which requires manual resetting via the RESET and BOOT buttons.
238+
Boards with unique flashing steps can include custom `deploy.md` file(s).
239+
Existing `board.json` files contain examples of all of these combinations.
240+
232241
See existing board definitions for further examples of configuration.
233242

234243
Configuration

‎ports/esp32/boards/ARDUINO_NANO_ESP32/board.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
"deploy": [
33
"deploy.md"
44
],
5+
"deploy_options": {
6+
"flash_offset": "0"
7+
},
58
"docs": "",
69
"features": [
710
"BLE",

‎ports/esp32/boards/ARDUINO_NANO_ESP32/deploy.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,5 @@ Please note that the DFU bootloader comes factory flashed. Should you for any re
1111
entire flash, the DFU bootloader will have to be re-installed. Please follow the instructions
1212
[here](https://support.arduino.cc/hc/en-us/articles/9810414060188-Reset-the-Arduino-bootloader-on-the-Nano-ESP32)
1313
to do so.
14+
15+
**Important** From the options below, download the `.app-bin` file for your board.

‎ports/esp32/boards/ESP32_GENERIC/board.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
"deploy": [
33
"../deploy.md"
44
],
5+
"deploy_options": {
6+
"flash_offset": "0x1000"
7+
},
58
"docs": "",
69
"features": [
710
"BLE",

‎ports/esp32/boards/ESP32_GENERIC_C3/board.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
{
22
"deploy": [
3-
"../deploy_c3.md"
3+
"../deploy.md"
44
],
5+
"deploy_options": {
6+
"flash_offset": "0"
7+
},
58
"docs": "",
69
"features": [
710
"BLE",

‎ports/esp32/boards/ESP32_GENERIC_C6/board.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
{
22
"deploy": [
3-
"../deploy_c6.md"
3+
"../deploy.md"
44
],
5+
"deploy_options": {
6+
"flash_offset": "0"
7+
},
58
"docs": "",
69
"features": [
710
"BLE",

‎ports/esp32/boards/ESP32_GENERIC_S2/board.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
{
22
"deploy": [
3-
"../deploy_s2.md"
3+
"../deploy.md"
44
],
5+
"deploy_options": {
6+
"flash_offset": "0x1000"
7+
},
58
"docs": "",
69
"features": [
710
"External Flash",

‎ports/esp32/boards/ESP32_GENERIC_S3/board.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
{
22
"deploy": [
3-
"../deploy_s3.md"
3+
"../deploy.md"
44
],
5+
"deploy_options": {
6+
"flash_offset": "0"
7+
},
58
"docs": "",
69
"features": [
710
"BLE",

‎ports/esp32/boards/LILYGO_TTGO_LORA32/board.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
"deploy": [
33
"../deploy.md"
44
],
5+
"deploy_options": {
6+
"flash_offset": "0x1000"
7+
},
58
"docs": "",
69
"features": [
710
"BLE",

‎ports/esp32/boards/LOLIN_C3_MINI/board.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
{
22
"deploy": [
3-
"../deploy_c3.md"
3+
"../deploy_nativeusb.md"
44
],
5+
"deploy_options": {
6+
"flash_offset": "0"
7+
},
58
"docs": "",
69
"features": [
710
"BLE",

‎ports/esp32/boards/LOLIN_S2_MINI/board.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
{
22
"deploy": [
3-
"../deploy_s2.md"
3+
"../deploy_nativeusb.md"
44
],
5+
"deploy_options": {
6+
"flash_offset": "0x1000"
7+
},
58
"docs": "",
69
"features": [
710
"External Flash",

‎ports/esp32/boards/LOLIN_S2_PICO/board.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
{
22
"deploy": [
3-
"../deploy_s2.md"
3+
"../deploy_nativeusb.md"
44
],
5+
"deploy_options": {
6+
"flash_offset": "0x1000"
7+
},
58
"docs": "",
69
"features": [
710
"Display",

‎ports/esp32/boards/M5STACK_ATOM/board.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
"deploy": [
33
"../deploy.md"
44
],
5+
"deploy_options": {
6+
"flash_offset": "0x1000"
7+
},
58
"docs": "",
69
"features": [
710
"External Flash",

‎ports/esp32/boards/M5STACK_ATOMS3_LITE/board.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
{
22
"deploy": [
3-
"deploy.md"
3+
"../deploy_nativeusb.md"
44
],
5+
"deploy_options": {
6+
"flash_offset": "0"
7+
},
58
"docs": "https://docs.m5stack.com/en/core/AtomS3%20Lite",
69
"features": [
710
"BLE",

‎ports/esp32/boards/M5STACK_ATOMS3_LITE/deploy.md

Lines changed: 0 additions & 22 deletions
This file was deleted.

‎ports/esp32/boards/M5STACK_NANOC6/board.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
{
22
"deploy": [
3-
"deploy_nanoc6.md"
3+
"../deploy_nativeusb.md"
44
],
5+
"deploy_options": {
6+
"flash_offset": "0"
7+
},
58
"docs": "",
69
"features": [
710
"BLE",

‎ports/esp32/boards/M5STACK_NANOC6/deploy_nanoc6.md

Lines changed: 0 additions & 18 deletions
This file was deleted.

‎ports/esp32/boards/OLIMEX_ESP32_EVB/board.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
"deploy": [
33
"../deploy.md"
44
],
5+
"deploy_options": {
6+
"flash_offset": "0x1000"
7+
},
58
"docs": "",
69
"features": [
710
"BLE",

‎ports/esp32/boards/OLIMEX_ESP32_POE/board.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
"deploy": [
33
"../deploy.md"
44
],
5+
"deploy_options": {
6+
"flash_offset": "0x1000"
7+
},
58
"docs": "",
69
"features": [
710
"BLE",

‎ports/esp32/boards/SIL_WESP32/board.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
"deploy": [
33
"../deploy.md"
44
],
5+
"deploy_options": {
6+
"flash_offset": "0x1000"
7+
},
58
"docs": "",
69
"features": [
710
"BLE",

‎ports/esp32/boards/UM_FEATHERS2/board.json

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
{
22
"deploy": [
3-
"deploy.md"
3+
"../deploy_flashmode.md",
4+
"../deploy_nativeusb.md"
45
],
6+
"deploy_options": {
7+
"flash_offset": "0x1000"
8+
},
59
"docs": "",
610
"features": [
711
"Battery Charging",

‎ports/esp32/boards/UM_FEATHERS2/deploy.md

Lines changed: 0 additions & 50 deletions
This file was deleted.

‎ports/esp32/boards/UM_FEATHERS2NEO/board.json

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
{
22
"deploy": [
3-
"deploy.md"
3+
"../deploy_flashmode.md",
4+
"../deploy_nativeusb.md"
45
],
6+
"deploy_options": {
7+
"flash_offset": "0x1000"
8+
},
59
"docs": "",
610
"features": [
711
"Battery Charging",

‎ports/esp32/boards/UM_FEATHERS2NEO/deploy.md

Lines changed: 0 additions & 50 deletions
This file was deleted.

‎ports/esp32/boards/UM_FEATHERS3/board.json

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
{
22
"deploy": [
3-
"deploy.md"
3+
"../deploy_flashmode.md",
4+
"../deploy_nativeusb.md"
45
],
6+
"deploy_options": {
7+
"flash_offset": "0"
8+
},
59
"docs": "",
610
"features": [
711
"BLE",

0 commit comments

Comments
 (0)