Skip to content

Commit

Permalink
Pull request project-chip#614: Feature/check on doc update for 1.1.0 1.1
Browse files Browse the repository at this point in the history
Merge in WMN_TOOLS/matter from feature/check_on_doc_update_for_1.1.0-1.1 to RC_1.1.0-1.1

Squashed commit of the following:

commit 675fec7a56cc388ddfbdb51c5ce82ac988afa8b9
Author: Ezra Hale <[email protected]>
Date:   Thu Feb 23 11:29:42 2023 -0500

    updated versions for v1.1.0-1.1

commit 50925b02bb762f6afc334d4de66cfe9235ed0592
Author: SenthilKumar Edaikkalpadi Kannusamy <[email protected]>
Date:   Thu Feb 23 16:00:22 2023 +0000

    Pull request project-chip#589: build commands and 917 Soc features are updated

    Merge in WMN_TOOLS/matter from feature/wifi_doc_update_for_v1.1.0-1.1 to feature/doc_update_for_v1.1.0-1.1

    Squashed commit of the following:

    commit 4fb6648a8d1fed46cbb38bbc8fc5c06c2708c7dc
    Author: Ezra Hale <[email protected]>
    Date:   Thu Feb 23 09:27:10 2023 -0500

        updated doc per Catherine's requests

    commit 3c093dfde67a9ebc6a152a8cf30846ae6ea6cd91
    Author: srningap <[email protected]>
    Date:   Wed Feb 22 19:14:57 2023 +0530

        Updated the Docs with based on CE team comments

    commit 5ce8df248cc14e989f9e9138acd00dba2eff137b
    Author: srningap <[email protected]>
    Date:   Wed Feb 22 13:44:22 2023 +0530

        Updated the docs as per the CE team review

    ... and 2 more commits

commit eb4470731f8b5e15367c97f2f8fe4a5bd635d6cd
Author: Anders Lynge Esbensen <[email protected]>
Date:   Thu Feb 23 10:56:42 2023 +0100

    Added a few words on the QR code publishing.

... and 2 more commits
  • Loading branch information
Ezra Hale authored and rerasool committed Feb 23, 2023
1 parent 025370c commit 3e9f43e
Show file tree
Hide file tree
Showing 24 changed files with 452 additions and 231 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,15 @@ _To see release notes containing list of features and knowns issues go to
[SiliconLabs/matter/releases](https://github.com/SiliconLabs/matter/releases)
and find the corresponding notes for the release you are using._

As seen below, Silicon Labs supports Matter on several different hardware platforms including the EFR32, RS9116, WF200 and the new SiWx917 which is a Wi-Fi System-on-Chip (SoC).

Device: EFR32+RS9116
![Silicon Labs](./docs/silabs/images/silicon_labs_matter.png)

This repo contains documentation, demos, examples and all the code needed for
Matter Accessory Device development on both Thread and Wi-Fi. The Thread
development use cases differs from Wi-Fi because the Thread protocol requires
the use of an Open Thread Border Router (OTBR).
Device: SiWx917 SoC
![Silicon Labs - SiWx917 soc](./docs/silabs/images/silicon_labs_matter_SiWx917.png)

This repo contains documentation, demos, examples and all the code needed for Matter Accessory Device development on both Thread and Wi-Fi. The Thread development use cases differs from Wi-Fi because the Thread protocol requires the use of an Open Thread Border Router (OTBR).

- To get started with the Thread demo and development see
[Matter Thread](./docs/silabs/thread/DEMO_OVERVIEW.md)
Expand Down
32 changes: 17 additions & 15 deletions docs/silabs/README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,28 @@
# Silicon Labs Matter Table of Contents

1. [Silicon Labs Matter Documentation Overview](OVERVIEW.md) <br>
1. [Silicon Labs Matter Documentation Overview](OVERVIEW.md)

2. Matter Prerequisites

1. [Matter Hardware Requirements](general/HARDWARE_REQUIREMENTS.md)
2. [Matter Software Requirements](general/SOFTWARE_REQUIREMENTS.md) <br><br>
2. [Matter Software Requirements](general/SOFTWARE_REQUIREMENTS.md)

3. [Matter over Thread \(15.4\)](thread/THREAD.md)

1. [Matter Thread Demo Overview](thread/DEMO_OVERVIEW.md)
2. [Loading the Raspberry Pi image onto the Matter Hub](thread/RASPI_IMG.md)
3. [Setting up the RCP](thread/RCP.md)
4. [Creating a Thread Matter End Device](thread/BUILD_FLASH_MAD.md)
5. [Using the chip-tool](thread/CHIP_TOOL.md)<BR> <BR>
5. [Using the chip-tool](thread/CHIP_TOOL.md)

4. Matter over Wi-Fi

1. [Matter Wi-Fi Demo Overview](wifi/DEMO_OVERVIEW.md)
2. [Building a Matter Wi-Fi End Device](wifi/SW_SETUP.md)
3. [Running the Matter Demo over Wi-Fi](wifi/RUN_DEMO.md)
<br><br>
3. [Running the Matter Demo on EFR32 hosts](wifi/RUN_DEMO.md)
4. [Ozone Environment Setup for the SiWx917 SoC](wifi/SiWx917_Enablement_For_Ozone.md)
5. [Flashing the SiWx917 SoC](general/FLASH_SILABS_SiWx917_SOC_DEVICE.md)
6. [Running the Matter Demo on SiWx917 SoC](wifi/RUN_DEMO_SiWx917_SoC.md)

5. Matter Bridging to Zigbee/Z-Wave

Expand All @@ -29,7 +31,6 @@
3. [Running the Matter Bridge](../../silabs_examples/unify-matter-bridge/readme_user.md#Running-the-Matter-Bridge)
4. [Controlling a Z-Wave OnOff device](../../silabs_examples/unify-matter-bridge/readme_user.md#Testing-the-bridge-using-the-chip-tool)
5. [Toggling a Group of OnOff devices](../../silabs_examples/unify-matter-bridge/readme_user.md#toggle-a-group-of-onoff-devices)
<br><br>

6. Development using VS Code

Expand All @@ -38,29 +39,30 @@
1. [Create](dev/vscode/CREATE.md)
2. [Build](dev/vscode/BUILD.md)
3. [Flash](dev/vscode/FLASH.md)
4. [Debug](dev/vscode/DEBUG.md) <br><br>
4. [Debug](dev/vscode/DEBUG.md)

7. Matter Overview Guides
1. [Commissioning Process Overview](general/COMMISSIONING.md)
2. [Security Overview](general/SECURITY.md)
5. [Matter Attestation Credentials for EFR32](../../silabs_examples/credentials/README.md)
3. [Matter Sleepy End Devices over Openthread](general/OT_SLEEPY_END_DEVICE.md)
4. [Matter OTA Software Update](general/OTA_SOFTWARE_UPDATE.md)
<br><br>

8. Reference Guides

1. [Matter Hardware Requirements](general/HARDWARE_REQUIREMENTS.md)
2. [Matter Software Requirements](general/SOFTWARE_REQUIREMENTS.md)
3. [Matter Artifacts Page](general/ARTIFACTS.md)
4. [Matter Commit Hashes](general/COMMIT_HASHES.md)
5. [How to Flash a Silicon Labs Device](general/FLASH_SILABS_DEVICE.md)
6. [How to Find Your Raspberry Pi](general/FIND_RASPI.md)
7. [Building a Custom Matter Device](general/CUSTOM_MATTER_DEVICE.md)
8. [Using Simplicity Studio's Pin Tool and Project Configurator with Matter](./general/PINTOOL.md)
9. [Using Simplicity Studio's BLE GATT Configurator with Matter](./general/GATT.md)
10. [Using Simplicity Studio's Energy Profiler with Matter](./general/EP.md)
11. [Using Wireshark to Capture Network Traffic in Matter](./general/WIRESHARK.md)
12. [Matter EFR32 Flash Savings Guide](general/CODE_SIZE_SAVINGS.md)<br><br>
6. [How to Flash the SiWx917 SoC](general/FLASH_SILABS_SiWx917_SOC_DEVICE.md)
7. [How to Find Your Raspberry Pi](general/FIND_RASPI.md)
8. [Building a Custom Matter Device](general/CUSTOM_MATTER_DEVICE.md)
9. [Using Simplicity Studio's Pin Tool and Project Configurator with Matter](./general/PINTOOL.md)
10. [Using Simplicity Studio's BLE GATT Configurator with Matter](./general/GATT.md)
11. [Using Simplicity Studio's Energy Profiler with Matter](./general/EP.md)
12. [Using Wireshark to Capture Network Traffic in Matter](./general/WIRESHARK.md)
13. [Matter EFR32 Flash Savings Guide](general/CODE_SIZE_SAVINGS.md)

9. Frequently Asked Questions (FAQ) / Troubleshooting

Expand Down
39 changes: 19 additions & 20 deletions docs/silabs/general/ARTIFACTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
This page provides links to pre-built software image "artifacts" that can be
used to set up the Matter Demo for the Thread and Wi-Fi use cases.

<br>

## Matter Hub Raspberry Pi Image

The Matter Hub image is intended to be flashed onto an SD card for a Raspberry
Expand All @@ -13,9 +11,7 @@ Matter chip-tool. Note the image is ~10GB in size so depending on your internet
connection this download may take some time. Start the Matter Hub Raspberry Pi
image download here:

https://www.silabs.com/documents/public/software/SilabsMatterPi.zip

<br>
https://www.silabs.com/documents/public/software/SilabsMatterPi_1.1.0-1.1.zip

## Radio Co-Processor (RCP) Images

Expand All @@ -24,53 +20,56 @@ used with a Raspberry Pi to allow the Raspberry Pi's Open Thread Border Router
to access the Thread network. Radio Co-Processor (RCP) images are available in
the Assets section of this page:

https://github.com/SiliconLabs/matter/releases/tag/v1.0.0

<br>
https://github.com/SiliconLabs/matter/releases/tag/v1.1.0-1.1

## Matter Accessory Device Images

The Matter Accessory Device Images are used to turn an EFR into a Matter device.
These are pre-built binary images for the Matter Demo. Matter Accessory Device
Images are located in the Assets section of this page:

https://github.com/SiliconLabs/matter/releases/tag/v1.0.0
https://github.com/SiliconLabs/matter/releases/tag/v1.1.0-1.1

For Matter over Thread, 3 different types of images are provided:

1. **Standard**: Includes all code including enabling the LCD for a QR Code that can be used for commissioning.
2. **Release**: A smaller image size with reduced functionality, including removal of the LCD support, thus no QR Code.
3. **Sleepy**: A sleepy device image for improved energy efficiency and running on battery power.

<br>

## Matter Bootloader Binaries

If you are using the OTA functionality and especially if you are using an
EFR32MG2x device, you will need to flash a bootloader binary on your device along
with the application image. Bootloader binaries for all of the Matter supported
devices are available here:

https://github.com/SiliconLabs/matter/releases/tag/v1.0.0

<br>
https://github.com/SiliconLabs/matter/releases/tag/v1.1.0-1.1

## RS9116 Firmware

The RS9116 firmware is used to update the RS9116 - it can be found in the
repository you have cloned, at the following relative path from the `/matter`
directory, `./third_party/silabs/wiseconnect-wifi-bt-sdk/firmware`

<br>

## SiWx917 Firmware

SiWx917 Firmware(rps) images are available in
the Assets section of this page:
> **Note**: SiWx917 firmware is only available to Alpha customers. Contact Silicon Labs support to obtain the WiseMCU SDK and install it as per the instructions on the [Software Requirements page](./SOFTWARE_REQUIREMENTS.md).
The SiWx917 firmware is used to update the SiWx917 device connectivity firmware. It can be found in the
repository you have cloned, at the following relative path from the `/matter`
directory, `./third_party/silabs/wisemcu-wifi-bt-sdk/connectivity_firmware`

## SiWx917 SoC Configuration Files for Flashing the Matter Application

In order to flash the Matter Application on the SiWx917 SoC, the Ozone Debugger must
be configured for the SiWx917 SoC device by following the instructions on the [Ozone Environment Setup for SiWx917 SoC page](../wifi/SiWx917_Enablement_For_Ozone.md).

The **JLinkDevices.xml** and **ELF** files referenced in the instructions may be found
in the Assets section of this page:

https://github.com/SiliconLabs/matter/releases/tag/v1.1.0-1.1

https://github.com/SiliconLabs/matter/releases/tag/v1.0.0

<br>
---

[Table of Contents](../README.md) | [Thread Demo](../thread/DEMO_OVERVIEW.md) |
Expand Down
14 changes: 14 additions & 0 deletions docs/silabs/general/FLASH_SILABS_SiWx917_SOC_DEVICE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# How to Flash a SiWx917 SoC Device

Once you have an image built, you can flash it onto your SiWx917 SoC device over USB connected to your development machine. This can be done using the Ozone Debugger.

> Note: Flashing using Simplicity Studio and Simplicity Commander is not yet supported for the SiWx917 SoC.
## Ozone J-Link Debugger:

- Multi-platform debugger and performance analyzer for J-Link and J-Trace
- Download for: [Windows](https://www.segger.com/downloads/jlink/Ozone_Setup_Windows_x64.exe) | [Mac](https://www.segger.com/downloads/jlink/Ozone_macOS_Universal.pkg) | [Linux](https://www.segger.com/downloads/jlink/Ozone_Linux_x86_64.deb)
- [Flashing and debug procedure for Ozone](../wifi/RUN_DEMO_SiWx917_SoC.md)

----
[Table of Contents](../README.md) | [Thread Demo](../thread/DEMO_OVERVIEW.md) | [Wi-Fi Demo](../wifi/DEMO_OVERVIEW.md)
80 changes: 46 additions & 34 deletions docs/silabs/general/HARDWARE_REQUIREMENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ them on a Raspberry Pi. To do so you will need:
- [XG24-RB4186C](https://www.silabs.com/development-tools/wireless/xg24-rb4186c-efr32xg24-wireless-gecko-radio-board)
- BRD4187C / SLWSTK6006A / Wireless Starter Kit / 2.4GHz@20dBm
- [XG24-RB4187C](https://www.silabs.com/development-tools/wireless/xg24-rb4187c-efr32xg24-wireless-gecko-radio-board)
<br><br>

- **MG12 boards:**

- BRD4161A / SLWSTK6000B / Wireless Starter Kit / 2.4GHz@19dBm
Expand All @@ -53,7 +53,6 @@ them on a Raspberry Pi. To do so you will need:
- [SLWRB4163A](https://www.silabs.com/development-tools/wireless/zigbee/slwrb4163a-efr32mg12-radio-board)
- BRD4164A / SLWSTK6000B / Wireless Starter Kit / 2.4GHz@19dBm
- [SLWRB4164A](https://www.silabs.com/development-tools/wireless/zigbee/slwrb4164a-efr32mg12-radio-board)
<br><br>

## Matter Over Thread Accessory Device Requirements

Expand Down Expand Up @@ -84,7 +83,7 @@ Matter Accessory Devices for Matter over Thread on the following platforms:
- [XGM240-RB4316A](https://www.silabs.com/development-tools/wireless/xgm240-rb4316a-xgm240p-module-radio-board?tab=overview)
- BRD4317A / SLWSTK6006A / Wireless Starter Kit/ 2.4GHz@20dBm
- [XGM240-RB4317A](https://www.silabs.com/development-tools/wireless/xgm240-rb4317a-xgm240p-module-radio-board?tab=overview)
<br><br>

- **MG12 boards:**

- [EFR32MG12 Development Kit](https://www.silabs.com/development-tools/wireless/zigbee/efr32mg12-dual-band-starter-kit)
Expand All @@ -101,53 +100,66 @@ Matter Accessory Devices for Matter over Thread on the following platforms:
- BRD4170A / SLWSTK6000B / Multiband Wireless Starter Kit / 2.4GHz@19dBm,
915MHz@19dBm
- [SLWRB4170A](https://www.silabs.com/development-tools/wireless/zigbee/slwrb4170a-efr32mg12-radio-board)
<br><br>


## Matter over Wi-Fi Accessory Device Requirements
## Matter over Wi-Fi Accessory Device Requirements for NCP mode

The Silicon Labs Matter over Wi-Fi demo and development requires two boards: the
Silicon Labs EFR32 Radio board to run the Matter code and the RS9116
or the SiWx917 or
the WF200 to run the Wi-Fi protocol stack. Pre-built images for both the EFR32
and the RS9116 are provided on the [Matter Artifacts page](./ARTIFACTS.md). The
following boards are supported for the Matter over Wi-Fi demos and development:
The Silicon Labs Matter over Wi-Fi NCP mode demo and development requires two boards: the
Silicon Labs EFR32 Radio board to run the Matter code and either the RS9116, SiWx917 or WF200 to run the Wi-Fi protocol stack.
Pre-built images for the EFR32 are provided on the [Matter Artifacts page](./ARTIFACTS.md). Pre-built images for SiWx917 or RS9116 connectivity
firmware are available as per the instructions on the [Software Requirements Page](./SOFTWARE_REQUIREMENTS.md).

> **Note:** The EFR32MG24 is the preferred starting point for Matter MCUs. It provides Secure Vault and can use the internal flash of the device to store an upgrade image.
> **Note:**
> 1. The EFR32MG24 is the preferred starting point for Matter MCUs. It provides Secure Vault and can use the internal flash of the device to store an upgrade image.
> 2. The WF200 connectivity firmware image is included in the EFR32MG12 or EFR32MG24 images on the [Matter Artifacts page](./ARTIFACTS.md) for running with the WF200 in NCP mode. The
Matter application downloads the connectivity firmware onto the WF200 on first-time startup.

The following boards are supported for the Matter over Wi-Fi demos and development:

- **MG24 boards:**

- BRD4186C / SLWSTK6006A / Wireless Starter Kit / 2.4GHz@10dBm
- BRD4186C / Wireless Starter Kit / 2.4GHz@10dBm
- [XG24-RB4186C](https://www.silabs.com/development-tools/wireless/xg24-rb4186c-efr32xg24-wireless-gecko-radio-board)
- BRD4187C / SLWSTK6006A / Wireless Starter Kit / 2.4GHz@20dBm
- MG24 with WSTK : [xG24-PK6009A](https://www.silabs.com/development-tools/wireless/efr32xg24-pro-kit-10-dbm?tab=overview)
- BRD4187C / Wireless Starter Kit / 2.4GHz@20dBm
- [XG24-RB4187C](https://www.silabs.com/development-tools/wireless/xg24-rb4187c-efr32xg24-wireless-gecko-radio-board)
<br><br>
- **MG12 boards:**
- MG24 with WSTK : [xG24-PK6010A](https://www.silabs.com/development-tools/wireless/efr32xg24-pro-kit-20-dbm?tab=overview)

- [EFR32MG12 Development Kit](https://www.silabs.com/development-tools/wireless/zigbee/efr32mg12-dual-band-starter-kit)
- BRD4161A / SLWSTK6000B / Wireless Starter Kit / 2.4GHz@19dBm
- [SLWRB4161A](https://www.silabs.com/development-tools/wireless/zigbee/slwrb4161a-efr32mg12-radio-board)
- BRD4162A / SLWSTK6000B / Wireless Starter Kit / 2.4GHz@10dBm
- [SLWRB4162A](https://www.silabs.com/development-tools/wireless/zigbee/slwrb4162a-efr32mg12-radio-board)
- BRD4163A / SLWSTK6000B / Wireless Starter Kit / 2.4GHz@19dBm
- [SLWRB4163A](https://www.silabs.com/development-tools/wireless/zigbee/slwrb4163a-efr32mg12-radio-board)
- BRD4164A / SLWSTK6000B / Wireless Starter Kit / 2.4GHz@19dBm
- [SLWRB4164A](https://www.silabs.com/development-tools/wireless/zigbee/slwrb4164a-efr32mg12-radio-board)
<br><br>
- **Wi-Fi NCP Dev Kits & boards**

- RS9116
- SB-EVK1 / Single Band Wi-Fi Development Kit / 2.4GHz
- [RS9116X-SB-EVK1](https://www.silabs.com/development-tools/wireless/wi-fi/rs9116x-sb-evk-development-kit)
- SB-EVK2 / Single Band Wi-Fi Development Kit / 2.4GHz
- [RS9116X-SB-EVK2](https://www.silabs.com/development-tools/wireless/wi-fi/rs9116x-sb-evk2-development-kit)
- DB-EVK1 / Dual Band Wi-Fi Development Kit / 2.4GHz & 5GHz
- [RS9116X-DB-EVK1](https://www.silabs.com/development-tools/wireless/wi-fi/rs9116x-db-evk-development-kit)
> **Note:** Matter only supported over 2.4GHz on this Dev kit.
- Interconnect board (included in the Wi-Fi kits)
- SPI Cable (included in the RS9116 kit)
- Jumper Cables (included in the RS9116 kit)
- SiWx917
- WF200
- WF200 / Single Band Wi-Fi Expansion Board / 2.4GHz
- [SLEXP8022A](https://www.silabs.com/development-tools/wireless/wi-fi/wf200-wifi-expansion-kit)
- WFM200S / Single Band Wi-Fi Expansion Board / 2.4GHz
- [SLEXP8023A](https://www.silabs.com/development-tools/wireless/wi-fi/wfm200-wifi-expansion-kit)

- **Wi-Fi Dev Kit**

- RS9116
- [RS9116X-SB-EVK1](https://www.silabs.com/development-tools/wireless/wi-fi/rs9116x-sb-evk-development-kit)
## Matter over Wi-Fi Accessory Device Requirements for SoC mode

The Silicon Labs Matter over Wi-Fi demo and development for SoC mode requires the SiWx917 SoC board that
supports Matter over Wi-Fi in a single-chip package - the integrated MCU is dedicated
for peripheral and application-related processing (Matter), while the ThreadArch® runs the
wireless and networking protocol stacks. Pre-built images for the SiWx917 connectivity firmware
are available as per the instructions on the [Software Requirements Page](./SOFTWARE_REQUIREMENTS.md). The
following boards are supported for the Matter over Wi-Fi demos and development:

- **Wi-Fi SoC boards**

- SiWx917
- [SiWx917](https://www.silabs.com/wireless/wi-fi/siwx917-wireless-socs)
- WF200
- [WF200](https://www.silabs.com/wireless/wi-fi/wf200-series-2-transceiver-ics)
- Interconnect board (included in the Wi-Fi kits)
- SPI Cable (included in the RS9116 kit)
- Jumper Cables (included in the RS9116 kit)


## Additional Matter over Wi-Fi Hardware Requirements

Expand Down
Loading

0 comments on commit 3e9f43e

Please sign in to comment.