diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 90b2ca2..9a1c364 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -22,7 +22,7 @@ jobs: fail-fast: false matrix: example: [empty-template, led-blink, smart-light] - swift: [swift-DEVELOPMENT-SNAPSHOT-2024-12-13-a] + swift: [swift-DEVELOPMENT-SNAPSHOT-2025-03-28-a] steps: - name: Checkout repo diff --git a/Dockerfile b/Dockerfile index 27a2cbd..8918d6b 100644 --- a/Dockerfile +++ b/Dockerfile @@ -14,11 +14,11 @@ RUN apt-get update \ # Install CMake >= 3.29 RUN pip install --upgrade cmake -# Download the ESP-IDF SDK (`master` or `v5.4` when released) +# Download ESP-IDF RUN mkdir -p ~/esp \ && cd ~/esp \ && git clone \ - --branch master \ + --branch v5.4.1 \ --depth 1 \ --shallow-submodules \ --recursive https://github.com/espressif/esp-idf.git \ diff --git a/README.md b/README.md index 6242d4c..6a2cf8f 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ Before running the examples, ensure you have the following tools available: - Software - [Swift Nightly Toolchain](https://www.swift.org/download) - [CMake 3.29+](https://cmake.org/download) - - [ESP-IDF 5.2.1](https://docs.espressif.com/projects/esp-idf/en/v5.2.1/esp32c6/get-started/index.html) + - [ESP-IDF v5.4.1](https://docs.espressif.com/projects/esp-idf/en/v5.4.1/esp32c6/get-started/index.html) - [ESP-Matter SDK 1.2](https://docs.espressif.com/projects/esp-matter/en/latest/esp32c6/introduction.html) > [!IMPORTANT] 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 c3f2e7a..e86cb88 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 @@ -9,10 +9,10 @@ $ brew install cmake ninja dfu-util # Create an ESP SDK directory $ mkdir -p ~/esp -# Download the ESP-IDF SDK (`master` or `v5.4` when released) +# Download the ESP-IDF SDK $ cd ~/esp $ git clone \ - --branch master \ + --branch v5.4.1 \ --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 ed58fca..b6845cc 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 @@ -9,10 +9,10 @@ $ brew install cmake ninja dfu-util # Create an ESP SDK directory $ mkdir -p ~/esp -# Download the ESP-IDF SDK (`master` or `v5.4` when released) +# Download the ESP-IDF SDK $ cd ~/esp $ git clone \ - --branch master \ + --branch v5.4.1 \ --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 cccf6f8..3f5c078 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 @@ -9,10 +9,10 @@ $ brew install cmake ninja dfu-util # Create an ESP SDK directory $ mkdir -p ~/esp -# Download the ESP-IDF SDK (`master` or `v5.4` when released) +# Download the ESP-IDF SDK $ cd ~/esp $ git clone \ - --branch master \ + --branch v5.4.1 \ --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 3346d27..e023fda 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 @@ -9,10 +9,10 @@ $ brew install cmake ninja dfu-util # Create an ESP SDK directory $ mkdir -p ~/esp -# Download the ESP-IDF SDK (`master` or `v5.4` when released) +# Download the ESP-IDF SDK $ cd ~/esp $ git clone \ - --branch master \ + --branch v5.4.1 \ --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 f9abff0..453b0b3 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.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. + 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.4.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 `master` branch (5.4 when released) from GitHub. + Clone the ESP-IDF repository version v5.4.1 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.