Skip to content

Commit 027d139

Browse files
committed
Updates build script.
1 parent 6318e4c commit 027d139

File tree

3 files changed

+333
-188
lines changed

3 files changed

+333
-188
lines changed

README.md

Lines changed: 52 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -570,18 +570,65 @@ Common options that are available across all esp32 targets:
570570
* `--task-stack-size={stack size in bytes}`: Sets the default stack size for threads
571571
* `CONFIG_*={value}`: You can alter the config settings of the esp-idf by using these settings. Refer to the ESP-IDF documentation
572572
for further information
573+
* `--uart-repl-bitrate={baud/bitrate}`: This changes the connection speed for the serial connection when using the UART REPL.
574+
This is a nice feature to use when transferring large files to the ESP32. The highest
575+
speed I have been able to set it to is 921600, you might be able to set it higher depending
576+
on the UART to USB bridge IC used and the type of physical connection.
577+
* `--enable-uart-repl={y/n}`: This allows you to turn on and off the UART based REPL. You will wany to set this of you use USB-CDC or JTAG for the REPL output
573578

574579

575580
Options specific to the ESP32-S3 processors:
576581

577-
* `--usb-otg`: Enable REPL output on pins 19 & 20 of the ESP32-S3
578-
* `--usb-jtag`: Enable JTAG output on pins 19 & 20 of the ESP32-S3
579582
* `--octal-flash`: Set this if you have octal SPI flash
580583

581-
Options specific to the ESP32-S2 processors:
584+
Options specific to the ESP32-S2, ESP32-S3, ESP32-C3 and ESP32-C6 processors:
582585

583-
* `--usb-otg`: Enable REPL output on pins 19 & 20 of the ESP32-S2
584-
* `--usb-jtag`: Enable JTAG output on pins 19 & 20 of the ESP32-S2
586+
* `--enable-cdc-repl={y/n}`: Enable/disable REPL output over CDC on the USB pins
587+
* `--enable-jtag-repl={y/n}`: Enable/disable REPL output over JTAG on the USB pins
588+
589+
590+
This next option is abailable for all ESP32 series MCU's I placed it here instead of above
591+
because it is going to need some in depth explaining. This is for advanced users.
592+
593+
* `--custom-board-path`
594+
595+
I added the ability to provide a path to a custom board. There are a few requirememnts for
596+
this to work properly. The path needs to point to the folder that holds the board specification
597+
files. Here is a list of required files.
598+
599+
* `board.json`: This file outlines what the board is. At a minimum the file needs to contain the following.
600+
```
601+
{
602+
"mcu": "{MCU}"
603+
}
604+
```
605+
where `{MCU}` is one of the follwing:
606+
607+
* esp32
608+
* esp32s2
609+
* exp32s3
610+
* exp32c3
611+
* exp32c6
612+
613+
* `sdkconfig.board`: This file contains all of the ESP-IDF specific config settings. If you don't know
614+
what needs to be set in here then please ask me for assistance.
615+
* `mpconfigboard.h`: MicroPython config settings. If you don't know what needs to be set in here then
616+
please ask me for assistance.
617+
* `mpconfigboard.cmake`: Build script. At a minimum the following should be in the build script.
618+
`{MCU}` is replaced with one of the options from the list of MCU's above.
619+
`{BOARD_CONATINING_FOLDER}` if the name of the folder these files are located in.
620+
```
621+
set(IDF_TARGET {MCU})
622+
623+
set(SDKCONFIG_DEFAULTS
624+
boards/sdkconfig.base
625+
${SDKCONFIG_IDF_VERSION_SPECIFIC}
626+
boards/{BOARD_CONATINING_FOLDER}/sdkconfig.board
627+
)
628+
```
629+
630+
* `partition.csv`: This file dictates what the partitions are supposed to be on the ESP32. As for assistance
631+
If you do not know how to create one of these.
585632

586633
<br>
587634

0 commit comments

Comments
 (0)