1. Supported host OSes

Matter is supported on Windows, Linux, and macOS.

2. Clone repository may fail

Errors:

Bootstrap: SSL error in Python when downloading CIPD client.

Solution: Please execute the commands suggested in the console output to install the Python SSL certificates, for more details see Pigweed prerequisite steps for macOS: https://pigweed.dev/docs/get_started/first_time_setup.html#install-prerequisites.

After installing the Python SSL certificates try to run the bootstrap script again using the "Update Repository" command on the imported Matter repository.

error: unable to create symlink src/test_driver/….: Permission denied

Solution: Please make sure to run Pigweed prerequisite steps from: https://pigweed.dev/docs/get_started/first_time_setup.html#configure-system-settings

---

Error:

Checking for Python …… MISSING!
Installing Python ……..
Start: This command cannot be run completely because the system cannot find all the information required.

Solution: This was seen on Windows when the first Python in the PATH is the alias provided by Microsoft. Open “Manage app execution aliases” and uncheck the two App Installer entries.

---

Error:

error: RPC failed; curl 92 HTTP/2 stream 0 was not closed cleanly: CANCEL (err 8)
error: 4627 bytes of body are still expected
fetch-pack: unexpected disconnect while reading sideband packet
fatal: early EOF
fatal: fetch-pack: invalid index-pack output

Solution: Git network connection error. Please retry the clone repository operation.

---

Error:

.venv\Scripts\activate.bat && pip install -r requirements.txt
ERROR: Could not find a version that satisfies the requirement spsdk==2.2.1 (from versions: 0.3.0, 0.3.1, 1.3.0, 1.3.1, 1.4.0, 1.4.0.post1, 1.4.0.post2, 1.5.0, 1.6.0, 1.6.1, 1.6.2, 1.6.3, 1.7.0, 1.7.1, 1.8.0, 1.9.0, 1.9.1, 1.10.0, 1.10.1, 1.11.0, 2.0.0, 2.0.1, 2.1.0, 2.1.1)
ERROR: No matching distribution found for spsdk==2.2.1

Solution: This happens if Python 3.8 is installed, and it is the first in PATH. If possible, either uninstall the Python 3.8 or make sure a newer Python version is the first in the PATH.

3. Build project fails

Error:

error: unable to create file lib/third_party/mcu_vendor/espressif/esp-idf/components/nghttp/nghttp2/doc/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.ttf: Filename too long

Solution: This is caused by the path length limit enforced by Windows. Please re-clone repository in a shorter path.

---

Error

../../third_party/connectedhomeip/third_party/nxp/nxp_matter_support/github_sdk/common_sdk/repo/middleware/lwip/src/include/lwip/opt.h:52:10: fatal error: lwipopts.h: No such file or directory
   52 | #include "lwipopts.h"
      |          ^~~~~~~~~~~~

Solution: This error might be encountered when building projects on RT/RW platforms for which the GN arguments are not provided. Please follow the building instructions from the README file of the used project and manually add the GN arguments in Build Configuration view.

4. ZAP launching may fail on Windows

Error:

'sh' is not recognized as an internal or external command

Solution: Please make sure ‘sh’ is installed and present in the PATH environment variable. Note: Git installer will install this utility too, so a fresh Git install may solve the problem (Git has this utility under {Git Folder}\usr\bin).

---

Error:

/bin/bash: c:/projects/repos/matter/.environment/cipd/packages/zap/zap: No such file or directory

Solution: Manually edit {Matter Repository}/scripts/tools/zap/run_zaptool.sh and change the call to "bash" at the end of the file into a "sh" call.

Change from:

bash -c " \
        $ZAP_CMD \
        ...

to:

sh -c " \
        $ZAP_CMD \
        ...

5. Flash Programmer tool fails to write default executable for the selected Matter project

Solution: Matter produces build artifacts without any extension. Please rename the file, add ‘.elf’ extension, and select it manually in the UI.

home