feat(idf): Add ci.json support for IDF examples

Author: lucasssvaz

.github/scripts/on-push-idf.sh

@@ -0,0 +1,24 @@
+#!/bin/bash
+
+set -e
+
+CHECK_REQUIREMENTS="./components/arduino-esp32/.github/scripts/sketch_utils.sh check_requirements"
+
+# Export IDF environment
+. ${IDF_PATH}/export.sh
+
+# Find all examples in ./components/arduino-esp32/idf_component_examples
+idf_component_examples=$(find ./components/arduino-esp32/idf_component_examples -mindepth 1 -maxdepth 1 -type d)
+
+for example in $idf_component_examples; do
+    idf.py -C "$example" set-target "$IDF_TARGET"
+
+    has_requirements=$(${CHECK_REQUIREMENTS} "$example" "$example/sdkconfig")
+    if [ "$has_requirements" -eq 0 ]; then
+        printf "\n\033[93m%s does not meet the requirements for %s. Skipping...\033[0m\n\n" "$example" "$IDF_TARGET"
+        continue
+    fi
+
+    printf "\n\033[95mBuilding %s\033[0m\n\n" "$example"
+    idf.py -C "$example" -DEXTRA_COMPONENT_DIRS="$PWD/components" build
+done

.github/scripts/sketch_utils.sh

@@ -16,7 +16,7 @@ function check_requirements { # check_requirements <sketchdir> <sdkconfig_path>
     local requirements_or
 
     if [ ! -f "$sdkconfig_path" ] || [ ! -f "$sketchdir/ci.json" ]; then
-        echo "ERROR: sdkconfig or ci.json not found" 1>&2
+        echo "WARNING: sdkconfig or ci.json not found. Assuming requirements are met." 1>&2
         # Return 1 on error to force the sketch to be built and fail. This way the
         # CI will fail and the user will know that the sketch has a problem.
     else

.github/workflows/push.yml

@@ -31,6 +31,7 @@ on:
       - "!libraries/**.properties"
       - "!libraries/**.py"
       - "package/**"
+      - "idf_component_examples/**"
       - "tools/**.py"
       - "platform.txt"
       - "programmers.txt"
@@ -125,6 +126,7 @@ jobs:
               - 'Kconfig.projbuild'
               - 'CMakeLists.txt'
               - "variants/esp32c2/**/*"
+              - "idf_component_examples/**"
 
       - name: Set chunks
         id: set-chunks
@@ -267,15 +269,16 @@ jobs:
           submodules: recursive
           path: components/arduino-esp32
 
+      - name: Setup jq
+        uses: dcarbone/install-jq-action@e397bd87438d72198f81efd21f876461183d383a # v3.0.1
+
       - name: Build
         env:
           IDF_TARGET: ${{ matrix.idf_target }}
         shell: bash
         run: |
-          . ${IDF_PATH}/export.sh
-          idf.py -C ./components/arduino-esp32/idf_component_examples/hello_world -DEXTRA_COMPONENT_DIRS=$PWD/components build
-          idf.py -C ./components/arduino-esp32/idf_component_examples/hw_cdc_hello_world -DEXTRA_COMPONENT_DIRS=$PWD/components build
-          idf.py -C ./components/arduino-esp32/idf_component_examples/esp_matter_light -DEXTRA_COMPONENT_DIRS=$PWD/components build
+          chmod a+x ./components/arduino-esp32/.github/scripts/*
+          ./components/arduino-esp32/.github/scripts/on-push-idf.sh
 
   # Save artifacts to gh-pages
   save-master-artifacts:

idf_component_examples/.gitignore

@@ -0,0 +1,3 @@
+build/
+managed_components/
+dependencies.lock

idf_component_examples/esp_matter_light/CMakeLists.txt

@@ -8,6 +8,7 @@ set(PROJECT_VER_NUMBER 1)
 # This should be done before using the IDF_TARGET variable.
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 
+idf_build_set_property(MINIMAL_BUILD ON)
 project(arduino_managed_component_light)
 
 # WARNING: This is just an example for using key for decrypting the encrypted OTA image

idf_component_examples/esp_matter_light/ci.json

@@ -0,0 +1,6 @@
+{
+  "requires": [
+    "CONFIG_SOC_WIFI_SUPPORTED=y",
+    "CONFIG_ESP_MATTER_ENABLE_DATA_MODEL=y"
+  ]
+}

idf_component_examples/esp_matter_light/main/Kconfig.projbuild

@@ -3,100 +3,40 @@ menu "Light Matter Accessory"
         config BUTTON_PIN
             int
             prompt "Button 1 GPIO"
-            default ENV_GPIO_BOOT_BUTTON
+            default 9 if IDF_TARGET_ESP32C3 || IDF_TARGET_ESP32C6
+            default 0
             range -1 ENV_GPIO_IN_RANGE_MAX
             help
                 The GPIO pin for button that will be used to turn on/off the Matter Light. It shall be connected to a push button. It can use the BOOT button of the development board.
     endmenu
 
-
     menu "LEDs"
         config WS2812_PIN
             int
             prompt "WS2812 RGB LED GPIO"
-            default ENV_GPIO_RGB_LED
+            default 8 if IDF_TARGET_ESP32C3 || IDF_TARGET_ESP32C6
+            default 48
             range -1 ENV_GPIO_OUT_RANGE_MAX
             help
                 The GPIO pin for the Matter Light that will be driven by RMT. It shall be connected to one single WS2812 RGB LED.
     endmenu
 
-    # TARGET CONFIGURATION
-    if IDF_TARGET_ESP32C3
-        config ENV_GPIO_RANGE_MIN
-            int
-            default 0
-
-        config ENV_GPIO_RANGE_MAX
-            int
-            default 19
-            # GPIOs 20/21 are always used by UART in examples
-
-        config ENV_GPIO_IN_RANGE_MAX
-            int
-            default ENV_GPIO_RANGE_MAX
-
-        config ENV_GPIO_OUT_RANGE_MAX
-            int
-            default ENV_GPIO_RANGE_MAX
-
-        config ENV_GPIO_BOOT_BUTTON
-            int
-            default 9
-
-        config ENV_GPIO_RGB_LED
-            int
-            default 8
-    endif
-    if IDF_TARGET_ESP32C6
-        config ENV_GPIO_RANGE_MIN
-            int
-            default 0
+    config ENV_GPIO_RANGE_MIN
+        int
+        default 0
 
-        config ENV_GPIO_RANGE_MAX
-            int
-            default 30
-            # GPIOs 16/17 are always used by UART in examples
+    config ENV_GPIO_RANGE_MAX
+        int
+        default 19 if IDF_TARGET_ESP32C3
+        default 30 if IDF_TARGET_ESP32C6
+        default 48
 
-        config ENV_GPIO_IN_RANGE_MAX
-            int
-            default ENV_GPIO_RANGE_MAX
+    config ENV_GPIO_IN_RANGE_MAX
+        int
+        default ENV_GPIO_RANGE_MAX
 
-        config ENV_GPIO_OUT_RANGE_MAX
-            int
-            default ENV_GPIO_RANGE_MAX
-
-        config ENV_GPIO_BOOT_BUTTON
-            int
-            default 9
-
-        config ENV_GPIO_RGB_LED
-            int
-            default 8
-    endif
-    if IDF_TARGET_ESP32S3
-        config ENV_GPIO_RANGE_MIN
-            int
-            default 0
-
-        config ENV_GPIO_RANGE_MAX
-            int
-            default 48
-
-        config ENV_GPIO_IN_RANGE_MAX
-            int
-            default ENV_GPIO_RANGE_MAX
-
-        config ENV_GPIO_OUT_RANGE_MAX
-            int
-            default ENV_GPIO_RANGE_MAX
-
-        config ENV_GPIO_BOOT_BUTTON
-            int
-            default 0
-
-        config ENV_GPIO_RGB_LED
-            int
-            default 48
-    endif
+    config ENV_GPIO_OUT_RANGE_MAX
+        int
+        default ENV_GPIO_RANGE_MAX
 
 endmenu

idf_component_examples/hello_world/CMakeLists.txt

@@ -5,4 +5,6 @@
 cmake_minimum_required(VERSION 3.16)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
+
+idf_build_set_property(MINIMAL_BUILD ON)
 project(main)

idf_component_examples/hw_cdc_hello_world/CMakeLists.txt

@@ -9,4 +9,5 @@ include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 list(APPEND compile_definitions "ARDUINO_USB_CDC_ON_BOOT=1")
 list(APPEND compile_definitions "ARDUINO_USB_MODE=1")
 
+idf_build_set_property(MINIMAL_BUILD ON)
 project(hw_cdc_hello_world)

idf_component_examples/hw_cdc_hello_world/ci.json

@@ -0,0 +1,5 @@
+{
+  "requires": [
+    "CONFIG_SOC_USB_SERIAL_JTAG_SUPPORTED=y"
+  ]
+}