Skip to content

Commit

Permalink
Pull request project-chip#433: Wi-Fi Documentation Updates for 917 So…
Browse files Browse the repository at this point in the history
…C Commissioning over BLE

Merge in WMN_TOOLS/matter from feature/wifi_doc_upd_917_soc_ble to RC_1.0.2-1.0

Squashed commit of the following:

commit 41d646a4dc194e1100c7cc353090b5628a1fd9ab
Author: Manav Mehta <mamehta@silabs.com>
Date:   Wed Dec 14 20:32:11 2022 +0530

    Removed <br>'s in all modified files

commit c50639dfa6e3d6c02f853034f4a0c3fef58af845
Author: Manav Mehta <mamehta@silabs.com>
Date:   Wed Dec 14 14:50:07 2022 +0530

    Remove mentions of on-network commissioning

commit 2db024267ff16f55f09b70f69a73bfe1650f64e3
Author: Manav Mehta <mamehta@silabs.com>
Date:   Wed Dec 14 13:46:35 2022 +0530

    917 SoC BLE Document corrections

... and 1 more commit
  • Loading branch information
Manav Mehta authored and Manav Mehta committed Dec 14, 2022
1 parent 422b125 commit 17ed094
Show file tree
Hide file tree
Showing 9 changed files with 47 additions and 199 deletions.
14 changes: 6 additions & 8 deletions docs/silabs/README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# 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

Expand All @@ -23,7 +23,6 @@
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)
<br><br>

5. Matter Bridging to Zigbee/Z-Wave

Expand All @@ -32,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 @@ -41,15 +39,15 @@
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)
Expand All @@ -64,7 +62,7 @@
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)<br><br>
13. [Matter EFR32 Flash Savings Guide](general/CODE_SIZE_SAVINGS.md)

9. Frequently Asked Questions (FAQ) / Troubleshooting

Expand Down
38 changes: 7 additions & 31 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 @@ -15,83 +13,61 @@ image download here:

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

<br>

## Radio Co-Processor (RCP) Images

The Radio Co-Processor firmware is used to turn an EFR into an RCP that can be
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.1-1.0

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

## 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.1-1.0
https://github.com/SiliconLabs/matter/releases/tag/v1.0.2-1.0

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.1-1.0

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

## 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).
https://github.com/SiliconLabs/matter/releases/tag/v1.0.1-1.0


## SiWx917 SoC Firmware

SiWx917 SoC Firmware(rps) image is available in the
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`

It can be used to update the SiWx917 SoC device firmware.

<br>

## 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 [here](../wifi/SiWx917_Enablement_For_Ozone.md).
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.0.1-1.0

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


---
Expand Down
2 changes: 0 additions & 2 deletions docs/silabs/general/FLASH_SILABS_SiWx917_SOC_DEVICE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ Once you have an image built, you can flash it onto your SiWx917 SoC device over

> Note: Flashing using Simplicity Studio and Simplicity Commander is not yet supported for the SiWx917 SoC.
<br>

## Ozone J-Link Debugger:

- [Flashing and debug procedure for Ozone](../wifi/RUN_DEMO_SiWx917_SoC.md)
Expand Down
17 changes: 6 additions & 11 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,30 +100,29 @@ 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 for NCP mode

The Silicon Labs Matter over Wi-Fi demo and development requires two boards: the
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).
The following boards are supported for the Matter over Wi-Fi demos and development:

> **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 pre-built EFR32MG12 or EFR32MG24 images on the [Matter Artifacts page](./ARTIFACTS.md) for running with the WF200 in NCP mode. The
> 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
- [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:**

- [EFR32MG12 Development Kit](https://www.silabs.com/development-tools/wireless/zigbee/efr32mg12-dual-band-starter-kit)
Expand All @@ -138,7 +136,6 @@ Matter application downloads the connectivity firmware onto the WF200 on first-t
- [SLWRB4164A](https://www.silabs.com/development-tools/wireless/zigbee/slwrb4164a-efr32mg12-radio-board)
- BRD4170A / SLWSTK6000B / Wireless Starter Kit / 2.4GHz@19dBm
- [SLWRB4170A](https://www.silabs.com/development-tools/wireless/zigbee/slwrb4170a-efr32mg12-radio-board)
<br><br>


- **Wi-Fi NCP Dev Kits & boards**
Expand All @@ -161,7 +158,6 @@ Matter application downloads the connectivity firmware onto the WF200 on first-t
- [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)
<br><br>


## Matter over Wi-Fi Accessory Device Requirements for SoC mode
Expand All @@ -177,7 +173,6 @@ following boards are supported for the Matter over Wi-Fi demos and development:

- SiWx917
- [SiWx917](https://www.silabs.com/wireless/wi-fi/siwx917-wireless-socs)
<br><br>


## Additional Matter over Wi-Fi Hardware Requirements
Expand Down
41 changes: 4 additions & 37 deletions docs/silabs/general/SOFTWARE_REQUIREMENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,12 @@

SSH client is used to communicate with the Raspberry Pi over a secure
shell.
<br>

2. [Raspberry Pi Disk Imager](https://www.raspberrypi.com/software/)

Raspberry Pi Disk Imager is used to flash the SD Card that contains the
operating system for the Raspberry Pi. Note that, for the Thread demo, the
operating system is the demo image.
<br>

3. Flash Tools

Expand All @@ -30,13 +28,12 @@
> **Note:**
> 1. Simplicity Studio and Commander tools support is not yet added for the SiWx917 SoC device.
> 2. The SiWx917 SoC device is not yet officially added in Ozone, but it can be configured in Ozone.
<br>
4. [Git Version Control ](https://git-scm.com/downloads)[only required for
building images and development]

Clone the Silicon Labs Matter repo, then enter and sync all the necessary
submodules with the following commands: <br>
submodules with the following commands:

```shell
$ git clone https://github.com/SiliconLabs/matter.git
Expand All @@ -49,19 +46,17 @@
```shell
$ ./scripts/checkout_submodules.py --shallow --recursive --platform efr32
```
<br>

5. If you are using an EFR32MG2x device you will require a bootloader to run the
demo applications. When you flash your application image be sure to include a
bootloader as well (if one is not already present). Bootloader images are
provided on the [Matter Artifacts page](../general/ARTIFACTS.md).

<br>

## **Windows-Specific Software Requirements:**

&emsp; These requirements are in addition to those mentioned above, for Windows
only. <br>
only.

&emsp; A Unix-like command line:

Expand All @@ -73,12 +68,10 @@ only. <br>
> WSL or Virtual Box are used to emulate a virtual Linux machine, which is
> useful for accessing the Linux command line tools

<br>

## **Mac-Specific Requirements (building own images):**

&emsp; These requirements are in addition to those mentioned above for Mac OS
users building their own images. <br>
users building their own images.

1. Install Homebrew

Expand All @@ -99,8 +92,6 @@ users building their own images. <br>
```shell
$ export PATH="/Applications/ARM/bin:$PATH"
```

<br>

Depending on your Mac processor, you will have to complete the following additional steps.

Expand All @@ -117,8 +108,6 @@ $ export PATH="/opt/homebrew/opt/openssl@3/bin:$PATH"
$ export PKG_CONFIG_PATH="/opt/homebrew/opt/openssl@3/lib/pkgconfig"
```

<br>

### **Intel Software Requirements:**

```shell
Expand All @@ -141,8 +130,6 @@ $ port install openssl
is sufficient to satisfy this
dependency.

<br>

## **Linux Specific Requirements:**

On Debian-based Linux distributions such as Ubuntu, these dependencies can be
Expand All @@ -152,8 +139,6 @@ satisfied with the following:
$ 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
```

<br>

## **Wi-Fi RS9116 Specific Requirements:**

Before you run the demo or development on the RS9116 please be sure that you
Expand All @@ -164,36 +149,18 @@ Pre-Built RS9116 firmware is available in the github repository under `third_par
1. [Setting up TeraTerm](https://docs.silabs.com/rs9116/wiseconnect/2.0/tera-term-setup)
2. [Updating the RS9116 Firmware](https://docs.silabs.com/rs9116/wiseconnect/2.0/update-evk-firmware)

<br>

## **Wi-Fi SiWx917 Specific Requirements:**

Before you run the demo or development on the SiWx917 please be sure that you
update the SiWx917 firmware.

<br>

### **NCP mode**

Pre-Built SiWx917 firmware for running in NCP mode (with the EFR32MG24) is available on the
[Matter Artifacts page](../general/ARTIFACTS.md).

<br>

### **SoC mode**

The WiseMCU Combo SDK package is only available to Alpha customers. Please contact Silicon Labs support.

On obtaining the package, extract it, rename the folder as `wisemcu-wifi-bt-sdk` and copy it in the github repository under `third_party/silabs`.

Pre-Built SiWx917 firmware for running in SoC mode is available under `third_party/silabs/wisemcu-wifi-bt-sdk/connectivity_firmware`

<br>

### **Flashing the firmware**
Pre-Built SiWx917 firmware is available under `third_party/silabs/wisemcu-wifi-bt-sdk/connectivity_firmware`

The following instructions are found on the docs.silabs.com website:

1. [Setting up TeraTerm](https://docs.silabs.com/SiWx917/wiseconnect/2.0/tera-term-setup)
2. For updating the SiWx917 Firmware, refer [Updating the RS9116 Firmware](https://docs.silabs.com/rs9116/wiseconnect/2.0/update-evk-firmware). Instructions are the same for both SiWx917 and RS9116.

Expand Down
Loading

0 comments on commit 17ed094

Please sign in to comment.