Set Up Your Development Environment

​

ACK-SDK package

• Smart-light sample app, found in the Cyprus-SDK/smartlight-mtr-app directory.
• Middleware components, found in the Cyprus-SDK/ace directory.
• Matter SDK, found in the Cyprus-SDK/ace/sdk/external/matter/repo directory. You can find the Matter version in the ReleaseNotes.txt file.

​

Prerequisites

• An approved ACK project and an ACK support engineer assigned to your project. For details, see Apply for an ACK Project.
• A Windows, MacOS, or Ubuntu 22.04 LTS host machine with a USB port.
• ACK development kit for ACK SDK for Matter.
• USB cable to connect the development board to the host machine.
• Access to the ACK SDK for Matter provided by your ACK support engineer. To start a project, see Apply for an ACK Project.
• If you have an Espressif development board, sign up for a GitLab account and request access to the Espressif repo. For access to the repo, send email to ack-access@espressif.com.
• If you have a Beken development board, send email to ack-support@bekencorp.com.
• Ubuntu 22.04 LTS Operating System installed on your computer or in a virtual machine (VM). You need at least 20 GB for the ACK packages. Ubuntu 22.04 comes with Python 3.10. These instructions require python 3.10.

pip --version

• A Git repository available in your Ubuntu development environment. You can add the ACK SDK for Matter to an existing Git repository or initialize a new repository in the SDK directory.

​

Steps to set up your development environment

1. Download required packages.
2. Build Matter tools.
3. Install ACK SDK tools.
4. Download the ZAP tool.
5. Connect your host machine to the development kit.

​

Step 1: Download required packages

1. To download the GN build tools, in your browser, open GN, and then download and unpack the latest version of the GN binary for Linux.
2. In an Ubuntu VM terminal, navigate to your home directory, and then edit .profile to add the GN directory path to your PATH variable. Save the file.
   PATH="$PATH:<path to GN binary>"
   

3. To update your PATH variable, log out of the VM, and then log back in.
4. To install Linux dependencies, at the command prompt, enter the following command.

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 cmake

5. If you already downloaded the SDK and extracted the files, go to Step 9.
6. To download the ACK SDK for Matter, navigate to the AWS S3 bucket provided by the ACK support engineer, and then download the Cyprus-SDK zip file.
7. To extract the files into a destination directory, such as Cyprus-SDK, enter the following command.

    unzip Cyprus-SDK_<version>.zip -d <destination directory, such as Cyprus-SDK>

8. Verify the Cyprus-SDK directory was created successfully.
9. If you have a Beken development kit, contact the ACK team for steps to download the required packages.
10. If you have an Espressif development kit, complete the following steps to download the required packages.
    To download the packages, you need a GitLab account and access to the Espressif repo.

tar -xzf esp-dpk.tar.gz

11. If you downloaded the SDK to an existing Git repository, go to step 13.
12. In your VM terminal window, navigate to the Cyprus-SDK directory.
13. To add a Git repository to the SDK, at the command prompt, enter the following command.

    git init

14. To commit the SDK files, at the command prompt, enter the following commands.

    git add .
    git commit -m "Initial commit of Cyprus SDK"

​

Step 2: Build Matter tools

1. To check out the Matter repo, follow the instructions in Checking out All Platforms.
2. To set up the environment, follow the instructions in Prepare for building.
3. To build the Matter SDK, follow the instructions in Build for the host OS (Linux or macOS).
4. To build the chip-tool, follow the instructions in Building from source.
   The chip-tool acts as a Matter controller that allows you to commission your device to the Matter network and use Matter commands to communicate with your device.
5. To build the chip-cert tool, follow the instructions in Building.
   You use the chip-cert tool to generate and verify Matter certificates.
6. In a convenient place, such as Notepad on Windows or TextEdit on Mac, paste the directory where you placed the chip-tool and chip-cert tools.

​

Step 3: Install ACK SDK tools

1. To download the ACK SDK tools package, navigate to the tools folder in the AWS S3 bucket, and then download the ACK_SDK_Tools-matter zip file.
2. To extract the files into a destination folder at the same level as the Cyprus-SDK, enter the following command in a Windows terminal.

unzip ACK_SDK_Tools-matter.zip -d <destination folder>

3. To install the acksdktools package, navigate to the destination folder, and then, enter the following command.

pip install .

4. To verify the ACK SDK tools installed correctly, enter the following command.

pip list

5. Verify that you see the acksdktools package in the list.

​

Step 4: Download the ZAP tool

1. Navigate to the ZAP repository in GitHub.
2. On the right side, under Releases, choose Latest.
3. Download the ZIP file for your host machine type.
4. To extract the files into a destination directory of your choice, in your VM terminal, enter the following command.

unzip zap.<OS type>.zip

​

Step 5: Connect your host machine to the development kit

    sudo usermod -a -G dialout $USER

    dmesg | grep tty

screen /dev/tty<port number> 115200

screen /dev/cu.usbserial-<port number> 115200

​

Related topics

• Building Matter
• CHIP Certificate Tool
• Working with the CHIP Tool
• Build Apps for ACK-based Matter Devices
• Provision ACK-based Matter Prototype Devices
• Commission ACK-based Matter Devices
• Certify ACK-based Matter Devices
• Manufacture ACK-based Matter Devices