Requirements and setup
This page outlines the requirements that you need to meet before you start working with the Matter and Zigbee add-on.
Hardware requirements
To use the Matter and Zigbee add-on, you need a development kit that supports and is able to fit both the Matter and Zigbee protocols.
Hardware platforms |
PCA |
Board name |
Board target |
|---|---|---|---|
PCA10184 |
|
||
PCA10156 |
|
Software requirements
For libraries and code for the Matter and Zigbee add-on, see the Matter and Zigbee Add-on repository.
To work with the Matter and Zigbee add-on, you need to install the nRF Connect SDK, including all its prerequisites and the nRF Connect SDK toolchain. Follow the Installing the nRF Connect SDK instructions, with the following exception:
In the Installing the nRF Connect SDK section, click Create a new application.
Select Browse nRF Connect SDK Add-on Index, then choose NCS Matter and Zigbee.
Select v1.0.0 of the Matter and Zigbee add-on. This step also installs the nRF Connect SDK v3.4.0.
Initialize a new workspace:
Run the following command to initialize west with the Matter and Zigbee add-on, which also initializes the nRF Connect SDK v3.4.0:
west init -m https://github.com/nrfconnect/ncs-matter-zigbeeUpdate the nRF Connect SDK modules:
west update
Include the add-on in an existing nRF Connect SDK workspace:
Assuming you have an existing nRF Connect SDK workspace in the
ncsfolder, run the following commands:Navigate to the workspace folder:
cd ncsClone the add-on repository:
git clone https://github.com/nrfconnect/ncs-matter-zigbeeSet the manifest path to the add-on directory:
west config manifest.path ncs-matter-zigbeeUpdate the nRF Connect SDK modules:
west update
Optionally, run these commands in case you need to go back to work on the nRF Connect SDK without the add-on:
Configure the manifest path back to the nRF Connect SDK directory:
west config manifest.path nrfUpdate nRF Connect SDK modules:
west updateCheck the current manifest path with the following command:
west config manifest.pathThe output should be:
nrfThis means that the current workspace is using the nRF Connect SDK.
See Configuring and building in the nRF Connect SDK documentation for information about how to permanently or temporarily change the configuration.