Add matter over Thread

Dockerize local environment

Author: alexbegoon

.gitmodules

@@ -10,7 +10,3 @@
 [submodule "vendor/boschsensortec/BME68x_SensorAPI"]
 	path = vendor/boschsensortec/BME68x_SensorAPI
 	url = https://github.com/boschsensortec/BME68x_SensorAPI
-[submodule "vendor/esp-matter"]
-	path = vendor/esp-matter
-	url = https://github.com/espressif/esp-matter.git
-	branch = release/v1.4

README.md

@@ -315,14 +315,16 @@ Follow these steps to set up your Smart IoT Sensor:
 
 ### Building the Firmware
 
-1. **Install ESP-IDF**
-
-   Follow the [ESP-IDF Getting Started Guide](https://docs.espressif.com/projects/esp-idf/en/v5.3.1/esp32/get-started/index.html) to set up the development environment.
-
+1. **Build dockerized environment**
+   ```bash
+   docker build ./ci/docker/ -t esp_idf_xiao_esp32c6_sensor:latest
+   ```
 2. **Configure the Project**
 
    ```bash
-   idf.py menuconfig
+   docker run --rm -it -v $PWD:/opt/esp/project \
+   -w /opt/esp/project \
+   esp_idf_xiao_esp32c6_sensor:latest idf.py menuconfig
    ```
 
    - Set Wi-Fi credentials
@@ -332,7 +334,16 @@ Follow these steps to set up your Smart IoT Sensor:
 3. **Build and Flash**
 
    ```bash
-   idf.py build
+   docker run --rm -t -v $PWD:/opt/esp/project \
+   -w /opt/esp/project \
+   esp_idf_xiao_esp32c6_sensor:latest idf.py build
+   ```
+
+   ```bash
+   docker run --device=<TARGET_PORT> \
+   --rm -v $PWD:/opt/esp/project \
+   -w /opt/esp/project \
+   -it esp_idf_xiao_esp32c6_sensor:latest \
    idf.py -p <TARGET_PORT> flash
    ```
 

ci/docker/Dockerfile

@@ -0,0 +1,44 @@
+ARG IDF_VERSION="v5.3.1"
+ARG IDF_INSTALL_TARGETS="esp32c6"
+ARG DEBIAN_FRONTEND=noninteractive
+
+FROM espressif/idf:${IDF_VERSION} AS esp-idf
+
+ARG ESP_MATTER_CLONE_URL=https://github.com/espressif/esp-matter.git
+ARG ESP_MATTER_CHECKOUT_REF=release/v1.4
+
+RUN : \
+  && apt-get update \
+  && DEBIAN_FRONTEND=${DEBIAN_FRONTEND} apt-get install -fy --no-install-recommends \
+    libgirepository1.0-dev \
+    libssl-dev \
+    pkg-config \
+    python3 \
+    python3-pip \
+  && apt-get clean \
+  && apt-get autoremove -y \
+  && rm -rf /var/lib/apt/lists/* \
+  && : # last line
+
+WORKDIR /opt/esp
+ENV ESP_MATTER_PATH=/opt/esp/esp-matter
+
+RUN set -x \
+    && mkdir -p $ESP_MATTER_PATH \
+    && cd $ESP_MATTER_PATH \
+    && git init \
+    && git remote add origin $ESP_MATTER_CLONE_URL \
+    && git fetch origin --depth=1 ${ESP_MATTER_CHECKOUT_REF} \
+    && git checkout FETCH_HEAD \
+    && git submodule update --init --depth 1 \
+    && cd ./connectedhomeip/connectedhomeip \
+    && ./scripts/checkout_submodules.py --platform esp32 linux --shallow \
+    && cd ../.. \
+    && ./install.sh \
+    && : # last line
+
+COPY entrypoint.sh /opt/esp/entrypoint.sh
+ENTRYPOINT [ "/opt/esp/entrypoint.sh" ]
+CMD [ "/bin/bash" ]
+
+WORKDIR /opt/esp/esp-matter

ci/docker/entrypoint.sh

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+set -e
+
+source $IDF_PATH/export.sh
+source $ESP_MATTER_PATH/export.sh
+
+exec "$@"

main/CMakeLists.txt

@@ -1,5 +1,5 @@
 if(CONFIG_SENSOR_CONNECTION_MATTER_OVER_THREAD)
-  set(ESP_MATTER_SDK_PATH "../vendor/esp-matter")
+  set(ESP_MATTER_SDK_PATH "/opt/esp/esp-matter")
 
   get_filename_component(
     MATTER_SDK_PATH ${ESP_MATTER_SDK_PATH}/connectedhomeip/connectedhomeip/
@@ -480,21 +480,33 @@ if(CONFIG_SENSOR_CONNECTION_MATTER_OVER_THREAD)
   endif()
 endif()
 
-idf_component_register(
-  INCLUDE_DIRS
-  ${INCLUDE_DIRS_LIST}
+list(APPEND INCLUDE_DIRS_LIST "${ESP_MATTER_SDK_PATH}/examples/common"
+     "${MATTER_SDK_PATH}/config/esp32/components"
+     "${ESP_MATTER_SDK_PATH}/components")
+
+list(
+  APPEND
+  INCLUDE_DIRS_LIST
   "."
   "../vendor/embedded-i2c-sgp41"
   "../vendor/gas-index-algorithm/sensirion_gas_index_algorithm"
   "../vendor/boschsensortec/BME280_SensorAPI"
-  "../vendor/boschsensortec/BME68x_SensorAPI"
-  SRC_DIRS
-  ${SRC_DIRS_LIST}
+  "../vendor/boschsensortec/BME68x_SensorAPI")
+
+list(
+  APPEND
+  SRC_DIRS_LIST
   "."
   "../vendor/embedded-i2c-sgp41"
   "../vendor/gas-index-algorithm/sensirion_gas_index_algorithm"
   "../vendor/boschsensortec/BME280_SensorAPI"
-  "../vendor/boschsensortec/BME68x_SensorAPI"
+  "../vendor/boschsensortec/BME68x_SensorAPI")
+
+idf_component_register(
+  INCLUDE_DIRS
+  ${INCLUDE_DIRS_LIST}
+  SRC_DIRS
+  ${SRC_DIRS_LIST}
   EXCLUDE_SRCS
   ${EXCLUDE_SRCS_LIST}
   PRIV_INCLUDE_DIRS

sdkconfig.defaults

@@ -1,3 +1,5 @@
+CONFIG_IDF_TARGET="esp32c6"
+
 #
 # Partition Table
 #