`ssh
Example:
`ssh ubuntu@10.4.148.44`
`password: raspberrypi`
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 index 00aba6bb0557e5..937a593186f86c 100644 --- 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) \ No newline at end of file diff --git a/docs/silabs/general/ZAP.md b/docs/silabs/general/ZAP.md index 9fee9d54b20f4d..106d6d8deca483 100644 --- 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) \ No newline at end of file diff --git a/docs/silabs/thread/BUILD_FLASH_MAD.md b/docs/silabs/thread/BUILD_FLASH_MAD.md index 6fab52e7226c1a..af89c067e28899 100644 --- 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
### **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.
@@ -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) \ No newline at end of file diff --git a/docs/silabs/thread/CHIP_TOOL.md b/docs/silabs/thread/CHIP_TOOL.md index 5cabcca2b09908..725ea98ef71a4f 100644 --- 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’`
> `$ alias otbrsetup=‘source $HOME/scripts/setupOTBR.sh’` + +---- +[Table of Contents](../README.md) | [Thread Demo](./DEMO_OVERVIEW.md) | [Wi-Fi Demo](../wifi/DEMO_OVERVIEW.md) \ No newline at end of file diff --git a/docs/silabs/thread/DEMO_OVERVIEW.md b/docs/silabs/thread/DEMO_OVERVIEW.md index 427811f8049ae6..b43be39d09f9b7 100644 --- a/docs/silabs/thread/DEMO_OVERVIEW.md +++ b/docs/silabs/thread/DEMO_OVERVIEW.md @@ -1,46 +1,44 @@ -[<< 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.
-## 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).
## 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.
-## 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)
@@ -48,10 +46,10 @@ Information on building and flashing the RCP is located here: ## 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)
@@ -69,3 +67,6 @@ Pi image: | mattertool off | Sends an **off** command to the MAD using ChipTool |
+ +---- +[Table of Contents](../README.md) | [Thread Demo](./DEMO_OVERVIEW.md) | [Wi-Fi Demo](../wifi/DEMO_OVERVIEW.md) \ No newline at end of file diff --git a/docs/silabs/thread/FAQ.md b/docs/silabs/thread/FAQ.md index c84b2dc8374d0c..62a94105135d4f 100644 --- a/docs/silabs/thread/FAQ.md +++ b/docs/silabs/thread/FAQ.md @@ -1,10 +1,3 @@ -[<< Back to TOC](../README.md) - - - # 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)
+ +---- +[Table of Contents](../README.md) | [Thread Demo](./DEMO_OVERVIEW.md) | [Wi-Fi Demo](../wifi/DEMO_OVERVIEW.md) \ No newline at end of file diff --git a/docs/silabs/thread/RASPI_IMG.md b/docs/silabs/thread/RASPI_IMG.md index 7d2aca86dac730..f7650478c7d792 100644 --- 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,14 +14,6 @@ Silicon Labs end device.
-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) - -
- ### Step 1. Raspberry Pi Image Download The provided Raspberry Pi image is used as a Matter Controller with the OTBR. @@ -31,28 +21,35 @@ 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. +
### 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.
### 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) \ No newline at end of file diff --git a/docs/silabs/thread/RCP.md b/docs/silabs/thread/RCP.md index 72f6bbd0eb9594..063a6516bc9b24 100644 --- a/docs/silabs/thread/RCP.md +++ b/docs/silabs/thread/RCP.md @@ -1,5 +1,3 @@ -[<< Back to TOC](../README.md) - # How to Build and Flash the Radio Co-Processor (RCP) The Radio Co-Processor is a 15.4 stack image flashed onto a Silicon Labs @@ -7,8 +5,7 @@ development kit or Thunderboard Sense 2. The 15.4 stack on the development kit communicates with the higher layers of the Thread stack running on the Raspberry Pi over a USB connection. -First, in order to flash the RCP, it should be connected to your laptop directly -over USB. +First, in order to flash the RCP, connect it to your laptop directly by USB. @@ -20,16 +17,16 @@ the OTBR need to be built off a commit that allows them to communicate properly. We have provided two ways to get the required image to flash the RCP. You can use one of the following options: -1. Using the pre-built image `ot-rcp` image file -2. Building the image file from the '`ot-efr32`' repository which is listed on +1. Use the pre-built image `ot-rcp` image file +2. Build the image file from the '`ot-efr32`' repository, which is listed on the [Matter Repositories and Commit Hashes page](../general/COMMIT_HASHES.md)
-### **Using the Pre-built Image File** +### **Using a Pre-built Image File** -All of the RCP image files are accessible through the -[Matter Artifacts Page](../general/ARTIFACTS.md). If you are using the pre-built +RCP image files for all demo boards are accessible through the +[Matter Artifacts Page](../general/ARTIFACTS.md). If you are using a pre-built image file, you can skip forward to Step #2: Flashing the RCP.
@@ -41,8 +38,8 @@ image file, you can skip forward to Step #2: Flashing the RCP. The ot-efr32 repo is located in Github here: https://github.com/SiliconLabs/ot-efr32. -In order to clone the ot-efr32 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/ot-efr32.git` @@ -51,7 +48,7 @@ the following command: > `$ cd ot-efr32`
> `$ git submodule update --init --recursive` -After updating the submodules you can checkout the correct branch or commit hash +After updating the submodules you can check out the correct branch or commit hash for the system. Check the current branch and commit hash used here: [Matter Branches and Commit Hashes](../general/COMMIT_HASHES.md) @@ -75,17 +72,17 @@ location: `
-There are a few different ways that a Matter network can be built using a +A Matter network can be built in a number of ways using a combination of Silicon Labs hardware, a Raspberry Pi, and any external -controller(Macbook, Ubuntu, Android, etc.) +controller (Macbook, Ubuntu, Android, etc.) -The suggested method involves using a Raspberry Pi to function as both, the -controller, and the OTBR, with a Silicon Labs device as the MAD. +The suggested method involves using a Raspberry Pi to function as both the +controller and the OTBR, with a Silicon Labs device as the MAD. -An alternate configuration would be using a Macbook as the controller, a -Raspberry Pi as the OTBR, with a Silicon Labs Device as the MAD. This requires +An alternate configuration is to use a Macbook as the controller, a +Raspberry Pi as the OTBR, and a Silicon Labs Device as the MAD. This requires additional routing between the controller and OTBR. + +---- +[Table of Contents](../README.md) | [Thread Demo](./DEMO_OVERVIEW.md) | [Wi-Fi Demo](../wifi/DEMO_OVERVIEW.md) \ No newline at end of file diff --git a/docs/silabs/thread/THREAD_PREREQS.md b/docs/silabs/thread/THREAD_PREREQS.md index d26a1d5b40ebc2..8c756339e180fb 100644 --- a/docs/silabs/thread/THREAD_PREREQS.md +++ b/docs/silabs/thread/THREAD_PREREQS.md @@ -1,32 +1,30 @@ -[<< Back to TOC](../README.md) - # Matter 15.4 Hardware and Software Prerequisites ## Software Requirements ### System Agnostic Software Requirements (Mac/ Linux/ Windows): -1. SSH Client ([Putty](https://www.putty.org/) or similar): +1. SSH Client ([PuTTY](https://www.putty.org/) or similar): > SSH client is used to communicate with the Raspberry Pi over a secure - > shell + > shell. 1. [Raspberry Pi Disk Imager](https://www.raspberrypi.com/software/) - > Raspberry Pi Disk Imager is used to flash the SD Card which contains the - > operating system for the Raspberry Pi + > 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. 1. [Flash tool](../general/FLASH_SILABS_DEVICE.md) > Simplicity Commander standalone or Simplicity Studio is used to flash > Silicon Labs hardware with firmware images for the RCP and the Matter - > Accessory Device -1. Git [Required for building images and development] + > Accessory Device. +1. Git [only required for building images and development] > Make sure Git is installed on the local machine that will be used to flash - > the devices to that the necessary repositories can be cloned locally and + > the devices so that the necessary repositories can be cloned locally and > used as needed.
### Windows-Specific Software Requirements - These are requirements in addition to those mentioned above, if using a -Windows machine.
+ These requirements are in addition to those mentioned above, for Windows only.
A Unix-like command line: @@ -93,3 +91,6 @@ Windows machine.
- [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) + +---- +[Table of Contents](../README.md) | [Thread Demo](./DEMO_OVERVIEW.md) | [Wi-Fi Demo](../wifi/DEMO_OVERVIEW.md) \ No newline at end of file diff --git a/docs/silabs/wifi/BUILD_CHIP_ENV.md b/docs/silabs/wifi/BUILD_CHIP_ENV.md index f28ea7f2d5717c..16764a5b997cc1 100644 --- a/docs/silabs/wifi/BUILD_CHIP_ENV.md +++ b/docs/silabs/wifi/BUILD_CHIP_ENV.md @@ -1,5 +1,3 @@ -[<< Back to TOC](../README.md) - # Build Environment using Linux This section will go through the steps required to build the demo using Linux. @@ -104,7 +102,7 @@ This is what you will burn into the EFR32. ## Compiling ChipTool -- Build the ChipTool on a laptop which has Wifi and BLE +- Build the ChipTool on a laptop which has Wi-Fi and Bluetooth LE - Run the following commands: > `$ cd $MATTER_WORKDIR/connectedhomeip`
@@ -113,4 +111,7 @@ This is what you will burn into the EFR32. This will build chiptool in `out/standalone` -Now, you will have all the binaries to flash onto MG12 platform. +Now you have all the binaries to flash onto the MG12 platform. + +---- +[Table of Contents](../README.md) | [Thread Demo](../thread/DEMO_OVERVIEW.md) | [Wi-Fi Demo](./DEMO_OVERVIEW.md) \ No newline at end of file diff --git a/docs/silabs/wifi/BUILD_PI_ENV.md b/docs/silabs/wifi/BUILD_PI_ENV.md index e5da598d1e68b8..16adbe73178ea5 100644 --- a/docs/silabs/wifi/BUILD_PI_ENV.md +++ b/docs/silabs/wifi/BUILD_PI_ENV.md @@ -1,42 +1,47 @@ -[<< Back to TOC](../README.md) +# Using the Pre-Built Rasberry Pi "Matter Hub" Image +When using a Raspberry Pi as a controller in your Matter network you have two options # Building Environment using Raspberry Pi 4 -1. Flash the Ubuntu OS onto the SD card -2. Insert the flashed SD card (directly or using a card reader) into the +To flash the Ubuntu OS onto the SD card: + +1. Insert the flashed SD card (directly or using a card reader) into the laptop/PC that will run the Raspberry Pi Imager tool -3. Launch Raspberry Pi 4 Imager -4. Click on 'Choose OS' --> 'Other General-purpose OS' --> 'Ubuntu' --> 'Ubuntu 22.04 64-bit server OS' -5. Click 'Storage' and select the 'SD card detect' -6. This Raspberry Pi 4's console can be accessed in multiple ways, refer to: +2. Launch Raspberry Pi 4 Imager +3. Click on 'Choose OS' --> 'Other General-purpose OS' --> 'Ubuntu' --> 'Ubuntu 22.04 64-bit server OS' +4. Click 'Storage' and select the 'SD card detect' +5. This Raspberry Pi 4's console can be accessed in multiple ways, refer to: https://www.raspberrypi.com/documentation/computers/remote-access.html -7. In this guide, Raspberru Pi 4 is being accessed using Putty. Enter the - details like User name, Password, SSID and it's password to connect to - network. Then, click 'Save' -8. Click 'Write' and then 'Yes' when you are asked for permission to erase data + In this guide, Raspberry Pi 4 is being accessed using Putty. +6. Enter the + details like User name, Password, SSID and its password to connect to + network. Click 'Save' +7. Click 'Write' and then 'Yes' when you are asked for permission to erase data on the SD card. It will then start flashing the OS onto the SD card -9. When it is done, click 'Continue' -10. Remove the SD card from the reader and insert it into the Raspberry Pi as +8. When it is done, click 'Continue'. +9. Remove the SD card from the reader and insert it into the Raspberry Pi as shown below:
-11. On powering up the board, the red and green lights should start blinking
-12. Use this reference to find the IP address of your Raspberry Pi: [Finding Your Raspberry Pi](../general/FIND_RASPI.md)
-13. Once you find the IP address, launch Putty, select 'Session', enter the IP
+On powering up the board, the red and green lights should start blinking. To start
+using the Raspberry Pi:
+
+1. Use this reference to find the IP address of your Raspberry Pi: [Finding Your Raspberry Pi](../general/FIND_RASPI.md)
+2. Once you find the IP address, launch Putty, select 'Session', enter the IP
address of the Raspberry Pi, and click 'Open'
-14. Enter the username and password given at the time of flashing and click
+3. Enter the username and password given at the time of flashing and click
'Enter'
If you don't give username and password default is user account "ubuntu" and password "ubuntu",
-15. Update the latest packages by running following commands in the terminal:
+4. Update the latest packages by running following commands in the terminal:
> `$ sudo apt update`
> `$ sudo apt install`
-16. Install required packages using the following commands:
+5. Install required packages using the following commands:
> `$ 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 \
@@ -46,29 +51,30 @@
> If you see any popups between installs, you can select 'Ok' or 'Continue'
## Installing prerequisites on Raspberry Pi 4
- Finally, install some Raspberry Pi specific dependencies
+ Finally, install some Raspberry Pi specific dependencies:
- refer this link : https://github.com/project-chip/connectedhomeip/blob/master/docs/guides/BUILDING.md
- In above link follow section "Installing prerequisites on Raspberry Pi 4".
+In [this link to the Project CHIP GitHub Site](https://github.com/project-chip/connectedhomeip/blob/master/docs/guides/BUILDING.md), follow the instructions in
+the section "Installing prerequisites on Raspberry Pi 4".
-## Bluetooth setup
- Make sure BLE is up and running on Raspberry-Pi.
- Raspberry pi internally has some issue in BLE and sometimes it crash in middle, BLE is used for
- commissioning purpose on Matter So make sure BLE is running.
+## Bluetooth Setup
+ Make sure BLE is up and running on Raspberry Pi.
+ Raspberry Pi internally has some issues with BLE that may cause
+ it to crash. Because BLE is used for
+ commissioning on Matter, make sure BLE is running.
- Use below commands to turn on or restart bluetooth on Raspberry - Pi.
+ `$ sudo systemctl status bluetooth.service`
- To stop BLE if it is already running.
- `$ sudo systemctl stop bluetooth.service`
+ To stop BLE if it is already running: `$ sudo systemctl stop bluetooth.service`
- To restart the Bluetooth service, we need to enable it first as we did before. Hence, we have been using the same systemctl command with a one word change e.g. enable.
+ To restart the Bluetooth service, first enable it:
`$ sudo systemctl enable bluetooth.service`
- When you check the status of a Bluetooth service, you will find it inactive because we haven’t restarted the service yet.
+ When you check the status of the Bluetooth service, it will be inactive because it has been enabled but not restarted:
`$ sudo systemctl status bluetooth.service`
- So, one needs to restart the Bluetooth service to make it active and running. So we have executed the query below.
- `$ sudo systemctl restart bluetooth.service`
+ Restart the service: `$ sudo systemctl restart bluetooth.service`
- After this command, when we have checked the status of the Bluetooth service, we found it active and running.
- `$ sudo systemctl status bluetooth.service`
+ Now the status of the service should be active and running: `$ sudo systemctl status bluetooth.service`
+
+----
+[Table of Contents](../README.md) | [Thread Demo](../thread/DEMO_OVERVIEW.md) | [Wi-Fi Demo](./DEMO_OVERVIEW.md)
\ No newline at end of file
diff --git a/docs/silabs/wifi/DEMO_OVERVIEW.md b/docs/silabs/wifi/DEMO_OVERVIEW.md
index 72082af46c5a18..2674a53d2aa7aa 100644
--- a/docs/silabs/wifi/DEMO_OVERVIEW.md
+++ b/docs/silabs/wifi/DEMO_OVERVIEW.md
@@ -1,60 +1,53 @@
-[<< Back to TOC](../README.md)
+# Matter over Wi-Fi Demo Overview
-# Matter over Wifi Demo Overview
-
-This document walks through the steps to build Matter Lighting-app project using
+This document walks through the steps to build the Matter Lighting-app project using
EFR32 BRD4161A + RS911X and EFR32 BRD4161A + WF200. Silicon Labs has two
-families of WiFi adatpers (1. RS911X 2. WF200). Both are supported in this WiFi
+families of Wi-Fi adapters (1. RS911X 2. WF200). Both are supported in this Wi-Fi
port of Matter.
-- -## Setup Overview +## Step 1: Matter Wi-Fi Prerequisites - +Before you being running the Matter Wi-Fi demo or developing for Wi-Fi you will want to make sure that you have all the required hardware and software for each use case. T -## EFR32MG12 + WF200 Connection +1. [Matter Wi-Fi Prerequisites](WIFI_PREREQS.md) - + This page goes through the hardware and software (host side) required for the demo. Make sure you have all the necessary hardware and software available before continuing. -
+## Step 2: Building the Chip-Tool for Wi-Fi - +In order to run the Matter Wi-Fi demo you will need to run the Chip-Tool on one of two platforms, either Linux/Mac or Raspberry Pi. -This document walks through the steps to build the Matter Lighting-app project -using EFR32 BRD4161A + RS911X and EFR32 BRD4161A + WF200. +1. [Build Linux Environment](BUILD_CHIP_ENV.md) -Follow this sequence if you are setting up for the first time: + This page contains instructions to set up the build environment on a Linux machine. + The instructions provide build steps for the application and the ChipTool. -1. [Matter Wifi Prerequisites](WIFI_PREREQS.md) +1. [Build Raspberry-Pi Environment](BUILD_PI_ENV.md) - This page goes through the hardware and software (host side) required for - the demo - make sure you have all the necessary hardware available before - continuing. + This page contains instructions to set up the build environment on the Raspberry + Pi. This is an alternative if you do not have a Linux machine. -2. [Build Linux Environment](BUILD_CHIP_ENV.md) +## Step 3: Building the Matter Accessory Device (MAD) for Wi-Fi - This part gives you steps to setup the build environment on a Linux machine. - The instructions gives you build steps for the application and the ChipTool. +If you are running the demo, you can simply download the proper image for your Matter Accessory Device from the [Matter Software Artifacts Page](../general/ARTIFACTS.md). Otherwise if you wish to build your Matter Accessory Device from scratch, you can begin with the [Software Setup](SW_SETUP.md): -3. [Build Raspberry-Pi Environment](BUILD_PI_ENV.md) +1. [Software Setup](SW_SETUP.md) - This section documents steps to setup the build environment on the Raspberry - Pi. + This page contains instructions to build the Lighting-app over Wi-Fi. Build commands are provided for both + the RS911x and WF200 adapters. -4. [Software Setup](SW_SETUP.md) +## Step 4: Running the Demo - This part gives you steps to build the Lighting-app over Wifi. Two separate - build commands are mentioned for RS911x and WF200 adapters to use - accordingly. +1. [Running Matter Demo over Wi-Fi using Linux](RUN_DEMO.md) -5. [Running Matter Demo over Wifi using Linux](RUN_DEMO.md) - - This part give you steps to run the Matter Wifi demo using ChipTool running + This contains instructions to run the Matter Wi-Fi demo using ChipTool running on a Linux Machine (either Laptop or Raspberry Pi) - follow this after successfully executing the above steps. -6. [optional] [Running Matter Demo over Wifi using Android](WIFI_ANDROID.md) +1. [optional] [Running Matter Demo over Wi-Fi using Android](WIFI_ANDROID.md) - This part give you steps to run the Matter Wifi demo using ChipTool running + This part give you steps to run the Matter Wi-Fi demo using ChipTool running on an Android phone (either Laptop or Raspberry Pi). + +---- +[Table of Contents](../README.md) | [Thread Demo](../thread/DEMO_OVERVIEW.md) | [Wi-Fi Demo](./DEMO_OVERVIEW.md) \ No newline at end of file diff --git a/docs/silabs/wifi/FAQ.md b/docs/silabs/wifi/FAQ.md index 765811ec0777d1..d3feaa601d8ff7 100644 --- a/docs/silabs/wifi/FAQ.md +++ b/docs/silabs/wifi/FAQ.md @@ -1,3 +1,5 @@ -[<< Back to TOC](../README.md) - # Frequently Asked Questions for Matter over Wifi + + +---- +[Table of Contents](../README.md) | [Thread Demo](../thread/DEMO_OVERVIEW.md) | [Wi-Fi Demo](./DEMO_OVERVIEW.md) \ No newline at end of file diff --git a/docs/silabs/wifi/RUN_DEMO.md b/docs/silabs/wifi/RUN_DEMO.md index deb82f3b82b1ef..eeaf32bdeba4c4 100644 --- a/docs/silabs/wifi/RUN_DEMO.md +++ b/docs/silabs/wifi/RUN_DEMO.md @@ -1,12 +1,11 @@ -[<< Back to TOC](../README.md) +# Runing the Matter Demo over Wi-fi -# Runing the Matter Demo over Wifi +## Flashing images/binaries on MG12 platform using Ozone, Simplicity Studio or Simplicity Commander. -## Flashing images/binaries on MG12 platform using Ozone +1. Plug the WSTK and EFR into the laptop. -1. Plug in the WSTK and EFR into the laptop +2. Launch Ozone, Simplicity Studio or Simplicity Commander Standalone - this will display a GUI. If you are not using Ozone, you can follow the instructions to [Flash a Silicon Labs Device](../general/FLASH_SILABS_DEVICE.md) -2. Launch Ozone - this will display a GUI 3. In 'New Project Wizard': @@ -31,7 +30,7 @@ 6. You will be asked to select the image/binary to be loaded: click on the three-dots on that tab and navigate to '`out/rs911x_lighting/BRD4161A`' through 'Browse', select the file named `chip-efr32-lighting-example.out` and - click 'Next', this is the same image which we built in previous step. + click 'Next'. This is the image built in previous step. 7. Make sure the next screen has 'Initial PC' selected as 'ELF Entry Point' - click 'Finish' @@ -53,7 +52,7 @@ > If you are restarting the device and do not need to re-flash the EFR > firmware then you can use these commands (JLinkExe & JLinRTTClient). The - > following commands will provide you with a serial cossole of the EFR32 + > following commands will provide you with a serial console of the EFR32 >
> `$ konsole -e JLinkExe -device EFR32MG12PXXXF1024 -if JTAG -speed 4000 -autoconnect 1 &` @@ -67,12 +66,12 @@
-## Demo Execution - Commissioning a Wifi Device using ChipTool for Linux +## Demo Execution - Commissioning a Wi-Fi Device using ChipTool for Linux -> Commissioning can also be done using ChipTool running either on -> Linux/Raspberry Pi +> Commissioning can be done using ChipTool running either on +> Linux or Raspberry Pi -1. Get the SSID and PSK of the Wifi network (WPA2 - Security) you are connected +1. Get the SSID and PSK of the Wi-Fi network (WPA2 - Security) you are connected to 2. Position the hardware near the laptop as the BLE antenna on the BRD4161A is slightly weak @@ -84,9 +83,9 @@ > `$ out/standalone/chip-tool pairing ble-wifi 1122 $SSID $PSK 20202021 3840` - > The node ID used here is 1122. This will be used in future comands. - > '\$SSID' is a placeholder for your Wifi SSID and '\$PSK' is a placeholder - > for the password of your Wifi network. + > The node ID used here is 1122. This will be used in future commands. + > '\$SSID' is a placeholder for your Wi-Fi SSID and '\$PSK' is a placeholder + > for the password of your Wi-Fi network. 4. Turning **on** the LED on the EFR32MG12:
`$ out/standalone/chip-tool onoff on 1122 1` @@ -96,20 +95,26 @@ > If there are any failures, run the following command and then re-run the > ChipTool command: `$ rm -rf /tmp/chip_*` +> If you are having difficulty getting the Chip-Tool to commission the device successfully it may be because you have more than one network interface available to the Chip-Tool. The device on which you are running the Chip-Tool must be on the same Wi-Fi network as your RS9116 or WF200 and there cannot be another network interface on the device that is running the Chip-Tool. For instance if you have an Ethernet connection as well as a Wi-Fi connection, you need to unplug the Ethernet connection and try running the Chip-Tool as in step #3 above. + > As the device remembers the Access Point credentials given for commissioning, > if you want to run the demo multiple times, do a factory reset by pressing the -> BTN0 on EFR32 MG12 for about 6-7seconds, you will observe the LED0 and LED1 -> flashes 3 times and QR code appears again on the LCD screen. +> BTN0 on EFR32 MG12 for about 6-7 seconds. The LED0 and LED1 +> flashes 3 times and the QR code appears again on the LCD screen.
The commissioning command mentioned above does the following: -- ChipTool scans BLE and located the SiLabs device that uses the specified +- ChipTool scans BLE and located the Silicon Labs device that uses the specified discriminator -- Sends the Wifi SSID and Passkey -- The SiLabs device will join the Wifi network and get an IPv4 address. It +- Sends the Wi-Fi SSID and Passkey +- The Silicon Labs device will join the Wi-Fi network and get an IPv4 address. It then starts providing mDNS records on IPv4 and IPv6 -- ChipTool then locates the SiLabs device over Wifi and establishes +- ChipTool then locates the device over Wi-Fi and establishes operational certificates -- Future communications (tests) will then happen over Wifi +- Future communications (tests) will then happen over Wi-Fi + + +---- +[Table of Contents](../README.md) | [Thread Demo](../thread/DEMO_OVERVIEW.md) | [Wi-Fi Demo](./DEMO_OVERVIEW.md) \ No newline at end of file diff --git a/docs/silabs/wifi/SW_SETUP.md b/docs/silabs/wifi/SW_SETUP.md index 0737c1371a6be8..fd28e250c0c19b 100644 --- a/docs/silabs/wifi/SW_SETUP.md +++ b/docs/silabs/wifi/SW_SETUP.md @@ -1,14 +1,20 @@ -[<< Back to TOC](../README.md) - # Software Setup and Preliminaries +## Using the Matter Accessory Device (MAD) Pre-Built Binaries +If you are just running the Matter demo, and are not interested in building the Matter Accessory Device images from scratch, you can download the MAD images for Wi-Fi from this software release on the [Artifacts Page](../general/ARTIFACTS.md) + +Once you have downloaded the image you require for your device, you can skip forward to the [Running the Matter Demo over Wi-Fi page](./RUN_DEMO.md) + +Otherwise if you are planning to build the Wi-Fi images from scratch please continue with this documentation. + + ## Software Setup -Run below commands on a Linux terminal running on either Linux machine, WSL or -Virtual Machine. +If you have not downloaded or cloned this repository, you can run the following commands on a Linux terminal running on either Linux machine, WSL or +Virtual Machine to clone the repository and run bootstrap to prepare to build the sample application images. 1. To download the - [Matter codebase](https://github.com/project-chip/connectedhomeip.git) run + [SiliconLabs Matter codebase](https://github.com/SiliconLabs/matter.git) run the following commands. Create a working directory - we will name it `matter` as part of this example flow: @@ -18,7 +24,7 @@ Virtual Machine. > `$ MATTER_WORKDIR=pwd` --> We will use $MATTER_WORKDIR later - > `$ git clone https://github.com/project-chip/connectedhomeip.git` + > `$ git clone https://github.com/SiliconLabs/matter.git` 2. Bootstrapping: @@ -59,9 +65,11 @@ This is what you will burn onto the EFR32. ## Compiling the ChipTool -- Build the chiptool on a laptop or Raspberry-pi ( If you are not using Linux - Laptop ) which has Wifi and BLE -- Run the following commands on a terminal where you will run chip-tool: +In order to control the Wi-Fi Matter Accessory Device you will have to compile and run the ChipTool on either a Linux, Mac or Raspberry Pi. The ChipTool builds faster on the Mac and Linux machines so that is recommended, but if you have access to a Raspberry Pi that will work as well. + +If you have not cloned this repository, you can run the following commands to clone the repository and set it up to build the ChipTool from source. + +1. Run the following commands on a terminal where you will run chip-tool: > `$ mkdir matter` @@ -69,7 +77,7 @@ This is what you will burn onto the EFR32. > `$ MATTER_WORKDIR=pwd` --> We will use $MATTER_WORKDIR later - > `$ git clone https://github.com/project-chip/connectedhomeip.git` + > `$ git clone https://github.com/SiliconLabs/matter.git` 2. Bootstrapping: @@ -88,5 +96,8 @@ This is what you will burn onto the EFR32. This will build chiptool in `out/standalone`. After this, follow the steps on the page - '[Runing the Matter Demo over Wifi](RUN_DEMO.md)' to flash the binaries and + '[Runing the Matter Demo over Wi-Fi](RUN_DEMO.md)' to flash the binaries and execute the demo. + +---- +[Table of Contents](../README.md) | [Thread Demo](../thread/DEMO_OVERVIEW.md) | [Wi-Fi Demo](./DEMO_OVERVIEW.md) \ No newline at end of file diff --git a/docs/silabs/wifi/WIFI.md b/docs/silabs/wifi/WIFI.md index 41b6babed7f661..3144cc8a91246a 100644 --- a/docs/silabs/wifi/WIFI.md +++ b/docs/silabs/wifi/WIFI.md @@ -1,20 +1,4 @@ -[<< Back to TOC](../README.md) - # Introduction -[TODO: general matter over wifi writeup] - - +---- +[Table of Contents](../README.md) | [Thread Demo](../thread/DEMO_OVERVIEW.md) | [Wi-Fi Demo](./DEMO_OVERVIEW.md) \ No newline at end of file diff --git a/docs/silabs/wifi/WIFI_ANDROID.md b/docs/silabs/wifi/WIFI_ANDROID.md index de52e42f9b117c..f1d0cb8fc4e82e 100644 --- a/docs/silabs/wifi/WIFI_ANDROID.md +++ b/docs/silabs/wifi/WIFI_ANDROID.md @@ -1,5 +1,3 @@ -[<< Back to TOC](../README.md) - # Commissioning Wifi Device using Android Commissioning can be done using an Android Phone through the following steps. @@ -38,3 +36,6 @@ Download pre-build application from the > - Press the BTN0 button and keep it pressed for about 1 min - this should > cause LED0 and LED1 to turns ON and OFF for 3 times. You can then leave > the button + +---- +[Table of Contents](../README.md) | [Thread Demo](../thread/DEMO_OVERVIEW.md) | [Wi-Fi Demo](./DEMO_OVERVIEW.md) \ No newline at end of file diff --git a/docs/silabs/wifi/WIFI_PREREQS.md b/docs/silabs/wifi/WIFI_PREREQS.md index 496c0629d63b0b..5ce41b3f8ef0e8 100644 --- a/docs/silabs/wifi/WIFI_PREREQS.md +++ b/docs/silabs/wifi/WIFI_PREREQS.md @@ -1,22 +1,30 @@ -[<< Back to TOC](../README.md) +# Matter Wi-Fi Prerequisites -# Matter Wifi Prerequisites - -Silicon Labs Matter Wifi is supported on two different platforms, the +Silicon Labs Matter Wi-Fi is supported on two different platforms, the [WF200](https://www.silabs.com/wireless/wi-fi/wf200-series-2-transceiver-ics) and the [RS9116](https://www.silabs.com/development-tools/wireless/wi-fi/rs9116x-sb-evk-development-kit). -In both cases the Wifi part is attached to an EFR32MG12 development board via a +In both cases the Wi-Fi part is attached to an EFR32MG12 development board via a daughter card. The EFR32MG12 is used as a host processor for the application and -for it's Bluetooth capability which is necessary for Matter commissioning. +for its Bluetooth capability, which is necessary for Matter commissioning. -In addition to the EFR32MG12 and Wifi boards, you will need to run the Matter -ChipTool on some device. This can be build and run on a Linux or Mac laptop or +In addition to the EFR32MG12 and Wi-Fi boards, you will need to run the Matter +ChipTool. This can be built and run on a Linux or Mac laptop or on a Raspberry Pi. -The hardware that you will need for Silicon Labs Matter Wifi development is as +The hardware that you will need for Silicon Labs Matter Wi-Fi development is as follows: +## EFR32MG12 + RS9116 Hardware Overview + + + +## EFR32MG12 + WF200 Hardware Overview + + + +
+ ## Hardware - Linux PC/Laptop **or** Raspberry Pi 4 (This is for running the ChipTool to @@ -26,34 +34,31 @@ follows: - BRD4161A/BRD4186C daughter boards are supported - [SLWRB4161A](https://www.silabs.com/development-tools/wireless/zigbee/slwrb4161a-efr32mg12-radio-board) - [XG24-RB4186C](https://www.silabs.com/development-tools/wireless/xg24-rb4186c-efr32xg24-wireless-gecko-radio-board) - > BLE and Matter code runs here - - Wifi Dev Kit, either + > BLE and Matter code run here + - Wi-Fi Dev Kit, either [RS9116X-SB-EVK1](https://www.silabs.com/development-tools/wireless/wi-fi/rs9116x-sb-evk-development-kit) **or** [WF200](https://www.silabs.com/wireless/wi-fi/wf200-series-2-transceiver-ics) - - Interconnect board (included in the wifi kits) + - Interconnect board (included in the Wi-Fi kits) - SPI Cable (included in the RS9116 kit) - Jumper Cables (included in the RS9116 kit) - Access point with Internet access -- microSD card (32GB) (If using Raspberry Pi) +- microSD card (32GB) (if using Raspberry Pi) - **[Optional]** Android Mobile phone (If using the ChipTool on Android)
## Software -- Ozone to flash the images generated +- Ozone (optional) to flash the images generated - Windows: [Download Ozone](https://www.segger.com/downloads/jlink/) > Search for "Ozone - The J-Link Debugger" and download the latest - > Windows installer depending on 32/64bit and install it. + > Windows (32 or 64 bit) version and install it - Linux: [Download Ozone](https://www.segger.com/downloads/jlink/Ozone_Linux_x86_64.deb) and install it -- [otional] ChipTool Android mobile application: - [Download](https://confluence.silabs.com/download/attachments/240625466/chip-app.zip?version=1&modificationDate=1647837891300&api=v2), - extract, and install to the Android mobile; [TODO: the link is a confluence - link!] -- Raspberry Pi imager tool: [Download](https://www.raspberrypi.com/software/) +- [Simplicity Studio or Simplicity Commander](../general/FLASH_SILABS_DEVICE.md) (optional) to flash images generated +- Raspberry Pi imager tool (optional): To flash an operating system or Raspberry Pi image on the SD card of the Raspberry Pi if you are using one to run the ChipTool. Note: The ChipTool may also be compiled and run on a Linux machine or Mac. [Download](https://www.raspberrypi.com/software/) - Upgrade firmware on RS9116 EVK: [Reference](http://draft-docs.suds.silabs.net/rs9116-wiseconnect/2.5/wifibt-wc-getting-started-with-pc/update-evk-firmware) @@ -66,3 +71,6 @@ Pre-Built Rs9116 firmware is available on the 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) + +---- +[Table of Contents](../README.md) | [Thread Demo](../thread/DEMO_OVERVIEW.md) | [Wi-Fi Demo](./DEMO_OVERVIEW.md) \ No newline at end of file diff --git a/examples/lighting-app/silabs/SiWx917/README.md b/examples/lighting-app/silabs/SiWx917/README.md index a8d588271aae84..ccc346887734cc 100644 --- a/examples/lighting-app/silabs/SiWx917/README.md +++ b/examples/lighting-app/silabs/SiWx917/README.md @@ -55,11 +55,11 @@ Silicon Labs platform. - Download the [Simplicity Commander](https://www.silabs.com/mcu/programming-options) - command line tool, and ensure that `commander` is your shell search path. + command line tool, and ensure that `commander` is in your shell search path. (For Mac OS X, `commander` is located inside `Commander.app/Contents/MacOS/`.) -- Download and install a suitable ARM gcc tool chain: +- Download and install a suitable ARM GCC tool chain: [GNU Arm Embedded Toolchain 9-2019-q4-major](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads) - Install some additional tools (likely already present for CHIP developers):