Pull request project-chip#29: Cherry-pick: Doc cleanup for v0.1.0

Merge in WMN_TOOLS/matter from cherry_pick_latest_doc to silabs Squashed commit of the following: commit 56a8d3cce83d5e57a022c9eadebb7123054c980b Author: Rehan Rasool <[email protected]> Date: Tue Jul 26 01:53:21 2022 +0000 Pull request project-chip#27: Doc cleanup for v0.1.0 Merge in WMN_TOOLS/matter from v0.1.0-cjo-doc-updates to RC_july_25_2022 Squashed commit of the following: commit 098a8e68963dcef2b5340b0fab3967b782c757e9 Author: Rehan Rasool <[email protected]> Date: Mon Jul 25 15:07:36 2022 -0400 Highlight Silabs documentation in main readme file to steer users in that direction commit e9724fdff7e008888ada038d6714a933a9da13cd Author: Ezra Hale <[email protected]> Date: Mon Jul 25 15:07:23 2022 -0400 raspberry pi imager tool is also optional commit 3bfca8dd7ba7a7f776d35f2c1203e9e81dd33294 Author: Ezra Hale <[email protected]> Date: Mon Jul 25 15:04:08 2022 -0400 updated ozone instructions to be clear this could be done with simplicity studio or commander too commit d71effaa13a15066f856bd918b41b788fea6827e Author: Ezra Hale <[email protected]> Date: Mon Jul 25 14:55:40 2022 -0400 fixed a few errors in the Wi-Fi documentation that pointed to the wrong repo, we should always point to the Silicon Labs Matter repo and not the CSA repo commit 9a6489181b347f1646a66954d94b559772ffb319 Author: Ezra Hale <[email protected]> Date: Mon Jul 25 14:41:25 2022 -0400 updated information on building ChipTool for Linux, Mac and Raspberry Pi commit 2a9546b10a3b2f200a27e572260df62309a5a523 Author: Ezra Hale <[email protected]> Date: Mon Jul 25 13:58:14 2022 -0400 added caveat around multiple interfaces commit 4be84ece40b19ec1fd364534fa5900f71604fe89 Author: Ezra Hale <[email protected]> Date: Mon Jul 25 12:52:57 2022 -0400 updated to remove todos commit b073ae430f4e6ac1d88cc43af75033bd7bc146f5 Author: Ezra Hale <[email protected]> Date: Mon Jul 25 11:49:16 2022 -0400 updated demo overview for wifi and navigation, moved to bottom, includes links for both demos commit 5337410ebef1d966febc53e017645e4eb7aee1dc Author: Ezra Hale <[email protected]> Date: Mon Jul 25 10:23:44 2022 -0400 updated header for raspi login credentials commit e9c19b147b8450f3d2aea291374e78bdfc366b3f Author: Ezra Hale <[email protected]> Date: Mon Jul 25 10:09:51 2022 -0400 updated raspi image connection to local network information commit 24ef311d3e0b85bf278f4926e0819bf19bbb4d64 Author: Ezra Hale <[email protected]> Date: Mon Jul 25 09:44:04 2022 -0400 added reference to Demo images for Wi-Fi commit 026cf89802a7cbc98a3c9afb1c1b0437451b5952 Author: Rehan Rasool <[email protected]> Date: Mon Jul 25 08:32:58 2022 -0400 fix space in doc commit ff33baa679c6b22e84cc0ddc9939e0f3292cbc33 Author: cjo-tra <[email protected]> Date: Sun Jul 24 21:54:33 2022 -0400 Demo copyedit (cherry picked from commit 24159f5e9258ad657566868669faaccdc2517f4e)
suveshpratapa · Mar 27, 2024 · db6e5eb · db6e5eb
1 parent 1a8a221
commit db6e5eb
Show file tree

Hide file tree

Showing 24 changed files with 295 additions and 274 deletions.
diff --git a/README.md b/README.md
@@ -1,8 +1,10 @@
 # Silicon Labs Matter
 
-Welcome to the Silicon Labs Matter Github repo. This is your one stop shop for all things related to Silicon Labs and Matter development. To develop a Matter application with Silicon Labs please start here: [Silicon Labs Matter Table of Contents](./docs/silabs/README.md)
+Welcome to the Silicon Labs Matter Github repo. This is your one stop shop for all things related to Silicon Labs and Matter development.
 
-<BR>
+**To develop a Matter application with Silicon Labs please start here: [Silicon Labs Matter Table of Contents](./docs/silabs/README.md)**
+
+---
 
 
 [![Builds](https://github.com/project-chip/connectedhomeip/workflows/Builds/badge.svg)](https://github.com/project-chip/connectedhomeip/actions/workflows/build.yaml)

diff --git a/docs/silabs/OVERVIEW.md b/docs/silabs/OVERVIEW.md
@@ -1,15 +1,16 @@
-[<< Back to TOC](./README.md)
-
 # Silicon Labs Matter Repo Overview
 
-Welcome to the Silicon Labs Matter Repo. For more information on Matter in general please checkout the main Matter Overview page located here [Matter Overview](../../README.md)
+Welcome to the Silicon Labs Matter Repo. For more information on Matter in general see the main [Matter Overview](../../README.md) page. 
+
+Silicon Labs supports Matter on both 802.15.4 (Thread) and 802.11 (Wi-Fi) transport protocols. 
 
-Silicon Labs supports Matter on both 802.15.4 (Thread) and 802.11 (Wifi) transport protocols. 
+This Repo is the starting point for all Silicon Labs-related Matter development. In this repo you will find documentation, demos, examples and all the code needed for Matter Accessory Device development on both Thread and .
 
-This Repo is the starting point for all Silicon Labs related Matter development. In this repo you will find documentation, demos, examples and all the code needed for Matter Accessory Device development on both Thread and Wifi.
+The Thread and  development use cases differ because the Thread protocol requires the use of an Open Thread Border Router (OTBR).  
 
-The Thread and Wifi development use cases differ because the Thread protocol requires the use of an Open Thread Border Router (OTBR).
+The Thread demo and development use case is described in the Thread section of this documentation located here: [Matter Thread](./thread/THREAD.md)
 
-The Thread development use case is described in the Thread section of this documentation located here: [Matter Thread](./thread/THREAD.md)
+The Wi-Fi demo and development use case is described in the Wi-Fi section of this documentation located here: [Matter Wi-Fi](./wifi/WIFI.md)
 
-The Wifi development use case is described in the Wifi section of this documentation located here: [Matter Wifi](./wifi/WIFI.md)
+----
+[Table of Contents](./README.md) | [Thread Demo](./thread/DEMO_OVERVIEW.md) | [Wi-Fi Demo](./wifi/DEMO_OVERVIEW.md)
diff --git a/docs/silabs/general/ARTIFACTS.md b/docs/silabs/general/ARTIFACTS.md
@@ -1,19 +1,19 @@
-[<< Back to TOC](../README.md)
+
 
 # Matter Software Artifacts
-This page provides links to pre-built software image "artifacts" that can be used to set up the Matter Demo for the Thread and Wifi use cases.
+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 Pi. The Matter Hub Image provides both an Open Thread Border Router and the Matter "ChipTool". Please download the Matter Hub Raspberry Pi image here. Note the image is ~10GB in size so depending on your internet connection this download may take some time. 
+The Matter Hub image is intended to be flashed onto an SD card for a Raspberry Pi. The Matter Hub Image provides both an Open Thread Border Router and the Matter "ChipTool". 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>
 
 ## 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, here: 
+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/v0.1.0
 
@@ -34,7 +34,9 @@ Matter Chip Tool .apk file is located here: http://silabs.com
 -->
 
 ## RS9116 Firmware
-The RS9116 firmware is used to update the RS9116. 
-RS9116 Firmware is located in GitHub here: 
+The RS9116 firmware is used to update the RS9116, and is located in GitHub here: 
+
+https://github.com/SiliconLabs/wiseconnect-wifi-bt-sdk/tree/2.5.0/firmware
 
-https://github.com/SiliconLabs/wiseconnect-wifi-bt-sdk/tree/2.5.0/firmware
+----
+[Table of Contents](../README.md) | [Thread Demo](../thread/DEMO_OVERVIEW.md) | [Wi-Fi Demo](../wifi/DEMO_OVERVIEW.md)
diff --git a/docs/silabs/general/COMMIT_HASHES.md b/docs/silabs/general/COMMIT_HASHES.md
@@ -1,5 +1,3 @@
-[<< Back to TOC](../README.md)
-
 # Matter Repositories and Commit Hashes
 
 The following repositories, branches and commit hashes are to be used together
@@ -28,3 +26,6 @@ in this release of the Silicon Labs Matter Out of Box Experience
 | Repo                                            | Branch | Commit Hash                              |
 | ----------------------------------------------- | ------ | ---------------------------------------- |
 | https://github.com/SiliconLabs/matter | \<this branch\>   | \<this commit\> |
+
+----
+[Table of Contents](../README.md) | [Thread Demo](../thread/DEMO_OVERVIEW.md) | [Wi-Fi Demo](../wifi/DEMO_OVERVIEW.md)
diff --git a/docs/silabs/general/FIND_RASPI.md b/docs/silabs/general/FIND_RASPI.md
@@ -1,5 +1,3 @@
-[<< Back to TOC](../README.md)
-
 # How to find your Raspberry Pi on the Network
 
 ## Finding the IP address of your Raspberry Pi
@@ -21,3 +19,6 @@ Sometimes it can be difficult to find your Raspberry Pi on the network. One way
 | Platform | Strategy |
 | -------- | -------- | 
 | Mac / Linux / Windows | Once you have found your Raspberry Pi's IP address, you can use Secure Shell (SSH) to connect to it over the command line with the following command: <br> &emsp; `ssh <raspberry pi's username>@<raspberry pi's IP address>` <br><br> Example: <br> &emsp; `ssh [email protected]` <br> &emsp;`password: raspberrypi` <br><br> When prompted provide the raspberry pi's password, in the case of the Silicon Labs Matter Hub image the username is ***ubuntu*** and the password is ***raspberrypi*** | 
+
+----
+[Table of Contents](../README.md) | [Thread Demo](../thread/DEMO_OVERVIEW.md) | [Wi-Fi Demo](../wifi/DEMO_OVERVIEW.md)
diff --git a/docs/silabs/general/FLASH_SILABS_DEVICE.md b/docs/silabs/general/FLASH_SILABS_DEVICE.md
@@ -1,5 +1,3 @@
-[<< Back to TOC](../README.md)
-
 # How to Flash a Silicon Labs Device
 
 Once you have an image built, you can flash it onto your EFR device (either a EFR32 development board or the Thunderboard Sense 2) over USB connected to your development machine. This can be done using either Simplicity Studio or the standalone Simplicity Commander.
@@ -14,3 +12,6 @@ A link to download Simplicity Commander's standalone version is located along wi
 Simplicity Studio is a complete development environment and tool suite. It has the ability to discover USB connected development boards and flash them.
 - [Download Simplicity Studio](https://www.silabs.com/developers/simplicity-studio)
 - [Simplicity Studio Reference Guide](https://docs.silabs.com/simplicity-studio-5-users-guide/latest/ss-5-users-guide-building-and-flashing/flashing)
+
+----
+[Table of Contents](../README.md) | [Thread Demo](../thread/DEMO_OVERVIEW.md) | [Wi-Fi Demo](../wifi/DEMO_OVERVIEW.md)
diff --git a/docs/silabs/general/ZAP.md b/docs/silabs/general/ZAP.md
@@ -1,5 +1,3 @@
-[<< Back to TOC](../README.md)
-
 # ZCL Advanced Platform (ZAP) Tool for Matter
 
 ## Overview
@@ -159,3 +157,6 @@ Then click generate in the top menu bar. The user will be prompted to choose a
 save location for the generated ZAP code. In the Silicon Labs Matter repository,
 the lock-app generated files belong in
 matter/zzz_generated/lock-app/zap-generated .
+
+----
+[Table of Contents](../README.md) | [Thread Demo](../thread/DEMO_OVERVIEW.md) | [Wi-Fi Demo](../wifi/DEMO_OVERVIEW.md)
diff --git a/docs/silabs/thread/BUILD_FLASH_MAD.md b/docs/silabs/thread/BUILD_FLASH_MAD.md
@@ -1,5 +1,3 @@
-[<< Back to TOC](../README.md)
-
 # How to Build and Flash the Matter Accessory Device (MAD)
 
 The Matter Accessory Device, such as the lighting-app, is the actual Matter
@@ -11,15 +9,15 @@ Chip-Tool.
 We have provided two ways to get the required image to flash the MAD. You can
 use one of the following options:
 
-1. Using the pre-built image file
-2. Building the image file from the '`connectedhomeip`' repository
+1. Use the pre-built image file
+2. Build the image file from the '`connectedhomeip`' repository
 
 <br>
 
 ### **Using the Pre-Built Image File**
 
 All of the Matter Accessory Device image files are accessible through the
-[Matter Artifacts Page](../general/ARTIFACTS.md). If you are using the pre-built
+[Matter Artifacts Page](../general/ARTIFACTS.md). If you are using a pre-built
 image file, you can skip forward to Step #2: Flashing the MAD.
 
 <br>
@@ -28,13 +26,13 @@ image file, you can skip forward to Step #2: Flashing the MAD.
 
 **1. Clone the Silicon Labs Matter repository**
 
-    Since you are reading this documentation it is assumed that you have already cloned the Silicon Labs Matter GitHub repository and have the right branch. If you have not you can follow the directions below.
+    You should have already cloned the Silicon Labs Matter GitHub repository and have the right branch as part of building an RCP image. If you have not, you can follow the directions below.
 
 The Silicon Labs Matter repo is located in Github here:
 https://github.com/SiliconLabs/matter.
 
-In order to clone the Matter repo you'll need to have Git installed on your
-local machine. Once you have Git installed you can use the following command:
+You must have Git installed on your
+local machine. To clone the repo use the following command:
 
 > `$ git clone https://github.com/SiliconLabs/matter.git`
 
@@ -68,3 +66,7 @@ the following instructions:
 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.
+
+
+----
+[Table of Contents](../README.md) | [Thread Demo](./DEMO_OVERVIEW.md) | [Wi-Fi Demo](../wifi/DEMO_OVERVIEW.md)
diff --git a/docs/silabs/thread/CHIP_TOOL.md b/docs/silabs/thread/CHIP_TOOL.md
@@ -1,5 +1,3 @@
-[<< Back to TOC](../README.md)
-
 # Using the ChipTool
 
 The following commands show how to start a new Thread network from the local
@@ -178,3 +176,6 @@ and rename the following alias to your liking.
 > `$ alias mattertool=‘source $HOME/scripts/matterTool.sh’` <br>
 
 > `$ alias otbrsetup=‘source $HOME/scripts/setupOTBR.sh’`
+
+----
+[Table of Contents](../README.md) | [Thread Demo](./DEMO_OVERVIEW.md) | [Wi-Fi Demo](../wifi/DEMO_OVERVIEW.md)
diff --git a/docs/silabs/thread/DEMO_OVERVIEW.md b/docs/silabs/thread/DEMO_OVERVIEW.md
@@ -1,57 +1,55 @@
-[<< Back to TOC](../README.md)
+# Matter over Thread Demo Overview
 
-# Matter Demo over Thread Overview
-
-This guide goes through the steps for running an example lighting-app for Matter
-over Thread. Please look at [this](THREAD.md) file for an introduction to the
+This section reviews the steps for running an example lighting-app for Matter
+over Thread. See [this file](THREAD.md) for an introduction to the
 Matter over Thread setup.
 
-At a high level, we will walk through starting a thread network, commissioning a
-new device to the thread network using BLE, and finally sending a basic OnOff
-command to the end device.
+At a high level, we will walk through starting a Thread network, commissioning a
+new device to the Thread network using Bluetooth LE, and finally sending a basic
+OnOff command to the end device.
 
 <br>
 
-## Step 0: Prerequisites
+## Prerequisites
 
-Before beginning your Matter project, consider the
-[Matter Hardware and Software Prerequisites](./THREAD_PREREQS.md). Here you will find all the information you need on Silicon Labs hardware supported for Matter development.
+Before beginning your Matter project, you should have the software and systems described in
+[Matter Hardware and Software Prerequisites](./THREAD_PREREQS.md).
 
 <br>
 
 ## Step 1: Setting up the Matter Hub (Raspberry Pi)
 
 The Matter Hub consists of the OTBR and the ChipTool running on a Raspberry Pi.
-Silicon Labs has developed a Raspberry Pi image which can be downloaded and
-flashed onto an SD Card that is then to be inserted into the Raspberry Pi.
+Silicon Labs has developed a Raspberry Pi image that can be downloaded and
+flashed onto an SD Card, which is then inserted into the Raspberry Pi.
 
 The Matter Controller sends IPv6 packets to the OTBR, which converts the IPv6
 packets into Thread packets. The Thread packets are then routed to the Silicon
 Labs end device.
 
-Please refer to this guide for the setup:
-[How to use Matter Hub \(Raspberry Pi\) Image](./RASPI_IMG.md)
+See [How to use Matter Hub \(Raspberry Pi\) Image](./RASPI_IMG.md) for setup
+instructions. 
 
 <br>
 
-## Step 2: Build and Flash the RCP
+## Step 2: Flash the RCP
 
-The Radio Co-Processor (RCP) is a thread device that connects to the Raspberry
-Pi via USB. First, to flash the RCP, it should be connected to your laptop via
-USB. Thereafter, it should be connected to the Raspberry Pi via USB as well.
+The Radio Co-Processor (RCP) is a Thread device that connects to the Raspberry
+Pi via USB. To flash the RCP, connect it to your laptop via
+USB. Thereafter, it should be connected to the Raspberry Pi via USB as well. Prebuilt RCP images are available for the demo
 
-Information on building and flashing the RCP is located here:
+Information on flashing and optionally building the RCP is located here:
 [How To Build and Flash the RCP](RCP.md)
 
 <br>
 
 ## Step 3: Build and Flash the MAD
 
 The Matter Accessory Device (MAD) is the actual Matter device that will be
-commissioned onto the Matter network and control using the ChipTool.
+commissioned onto the Matter network and controlled using the ChipTool. Prebuilt MAD images are available for the demo.
 
-Information on how to build and flash the Matter Accessory device is located
-here: [How To Build and Flash the Matter Accessory Device](./MATTER_DEVICE.md)
+Information on flashing and optionally building the Matter Accessory device is located
+here: [How To Build and Flash the Matter Accessory Device](./BUILD_FLASH_MAD.md)
 
 <br>
 
@@ -69,3 +67,6 @@ Pi image:
 | mattertool off         | Sends an **off** command to the MAD using ChipTool |
 
 <br>
+
+----
+[Table of Contents](../README.md) | [Thread Demo](./DEMO_OVERVIEW.md) | [Wi-Fi Demo](../wifi/DEMO_OVERVIEW.md)
diff --git a/docs/silabs/thread/FAQ.md b/docs/silabs/thread/FAQ.md
@@ -1,10 +1,3 @@
-[<< Back to TOC](../README.md)
-
-<!-- - connecting raspi to netwrok
-- why is mattertool not working:
-  - bad image
-  - image not flashed correctly -->
-
 # Frequently Asked Questions for Matter over Thread
 
 ## Demo
@@ -31,3 +24,6 @@
         [Raspberry Pi Remote Access](https://www.raspberrypi.com/documentation/computers/remote-access.html)
 
 <br>
+
+----
+[Table of Contents](../README.md) | [Thread Demo](./DEMO_OVERVIEW.md) | [Wi-Fi Demo](../wifi/DEMO_OVERVIEW.md)
diff --git a/docs/silabs/thread/RASPI_IMG.md b/docs/silabs/thread/RASPI_IMG.md
@@ -1,9 +1,7 @@
-[<< Back to TOC](../README.md)
-
 # Setting up the Matter Hub (Raspberry Pi)
 
-The Matter Hub consists of the Open Thread Border Router and the ChipTool
-running on a Raspberry Pi. Silicon Labs has developed a Raspberry Pi image which
+The Matter Hub consists of the Open Thread Border Router (OTBR) and the ChipTool
+running on a Raspberry Pi. Silicon Labs has developed a Raspberry Pi image that
 can be downloaded and flashed onto an SD Card for the Raspberry Pi.
 
 In short, the Matter Controller sends IPv6 packets to the OTBR, which converts
@@ -16,43 +14,42 @@ Silicon Labs end device.
 
 <br>
 
-The Raspberry Pi should be connected to a network - this could be ethernet or a
-Wifi network.
-
-Please refer to this page on how to connect your Raspberry Pi to a wifi network:
-[Connecting Raspberry Pi to Wifi](https://www.raspberrypi.com/documentation/computers/configuration.html#configuring-networking)
-
-<br>
-
 ### Step 1. Raspberry Pi Image Download
 
 The provided Raspberry Pi image is used as a Matter Controller with the OTBR.
 
 The image can be downloaded from the
 [Matter Artifacts page](../general/ARTIFACTS.md)
 
+> Please note that this image, even when zipped up, is quite large ~10GB so this download will take a while if you are on a slow connection. This image includes both the Ubuntu operating system as well as the OTBR and Chip-Tool, so there is a lot of sofware pre-packaged in this image, hence the size.
+
 <br>
 
 ### Step 2. Flashing your Raspberry Pi
 
 [Raspberry Pi Disk Imager](https://www.raspberrypi.com/software/) can be used to
-flash the SD Card which contains the operating system for the Raspberry Pi.
+flash the SD Card that contains the operating system for the Raspberry Pi. Under Operating System select 'Use Custom' and then select the .img file. 
 
 Alternatively, a tool like [balenaEtcher](https://www.balena.io/etcher/) can be
 used to flash the image to a micro SD card.
 
 > After flashing the SD card, insert it into the Raspberry Pi and reset the
-> Raspberry Pi. Then, wait at least 10 seconds for it to come up and start the
+> Raspberry Pi by unplugging it from the power source and plugging it back in. Then, wait at least 10 seconds for it to come up and start the
 > SSH server.
 
 <br>
 
 ### Step 3. Finding your Raspberry Pi on the Network
 
-Please see the [Finding Your Raspberry Pi page](../general/FIND_RASPI.md) for
+The Raspberry Pi should be connected to a network - this could be Ethernet or a
+Wi-Fi network.
+
+The preference here is to use Ethernet, however if you are using Wi-Fi for your connection to the Raspberry Pi, please see [Connecting Raspberry Pi to Wi-Fi](https://www.raspberrypi.com/documentation/computers/configuration.html#configuring-networking) for instructions on how to connect your Raspberry Pi to a Wi-Fi network.
+
+Once you have connected your Raspberry Pi to the network, you will want to connect to your Raspberry Pi over SSH. In order to do this you will need the IP address of your Raspberry Pi. Please see the [Finding Your Raspberry Pi page](../general/FIND_RASPI.md) for
 more information on finding the Raspberry Pi on the local network.
 
-##### Raspberry Pi Login Credentials
+#### Raspberry Pi Login Credentials
 
 -   user: **ubuntu**
 -   password: **raspberrypi**
@@ -70,3 +67,6 @@ application inside the Raspberry Pi image.
 
 Please refer to the ChipTool page for information on using the Matter Hub with
 `mattertool` commands: [ChipTool page](./CHIP_TOOL.md)
+
+----
+[Table of Contents](../README.md) | [Thread Demo](./DEMO_OVERVIEW.md) | [Wi-Fi Demo](../wifi/DEMO_OVERVIEW.md)