Software Setup and Preliminaries#
Using the Matter Accessory Device (MAD) Pre-Built Binaries#
[GITHUB]
If you are just running the Matter demo, and are not interested in building the Matter Accessory Device images from scratch, you can download the MAD images for Wi-Fi from this software release on the Matter Artifacts Page
Once you have downloaded the image you require for your device, you can skip forward to the Running the Matter Demo over Wi-Fi page
If you are planning to build the Wi-Fi images from scratch, continue with this documentation.
Software Setup#
[GITHUB]
If you have not downloaded or cloned this repository, you can run the following commands on a Linux terminal running on either Linux machine, WSL or Virtual Machine to clone the repository and run bootstrap to prepare to build the sample application images.
To download the Silicon Labs Matter codebase run the following commands.
git clone https://github.com/SiliconLabs/matter.git
Bootstrapping:
$ cd matter $ ./scripts/checkout_submodules.py --shallow --recursive --platform efr32 $ . scripts/bootstrap.sh # Create a directory where binaries will be updated/compiled called `out` $ mkdir out
Compiling the chip-tool#
[SIMPLICITY STUDIO] & [GITHUB]
In order to control the Wi-Fi Matter Accessory Device you will have to compile and run the chip-tool on either a Linux, Mac or Raspberry Pi. The chip-tool builds faster on the Mac and Linux machines so that is recommended, but if you have access to a Raspberry Pi that will work as well.
Build the chip-tool
./scripts/examples/gn_build_example.sh examples/chip-tool out/standalone
This will build chip-tool in
out/standalone
.
Building the Matter Application in Simplicity Studio#
[SIMPLICITY STUDIO]
Silicon Labs offers a complete IDE and Matter Development tool set inside Simplicity Studio. For more information on using Simplicity Studio to build your Matter Accessory Device please consider the Matter in Simplicity Studio section in this documentation.
Building the Matter Application from GitHub#
[GITHUB]
The following commands are for building the Matter application. Depending on which device you are using, select the appropriate command to build.
Note:
The following build commands are for the
lighting-app
application.In order to build different applications other than
lighting-app
(such aslock-app
), substitute the appropriate application name.Additional examples are provided in the /examples directory, or /silabs_examples (such as
onoff-plug-app
).In order to build from /silabs_examples (such as
onoff-plug-app
), substituteexamples
withsilabs_examples
.To build for EFR32MG12 or EFR32MG24 host processors, substite
BRD41xxx
in the build command with the appropriate MG12 or MG24 board number from the Hardware Requirements Page.
Run the following:
Note: In the following commands you will notice that the board names are abstracted as in
BRD41xxx
these references should be replaced with the board that you are using. You can find the board name on the back of the radio board, soBRD41xxx
should becomeBRD4161A
for instance.
cd matter
<run_appropriate_build_command_from_below>
Build command for EFR32MG12 + RS9116:
./scripts/examples/gn_efr32_example.sh examples/lighting-app/efr32 out/rs911x_lighting BRD41xxx --wifi rs911x |& tee out/rs911x_lighting.log
Build command for EFR32MG24 + RS9116:
./scripts/examples/gn_efr32_example.sh examples/lighting-app/efr32 out/rs911x_lighting BRD41xxx disable_lcd=true use_external_flash=false --wifi rs911x |& tee out/rs911x_lighting.log
Build command for EFR32MG24 + SiWx917:
./scripts/examples/gn_efr32_example.sh examples/lighting-app/efr32 out/siwx917_lighting BRD41xxx disable_lcd=true use_external_flash=false --wifi rs911x |& tee out/siwx917_lighting.log
Build command for EFR32MG12 + WF200:
./scripts/examples/gn_efr32_example.sh examples/lighting-app/efr32 out/wf200_lighting BRD41xxx chip_build_libshell=false is_debug=false --wifi wf200 |& tee out/wf200_lighting.log
Build command for EFR32MG24 + WF200:
./scripts/examples/gn_efr32_example.sh examples/lighting-app/efr32 out/wf200_lighting BRD41xxx chip_build_libshell=false disable_lcd=false is_debug=false --wifi wf200 |& tee out/wf200_lighting.log
A complete list of hardware supported is included on the Hardware Requirements page.
Enable or disable the lighting application's features using the following flags.
rs91x_wpa3_only
: Use this flag while building to enable wpa3 mode in rs91x wifi chip../scripts/examples/gn_efr32_example.sh examples/lighting-app/efr32/ out/rs911x_lighting BRD41xxx rs91x_wpa3_only=true --wifi rs911x |& tee out/rs911x_lighting.log
Note:
WPA/WPA2 is enabled by default for the rs911x
Enabling WPA3 will disable WPA and WPA2 support
segger_rtt_buffer_size_up
: Flag to get the complete logs without truncation../scripts/examples/gn_efr32_example.sh examples/lighting-app/efr32/ out/rs911x_lighting BRD41xxx segger_rtt_buffer_size_up=2068 --wifi rs911x |& tee out/rs911x_lighting.log
show_qr_code=false
: Use this flag while building to disable QR code../scripts/examples/gn_efr32_example.sh examples/lighting-app/efr32/ out/rs911x_lighting BRD41xxx show_qr_code=false --wifi rs911x |& tee out/rs911x_lighting.log
Note:
QR code is enabled by default for all except MG24
QR code is disabled for MG24 because of lcd disable. It cannot be enabled using the flag.
The generated software can be found in
out/rs911x_xxx/BRD41xxx/*.s37
.
This is what you will flash onto the EFR32. For more information on how to flash the EFR32 see Flashing a Silicon Labs Device
[Optional: Increasing stack size ]
Navigate to
matter
and open the file in the path
examples/platform/efr32/FreeRTOSConfig.h
. Find the macro:
`configMINIMAL_STACK_SIZE
`, and change the macro value from 140
to
320
.