ESPMatter环境搭建

1.2 安装ESP-IDF

参考： esp环境搭建

安装 ESP-IDF (Espressif IoT Development Framework)

构建示例程序 ESP32C3 模块的工具链为 riscv-esp32-elf，VSCode 已经预装相应组件，可以命令栏选择。

ESP-IDF 依赖环境安装：Linux -- Ubuntu 20.02

sudo apt-get install git wget flex bison gperf python3 python3-pip python3-setuptools cmake ninja-build ccache libffi-dev libssl-dev dfu-util libusb-1.0-0
 -y

获取IDF 仓库(v4.4.2 或 v4.4.3)

• Clone ESP-IDF v4.4.2 release

 //配置一下Git的用户名密码 方便后面重复下载
 git config --global user.name   "passwd"  
 git config --global user.email  "username"
 
git clone --recursive https://github.com/espressif/esp-idf.git
cd esp-idf
git checkout v4.4.2
git submodule update --init --recursive
./install.sh
cd ..

//2022年镜像 将github.com 换为github.com.cnpmjs.org即可实现加速

2.安装 Matter 环境

• Matter 依赖环境安装：Linux

sudo apt-get install git gcc g++ pkg-config libssl-dev libdbus-1-dev \
     libglib2.0-dev libavahi-client-dev ninja-build python3-venv python3-dev \
     python3-pip unzip libgirepository1.0-dev libcairo2-dev libreadline-dev -y

• 获取 Matter仓库 失败可参考问题描述（不翻墙基本成功不了) 官方链接

//(推荐) 由于上游 connectedhomeip 中有很多子模块，克隆 esp-matter 存储库需要一段时间，因此如果你想进行浅克隆，请使用以下命令：
git clone --depth 1 https://github.com/espressif/esp-matter.git
cd esp-matter
git submodule update --init --depth 1 //失败参考问题1
cd /connectedhomeip/connectedhomeip
// 同步子模块（受网速影响，可能需要比较长的时间）
./scripts/checkout_submodules.py --platform esp32 linux --shallow
cd ../../
./install.sh //安装matter相关依赖
cd ..

//(国内较困难需要翻墙)要克隆包含所有子模块的 esp-matter 存储库，请使用以下命令：
git clone --recursive https://gitclone.com/github.com/espressif/esp-matter.git
cd esp-matter
./install.sh
cd ..

// 当子模块拉取失败在翻墙的网络中可以尝试 直接拉取chip
git clone https://github.com/project-chip/connectedhomeip.git
//加速地址
git clone --recursive https://gitclone.com/github.com/project-chip/connectedhomeip.git

 

问题1：拉取子模块失败

因为esp-matter 的sdk库存储在github中国内拉取可能会失败，导致安装出错。建议进行翻墙来加快克隆速度减少报错。 在拉取过程中容易出现子模块拉取失败的情况，
这时候可以进入esp-matter/connectedhomeip/connectedhomeip目录 执行git submodule update --init --recursive -f 强制拉取子模块。

问题2：安装 connectedhomeip 依赖包

sudo apt-get install gn pkg-config libglib2.0-dev python3-venv libgirepository- 1.0-1 libdbus-1-dev

//对于 ubuntu 20.04 ⽤⼾，源上没有 gn，可以⼿动下载 gn 进⾏安装

sudo apt-get install unzip 

wget https://dl.espressif.com/AE/gn-linux-amd64-2071.zip 

sudo unzip gn-linux-amd64-2071.zip -d /usr/bin/

sudo chmod 777 /usr/bin/gn

问题3：编译 connectedhomeip 相关⼯具 以上⼯具需要在 connectedhomeip 更新后重新编译，如未更新，不需要每次编译。

cd esp-matter/connectedhomeip/connectedhomeip 
gn gen out/host # 下⾯命令会编译所有⼯具，需要耗费⼀些时间，暂不推荐使⽤ 
ninja -C out/host # 也可⽤以下命令单独编译 esp-matter 所需⼯具，较快，推荐使⽤ 
ninja -C out/host chip-cert 
ninja -C out/host chip-tool 
ninja -C out/host spake2p

问题4：安装时出错：OSError: [Errno 101] Network is unreachable

Git中对问题的描述

注意：Matter 安装执行 

install.sh 脚本时若遇到 相关Python 版本的报错，此时需注意关闭掉主机原有Python 版本，若启动 Anaconda3 工具，需关闭掉以 Matter 依赖安装的Python 版本为主。

问题5 编译示例出现依赖库链接失败：

执行：

pip install lark stringcase pip install jinja2

3 .配置环境变量

每次打开新终端时都应该这样做

cd esp-idf; . ./export.sh; cd ..
cd esp-matter; . ./export.sh; cd ..

启用 Ccache 以加快 IDF 构建速度。

Ccache 是一个编译器缓存。物质构建非常缓慢，需要花费大量时间。Ccache 缓存以前的编译并在后续构建中加速重新编译。

export IDF_CCACHE_ENABLE=1

此处编写一个脚本处理（根据各自主机配置路径）

#!/bin/bash
# matter.sh

EPS_MATTER_PATH="/home/huiqn/esp/esp-matter"

export IDF_PATH="/home/huqin/esp/esp-idf"
source $IDF_PATH/export.sh
source $EPS_MATTER_PATH/export.sh
export IDF_CCACHE_ENABLE=1

echo "start matter"
#cd $EPS_MATTER_PATH
//每次打开客户端执行 source matter.sh 1 命令；

更快捷的方式：

vi ~/.bashrc
//添加
alias get_matter='. /home/huqin/esp/matter.sh'
:wq
source ~/.bashrc
//每次打开客户端执行 get_matter 命令；

4 .VSCode CMake软件环境配置

由于ESP-Matter 程序代码是基于CMake构建的，因此建议安装CMake 和 CMake Tools 插件， 并按 Ctrl+Shift+P 设置CMake:Configure配置CMake, 点击该选项系统插件CMake Tools会自动创建项目数据库

引导程序环境

执行以下命令以引导 Matter 环境。此脚本需要 关心下载GN，忍者，并设置Python环境 用于构建和测试的库。

source scripts/bootstrap.sh

每当 Matter 环境过时，都可以通过运行上面来更新 命令。

对于MacOS，python软件包不会使用脚本安装，因为它仅限于x64 Linux平台。它是受限制的 因为，在 MacOS 上为 （依赖 ） 构建轮子失败。gdbguibootstrap.shgeventgdbgui

请在每次引导后运行以下命令。

解决方法是将轮子安装为二进制：gdbgui

python3 -m pip install -c scripts/setup/constraints.txt --no-cache --prefer-binary gdbgui==0.13.2.0 deactivate

---

建立 IDF 和 Matter 环境后，请转到 应用程序构建和调试指南。