Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Silabs doc updates #23330

Merged
merged 5 commits into from
Oct 26, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 56 additions & 12 deletions examples/light-switch-app/efr32/README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,56 @@
# CHIP EFR32 Light Switch Example
# Matter EFR32 Light Switch Example

An example showing the use of CHIP on the Silicon Labs EFR32 MG12.
An example showing the use of CHIP on the Silicon Labs EFR32 MG12 and MG24.

<hr>

- [CHIP EFR32 Light Switch Example](#chip-efr32-light-switch-example)
- [Matter EFR32 Light Switch Example](#matter-efr32-light-switch-example)
- [Introduction](#introduction)
- [Building](#building)
- [Note](#note)
- [Linux](#linux)
- [Mac OS X](#mac-os-x)
- [Flashing the Application](#flashing-the-application)
- [Viewing Logging Output](#viewing-logging-output)
- [Running the Complete Example](#running-the-complete-example)
- [Notes](#notes)
- [On Border Router:](#on-border-router)
- [On PC(Linux):](#on-pclinux)
- [Running RPC console](#running-rpc-console)
- [Memory settings](#memory-settings)
- [OTA Software Update](#ota-software-update)
- [Building options](#building-options)
- [Disabling logging](#disabling-logging)
- [Debug build / release build](#debug-build--release-build)
- [Disabling LCD](#disabling-lcd)
- [KVS maximum entry count](#kvs-maximum-entry-count)

<hr>

> **NOTE:** Silicon Laboratories now maintains a public matter GitHub repo with
> frequent releases thoroughly tested and validated. Developers looking to
> develop matter products with silabs hardware are encouraged to use our latest
> release with added tools and documentation.
> [Silabs Matter Github](https://github.com/SiliconLabs/matter/releases)

<a name="intro"></a>

## Introduction

The EFR32 light switch example provides a baseline demonstration of a on-off
light switch device, built using CHIP and the Silicon Labs gecko SDK. It can be
controlled by a Chip controller over Openthread network.
light switch device, built using Matter and the Silicon Labs gecko SDK. It can
be controlled by a Chip controller over an Openthread or Wifi network.

The EFR32 device can be commissioned over Bluetooth Low Energy where the device
and the Chip controller will exchange security information with the Rendez-vous
procedure. Thread Network credentials are then provided to the EFR32 device
which will then join the network.
procedure. If using Thread, Thread Network credentials are then provided to the
EFR32 device which will then join the network.

The LCD on the Silabs WSTK shows a QR Code containing the needed commissioning
information for the BLE connection and starting the Rendez-vous procedure.
If the LCD is enabled, the LCD on the Silabs WSTK shows a QR Code containing the
needed commissioning information for the BLE connection and starting the
Rendez-vous procedure.

The light switch example is intended to serve both as a means to explore the
workings of CHIP as well as a template for creating real products based on the
workings of Matter as well as a template for creating real products based on the
Silicon Labs platform.

<a name="building"></a>
Expand All @@ -55,14 +70,43 @@ Silicon Labs platform.

#### Linux

$ sudo apt-get install git libwebkitgtk-1.0-0 ninja-build```
$ sudo apt-get install git ninja-build

#### Mac OS X

$ brew install ninja

- Supported hardware:

- > For the latest supported hardware please refer to the
> [Hardware Requirements](https://github.com/SiliconLabs/matter/blob/latest/docs/silabs/general/HARDWARE_REQUIREMENTS.md)
> in the Silicon Labs Matter Github Repo

MG12 boards:

- BRD4161A / SLWSTK6000B / Wireless Starter Kit / 2.4GHz@19dBm
- BRD4162A / SLWSTK6000B / Wireless Starter Kit / 2.4GHz@10dBm
- BRD4163A / SLWSTK6000B / Wireless Starter Kit / 2.4GHz@10dBm,
868MHz@19dBm
- BRD4164A / SLWSTK6000B / Wireless Starter Kit / 2.4GHz@19dBm
- BRD4166A / SLTB004A / Thunderboard Sense 2 / 2.4GHz@10dBm
- BRD4170A / SLWSTK6000B / Multiband Wireless Starter Kit / 2.4GHz@19dBm,
915MHz@19dBm
- BRD4304A / SLWSTK6000B / MGM12P Module / 2.4GHz@19dBm

MG21 boards: Currently not supported due to RAM limitation.

- BRD4180A / SLWSTK6006A / Wireless Starter Kit / 2.4GHz@20dBm

MG24 boards :

- BRD2601B / SLWSTK6000B / Wireless Starter Kit / 2.4GHz@10dBm
- BRD2703A / SLWSTK6000B / Wireless Starter Kit / 2.4GHz@10dBm
- BRD4186A / SLWSTK6006A / Wireless Starter Kit / 2.4GHz@10dBm
- BRD4186C / SLWSTK6006A / Wireless Starter Kit / 2.4GHz@10dBm
- BRD4187A / SLWSTK6006A / Wireless Starter Kit / 2.4GHz@20dBm
- BRD4187C / SLWSTK6006A / Wireless Starter Kit / 2.4GHz@20dBm

MG12 boards:

- BRD4161A / SLWSTK6000B / Wireless Starter Kit / 2.4GHz@19dBm
Expand Down
65 changes: 53 additions & 12 deletions examples/lighting-app/efr32/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
# CHIP EFR32 Lighting Example
# Matter EFR32 Lighting Example

An example showing the use of CHIP on the Silicon Labs EFR32 MG12.
An example showing the use of CHIP on the Silicon Labs EFR32 MG12 and MG24.

<hr>

- [CHIP EFR32 Lighting Example](#chip-efr32-lighting-example)
- [Matter EFR32 Lighting Example](#matter-efr32-lighting-example)
- [Introduction](#introduction)
- [Building](#building)
- [Note](#note)
- [Flashing the Application](#flashing-the-application)
- [Viewing Logging Output](#viewing-logging-output)
- [Running the Complete Example](#running-the-complete-example)
Expand All @@ -16,27 +15,40 @@ An example showing the use of CHIP on the Silicon Labs EFR32 MG12.
- [Device Tracing](#device-tracing)
- [Memory settings](#memory-settings)
- [OTA Software Update](#ota-software-update)
- [Group Communication (Multicast)](#group-communication-multicast)
- [Building options](#building-options)
- [Disabling logging](#disabling-logging)
- [Debug build / release build](#debug-build--release-build)
- [Disabling LCD](#disabling-lcd)
- [KVS maximum entry count](#kvs-maximum-entry-count)

<hr>

> **NOTE:** Silicon Laboratories now maintains a public matter GitHub repo with
> frequent releases thoroughly tested and validated. Developers looking to
> develop matter products with silabs hardware are encouraged to use our latest
> release with added tools and documentation.
> [Silabs Matter Github](https://github.com/SiliconLabs/matter/releases)

<a name="intro"></a>

## Introduction

The EFR32 lighting example provides a baseline demonstration of a Light control
device, built using CHIP and the Silicon Labs gecko SDK. It can be controlled by
a Chip controller over Openthread network..
device, built using Matter and the Silicon Labs gecko SDK. It can be controlled
by a Chip controller over an Openthread or Wifi network..

The EFR32 device can be commissioned over Bluetooth Low Energy where the device
and the Chip controller will exchange security information with the Rendez-vous
procedure. Thread Network credentials are then provided to the EFR32 device
which will then join the network.
procedure. If using Thread, Thread Network credentials are then provided to the
EFR32 device which will then join the Thread network.

The LCD on the Silabs WSTK shows a QR Code containing the needed commissioning
information for the BLE connection and starting the Rendez-vous procedure.
If the LCD is enabled, the LCD on the Silabs WSTK shows a QR Code containing the
needed commissioning information for the BLE connection and starting the
Rendez-vous procedure.

The lighting example is intended to serve both as a means to explore the
workings of CHIP as well as a template for creating real products based on the
workings of Matter as well as a template for creating real products based on the
Silicon Labs platform.

<a name="building"></a>
Expand All @@ -54,12 +66,41 @@ Silicon Labs platform.

- Install some additional tools (likely already present for CHIP developers):

- Linux: `sudo apt-get install git libwebkitgtk-1.0-0 ninja-build`
- Linux: `sudo apt-get install git ninja-build`

- Mac OS X: `brew install ninja`

- Supported hardware:

- > For the latest supported hardware please refer to the
> [Hardware Requirements](https://github.com/SiliconLabs/matter/blob/latest/docs/silabs/general/HARDWARE_REQUIREMENTS.md)
> in the Silicon Labs Matter Github Repo

MG12 boards:

- BRD4161A / SLWSTK6000B / Wireless Starter Kit / 2.4GHz@19dBm
- BRD4162A / SLWSTK6000B / Wireless Starter Kit / 2.4GHz@10dBm
- BRD4163A / SLWSTK6000B / Wireless Starter Kit / 2.4GHz@10dBm,
868MHz@19dBm
- BRD4164A / SLWSTK6000B / Wireless Starter Kit / 2.4GHz@19dBm
- BRD4166A / SLTB004A / Thunderboard Sense 2 / 2.4GHz@10dBm
- BRD4170A / SLWSTK6000B / Multiband Wireless Starter Kit / 2.4GHz@19dBm,
915MHz@19dBm
- BRD4304A / SLWSTK6000B / MGM12P Module / 2.4GHz@19dBm

MG21 boards: Currently not supported due to RAM limitation.

- BRD4180A / SLWSTK6006A / Wireless Starter Kit / 2.4GHz@20dBm

MG24 boards :

- BRD2601B / SLWSTK6000B / Wireless Starter Kit / 2.4GHz@10dBm
- BRD2703A / SLWSTK6000B / Wireless Starter Kit / 2.4GHz@10dBm
- BRD4186A / SLWSTK6006A / Wireless Starter Kit / 2.4GHz@10dBm
- BRD4186C / SLWSTK6006A / Wireless Starter Kit / 2.4GHz@10dBm
- BRD4187A / SLWSTK6006A / Wireless Starter Kit / 2.4GHz@20dBm
- BRD4187C / SLWSTK6006A / Wireless Starter Kit / 2.4GHz@20dBm

MG12 boards:

- BRD4161A / SLWSTK6000B / Wireless Starter Kit / 2.4GHz@19dBm
Expand Down
70 changes: 57 additions & 13 deletions examples/lock-app/efr32/README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,51 @@
#CHIP EFR32 Lock Example
# Matter EFR32 Lock Example

An example showing the use of CHIP on the Silicon Labs EFR32 MG12.
An example showing the use of CHIP on the Silicon Labs EFR32 MG12 and MG24.

<hr>

- [CHIP EFR32 Lock Example](#chip-efr32-lock-example)
- [Matter EFR32 Lock Example](#matter-efr32-lock-example)
- [Introduction](#introduction)
- [Building](#building)
- [Note](#note)
- [Flashing the Application](#flashing-the-application)
- [Viewing Logging Output](#viewing-logging-output)
- [Running the Complete Example](#running-the-complete-example)
- [Notes](#notes)
- [Memory settings](#memory-settings)
- [OTA Software Update](#ota-software-update)
- [Building options](#building-options)
- [Disabling logging](#disabling-logging)
- [Debug build / release build](#debug-build--release-build)
- [Disabling LCD](#disabling-lcd)
- [KVS maximum entry count](#kvs-maximum-entry-count)

<hr>

> **NOTE:** Silicon Laboratories now maintains a public matter GitHub repo with
> frequent releases thoroughly tested and validated. Developers looking to
> develop matter products with silabs hardware are encouraged to use our latest
> release with added tools and documentation.
> [Silabs Matter Github](https://github.com/SiliconLabs/matter/releases)

<a name="intro"></a>

## Introduction

The EFR32 lock example provides a baseline demonstration of a door lock control
device, built using CHIP and the Silicon Labs gecko SDK. It can be controlled by
a Chip controller over Openthread network..
device, built using Matter and the Silicon Labs gecko SDK. It can be controlled
by a Chip controller over an Openthread or Wifi network..

The EFR32 device can be commissioned over Bluetooth Low Energy where the device
and the Chip controller will exchange security information with the Rendez-vous
procedure. Thread Network credentials are then provided to the EFR32 device
which will then join the network.
procedure. If using Thread, Thread Network credentials are then provided to the
EFR32 device which will then join the Thread network.

The LCD on the Silabs WSTK shows a QR Code containing the needed commissioning
information for the BLE connection and starting the Rendez-vous procedure.
If the LCD is enabled, the LCD on the Silabs WSTK shows a QR Code containing the
needed commissioning information for the BLE connection and starting the
Rendez-vous procedure.

The lighting example is intended to serve both as a means to explore the
workings of CHIP as well as a template for creating real products based on the
workings of Matter as well as a template for creating real products based on the
Silicon Labs platform.

<a name="building"></a>
Expand All @@ -52,12 +63,45 @@ Silicon Labs platform.

- Install some additional tools(likely already present for CHIP developers):

#Linux `sudo apt-get install git libwebkitgtk-1.0-0 ninja-build`
Linux

sudo apt-get install git ninja-build

#Mac OS X `brew install ninja`
Mac OS X

brew install ninja

- Supported hardware:

- > For the latest supported hardware please refer to the
> [Hardware Requirements](https://github.com/SiliconLabs/matter/blob/latest/docs/silabs/general/HARDWARE_REQUIREMENTS.md)
> in the Silicon Labs Matter Github Repo

MG12 boards:

- BRD4161A / SLWSTK6000B / Wireless Starter Kit / 2.4GHz@19dBm
- BRD4162A / SLWSTK6000B / Wireless Starter Kit / 2.4GHz@10dBm
- BRD4163A / SLWSTK6000B / Wireless Starter Kit / 2.4GHz@10dBm,
868MHz@19dBm
- BRD4164A / SLWSTK6000B / Wireless Starter Kit / 2.4GHz@19dBm
- BRD4166A / SLTB004A / Thunderboard Sense 2 / 2.4GHz@10dBm
- BRD4170A / SLWSTK6000B / Multiband Wireless Starter Kit / 2.4GHz@19dBm,
915MHz@19dBm
- BRD4304A / SLWSTK6000B / MGM12P Module / 2.4GHz@19dBm

MG21 boards: Currently not supported due to RAM limitation.

- BRD4180A / SLWSTK6006A / Wireless Starter Kit / 2.4GHz@20dBm

MG24 boards :

- BRD2601B / SLWSTK6000B / Wireless Starter Kit / 2.4GHz@10dBm
- BRD2703A / SLWSTK6000B / Wireless Starter Kit / 2.4GHz@10dBm
- BRD4186A / SLWSTK6006A / Wireless Starter Kit / 2.4GHz@10dBm
- BRD4186C / SLWSTK6006A / Wireless Starter Kit / 2.4GHz@10dBm
- BRD4187A / SLWSTK6006A / Wireless Starter Kit / 2.4GHz@20dBm
- BRD4187C / SLWSTK6006A / Wireless Starter Kit / 2.4GHz@20dBm

MG12 boards:

- BRD4161A / SLWSTK6000B / Wireless Starter Kit / 2.4GHz@19dBm
Expand Down
Loading