Setup ESP-IDF and Matter Environment#

Setting up IDF and Matter environment is one time setup.

Setup ESP-IDF (Espressif IoT Development Framework)#

Building the example application requires the use of the ESP-IDF and the xtensa-esp32-elf toolchain for ESP32 modules or the riscv-esp32-elf toolchain for ESP32C3 modules.

The VSCode devcontainer has these components pre-installed, so you can skip this step.

Install Prerequisites#

Get IDF v4.4.3#

  • Clone ESP-IDF v4.4.3 release

    $ git clone -b v4.4.3 --recursive https://github.com/espressif/esp-idf.git
$ cd esp-idf
$ ./install.sh

  • To update an existing esp-idf toolchain to v4.4.3:

    $ cd path/to/esp-idf
$ git fetch origin
$ git checkout v4.4.3
$ git reset --hard origin/v4.4.3
$ git submodule update --recursive --init
$ git clean -fdx
$ ./install.sh

  • For ESP32H2, please checkout tag v5.0-beta1, currently only lighting-app is supported on H2

    $ cd esp-idf
$ git checkout v5.0-beta1
$ git submodule update --init
$ ./install.sh

Setup Matter environment#

Install Prerequisites#

Prepare for building#

Before running any other build command, the scripts/activate.sh environment setup script should be sourced at the top level. This script takes care of downloading GN, ninja, and setting up a Python environment with libraries used to build and test.

source scripts/activate.sh

If this script says the environment is out of date, it can be updated by running:

source scripts/bootstrap.sh

Once IDF and Matter environment is set up, head over to application building and commissioning guide.