diff --git a/sld247-matter-overview/index.md b/sld247-matter-overview/index.md index 9fa340b..edb73c7 100644 --- a/sld247-matter-overview/index.md +++ b/sld247-matter-overview/index.md @@ -13,16 +13,20 @@ The procedures here describe how to make a simple network of a light, a switch, ## Initial Setup Both the Matter over Wi-Fi and Matter over Thread demos require that you have set up a simple development environment with Simplicity Studio, -two EFR32MG24-based development boards, and a Raspberry Pi used as a Matter hub. The following requirements are common to both demos. The Thread demo also requires a radio co-processor (RCP) as part of the Matter hub. The requirements for this are provided in the [introduction to the Thread demo](/matter/{build-docspace-version}/matter-light-switch-example/02-thread-light-switch-example). +two Matter compatible development boards (see the [Silicon Labs Matter Selector Guide](https://www.silabs.com/wireless/matter/selector-guide) for available boards and their capabilities), and a Raspberry Pi used as the Matter Controller. The following requirements are common to both demos. The Thread demo requires a radio co-processor (RCP) connected to the Matter Controller. The requirements for this are provided in the [introduction to the Thread demo](/matter/{build-docspace-version}/matter-light-switch-example/02-thread-light-switch-example). ### Hardware Requirements #### Matter Hub -- 1 Raspberry Pi 4B +- 1 Raspberry Pi 4B or newer - 1x high speed, 64 GB SD card -#### Matter Devices + +**Matter Over Thread Devices** + +- SoC: EFR32x MG24, MG26, MG301 +- RCP: EFR32x MG21, MG24, MG26, MG301 **Matter Over Wi-Fi Accessory Device Requirements for NCP Mode** @@ -62,7 +66,7 @@ Pre-built images for the SiWx917 connectivity firmware are available per the ins ### Software Requirements -**Simplicity Studio 5**: Download and install Simplicity Studio 5 for your operating system from the Silicon Labs [Simplicity Studio page](https://www.silabs.com/developers/simplicity-studio). While the installation process is easy to follow, instructions are provided in the Simplicity Studio v5 [Getting Started section](https://docs.silabs.com/simplicity-studio-5-users-guide/latest/ss-5-users-guide-getting-started/install-ss-5-and-software). +**Simplicity Studio**: Download and install Simplicity Studio for your operating system from the Silicon Labs [Simplicity Studio page](https://www.silabs.com/developers/simplicity-studio). Detailed instructions are provided in the Simplicity Studio [User Guide](https://docs.silabs.com/ssv6ug/latest/ssv6ug-overview/). **Ozone - The J-Link Debugger**: [Ozone](https://www.segger.com/products/development-tools/ozone-j-link-debugger/) is a full-featured graphical debugger for embedded applications. With Ozone, it is possible to debug any embedded application on C/C++ source and assembly level. @@ -70,9 +74,13 @@ Pre-built images for the SiWx917 connectivity firmware are available per the ins **Tera Term**: [Tera Term](https://github.com/TeraTermProject/osdn-download) is the terminal emulator for Microsoft Windows that supports serial port, telnet, and SSH connections. -**Silicon Labs Matter SiSDK Extension**: Once Simplicity Studio 5 is installed, you will be prompted to install the Simplicity SDK, formerly released as Gecko SDK (GSDK). Here you should also install the Matter Enablement Package by making sure the extension is checked, as shown. +**Silicon Labs Matter SiSDK Extension**: Once Simplicity Studio is installed, you will be prompted to install the Simplicity SDK. Here you should also install the Matter Enablement Package by making sure the extension is checked, as shown. + +![Installing the Matter Extension](./resources/ssv6-matter-install-guide-1.png) + +![Installing the Matter Extension](./resources/ssv6-matter-install-guide-2.png) -![Installing the Matter Extension](./resources/install-package-advanced-device.png) +![Installing the Matter Extension](./resources/ssv6-matter-install-guide-3.png) **Installation of Wi-Fi SDK and WiSeConnect Packages**: The following packages will be installed during the installation of Simplicity Studio. Refer to [Package Installation](/matter/{build-docspace-version}/matter-wifi-getting-started-example/software-installation). @@ -88,9 +96,9 @@ Pre-built images for the SiWx917 connectivity firmware are available per the ins ### Visual Studio Code Development -In addition to creating and building your Matter project within Simplicity Studio, Silicon Labs also provides Visual Studio Code (VSCode) IDE integration. +Once a Matter project is created and any components or ZCL clusters modified in Simplicity Studio, Silicon Labs provides a Visual Studio Code (VS Code) IDE extension where code changes can be made. Simplicity Studio 6 (SSv6) does not provide an IDE; instead, VS Code is used. Projects can be built, flashed and debugged directly from VS Code. -For more information on development within Visual Studio Code, please visit [Visual Studio Code Enablement](https://docs.silabs.com/simplicity-studio-5-users-guide/latest/ss-5-users-guide-vscode-ide/). +For more information on development with Visual Studio Code, please visit [Visual Studio Code Enablement](https://docs.silabs.com/ss-vscode/latest/ss-vscode-start/). ## Next Steps diff --git a/sld247-matter-overview/resources/install-package-advanced-device.png b/sld247-matter-overview/resources/install-package-advanced-device.png deleted file mode 100644 index ffbfdd2..0000000 Binary files a/sld247-matter-overview/resources/install-package-advanced-device.png and /dev/null differ diff --git a/sld247-matter-overview/resources/ssv6-matter-install-guide-1.png b/sld247-matter-overview/resources/ssv6-matter-install-guide-1.png new file mode 100644 index 0000000..ebdc1c7 Binary files /dev/null and b/sld247-matter-overview/resources/ssv6-matter-install-guide-1.png differ diff --git a/sld247-matter-overview/resources/ssv6-matter-install-guide-2.png b/sld247-matter-overview/resources/ssv6-matter-install-guide-2.png new file mode 100644 index 0000000..173e84e Binary files /dev/null and b/sld247-matter-overview/resources/ssv6-matter-install-guide-2.png differ diff --git a/sld247-matter-overview/resources/ssv6-matter-install-guide-3.png b/sld247-matter-overview/resources/ssv6-matter-install-guide-3.png new file mode 100644 index 0000000..cb136e7 Binary files /dev/null and b/sld247-matter-overview/resources/ssv6-matter-install-guide-3.png differ diff --git a/sld250-matter-references/flash-silabs-device.md b/sld250-matter-references/flash-silabs-device.md index a898d30..8aa5c02 100644 --- a/sld250-matter-references/flash-silabs-device.md +++ b/sld250-matter-references/flash-silabs-device.md @@ -8,12 +8,9 @@ Simplicity Studio is a complete development environment and tool suite. It has t - [Download Simplicity Studio](https://www.silabs.com/developers/simplicity-studio). - Building Application Using Simplicity Studio: - - [Build Application for EFR32](/matter/{build-docspace-version}/matter-wifi-run-demo/build-efx32-application-using-studio) - - [Build Application for SoC](/matter/{build-docspace-version}/matter-wifi-run-demo/build-soc-application-using-studio) -- Flash Application Using Simplicity Studio: - - [Build Application for EFR32 Step 9](/matter/{build-docspace-version}/matter-wifi-run-demo/build-efx32-application-using-studio) - - [Build Application for SoC Step 9](/matter/{build-docspace-version}/matter-wifi-run-demo/build-soc-application-using-studio) -- [Simplicity Studio Reference Guide](https://docs.silabs.com/simplicity-studio-5-users-guide/latest/ss-5-users-guide-building-and-flashing/flashing) + - [Build Application for EFR32](/matter/{build-docspace-version}/matter-quick-start-demo/02-thread-quick-start-demo.md#step-2-build-the-project-in-the-silicon-labs-extension-for-the-visual-studio-code-ide) +- [Flash Application](/matter/{build-docspace-version}/sld251-matter-thread/build-flash-mad.md#step-2-flash-the-matter-accessory-device) +- [Simplicity Studio Reference Guide](https://docs.silabs.com/ssv6ug/latest/ssv6ug-overview/) ## Simplicity Commander diff --git a/sld250-matter-references/matter-ep.md b/sld250-matter-references/matter-ep.md index d60e387..36c0055 100644 --- a/sld250-matter-references/matter-ep.md +++ b/sld250-matter-references/matter-ep.md @@ -11,4 +11,4 @@ Matter project will not have been created inside Simplicity Studio. Complete documentation on using the Simplicity Studio Energy Profiler is provided in the -[Simplicity Studio 5 Energy Profiler User's Guide](https://docs.silabs.com/simplicity-studio-5-users-guide/latest/ss-5-users-guide-tools-energy-profiler/). +[Simplicity Energy Profiler User's Guide](https://docs.silabs.com/energy-profiler/latest/energy-profiler-start/). diff --git a/sld250-matter-references/matter-pintool.md b/sld250-matter-references/matter-pintool.md index 1b52b32..3a96dd7 100644 --- a/sld250-matter-references/matter-pintool.md +++ b/sld250-matter-references/matter-pintool.md @@ -19,24 +19,29 @@ When creating a configuration for a custom board do the following: 3. Copy the generated output config files into a custom board support directory within the Matter repository. -## 2. Create a sample "Empty C++ project" in Simplicity Studio +## 2. Create a Sample "Empty C++ project" in Simplicity Studio -1. In Simplicity Studio click `Create a New Project` - to start the project wizard. Choose your development board type, and the - latest Gecko SDK you'll be working from. Click **Next**. +1. In Simplicity Studio, next to **Start a New Project**, click **all projects & demos** to start the project wizard. +2. In the upper right, click **Select Device** to choose your development board, and in the dropdown, select the appropriate Simplicity SDK. +3. Scroll to the **Empty C++ Project** example, and click **Create**. +4. Click **Finish** to create your project. + to start the project wizard. Choose your development board type via the `+ Select Device` button, and the + latest Simplicity SDK you'll be working from -2. Select the `Empty C++ Project` example and click **Next**. +5. Select the `Empty C++ Project` example and click **Create**. -3. Click **Finish** to create your project. +6. Select a compatible device then click **Next**. + +7. Click **Finish** to create your project. ## 3. Customize your Components and Pin configuration in Simplicity Studio -Once you have your project created you will see your project and project -configuration in Simplicity Studio's Project Configurator. Full documentation on +Once you have your project created, you will see your project and project +configuration in Simplicity Studio's Project Configurator. For full documentation on the use of the Project Configurator and Pin Tool, see the [Simplicity Studio User's Guide](https://docs.silabs.com/ssv6ug/latest/ssv6-configure-project/pin-tool). the use of the Project Configurator and Pin Tool are located here: -[Simplicity Studio 5 User's Guide](https://docs.silabs.com/simplicity-studio-5-users-guide/latest/ss-5-users-guide-developing-with-project-configurator/) +[Simplicity Studio User's Guide](https://docs.silabs.com/ssv6ug/latest/ssv6-configure-project/pin-tool) -## 4. Generate your Component and Pin configuration in Simplicity Studio +## 4. Generate your Component and Pin Configuration in Simplicity Studio When you save your project configuration, Simplicity Studio saves all the generated header files out into a `config` directory in your diff --git a/sld250-matter-references/using-studio.md b/sld250-matter-references/using-studio.md index c0334db..0c2baf7 100644 --- a/sld250-matter-references/using-studio.md +++ b/sld250-matter-references/using-studio.md @@ -1,18 +1,18 @@ # Development Tools in Simplicity Studio -Simplicity Studio contains a number of integrated tools that you can use with projects created within that environment. +Simplicity Studio contains a number of integrated tools that you can use with projects created within that environment. Documentation on all of these tools can be found in the [Simplicity Studio 6 User's Guide](https://docs.silabs.com/ssv6ug/latest/ssv6ug-overview/). ## Bluetooth GATT Configurator -The Simplicity Studio Bluetooth LE (BLE) GATT Configurator is an Advanced Configurator within the Simplicity Studio Project Configuration suite. You can add the BLE GATT configuration by adding the `Bluetooth > GATT > Configuration` component to your project. This will enable the BLE GATT Configurator under `Configuration Tools > Bluetooth GATT Configurator`. See the Simplicity Studio v5 User's Guide for more information on using the [BLE GATT Configurator](https://docs.silabs.com/simplicity-studio-5-users-guide/latest/ss-5-users-guide-developing-with-project-configurator/bluetooth-gatt-configurator). +The Simplicity Studio Bluetooth LE (BLE) GATT Configurator is an Advanced Configurator within the Simplicity Studio Project Configuration suite. You can add the BLE GATT configuration by adding the **Bluetooth > GATT > Configuration** component to your project. This will enable the BLE GATT Configurator under **Configuration Tools > Bluetooth GATT Configurator**. See the Simplicity Studio User's Guide for more information on using the [BLE GATT Configurator](https://docs.silabs.com/ssv6ug/latest/ssv6-configure-project/bluetooth-gatt-configurator). ## Energy Profiler Simplicity Studio's Energy Profiler allows you to see a graphical view of your device's energy usage over time. This can be very useful when developing an energy-friendly device. Complete documentation on using the Simplicity Studio Energy Profiler is provided in the -[Simplicity Studio 5 Energy Profiler User's Guide](https://docs.silabs.com/simplicity-studio-5-users-guide/latest/ss-5-users-guide-tools-energy-profiler/). +[Simplicity Energy Profiler User's Guide](https://docs.silabs.com/energy-profiler/latest/energy-profiler-start/). ## Custom Hardware Configuration -At some point during product development you may need to move your project over to your custom hardware. In this case, you will likely need to change the pinout and hardware configuration in the example project to reflect your own custom project. You can do this using the Pin Tool. The Simplicity Studio 5 User's Guide contains full documentation on using the [Pin Tool](https://docs.silabs.com/simplicity-studio-5-users-guide/latest/ss-5-users-guide-developing-with-project-configurator/pin-tool). +At some point during product development, you may need to move your project over to your custom hardware. In this case, you will likely need to change the pinout and hardware configuration in the example project to reflect your own custom project. You can do this using the Pin Tool. The Simplicity Studio User's Guide contains full documentation on using the [Pin Tool](https://docs.silabs.com/ssv6ug/latest/ssv6-configure-project/pin-tool). diff --git a/sld251-matter-thread/build-flash-mad.md b/sld251-matter-thread/build-flash-mad.md index ba6df93..8b91a32 100644 --- a/sld251-matter-thread/build-flash-mad.md +++ b/sld251-matter-thread/build-flash-mad.md @@ -6,7 +6,7 @@ The Matter Accessory Device, such as the lighting-app, is the actual Matter devi Use one of the following options to get the required image to flash the MAD: -1. Use the pre-built image file from either Simplicity Studio or [Matter Artifacts page](/matter/{build-docspace-version}/matter-prerequisites/matter-artifacts). +1. Use the pre-built image file from either Simplicity Studio (Demos) or [Matter Artifacts page](/matter/{build-docspace-version}/matter-prerequisites/matter-artifacts). 2. Build the image file from Simplicity Studio or out of the CSA Matter GitHub repository. ### Using the Pre-Built Image File @@ -17,13 +17,16 @@ Prebuilt image files are available both on GitHub and inside Simplicity Studio. To find the demos within Simplicity Studio, even if you do not have a device connected: -1. In Simplicity Studio, click the Launcher in the upper right hand corner. -2. Under **Get Started**, choose **All Products**. -3. Choose a board to start with such as **BRD4186C Rev A01** and click **Start**. This will bring up the Launcher window for that part. -4. In the top navigation, choose **Example Projects & Demos**. -5. In the left hand navigation, choose **Matter** to show all the Matter demos. -6. The demos are marked as "demo" and allow you to "run" them. Projects can be "created". -7. Choose the demo you wish to use, and click **Run** to flash it onto your board. +1. In Simplicity Studio, click the **Home** tab in the upper left corner. +2. Next to **Start a New Project**, click **all projects & demos**. +3. In the upper right, click **Select Device** to choose a connected board or search for a virtual board such as **BRD4187C**. This filters the window for that part. +4. In the left navigation, check **Matter** to show all Matter demos. + The demos are marked as **Demo** and allow you to **Run** them. Projects can be *created*. +5. Choose a demo, and click **Run** to flash it onto your board. +6. Choose a board to by clicking on **Select Device**, you can choose from a connected board or search for one such as **BRD4187C** and on the board. This will filter the window for that part. +7. In the left hand navigation, choose **Matter** to show all the Matter demos. +8. The demos are marked as "demo" and allow you to "run" them. Projects can be "created". +9. Choose the demo you wish to use, and click **Run** to flash it onto your board. #### Silicon Labs GitHub @@ -33,14 +36,25 @@ If you are coming from Simplicity Studio, you may have already installed the dem ### Building the Matter Image File - The entire build process for Simplicity Studio is covered in the [Matter Over Thread Quick Start Guide](/matter/{build-docspace-version}/matter-light-switch-example/02-thread-light-switch-example). - -- [Build Using Simplicity Studio](/matter/{build-docspace-version}/matter-light-switch-example/02-thread-light-switch-example) + The entire build process for Simplicity Studio is covered in the [Matter over Thread QuickStart Demo](/matter/{build-docspace-version}/matter-quick-start-demo/02-thread-quick-start-demo.md#step-1-create-a-matter-sample-project). ## Step 2: Flash the Matter Accessory Device -For more information on how to flash your Silicon Labs development platform, see the following instructions: [How to Flash a Silicon Labs Device](/matter/{build-docspace-version}/matter-references/flash-silabs-device). -For more information on how to flash your Silicon Labs development platform, see the following instructions: [How to Flash a Silicon Labs Device](/matter/{build-docspace-version}/matter-references/flash-silabs-device). +There are a few ways to flash a device using Simplicity Studio. + +1. [Flash from VS Code](/matter/{build-docspace-version}/matter-quick-start-demo/02-thread-quick-start-demo.md#step-3-flash-the-device) +2. Flash from Commander GUI: + 1. In Simplicity Studio, click **Tools**, click **Commander**, and then click **Open Tool**. + The stand-alone Commander GUI opens. + 2. Select the board, click **Flash**, and then click **Browse** to find the image file and flash it. + + ![Commander GUI](./resources/studio-6-commander-gui.png) + 2. This will open the stand alone Commander GUI. From here select the board and then click on the flash tab. Browse to the image file and flash it. + + ![Commander Flash](./resources/studio-6-commander-flash-tab.png) + +3. [Flash from Commander CLI](https://docs.silabs.com/simplicity-commander/latest/simplicity-commander-commands/device-flashing-commands) +4. [Flash using Simplicity Device Manager](https://docs.silabs.com/device-manager/latest/device-manager-work-in/devices) Once your Matter Accessory Device has been flashed, it should show a QR code on the LCD. If no QR Code is present, it may be that you need to add a bootloader to your device. Bootloader images are provided on the [Matter Artifacts page](/matter/{build-docspace-version}/matter-prerequisites/matter-artifacts). diff --git a/sld251-matter-thread/demo-overview.md b/sld251-matter-thread/demo-overview.md deleted file mode 100644 index dca95bb..0000000 --- a/sld251-matter-thread/demo-overview.md +++ /dev/null @@ -1,2 +0,0 @@ -# Matter over Thread Example - diff --git a/sld251-matter-thread/matter-rcp.md b/sld251-matter-thread/matter-rcp.md index 7d1b44d..118d50a 100644 --- a/sld251-matter-thread/matter-rcp.md +++ b/sld251-matter-thread/matter-rcp.md @@ -20,7 +20,11 @@ RCP image files for all demo boards are accessible through the [Matter Artifacts ### Building the Image File from Simplicity Studio -RCP Images can be built from Simplicity Studio. Select **File > New > Silicon Labs Project Wizard**, look through the **Example Projects**, and then select the **Openthread - RCP Project**. Once the project is generated, you can build and flash the RCP. You can follow along in the [Simplicity Studio Getting Started Guide](https://docs.silabs.com/simplicity-studio-5-users-guide/latest/ss-5-users-guide-getting-started/start-a-project) for more information. +RCP Images can be built from Simplicity Studio. + +Click **Home**. Next to **Start a New Project**, click **all projects & demos**, look through the **Example Projects & Demos**, and then select the **OpenThread - RCP** project. + +Once the project is generated, you can build and flash the RCP. You can follow along in the [Light Switch Example](/matter/{build-docspace-version}/matter-light-switch-example/02-thread-light-switch-example.md#setting-up-the-matter-hub) for more information. ### Building the Image File from the ot-efr32 Repository @@ -63,7 +67,7 @@ The output of the build process puts all the image files in the following locati ## Step 2: Flash the RCP -Once you get the RCP image, either by downloading a prebuilt image or building the image file, you can flash it to your device. This is done directly from your laptop and not through the Raspberry Pi, so make sure that the device is connected directly over USB to your laptop. You can flash your RCP using Simplicity Studio or using standalone Simplicity Commander. +Once you get the RCP image, either by downloading a prebuilt image or building the image file, you can flash it to your device. This is done directly from your laptop and not through the Raspberry Pi, so make sure that the device is connected directly over USB to your laptop. You can flash your RCP using Simplicity Studio or using standalone Simplicity Commander (see [How to Build and Flash the Matter Accessory Device](/matter/{build-docspace-version}/matter-thread/build-flash-mad.md#step-2-flash-the-matter-accessory-device)). Once you have flashed the image, the device becomes the RCP. Disconnect it from you laptop and connect it via USB to the Raspberry Pi. diff --git a/sld251-matter-thread/matter-thread.md b/sld251-matter-thread/matter-thread.md deleted file mode 100644 index 4de752e..0000000 --- a/sld251-matter-thread/matter-thread.md +++ /dev/null @@ -1,3 +0,0 @@ -# Introduction - - diff --git a/sld251-matter-thread/resources/studio-6-commander-flash-tab.png b/sld251-matter-thread/resources/studio-6-commander-flash-tab.png new file mode 100644 index 0000000..04b89f4 Binary files /dev/null and b/sld251-matter-thread/resources/studio-6-commander-flash-tab.png differ diff --git a/sld251-matter-thread/resources/studio-6-commander-gui.png b/sld251-matter-thread/resources/studio-6-commander-gui.png new file mode 100644 index 0000000..0bf48bb Binary files /dev/null and b/sld251-matter-thread/resources/studio-6-commander-gui.png differ diff --git a/sld406-matter-light-switch-example/02-thread-light-switch-example.md b/sld406-matter-light-switch-example/02-thread-light-switch-example.md index 1eff3e6..579db34 100644 --- a/sld406-matter-light-switch-example/02-thread-light-switch-example.md +++ b/sld406-matter-light-switch-example/02-thread-light-switch-example.md @@ -4,23 +4,31 @@ 1. Prepare a compatible development board to become your Matter hub's ot-rcp: - 1. Start Simplicity Studio 5 with the latest SiSDK and Silicon Labs Matter SiSDK Extension installed (see details in the [Overview](/matter/{build-docspace-version}/matter-overview#software-requirements)). + 1. Start Simplicity Studio with the latest SiSDK and Silicon Labs Matter SiSDK Extension installed (see details in the [Overview](/matter/{build-docspace-version}/matter-overview#software-requirements)). - ![the Matter extension](./resources/image1.png) + ![the Matter extension](./resources/matter-sdk-version.png) 2. Connect the dev board to your development computer. - 3. Once it shows up in the Debug Adapters view, select it. + 3. Once it displays in the **Devices** panel, select it. - ![Debug Adapters view](resources/image2.png) + ![Devices view](resources/matter-ssv6-connected-devices.png) - 4. Go to the Example Projects and Demos tab. Select the **OpenThread** filter and enter *openthread rcp* in the **Filter on keywords** box. Select the **OpenThread - RCP** example and click **Run**. + The device page opens. + 4. Click **Create New Project**. + The **Example Projects & Demos** tab displays. + 5. Enter *openthread rcp* in the **Filter on keywords** box. + 6. Select the **OpenThread - RCP** example and click **Create**. - ![Example projects and demos view](resources/image3.png) + ![Example projects and demos view](resources/ssv6-ot-rcp-demo.png) - 5. Disconnect the dev board and connect it to your RPi4B. + 7. Now build & flash the ot-rcp project using the Simplicity Studio VS Code Extension (for a detailed breakdown of these steps, see the [Matter over Thread QuickStart Demo](/matter/{build-docspace-version}/-matter-quick-start-demo/02-thread-quick-start-demo.md#step-1-create-a-matter-sample-project). + This example shows a Matter Lighting device but the steps are identical for an RCP project). + 8. Once the RCP firmware has been built and flashes, disconnect the dev board and connect it to your Raspberry Pi. -2. Prepare the Raspberry Pi 4B (RPi4B) to become a Matter hub: + > Note: The Matter hub OpenThread RCP (ot-rcp) must be programmed with a bootloader and firmware image to act as the ot-rcp for the Raspberry Pi. You can obtain a copy of the latest version here: [Silicon Labs Matter Artifacts](/matter/{build-docspace-version}/matter-prerequisites/matter-artifacts). + +2. Prepare the Raspberry Pi (RPi4B in this example) to become a Matter hub: 1. Download and extract the Matter hub Raspberry Pi image (see details under [Software requirements](/matter/{build-docspace-version}/matter-overview#software-requirements)). @@ -64,52 +72,27 @@ You now have a working Matter hub. Keep the PuTTY session open for the following ## Creating the Matter Accessory Devices (MADs) -1. In Simplicity Studio 5, create the light MAD: - - 1. Switch to the Launcher view (if not already in it). - - 2. Connect one compatible dev board to your development computer. This example uses a BRD4186C. - - 3. Once it shows up in the Debug Adapters view, select it. - - 4. Go to the Example Projects and Demos tab, turn off **Demos**, check the **Matter** filter under **Wireless Technology**, and enter *thread* in the **Filter on keywords** box. Select the **Matter - SoC Lighting over Thread with external Bootloader Solution** and click **Create**. - - ![Select the example project](resources/example-project.png) - - 5. Name your project and click **Finish** (no other changes are required at this time). - - ![Create the project](resources/create-project.png) - - 6. Once the solution is created, select it in the Project Explorer view and click the hammer icon to build. This will begin building both the bootloader and application images. - - ![Build the project](resources/build-project.png) - - 7. Once the compilation is done, right-click the dev board in the Debug Adapters view and select **Upload application**. - - ![Upload application](resources/image13.png) +1. In Simplicity Studio, create the light MAD: - 8. Select the **Application image path** for your newly compiled solution application. The resulting application image will be within the **artifact** directory inside the solution project. This image has both the bootloader and application binaries combined into one image. Check **Erase chip before uploading image**. Bootloader images are also provided in the zip file referenced on the [Silicon Labs Matter Artifacts page](/matter/{build-docspace-version}/matter-prerequisites/matter-artifacts). Unzip and reference the extracted location if electing to use these default bootloader images. + 1. Connect one compatible dev board to your development computer. This example uses a BRD4187C. - ![Application image upload](resources/image-upload.png) + 2. Once it displays in the **Devices** panel, select it. - **Note**: If you are unsure of the path for the newly created binary, you can find the project’s path in the project’s *Properties* window under *Resource*. The binary is typically located in: - >*{solution folder}\|{project name folder}\|{GNU ARM v??? folder}\|{project name binary}.s37* + 3. This will bring up the Example Projects and Demos tab, check the **Matter** filter under **Wireless Technology**, and enter *lighting* in the **Filter on keywords** box. Select the **Matter - SoC Lighting over Thread with external Bootloader Solution** and click **Create**. - For example, you will find the binary for a Matter light over Thread project with the default name here: - >*{solution folder}/MatterLightOverThread/GNU ARM v12.2.1 - Default/MatterLightOverThread.s37* + ![Select the example project](resources/studio-6-matter-thread-demo-lighting-projects.png) - The combined binary (bootloader and application image) will be located in: - >*{solution folder}/MatterLightOverThread/artifact/MatterLightOverThreadSolution-full.s37* + 4. Name your project and click **Finish** (no other changes are required at this time). - **Note**: You should only need to upload a bootloader image and erase the chip once. Subsequent application uploads do not need the bootloader image or chip erasure. + 5. Once the solution is created, you will be redirected to the Projects view with the MatterLightOverThread.slcp file open. If not simply open the file yourself. - ![Image location](resources/image-location.png) + ![Build the project](resources/studio-6-matter-project-demo.png) - 9. If you are using a dev board with a WSTK, you should now see a QR code displayed on the WSTK's LCD. + 6. Building & flashing is done in Visual Studio Code using the Silicon Labs extension. For a detailed breakdown of these steps, see the [Matter over Thread QuickStart Demo](/matter/{build-docspace-version}/matter-quick-start-demo/02-thread-quick-start-demo.md#step-1-create-a-matter-sample-project). - 10. Disconnect the dev board from your development computer. + 7. If you are using a dev board with a WSTK, you should now see a QR code displayed on the WSTK's LCD. - 11. **Optional**: you may want to label this device as your light or switch, as appropriate, to make it easier to identify later. + 8. Disconnect the dev board from your development computer. 2. Repeat the process above with the second dev board but selecting the *Matter - SoC Light Switch over Thread* example instead. diff --git a/sld406-matter-light-switch-example/resources/matter-sdk-version.png b/sld406-matter-light-switch-example/resources/matter-sdk-version.png new file mode 100644 index 0000000..3d50f3c Binary files /dev/null and b/sld406-matter-light-switch-example/resources/matter-sdk-version.png differ diff --git a/sld406-matter-light-switch-example/resources/matter-ssv6-connected-devices.png b/sld406-matter-light-switch-example/resources/matter-ssv6-connected-devices.png new file mode 100644 index 0000000..7bec5a9 Binary files /dev/null and b/sld406-matter-light-switch-example/resources/matter-ssv6-connected-devices.png differ diff --git a/sld406-matter-light-switch-example/resources/ssv6-ot-rcp-demo.png b/sld406-matter-light-switch-example/resources/ssv6-ot-rcp-demo.png new file mode 100644 index 0000000..eb0bce4 Binary files /dev/null and b/sld406-matter-light-switch-example/resources/ssv6-ot-rcp-demo.png differ diff --git a/sld406-matter-light-switch-example/resources/studio-6-build.png b/sld406-matter-light-switch-example/resources/studio-6-build.png new file mode 100644 index 0000000..5a01c6a Binary files /dev/null and b/sld406-matter-light-switch-example/resources/studio-6-build.png differ diff --git a/sld406-matter-light-switch-example/resources/studio-6-matter-launcher.png b/sld406-matter-light-switch-example/resources/studio-6-matter-launcher.png new file mode 100644 index 0000000..bf1de4d Binary files /dev/null and b/sld406-matter-light-switch-example/resources/studio-6-matter-launcher.png differ diff --git a/sld406-matter-light-switch-example/resources/studio-6-matter-project-demo.png b/sld406-matter-light-switch-example/resources/studio-6-matter-project-demo.png new file mode 100644 index 0000000..74786d1 Binary files /dev/null and b/sld406-matter-light-switch-example/resources/studio-6-matter-project-demo.png differ diff --git a/sld406-matter-light-switch-example/resources/studio-6-matter-thread-demo-board-selector.png b/sld406-matter-light-switch-example/resources/studio-6-matter-thread-demo-board-selector.png new file mode 100644 index 0000000..52820c5 Binary files /dev/null and b/sld406-matter-light-switch-example/resources/studio-6-matter-thread-demo-board-selector.png differ diff --git a/sld406-matter-light-switch-example/resources/studio-6-matter-thread-demo-lighting-projects.png b/sld406-matter-light-switch-example/resources/studio-6-matter-thread-demo-lighting-projects.png new file mode 100644 index 0000000..3b0aeb7 Binary files /dev/null and b/sld406-matter-light-switch-example/resources/studio-6-matter-thread-demo-lighting-projects.png differ diff --git a/sld406-matter-light-switch-example/resources/studio-6-select-device.png b/sld406-matter-light-switch-example/resources/studio-6-select-device.png new file mode 100644 index 0000000..20f5a40 Binary files /dev/null and b/sld406-matter-light-switch-example/resources/studio-6-select-device.png differ diff --git a/sld416-matter-certification/index.md b/sld416-matter-certification/index.md index 7c4e23b..b5f2d86 100644 --- a/sld416-matter-certification/index.md +++ b/sld416-matter-certification/index.md @@ -41,16 +41,15 @@ Pre-testing new Matter products using the Matter Test Harness (TH) before sendin - **Support**: If issues are encountered during pre-testing, Silicon Labs can provide more efficient support. - **Test Accuracy**: Occasionally, issues can arise from the test itself rather than the Device Under Test (DUT) firmware. In such cases, additional parameters might be needed to run certain tests successfully. Pre-testing helps identify and address these issues ahead of time. -If your Matter ceritifcation process includes inheritance of our OpenThread Certification Libraries for an SoC product, you will need to provide proof of the use of those libraries using the linker output. To ensure your project generates this, make sure during your pre-testing to do the following (these steps assume the use of Simplicity Studio v5): +If your Matter certification process includes inheritance of our OpenThread Certification Libraries for an SoC product, you will need to provide proof of the use of those libraries using the linker output. To ensure your project generates this, make sure during your pre-testing to do the following (these steps assume the use of Simplicity Studio v6): + - Add the **OpenThread Certification Libraries** component to your project. + + ![OpenThread Certification Libraries Component](./resources/studio-6-ot-cert-libs-component.png) + - Add the "-WL,-verbose" linker option through gcc (see screenshot below): - - Open the project properties by either right-clicking the project and selecting **Properties** from the **Project Explorer** or from the **Project** menu at the top while the project is selected. - - On the left side, browse to **C/C++ Build** > **Settings**. - - Under **Tool Settings**, browse to **GNU ARM C++ Linker** > **Miscellaneous**. - - Under **Linker Flags**, add a new entry containing "*-Wl,--verbose*" and click **Apply** and **Apply and Close**. - - Finally, from the **Project** menu choose **Clean...** and perform a clean and fresh build. - ![Matter Project SSv5 Wl verbose steps](resources/matter-certification-ssv5-wlverbose-steps.png) + ![Matter Project SSv6 Wl verbose steps](resources/vs-code-verbose-linker-option.png) ## Possible Matter Certification Paths diff --git a/sld416-matter-certification/resources/studio-6-ot-cert-libs-component.png b/sld416-matter-certification/resources/studio-6-ot-cert-libs-component.png new file mode 100644 index 0000000..ade9374 Binary files /dev/null and b/sld416-matter-certification/resources/studio-6-ot-cert-libs-component.png differ diff --git a/sld416-matter-certification/resources/vs-code-verbose-linker-option.png b/sld416-matter-certification/resources/vs-code-verbose-linker-option.png new file mode 100644 index 0000000..a6a226f Binary files /dev/null and b/sld416-matter-certification/resources/vs-code-verbose-linker-option.png differ diff --git a/sld477-matter-quick-start-demo/02-thread-quick-start-demo.md b/sld477-matter-quick-start-demo/02-thread-quick-start-demo.md index c0a76f2..fe2f54d 100644 --- a/sld477-matter-quick-start-demo/02-thread-quick-start-demo.md +++ b/sld477-matter-quick-start-demo/02-thread-quick-start-demo.md @@ -1,18 +1,18 @@ # Matter over Thread Quick-Start Demo -This Quick-Start Guide will demo the out-of-box experience for adding an EFR32MG24 Matter Accessory Device to ecosystems. +This Quick-Start Guide demonstrates the out-of-box experience for adding an EFR32MG24 Matter Accessory Device to ecosystems. Other boards are also supported. For the full list of Matter capable hardware, refer to the [Silicon Labs Matter Selector Guide](https://www.silabs.com/wireless/matter/selector-guide). This demo uses the **Matter - SoC Lighting over Thread** example application available in Simplicity Studio. The guide walks through flashing the EFR32 SoC device, commissioning it to an ecosystem using the Simplicity Connect mobile app, and controlling it from either Google Home or Apple Home apps. ## Software Requirements -- Simplicity Studio v5 with SiSDK - 2025.6.2 + Silicon Labs Matter - 2.7.0 +- Simplicity Studio with SiSDK - 2025.6.2 + Silicon Labs Matter - 2.7.0 - Simplicity Connect mobile App on Smartphone ## Hardware Requirements - Android smartphone OR iPhone -- 1 x Silabs WSTK + EFR32MG24 2.4 GHz 20 dBm RB (BRD4161A) +- 1 x Silabs WSTK + EFR32MG24 2.4 GHz 20 dBm RB (BRD4187C) ->**Note:** Refer to [EFR32MG24 Tech Docs](https://www.silabs.com/development-tools/wireless/efr32xg24-pro-kit-20-dbm?tab=techdocs) for more details. +>**Note**: Refer to [EFR32MG24 Tech Docs](https://www.silabs.com/development-tools/wireless/efr32xg24-pro-kit-20-dbm?tab=techdocs) for more details. ### (Optional) Ecosystem requirements @@ -30,17 +30,25 @@ This Quick-Start Guide will demo the out-of-box experience for adding an EFR32MG ### Step 2: Launch Simplicity Studio -If the following screen does not appear automatically, select the Launcher icon on the top right of the window. The EFR32MG24 will appear in the **Connected Devices** tab. +If the following screen does not appear automatically, click the **Home** icon If the Matter extension is installed, you should see the Matter tile like in the image below. -![Simplicity Studio Launcher](./images/studio-launcher-thread.png) +Click the Matter tile. The **Example Projects & Demos** tab will appear already filtered for Matter. -Click the start button and the following screen will appear. Navigate to the **Example Projects & Demos** tab and filter for *Matter*. +![Simplicity Studio Launcher](./images/studio-6-matter-launcher.png) -![Simplicity Studio Example Projects & Demos](./images/studio-demos-thread.png) +Click **Select Device** and the connected devices should appear. -For this quick start guide, select the **Matter - SoC Lighting over Thread** demo. A number of other apps are also available including a Lock, Thermostat, Appliance, and Window Covering. When ready, click **Run** to flash the device. When the device is flashed, a QR code will appear on the WSTK screen. +![Simplicity Studio Example Projects & Demos](./images/studio-6-select-device.png) + +Select the appropriate device, in this case BRD4187C. + +![Simplicity Studio Select Device](./images/studio-6-matter-thread-demo-board-selector.png) -![Simplicity Studio Run Demo](./images/studio-run-demo-thread.png) +Type **lighting** into the keyword search and you will see the following screen. + +![Simplicity Studio Example Projects & Demos](./images/studio-6-matter-thread-demo-lighting-projects.png) + +For this quick start guide, select the **Matter - SoC Lighting over Thread** demo. A number of other apps are also available including a Lock, Thermostat, Appliance, and Window Covering. When ready, click **Run** to flash the device. When the device is flashed, a QR code will appear on the WSTK screen. ### Step 3: Prepare the Device for Commissioning @@ -92,34 +100,37 @@ Once commissioning completes, the Apple Home app prompts you to select one room ## Taking it Further -After successfully running the Matter Lighting app to the ecosystem, the next step is to create, build, and flash a Matter sample project from Simplicity Studio. +After successfully running the Matter Lighting app to the ecosystem, the next step is to create, build, and flash a Matter sample project from Simplicity Studio. This section describes creating a new Matter project, building it in the Silicon Labs Extension for the Visual Studio Code IDE, and flashing it to the EFR32 SoC device. + +For instructions on installing Simplicity Studio and the Silicon Labs Extension for the Visual Studio Code IDE, refer to the [Simplicity Studio 6 Getting Started Guide](https://docs.silabs.com/ssv6ug/latest/ssv6ug-overview/) and [Simplicity Studio Extension for VS Code](https://docs.silabs.com/ss-vscode/latest/ss-vscode-start/). ### Step 1: Create a Matter Sample Project -1. Open Simplicity Studio and select **Create New Project**. -2. Filter for *Matter* and select the **Matter - SoC Lighting over Thread with external Bootloader** sample application and select **Create**. -3. Click **Finish**. - Simplicity Studio will create a new Solution called MatterLightOverWiFiSolution with the MatterLightOverThreadSolution project inside. -4. Open the project. +1. Open Simplicity Studio and repeat the same steps as [above](#flashing-the-efr32-soc-matter-accessory-device). +2. Instead of selecting **Run** for the demo, click **Create** for the **Matter - SoC Lighting over Thread with external Bootloader** example. +3. Review the Project Configuration and click **Finish**. Simplicity Studio creates a new Solution called MatterLightOverThreadSolution with the MatterLightOverThread project inside the workspace. + ![Creating a project](./images/studio-6-matter-project-demo.png) +4. After the project is created, click the **Open in VS Code** button to open the project in the Silicon Labs Extension for the Visual Studio Code IDE. - ![Creating a project](./images/studio-project.png) +### Step 2: Build the Project in the Silicon Labs Extension for the Visual Studio Code IDE -### Step 2: Build the Project +1. Once the MatterLightOverThreadSolution is open, hover over the solution and click the **Build** button. -1. Once the project is open, click the **Build** button in the toolbar. -2. Ensure that the build completes successfully without any errors. + ![Building the project](./images/studio-6-build.png) - ![Creating a project](./images/studio-build.png) +2. Ensure that the build completes successfully without any errors. ### Step 3: Flash the Device -1. After building the project, the output will include an `.s37` file in the GNU ARM v12.2.1 - Default folder. +1. After building the project, the output will include an `.s37` file in the Binaries folder. 2. Connect the Silabs WSTK + EFR32 SoC to the PC via USB. -3. Navigate to **Tools** and open Simplicity Commander. -4. Select the desired board according to its serial number and navigate to the **Flash** tab. -5. Click **Browse** and select the `.s37` file from the build output. -6. Click **Flash** to flash the device. +3. Hover over either of the binaries in the Binaries folder to reveal the Flash button. One of these is only the application while the other includes the application and the external bootloader. Click **Flash** to flash the device. + + ![flashing the binary](./images/flashing-studio-6.png) +4. A successful flash will looks like the image below. + + ![successful flash](./images/successful-flash.png) -Once the device is flashed, it will be ready for commissioning and further testing. +Once the device is flashed, it is ready for commissioning and further testing. > **Note:** By default, device logs are enabled on UART (serial terminal). Refer to [Logging Configurations](/matter/{build-docspace-version}/matter-overview-guides/matter-logging-configuration) to configure the logging destination to JLink or UART. diff --git a/sld477-matter-quick-start-demo/images/flashing-studio-6.png b/sld477-matter-quick-start-demo/images/flashing-studio-6.png new file mode 100644 index 0000000..21922f5 Binary files /dev/null and b/sld477-matter-quick-start-demo/images/flashing-studio-6.png differ diff --git a/sld477-matter-quick-start-demo/images/studio-6-build.png b/sld477-matter-quick-start-demo/images/studio-6-build.png new file mode 100644 index 0000000..5a01c6a Binary files /dev/null and b/sld477-matter-quick-start-demo/images/studio-6-build.png differ diff --git a/sld477-matter-quick-start-demo/images/studio-6-matter-launcher.png b/sld477-matter-quick-start-demo/images/studio-6-matter-launcher.png new file mode 100644 index 0000000..bf1de4d Binary files /dev/null and b/sld477-matter-quick-start-demo/images/studio-6-matter-launcher.png differ diff --git a/sld477-matter-quick-start-demo/images/studio-6-matter-project-demo.png b/sld477-matter-quick-start-demo/images/studio-6-matter-project-demo.png new file mode 100644 index 0000000..74786d1 Binary files /dev/null and b/sld477-matter-quick-start-demo/images/studio-6-matter-project-demo.png differ diff --git a/sld477-matter-quick-start-demo/images/studio-6-matter-thread-demo-board-selector.png b/sld477-matter-quick-start-demo/images/studio-6-matter-thread-demo-board-selector.png new file mode 100644 index 0000000..52820c5 Binary files /dev/null and b/sld477-matter-quick-start-demo/images/studio-6-matter-thread-demo-board-selector.png differ diff --git a/sld477-matter-quick-start-demo/images/studio-6-matter-thread-demo-lighting-projects.png b/sld477-matter-quick-start-demo/images/studio-6-matter-thread-demo-lighting-projects.png new file mode 100644 index 0000000..3b0aeb7 Binary files /dev/null and b/sld477-matter-quick-start-demo/images/studio-6-matter-thread-demo-lighting-projects.png differ diff --git a/sld477-matter-quick-start-demo/images/studio-6-select-device.png b/sld477-matter-quick-start-demo/images/studio-6-select-device.png new file mode 100644 index 0000000..20f5a40 Binary files /dev/null and b/sld477-matter-quick-start-demo/images/studio-6-select-device.png differ diff --git a/sld477-matter-quick-start-demo/images/successful-flash.png b/sld477-matter-quick-start-demo/images/successful-flash.png new file mode 100644 index 0000000..d77ce74 Binary files /dev/null and b/sld477-matter-quick-start-demo/images/successful-flash.png differ