Skip to content

tanishqmanuja/esp-matter.scripts

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

3 Commits
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Matter Scripts

Helper scripts to simplify setting up the ESP-IDF and ESP-Matter development environments.

Scripts

env.sh

Sets up your environment for working with ESP-IDF and ESP-Matter:

  • Sources esp-idf and esp-matter environment scripts.
  • Enables ccache to speed up compilation.
  • Sets the Matter SDK path ($MATTER_SDK_PATH) and adds Matter host tools to your PATH.
  • Provides helpful shortcuts for common IDF commands:
    • itarget β€” Set target
    • ibuild β€” Build project
    • iflash β€” Flash firmware
    • ierase β€” Erase flash
    • imenu β€” Open menuconfig
    • imonitor β€” Monitor serial output
  • Provides a helper function iflashmfg to easily flash manufacturing binaries.

Usage:

source env.sh

install.sh

Fully 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.sh

Use a different ESP-IDF version:

./install.sh --idf-version v5.3

About

πŸ“„ Useful matter scripts.

Topics

Resources

Stars

Watchers

Forks

Languages