From c15a008d3f8e6e84cbb0782999cfbcfadd4bfc14 Mon Sep 17 00:00:00 2001 From: Paul Solt Date: Mon, 7 Oct 2024 10:36:01 -0400 Subject: [PATCH 1/2] Update the ESP-IDF tooling to master or v5.4 when released to fix issues for Embedded Swift. Random numbers do not work on 5.1.2 - 5.3.1, the fix is on master, but we don't have a 5.4 release yet. There are other fixes as well. --- .../Resources/install-esp-terminal/install-esp-terminal-03.sh | 4 ++-- .../Resources/install-esp-terminal/install-esp-terminal-04.sh | 4 ++-- .../Resources/install-esp-terminal/install-esp-terminal-05.sh | 4 ++-- .../Resources/install-esp-terminal/install-esp-terminal-06.sh | 4 ++-- .../Documentation.docc/Tutorials/Setup-MacOS.tutorial | 4 ++-- 5 files changed, 10 insertions(+), 10 deletions(-) diff --git a/Sources/SwiftMatterExamples/Documentation.docc/Resources/install-esp-terminal/install-esp-terminal-03.sh b/Sources/SwiftMatterExamples/Documentation.docc/Resources/install-esp-terminal/install-esp-terminal-03.sh index 1f29a6b..5f39e99 100644 --- a/Sources/SwiftMatterExamples/Documentation.docc/Resources/install-esp-terminal/install-esp-terminal-03.sh +++ b/Sources/SwiftMatterExamples/Documentation.docc/Resources/install-esp-terminal/install-esp-terminal-03.sh @@ -7,10 +7,10 @@ $ brew install cmake ninja dfu-util # Create an ESP SDK directory $ mkdir -p ~/esp -# Download the ESP-IDF SDK +# Download the ESP-IDF SDK (`master` or `v5.4` when released) $ cd ~/esp $ git clone \ - --branch v5.2.1 \ + --branch master \ --depth 1 \ --shallow-submodules \ --recursive https://github.com/espressif/esp-idf.git \ diff --git a/Sources/SwiftMatterExamples/Documentation.docc/Resources/install-esp-terminal/install-esp-terminal-04.sh b/Sources/SwiftMatterExamples/Documentation.docc/Resources/install-esp-terminal/install-esp-terminal-04.sh index cc25560..101125a 100644 --- a/Sources/SwiftMatterExamples/Documentation.docc/Resources/install-esp-terminal/install-esp-terminal-04.sh +++ b/Sources/SwiftMatterExamples/Documentation.docc/Resources/install-esp-terminal/install-esp-terminal-04.sh @@ -7,10 +7,10 @@ $ brew install cmake ninja dfu-util # Create an ESP SDK directory $ mkdir -p ~/esp -# Download the ESP-IDF SDK +# Download the ESP-IDF SDK (`master` or `v5.4` when released) $ cd ~/esp $ git clone \ - --branch v5.2.1 \ + --branch master \ --depth 1 \ --shallow-submodules \ --recursive https://github.com/espressif/esp-idf.git \ diff --git a/Sources/SwiftMatterExamples/Documentation.docc/Resources/install-esp-terminal/install-esp-terminal-05.sh b/Sources/SwiftMatterExamples/Documentation.docc/Resources/install-esp-terminal/install-esp-terminal-05.sh index 58b7a8f..c6de67d 100644 --- a/Sources/SwiftMatterExamples/Documentation.docc/Resources/install-esp-terminal/install-esp-terminal-05.sh +++ b/Sources/SwiftMatterExamples/Documentation.docc/Resources/install-esp-terminal/install-esp-terminal-05.sh @@ -7,10 +7,10 @@ $ brew install cmake ninja dfu-util # Create an ESP SDK directory $ mkdir -p ~/esp -# Download the ESP-IDF SDK +# Download the ESP-IDF SDK (`master` or `v5.4` when released) $ cd ~/esp $ git clone \ - --branch v5.2.1 \ + --branch master \ --depth 1 \ --shallow-submodules \ --recursive https://github.com/espressif/esp-idf.git \ diff --git a/Sources/SwiftMatterExamples/Documentation.docc/Resources/install-esp-terminal/install-esp-terminal-06.sh b/Sources/SwiftMatterExamples/Documentation.docc/Resources/install-esp-terminal/install-esp-terminal-06.sh index d486d1c..7e05264 100644 --- a/Sources/SwiftMatterExamples/Documentation.docc/Resources/install-esp-terminal/install-esp-terminal-06.sh +++ b/Sources/SwiftMatterExamples/Documentation.docc/Resources/install-esp-terminal/install-esp-terminal-06.sh @@ -7,10 +7,10 @@ $ brew install cmake ninja dfu-util # Create an ESP SDK directory $ mkdir -p ~/esp -# Download the ESP-IDF SDK +# Download the ESP-IDF SDK (`master` or `v5.4` when released) $ cd ~/esp $ git clone \ - --branch v5.2.1 \ + --branch master \ --depth 1 \ --shallow-submodules \ --recursive https://github.com/espressif/esp-idf.git \ diff --git a/Sources/SwiftMatterExamples/Documentation.docc/Tutorials/Setup-MacOS.tutorial b/Sources/SwiftMatterExamples/Documentation.docc/Tutorials/Setup-MacOS.tutorial index 339f8b4..f9abff0 100644 --- a/Sources/SwiftMatterExamples/Documentation.docc/Tutorials/Setup-MacOS.tutorial +++ b/Sources/SwiftMatterExamples/Documentation.docc/Tutorials/Setup-MacOS.tutorial @@ -83,7 +83,7 @@ @ContentAndMedia { Install the tools and SDKs needed to build an ESP32-C6 Matter accessory. - The steps here should be enough to get started quickly, but for additional detailed instructions see the official [ESP-IDF Setup](https://docs.espressif.com/projects/esp-idf/en/v5.2.1/esp32/get-started/linux-macos-setup.html) and [ESP-Matter Setup](https://docs.espressif.com/projects/esp-matter/en/latest/esp32/developing.html#esp-matter-setup) documentation. + The steps here should be enough to get started quickly, but for additional detailed instructions see the official [ESP-IDF Setup](https://docs.espressif.com/projects/esp-idf/en/v5.3.1/esp32/get-started/linux-macos-setup.html) and [ESP-Matter Setup](https://docs.espressif.com/projects/esp-matter/en/latest/esp32/developing.html#esp-matter-setup) documentation. } @Steps { @@ -108,7 +108,7 @@ } @Step { - Clone the ESP-IDF repository version 5.2.1 from GitHub. + Clone the ESP-IDF `master` branch (5.4 when released) from GitHub. Note this SDK is quite large (~500 MB for a shallow clone) and may take significant time to download depending on your internet connection. From 0aa1638ec41c7ec662671eb4ff076900089b6e6a Mon Sep 17 00:00:00 2001 From: Paul Solt Date: Mon, 7 Oct 2024 10:53:05 -0400 Subject: [PATCH 2/2] Update the docker to use ESP-IDF master/v5.4 --- Dockerfile | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Dockerfile b/Dockerfile index 34a8223..a0c9194 100644 --- a/Dockerfile +++ b/Dockerfile @@ -11,11 +11,11 @@ RUN apt-get update \ # Install CMake >= 3.29 RUN pip install --upgrade cmake -# Download ESP-IDF +# Download the ESP-IDF SDK (`master` or `v5.4` when released) RUN mkdir -p ~/esp \ && cd ~/esp \ && git clone \ - --branch v5.2.1 \ + --branch master \ --depth 1 \ --shallow-submodules \ --recursive https://github.com/espressif/esp-idf.git \