From 0265a97c5de133b1daf45507476a4dabfeab0944 Mon Sep 17 00:00:00 2001 From: Johnathon Slightham Date: Tue, 30 Sep 2025 12:24:56 -0400 Subject: [PATCH] Change to ESP-IDF v5.5.x --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 209d910..2fb25da 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,10 @@
## Setup -**This project is currently setup to work with the ESP32-S3 board.** We use ESP-IDF version 5.4. The Espressif docs have a [well written article](https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-guides/build-system.html) that explains the build system. +**This project is currently setup to work with the ESP32-S3 board.** +We use ESP-IDF version 5.5.1. +The Espressif docs have a [well written article](https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-guides/build-system.html) that explains the build system. +Versions before 5.5 are incompatible due to an issue with the CMakeLists.txt file in the ledc component (that we depend on). ### Install Dependencies #### MacOS @@ -42,7 +45,7 @@ cd ~/esp/isp-idf Install ESP-IDF with with the GUI [Windows installer](https://dl.espressif.com/dl/esp-idf/?idf=4.4). - Use default options. - You may install ESP-IDF to a path that is different than the default, however, keep the length of the path under 90 characters and do not include any spaces or non ASCII characters. -- Select version v5.4.x. +- Select version v5.5.x. - Ensure that the `esp32s3` checkbox is selected (should be by default) - The installer will automatically provide - Embedded Python @@ -77,7 +80,7 @@ Run the following commands in a command prompt. Export environment variables (alternatively run the ESP-IDF Command Prompt shortcut) ``` -# Example path: C:\Espressif\frameworks\esp-idf-v5.4.1-3\ +# Example path: C:\Espressif\frameworks\esp-idf-v5.5.1-3\ /Path/To/ESP-IDF/export.bat ```