mirror of https://github.com/espressif/esp-matter.git synced 2026-04-27 11:03:05 +00:00

Files

T

History

shripad621git ce717135ed tools/docker: Fixed the esp-matter docker image for the idf path export

- The latest esp-matter docker image for failing on
  the esp-idf path export.
- Fixed the export path issue as per latest changes
  in esp-idf export script.

2025-05-13 11:04:40 +05:30

chip_idf

tools/Dockerfile: Added the python certification tests Dockerfile changes

2025-01-17 17:33:18 +08:00

matter_builds

tools/docker: Fixed the esp-matter docker image for the idf path export

2025-05-13 11:04:40 +05:30

README.md

Docker image improvements

2023-08-25 10:51:33 +00:00

README.md

Espressif's SDK for Matter Docker Image

This is a Docker image for the Espressif's SDK for Matter (ESP-MATTER). It is intended for building applications of ESP-IDF that uses Espressif's SDK for Matter, when doing automated builds.

This image contains a copy of the Espressif's SDK for Matter, a copy of ESP-IDF and the required tools for Matter to build ESP-IDF projects that use Espressif's SDK for Matter.

Basic Usage

Build a project located in the current directory using idf.py build command:

docker run --rm -v $PWD:/project -w /project espressif/esp-matter:latest idf.py build

Building custom images

The Dockerfile in Espressif's SDK for Matter repository provides several build arguments which can be used to customize the Docker image:

These are the different build arguments that can be used:

ESP_MATTER_CLONE_URL: URL of the repository to clone Espressif's SDK for Matter. Can be set to a custom URL when working with a fork of Espressif's SDK for Matter. Default is https://github.com/espressif/esp-matter.git.
ESP_MATTER_CHECKOUT_REF: If this argument is set to a non-empty value, the given ESP_MATTER_CHECKOUT_REF will be fetched and checkout. This argument can be set to a tag, a branch or the SHA of the specific commit to check out. Default is main.

You can also use build arguments to control the ESP-IDF download:

IDF_CLONE_URL: URL of the repository to clone ESP-IDF from. Can be set to a custom URL when working with a fork of ESP-IDF. Default is https://github.com/espressif/esp-idf.git.
IDF_CHECKOUT_REF: If this argument is set to a non-empty value, the given ESP_MATTER_CHECKOUT_REF will be fetched and checkout. This argument can be set to a tag, a branch or the SHA of the specific commit to check out. Default is v5.1 tag.
IDF_CLONE_SHALLOW: If this argument is set to a non-empty value, --depth=1 --shallow-submodules arguments will be used when performing git clone. This significantly reduces the amount of data downloaded and the size of the resulting Docker image. However, if switching to a different branch in such a "shallow" repository is necessary, an additional git fetch origin <branch> command must be executed first.