Quick Start Guide

[中文]

Downloading Armino Matter SDK code

You can download Armino Matter SDK from gitlab:

git clone git@gitlab.bekencorp.com:armino/bk_matter.git
(git checkout specified tag or branch)
git submodule update --init --recursive

Note

Download the latest SDK code from the official GitLab, and need approval with the relevant account.

Set up build environment for Armino

Please refer to bk7236 bk7258

Note: It is recommended to use Ubuntu version 22.04 or above.

Set up build environment for Matter

  1. Installing prerequisites on 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
    python3-lark python3-jinja2
pip install stringcase

Note: Python version 3.10 or above is required.

  1. Install gn: from here download, and install

sudo cp gn /usr/local/bin
sudo chmod +x /usr/local/bin

  1. Make sue ninja 和 gn install successfully

ninja --version

gn --version

  1. Compiling

make bk7236 PROJECT=matter
# Note: For the first make operation, it is recommended to execute "make clean" first.
#       If the compiler reports a ModuleNotFoundError during compilation, install the corresponding Python module using "pip install " according to the error prompt.

  1. Configure the zap tool

# When the compilation fails due to miss zap-cli or zap tool, you need to add the path of zap tool to the environment variable, as follows:
# Add zap tool to PATH. You can directly execute command in the shell to modiry the PATH temporarily, or  add PATH to ~/.bashrc file to modify the PATH permanently.
export PATH=<path-to-connectedhomeip>/zap/:$PATH
# If you add the zap path to ~/.bashrc , you need to execute
source ~/.bashrc

Introduction to Zap tool: [zap] is a visual tool for configuring Matter applications. For detailed information on the zap tool and code generation, please refer to the [official documentation].