Helper scripts to simplify setting up the ESP-IDF and ESP-Matter development environments.
Sets up your environment for working with ESP-IDF and ESP-Matter:
- Sources
esp-idfandesp-matterenvironment scripts. - Enables
ccacheto speed up compilation. - Sets the Matter SDK path (
$MATTER_SDK_PATH) and adds Matter host tools to yourPATH. - Provides helpful shortcuts for common IDF commands:
itargetβ Set targetibuildβ Build projectiflashβ Flash firmwareieraseβ Erase flashimenuβ Open menuconfigimonitorβ Monitor serial output
- Provides a helper function
iflashmfgto easily flash manufacturing binaries.
Usage:
source env.shFully automated setup of the ESP-IDF and ESP-Matter SDKs.
| Option | Description |
|---|---|
--packages |
Install required system packages |
--idf-version <ver> |
Specify ESP-IDF version (default: v5.4.1) |
--matter-branch <branch> |
Specify ESP-Matter branch (default: main) |
--clean-idf |
Remove existing ~/esp-idf before setup |
--clean-matter |
Remove existing ~/esp-matter before setup |
--clean |
Shortcut for --clean-idf and --clean-matter |
--help, -h |
Show usage instructions |
Examples:
Basic (installs esp-idf and esp-matter)
./install.shUse a different ESP-IDF version:
./install.sh --idf-version v5.3