[Docs] Added/Updated Lib builder docs #6401
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pedrominatel
added
the
Type: Documentation
VojtechBartoska
approved these changes
Mar 10, 2022
me-no-dev
reviewed
Mar 10, 2022
docs/source/lib_builder.rst
Outdated
|
|
||
| - Step 4 - Run ``install-esp-idf`` installation script (if you already have an ``$IDF_PATH`` defined, it will use your local copy of the repository):: | ||
| Set the build type. ex. 'build' to build the project and prepare for uploading to a board |
me-no-dev
reviewed
Mar 10, 2022
docs/source/lib_builder.rst
Outdated
| The script automates the process of building `Arduino as an ESP-IDF component <https://github.com/espressif/arduino-esp32/blob/master/docs/esp-idf_component.md>`_. | ||
| Once it is complete, you can cherry pick the needed libraries from ``out/tools/sdk/lib``, or run ``tools/copy-to-arduino.sh`` to copy the entire built system. | ||
| ``tools/config.sh`` contains a number of variables that control the process, particularly the ``$IDF_BRANCH`` variable. You can adjust this to try building against newer versions, but there are absolutely no guarantees that any components will work or even successfully compile against a newer IDF. | ||
| ./build.sh -b |
There was a problem hiding this comment.
./build.sh -t esp32 -b idf_libs qio 80m
me-no-dev
reviewed
Mar 10, 2022
docs/source/lib_builder.rst
Outdated
|
|
||
| - Step 5 - Copy the configuration (recommended) or directly edit sdkconfig using ``idf.py menuconfig``:: | ||
| ./build.sh -b <build|menuconfig|idf_libs|copy_bootloader|mem_variant> |
There was a problem hiding this comment.
./build.sh -t esp32 -b <build|menuconfig|idf_libs|copy_bootloader|mem_variant>
|
merged into S3 branch since it depends on it :) |
Jason2866
added a commit
to tasmota/arduino-esp32
that referenced
this pull request
Mar 30, 2022
* Initial S3 Support Just so we can compile and test! Some things might/will not work. SPI and UART baud detect need to be looked at. * Add S3 Toolchain * Update Esptool and add some missing adjustments * Add Dual-Core Support * Fix bootloop issue and enable DSP optimization * Run Arduino on Core1 * Rework USB selection * Update HWCDC.cpp * Update USB.cpp * Update esp32-hal-tinyusb.c * fix S3 flash image base (espressif#6208) * Added my new Unexpected Maker ESP32-S3 boards (espressif#6211) * Fixes UART_1 TX Pin setup When passing the PR to this branch, it seems that the change to this line was forgotten. * Initial SPI support and S3-Box variant * Bootloader is at 0x0000 for S3 (espressif#6215) * small adjustments for NVS and PSRAM init * WIP: Initial support for PSRAM (QSPI and OPI) * [FEATURE] Basic implementation of Arduino's I2S library (espressif#5304) Basic version of Arduino's I2S library. We currently support only 16bps + 16000 Hz sampling frequency. Other bitrates and sample rates will print warning and continue to operate, however the resulting audio quality may be poor. There will be further effort to fix these issues. * [I2S] Fix lib-builder error * Update idf_component.yml (espressif#6232) took me a while * Fixes RMT examples and adds ESP32-S3 config (espressif#6235) * WIP: Initial OPI support * Update Libs with the new lib-builder scripts * Update board menu for ESP32-S3 * fix ethernet clock runtime setting (espressif#6340) this was not possible anymore since the GPIO refactoring. This superseeds espressif/esp32-arduino-lib-builder#60 (which works only for clock on GPIO17). A PR will provided to revert this. @me-no-dev fyi The fix is done from @arendst Credits go to him! * Update IDF libs and fix missing BLE 4.2 features * Update CI scripts * script fixes * Add guard to USB examples * Disable some examples for ESP32-S3 * skip one more sketch and try again PIO * Fox SPI example and add proper esptool for PIO CI * Update ResetReason.ino * Update IDF, Add ESP-SR and RainMaker * Enable RainMaker on all chips * Enable hardware test on ESP32-S3 * Adjust build dir for tests and sketches * Update tests_build.sh * Send event also if tests fail * Add helper script for updating the core version * [Docs] Added/Updated Lib builder docs (espressif#6401) * [Docs] Added/Updated Lib builder docs * [Docs] Fixes according to the PR review * [Docs] Fixes according to the PR review * SD_MMC: add ESP32-S3 support * CmakeList + Rainmaker src files edit * remove Rainmaker * Tasmota change * Fix Unicore WDT on HTTP OTA update * Revert "ESP32-S3 SDMMC support" (#20) * Fix reboot into download from TinyUSB on ESP32-S3 Requires manual reboot back into the new firmware after flashing has finished * Fix psram crash pico d4 (#110) * Fix reboot into download from TinyUSB on ESP32-S3 (#111) Requires manual reboot back into the new firmware after flashing has finished Co-authored-by: me-no-dev <hristo@espressif.com> * Revert "Fix psram crash pico d4 (#110)" (#113) This reverts commit 56cf555. * Fix boot freeze when trying to init PSRAM on Pico D4 * revert tinyusb * hal/usb_serial_jtag_ll.h only C3, H2, S3 * Fix sd mmc * add wpa_supplicant as requirement * Update platform.txt * remove Rainmaker * Update boards.txt * Update HardwareSerial.h * Update USBCDC.cpp * Update esptool.py * Update platformio-build-esp32.py * Update platformio-build-esp32c3.py * Update platformio-build-esp32s2.py * Update platformio-build-esp32s3.py * fix merge errors * Reordering - HardwareSerial Constructor * Update platformio-build-esp32.py * Update platformio-build-esp32c3.py * Update platformio-build-esp32s2.py * Update platformio-build-esp32s3.py Co-authored-by: me-no-dev <hristo@espressif.com> Co-authored-by: Unexpected Maker <seon@unexpectedmaker.com> Co-authored-by: Rodrigo Garcia <rodrigo.garcia@espressif.com> Co-authored-by: Tomáš Pilný <34927466+PilnyTomas@users.noreply.github.com> Co-authored-by: Me No Dev <me-no-dev@users.noreply.github.com> Co-authored-by: Pedro Minatel <pedro.minatel@espressif.com> Co-authored-by: Ivan Grokhotkov <ivan@espressif.com> Co-authored-by: Jan Procházka <90197375+P-R-O-C-H-Y@users.noreply.github.com>
Jason2866
added a commit
to tasmota/arduino-esp32
that referenced
this pull request
Mar 30, 2022
* Initial S3 Support Just so we can compile and test! Some things might/will not work. SPI and UART baud detect need to be looked at. * Add S3 Toolchain * Update Esptool and add some missing adjustments * Add Dual-Core Support * Fix bootloop issue and enable DSP optimization * Run Arduino on Core1 * Rework USB selection * Update HWCDC.cpp * Update USB.cpp * Update esp32-hal-tinyusb.c * fix S3 flash image base (espressif#6208) * Added my new Unexpected Maker ESP32-S3 boards (espressif#6211) * Fixes UART_1 TX Pin setup When passing the PR to this branch, it seems that the change to this line was forgotten. * Initial SPI support and S3-Box variant * Bootloader is at 0x0000 for S3 (espressif#6215) * small adjustments for NVS and PSRAM init * WIP: Initial support for PSRAM (QSPI and OPI) * [FEATURE] Basic implementation of Arduino's I2S library (espressif#5304) Basic version of Arduino's I2S library. We currently support only 16bps + 16000 Hz sampling frequency. Other bitrates and sample rates will print warning and continue to operate, however the resulting audio quality may be poor. There will be further effort to fix these issues. * [I2S] Fix lib-builder error * Update idf_component.yml (espressif#6232) took me a while * Fixes RMT examples and adds ESP32-S3 config (espressif#6235) * WIP: Initial OPI support * Update Libs with the new lib-builder scripts * Update board menu for ESP32-S3 * fix ethernet clock runtime setting (espressif#6340) this was not possible anymore since the GPIO refactoring. This superseeds espressif/esp32-arduino-lib-builder#60 (which works only for clock on GPIO17). A PR will provided to revert this. @me-no-dev fyi The fix is done from @arendst Credits go to him! * Update IDF libs and fix missing BLE 4.2 features * Update CI scripts * script fixes * Add guard to USB examples * Disable some examples for ESP32-S3 * skip one more sketch and try again PIO * Fox SPI example and add proper esptool for PIO CI * Update ResetReason.ino * Update IDF, Add ESP-SR and RainMaker * Enable RainMaker on all chips * Enable hardware test on ESP32-S3 * Adjust build dir for tests and sketches * Update tests_build.sh * Send event also if tests fail * Add helper script for updating the core version * [Docs] Added/Updated Lib builder docs (espressif#6401) * [Docs] Added/Updated Lib builder docs * [Docs] Fixes according to the PR review * [Docs] Fixes according to the PR review * SD_MMC: add ESP32-S3 support * CmakeList + Rainmaker src files edit * remove Rainmaker * Tasmota change * Fix Unicore WDT on HTTP OTA update * Revert "ESP32-S3 SDMMC support" (#20) * Fix reboot into download from TinyUSB on ESP32-S3 Requires manual reboot back into the new firmware after flashing has finished * Fix psram crash pico d4 (#110) * Fix reboot into download from TinyUSB on ESP32-S3 (#111) Requires manual reboot back into the new firmware after flashing has finished Co-authored-by: me-no-dev <hristo@espressif.com> * Revert "Fix psram crash pico d4 (#110)" (#113) This reverts commit 56cf555. * Fix boot freeze when trying to init PSRAM on Pico D4 * revert tinyusb * hal/usb_serial_jtag_ll.h only C3, H2, S3 * Fix sd mmc * add wpa_supplicant as requirement * Update platform.txt * remove Rainmaker * Update boards.txt * Update HardwareSerial.h * Update USBCDC.cpp * Update esptool.py * Update platformio-build-esp32.py * Update platformio-build-esp32c3.py * Update platformio-build-esp32s2.py * Update platformio-build-esp32s3.py * fix merge errors * Reordering - HardwareSerial Constructor * Update platformio-build-esp32.py * Update platformio-build-esp32c3.py * Update platformio-build-esp32s2.py * Update platformio-build-esp32s3.py * Update pins_arduino.h * Update platformio-build-esp32.py * Update platformio-build-esp32c3.py * Update platformio-build-esp32s2.py * Update platformio-build-esp32s3.py Co-authored-by: me-no-dev <hristo@espressif.com> Co-authored-by: Unexpected Maker <seon@unexpectedmaker.com> Co-authored-by: Rodrigo Garcia <rodrigo.garcia@espressif.com> Co-authored-by: Tomáš Pilný <34927466+PilnyTomas@users.noreply.github.com> Co-authored-by: Me No Dev <me-no-dev@users.noreply.github.com> Co-authored-by: Pedro Minatel <pedro.minatel@espressif.com> Co-authored-by: Ivan Grokhotkov <ivan@espressif.com> Co-authored-by: Jan Procházka <90197375+P-R-O-C-H-Y@users.noreply.github.com>
Jason2866
added a commit
to tasmota/arduino-esp32
that referenced
this pull request
Mar 31, 2022
* Tasmota changes (#123) * Initial S3 Support Just so we can compile and test! Some things might/will not work. SPI and UART baud detect need to be looked at. * Add S3 Toolchain * Update Esptool and add some missing adjustments * Add Dual-Core Support * Fix bootloop issue and enable DSP optimization * Run Arduino on Core1 * Rework USB selection * Update HWCDC.cpp * Update USB.cpp * Update esp32-hal-tinyusb.c * fix S3 flash image base (espressif#6208) * Added my new Unexpected Maker ESP32-S3 boards (espressif#6211) * Fixes UART_1 TX Pin setup When passing the PR to this branch, it seems that the change to this line was forgotten. * Initial SPI support and S3-Box variant * Bootloader is at 0x0000 for S3 (espressif#6215) * small adjustments for NVS and PSRAM init * WIP: Initial support for PSRAM (QSPI and OPI) * [FEATURE] Basic implementation of Arduino's I2S library (espressif#5304) Basic version of Arduino's I2S library. We currently support only 16bps + 16000 Hz sampling frequency. Other bitrates and sample rates will print warning and continue to operate, however the resulting audio quality may be poor. There will be further effort to fix these issues. * [I2S] Fix lib-builder error * Update idf_component.yml (espressif#6232) took me a while * Fixes RMT examples and adds ESP32-S3 config (espressif#6235) * WIP: Initial OPI support * Update Libs with the new lib-builder scripts * Update board menu for ESP32-S3 * fix ethernet clock runtime setting (espressif#6340) this was not possible anymore since the GPIO refactoring. This superseeds espressif/esp32-arduino-lib-builder#60 (which works only for clock on GPIO17). A PR will provided to revert this. @me-no-dev fyi The fix is done from @arendst Credits go to him! * Update IDF libs and fix missing BLE 4.2 features * Update CI scripts * script fixes * Add guard to USB examples * Disable some examples for ESP32-S3 * skip one more sketch and try again PIO * Fox SPI example and add proper esptool for PIO CI * Update ResetReason.ino * Update IDF, Add ESP-SR and RainMaker * Enable RainMaker on all chips * Enable hardware test on ESP32-S3 * Adjust build dir for tests and sketches * Update tests_build.sh * Send event also if tests fail * Add helper script for updating the core version * [Docs] Added/Updated Lib builder docs (espressif#6401) * [Docs] Added/Updated Lib builder docs * [Docs] Fixes according to the PR review * [Docs] Fixes according to the PR review * SD_MMC: add ESP32-S3 support * CmakeList + Rainmaker src files edit * remove Rainmaker * Tasmota change * Fix Unicore WDT on HTTP OTA update * Revert "ESP32-S3 SDMMC support" (#20) * Fix reboot into download from TinyUSB on ESP32-S3 Requires manual reboot back into the new firmware after flashing has finished * Fix psram crash pico d4 (#110) * Fix reboot into download from TinyUSB on ESP32-S3 (#111) Requires manual reboot back into the new firmware after flashing has finished Co-authored-by: me-no-dev <hristo@espressif.com> * Revert "Fix psram crash pico d4 (#110)" (#113) This reverts commit 56cf555. * Fix boot freeze when trying to init PSRAM on Pico D4 * revert tinyusb * hal/usb_serial_jtag_ll.h only C3, H2, S3 * Fix sd mmc * add wpa_supplicant as requirement * Update platform.txt * remove Rainmaker * Update boards.txt * Update HardwareSerial.h * Update USBCDC.cpp * Update esptool.py * Update platformio-build-esp32.py * Update platformio-build-esp32c3.py * Update platformio-build-esp32s2.py * Update platformio-build-esp32s3.py * fix merge errors * Reordering - HardwareSerial Constructor * Update platformio-build-esp32.py * Update platformio-build-esp32c3.py * Update platformio-build-esp32s2.py * Update platformio-build-esp32s3.py * Update pins_arduino.h * Update platformio-build-esp32.py * Update platformio-build-esp32c3.py * Update platformio-build-esp32s2.py * Update platformio-build-esp32s3.py Co-authored-by: me-no-dev <hristo@espressif.com> Co-authored-by: Unexpected Maker <seon@unexpectedmaker.com> Co-authored-by: Rodrigo Garcia <rodrigo.garcia@espressif.com> Co-authored-by: Tomáš Pilný <34927466+PilnyTomas@users.noreply.github.com> Co-authored-by: Me No Dev <me-no-dev@users.noreply.github.com> Co-authored-by: Pedro Minatel <pedro.minatel@espressif.com> Co-authored-by: Ivan Grokhotkov <ivan@espressif.com> Co-authored-by: Jan Procházka <90197375+P-R-O-C-H-Y@users.noreply.github.com> * revert espressif#6456 Co-authored-by: me-no-dev <hristo@espressif.com> Co-authored-by: Unexpected Maker <seon@unexpectedmaker.com> Co-authored-by: Rodrigo Garcia <rodrigo.garcia@espressif.com> Co-authored-by: Tomáš Pilný <34927466+PilnyTomas@users.noreply.github.com> Co-authored-by: Me No Dev <me-no-dev@users.noreply.github.com> Co-authored-by: Pedro Minatel <pedro.minatel@espressif.com> Co-authored-by: Ivan Grokhotkov <ivan@espressif.com> Co-authored-by: Jan Procházka <90197375+P-R-O-C-H-Y@users.noreply.github.com>
Jason2866
added a commit
to Jason2866/arduino-esp32
that referenced
this pull request
Apr 19, 2022
* Tasmota changes (espressif#123) * Initial S3 Support Just so we can compile and test! Some things might/will not work. SPI and UART baud detect need to be looked at. * Add S3 Toolchain * Update Esptool and add some missing adjustments * Add Dual-Core Support * Fix bootloop issue and enable DSP optimization * Run Arduino on Core1 * Rework USB selection * Update HWCDC.cpp * Update USB.cpp * Update esp32-hal-tinyusb.c * fix S3 flash image base (espressif#6208) * Added my new Unexpected Maker ESP32-S3 boards (espressif#6211) * Fixes UART_1 TX Pin setup When passing the PR to this branch, it seems that the change to this line was forgotten. * Initial SPI support and S3-Box variant * Bootloader is at 0x0000 for S3 (espressif#6215) * small adjustments for NVS and PSRAM init * WIP: Initial support for PSRAM (QSPI and OPI) * [FEATURE] Basic implementation of Arduino's I2S library (espressif#5304) Basic version of Arduino's I2S library. We currently support only 16bps + 16000 Hz sampling frequency. Other bitrates and sample rates will print warning and continue to operate, however the resulting audio quality may be poor. There will be further effort to fix these issues. * [I2S] Fix lib-builder error * Update idf_component.yml (espressif#6232) took me a while * Fixes RMT examples and adds ESP32-S3 config (espressif#6235) * WIP: Initial OPI support * Update Libs with the new lib-builder scripts * Update board menu for ESP32-S3 * fix ethernet clock runtime setting (espressif#6340) this was not possible anymore since the GPIO refactoring. This superseeds espressif/esp32-arduino-lib-builder#60 (which works only for clock on GPIO17). A PR will provided to revert this. @me-no-dev fyi The fix is done from @arendst Credits go to him! * Update IDF libs and fix missing BLE 4.2 features * Update CI scripts * script fixes * Add guard to USB examples * Disable some examples for ESP32-S3 * skip one more sketch and try again PIO * Fox SPI example and add proper esptool for PIO CI * Update ResetReason.ino * Update IDF, Add ESP-SR and RainMaker * Enable RainMaker on all chips * Enable hardware test on ESP32-S3 * Adjust build dir for tests and sketches * Update tests_build.sh * Send event also if tests fail * Add helper script for updating the core version * [Docs] Added/Updated Lib builder docs (espressif#6401) * [Docs] Added/Updated Lib builder docs * [Docs] Fixes according to the PR review * [Docs] Fixes according to the PR review * SD_MMC: add ESP32-S3 support * CmakeList + Rainmaker src files edit * remove Rainmaker * Tasmota change * Fix Unicore WDT on HTTP OTA update * Revert "ESP32-S3 SDMMC support" (#20) * Fix reboot into download from TinyUSB on ESP32-S3 Requires manual reboot back into the new firmware after flashing has finished * Fix psram crash pico d4 (espressif#110) * Fix reboot into download from TinyUSB on ESP32-S3 (espressif#111) Requires manual reboot back into the new firmware after flashing has finished Co-authored-by: me-no-dev <hristo@espressif.com> * Revert "Fix psram crash pico d4 (espressif#110)" (espressif#113) This reverts commit 56cf555. * Fix boot freeze when trying to init PSRAM on Pico D4 * revert tinyusb * hal/usb_serial_jtag_ll.h only C3, H2, S3 * Fix sd mmc * add wpa_supplicant as requirement * Update platform.txt * remove Rainmaker * Update boards.txt * Update HardwareSerial.h * Update USBCDC.cpp * Update esptool.py * Update platformio-build-esp32.py * Update platformio-build-esp32c3.py * Update platformio-build-esp32s2.py * Update platformio-build-esp32s3.py * fix merge errors * Reordering - HardwareSerial Constructor * Update platformio-build-esp32.py * Update platformio-build-esp32c3.py * Update platformio-build-esp32s2.py * Update platformio-build-esp32s3.py * Update pins_arduino.h * Update platformio-build-esp32.py * Update platformio-build-esp32c3.py * Update platformio-build-esp32s2.py * Update platformio-build-esp32s3.py Co-authored-by: me-no-dev <hristo@espressif.com> Co-authored-by: Unexpected Maker <seon@unexpectedmaker.com> Co-authored-by: Rodrigo Garcia <rodrigo.garcia@espressif.com> Co-authored-by: Tomáš Pilný <34927466+PilnyTomas@users.noreply.github.com> Co-authored-by: Me No Dev <me-no-dev@users.noreply.github.com> Co-authored-by: Pedro Minatel <pedro.minatel@espressif.com> Co-authored-by: Ivan Grokhotkov <ivan@espressif.com> Co-authored-by: Jan Procházka <90197375+P-R-O-C-H-Y@users.noreply.github.com> * Bugfix fs read+speed improvements (espressif#127) * Revert "Edited VFSFileImpl::read to use both read/fread (espressif#6456)" This reverts commit 7b89b39. * Added default file buffer size + function to change it by user Co-authored-by: Jan Procházka <90197375+P-R-O-C-H-Y@users.noreply.github.com> Co-authored-by: me-no-dev <hristo@espressif.com> Co-authored-by: Unexpected Maker <seon@unexpectedmaker.com> Co-authored-by: Rodrigo Garcia <rodrigo.garcia@espressif.com> Co-authored-by: Tomáš Pilný <34927466+PilnyTomas@users.noreply.github.com> Co-authored-by: Me No Dev <me-no-dev@users.noreply.github.com> Co-authored-by: Pedro Minatel <pedro.minatel@espressif.com> Co-authored-by: Ivan Grokhotkov <ivan@espressif.com> Co-authored-by: Jan Procházka <90197375+P-R-O-C-H-Y@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Update on the library builder procedures.
Impact
None
Related links
https://github.com/espressif/arduino-esp32/projects/5#card-63388323