Skip to content

Commit 8bbe2ea

Browse files
miduggan24Copilotgemini-code-assist[bot]restyled-commits
authored
Update Silabs Documentation Links (project-chip#41509)
* update silabs documentation to updated links * Update examples/closure-app/silabs/README.md Co-authored-by: Copilot <[email protected]> * Update examples/thermostat/silabs/README.md Co-authored-by: Copilot <[email protected]> * Update examples/thermostat/silabs/README.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * resolve restyle failures by running prettier on all files in PR * Restyled by prettier-markdown * resolve matter_sdk styling comments --------- Co-authored-by: Copilot <[email protected]> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Restyled.io <[email protected]>
1 parent ac328e4 commit 8bbe2ea

File tree

16 files changed

+914
-896
lines changed

16 files changed

+914
-896
lines changed

docs/platforms/silabs/silabs_cli_guide.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ with or without the Matter CLI. For Wi-Fi devices, only the Matter CLI is
99
available.
1010

1111
- [Introduction](#introduction)
12-
- [Enable the CLI interfaces](#enable-the-cli-interfaces)
12+
- [Enable the CLI Interfaces](#enable-the-cli-interfaces)
1313
- [Matter CLI](#matter-cli)
1414
- [OpenThread CLI](#openthread-cli)
15-
- [Connecting to the device](#connecting-to-the-device)
15+
- [Connecting to the Device](#connecting-to-the-device)
1616
- [Screen Utility](#screen-utility)
1717
- [Tera Term](#tera-term)
1818
- [Command List](#command-list)
@@ -70,7 +70,7 @@ screen /dev/cu.usbmodem0004403048491 115200 8-N-1
7070
### Tera Term
7171

7272
See the
73-
[Tera Term guide](https://siliconlabs.github.io/matter/latest/wifi/MATTER_SHELL.html)
73+
[Tera Term guide](https://docs.silabs.com/matter/latest/matter-overview-guides/serial-port-communications)
7474
on how to connect to the device on Windows.
7575

7676
## Command List
@@ -89,7 +89,6 @@ When the prompt `matterCli>` is printed, the device is ready for a command.
8989
- [device](#device)
9090
- [onboardingcodes](#onboardingcodes)
9191
- [dns](#dns)
92-
- [dns](#dns)
9392
- [ota](#ota)
9493
- [stat](#stat)
9594
- [echo](#echo)

docs/platforms/silabs/silabs_getting_started.md

Lines changed: 25 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ sample app.
1212
> frequent releases thoroughly tested and validated. Developers looking to
1313
> develop matter products with silabs hardware are encouraged to use our latest
1414
> release with added tools and documentation.
15-
> [Silabs Matter Github](https://github.com/SiliconLabs/matter/releases)
15+
> [Silabs matter_sdk Github](https://github.com/SiliconLabsSoftware/matter_sdk/tags)
1616
>
1717
> Developers can find more resources on the
1818
> [Silicon Labs Matter Community Page](https://community.silabs.com/s/article/connected-home-over-ip-chip-faq?language=en_US).
@@ -35,20 +35,20 @@ sample app.
3535
### Hardware Requirements
3636

3737
For the list of hardware requirements, see the official
38-
[Silicon Labs Matter HW requirements](https://siliconlabs.github.io/matter/latest/general/HARDWARE_REQUIREMENTS.html)
38+
[Silicon Labs Matter HW requirements](https://docs.silabs.com/matter/latest/matter-prerequisites/hardware-requirements)
3939
documentation.
4040

4141
### Software Requirements
4242

4343
For the list of software requirements, see the official
44-
[Silicon Labs Matter Software requirements](https://siliconlabs.github.io/matter/latest/general/SOFTWARE_REQUIREMENTS.html)
44+
[Silicon Labs Matter Software requirements](https://docs.silabs.com/matter/latest/matter-prerequisites/software-requirements)
4545
documentation.
4646

4747
#### Software Artifacts
4848

4949
For pre-built binaries for the latest Silicon Labs Matter release, see the
5050
official
51-
[Silicon Labs Matter Software Artifacts](https://siliconlabs.github.io/matter/latest/general/ARTIFACTS.html#matter-software-artifacts).
51+
[Silicon Labs Matter Software Artifacts](https://docs.silabs.com/matter/latest/matter-prerequisites/matter-artifacts).
5252
This includes all necessary binaries to run a Silicon Labs sample app.
5353

5454
## Building
@@ -57,32 +57,40 @@ Silicon Labs currently supports the following list of sample apps in the main
5757
Matter SDK. Every sample has its own documentation explaining its unique
5858
features and functionalities. The examples in the `CSA Matter Repository` column
5959
are supported in the main Matter SDK. Additionally, the
60-
[Silabs Matter Repository](https://github.com/SiliconLabs/matter) offers extra
61-
sample applications for different device-types
60+
[Silabs Matter Repository](https://github.com/SiliconLabsSoftware/matter_sdk)
61+
offers extra sample applications for different device-types
6262

6363
<table>
6464
<tbody>
6565
<tr>
6666
<th>CSA Matter Repository</th>
67-
<th> <a href="https://github.com/SiliconLabs/matter">Silabs Matter Repository</a></th>
67+
<th> <a href="https://github.com/SiliconLabsSoftware/matter_sdk">Silabs matter_sdk Repository</a></th>
6868
</tr>
6969
<tr>
7070
<td>
7171
<ul>
72-
<li> <a href="../../lighting-app/silabs/README.md">Lighting App</a></li>
73-
<li> <a href="../../light-switch-app/silabs/README.md)">Light-Switch App</a></li>
74-
<li> <a href="../../chef/README.md">Chef App</a></li>
75-
<li> <a href="../../lock-app/silabs/README.md">Lock App</a></li>
76-
<li> <a href="../../pump-app/silabs/README.md">Pump App</a></li>
77-
<li> <a href="../../smoke-co-alarm-app/silabs/README.md">Smoke & CO Alarm App</a></li>
78-
<li> <a href="../../thermostat/silabs/README.md">Thermostat App</a></li>
72+
<li> <a href="../../../examples/lighting-app/silabs/README.md">Lighting App</a></li>
73+
<li> <a href="../../../examples/light-switch-app/silabs/README.md">Light-Switch App</a></li>
74+
<li> <a href="../../../examples/chef/README.md">Chef App</a></li>
75+
<li> <a href="../../../examples/lock-app/silabs/README.md">Lock App</a></li>
76+
<li> <a href="../../../examples/pump-app/silabs/README.md">Pump App</a></li>
77+
<li> <a href="../../../examples/smoke-co-alarm-app/silabs/README.md">Smoke & CO Alarm App</a></li>
78+
<li> <a href="../../../examples/thermostat/silabs/README.md">Thermostat App</a></li>
79+
<li> <a href="../../../examples/air-quality-sensor-app/silabs/README.md">Air Quality Sensor App</a></li>
80+
<li> <a href="../../../examples/closure-app/silabs/README.md">Closure App</a></li>
81+
<li> <a href="../../../examples/dishwasher-app/silabs/README.md">Dishwasher App</a></li>
82+
<li> <a href="../../../examples/energy-management-app/silabs/README.md">Energy Management App</a></li>
83+
<li> <a href="../../../examples/lit-icd-app/silabs/README.md">LIT ICD App</a></li>
84+
<li> <a href="../../../examples/refrigerator-app/silabs/README.md">Refrigerator App</a></li>
85+
<li> <a href="../../../examples/window-app/silabs/README.md">Window App</a></li>
7986
</ul>
8087
</td>
8188
<td>
8289
<ul>
83-
<li><a href="https://github.com/SiliconLabs/matter/blob/release_2.2.0-1.2/silabs_examples/dishwasher-app/silabs/README.md">Dishwasher App</a></li>
84-
<li><a href="https://github.com/SiliconLabs/matter/blob/release_2.2.0-1.2/silabs_examples/onoff-plug-app/README.md">On-Off Plug App</a></li>
85-
<li><a href="https://github.com/SiliconLabs/matter/blob/release_2.2.0-1.2/silabs_examples/silabs-sensors/README.md">Multi Sensor App</a></li>
90+
<li><a href="https://github.com/SiliconLabsSoftware/matter_sdk/blob/main/examples/base-platform-app/silabs/README.md">Platform App</a></li>
91+
<li><a href="https://github.com/SiliconLabsSoftware/matter_sdk/blob/main/examples/onoff-plug-app/silabs/README.md">On-Off Plug App</a></li>
92+
<li><a href="https://github.com/SiliconLabsSoftware/matter_sdk/blob/main/examples/multi-sensor-app/silabs">Multi Sensor App</a></li>
93+
<li><a href="https://github.com/SiliconLabsSoftware/matter_sdk/blob/main/examples/template/silabs/README.md">Template App</a></li>
8694
</ul>
8795
</td>
8896
</tr>

examples/air-quality-sensor-app/silabs/README.md

Lines changed: 62 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,10 @@ An example showing the use of CHIP on the Silicon Labs EFR32 MG12 and MG24.
1111
- [Mac OS X](#mac-os-x)
1212
- [Flashing the Application](#flashing-the-application)
1313
- [Viewing Logging Output](#viewing-logging-output)
14-
- [SeggerRTT](#segger-rtt)
15-
- [Serial Console](#console-log)
14+
- [SEGGER RTT](#segger-rtt)
15+
- [Console Log](#console-log)
16+
- [Configuring the VCOM](#configuring-the-vcom)
17+
- [Using the console](#using-the-console)
1618
- [Running the Complete Example](#running-the-complete-example)
1719
- [Notes](#notes)
1820
- [On Border Router:](#on-border-router)
@@ -32,7 +34,7 @@ An example showing the use of CHIP on the Silicon Labs EFR32 MG12 and MG24.
3234
> frequent releases thoroughly tested and validated. Developers looking to
3335
> develop matter products with silabs hardware are encouraged to use our latest
3436
> release with added tools and documentation.
35-
> [Silabs Matter Github](https://github.com/SiliconLabs/matter/releases)
37+
> [Silabs matter_sdk Github](https://github.com/SiliconLabsSoftware/matter_sdk/tags)
3638
3739
## Introduction
3840

@@ -78,8 +80,8 @@ the Silicon Labs platform.
7880
- Supported hardware:
7981

8082
- > For the latest supported hardware please refer to the
81-
> [Hardware Requirements](https://github.com/SiliconLabs/matter/blob/latest/docs/silabs/general/HARDWARE_REQUIREMENTS.md)
82-
> in the Silicon Labs Matter Github Repo
83+
> [Hardware Requirements](https://docs.silabs.com/matter/latest/matter-prerequisites/hardware-requirements)
84+
> in the Silicon Labs Matter Documentation
8385
8486
MG21 boards: Currently not supported due to RAM limitation.
8587

@@ -103,52 +105,52 @@ the Silicon Labs platform.
103105

104106
* Build the example application:
105107

106-
cd ~/connectedhomeip
107-
./scripts/examples/gn_silabs_example.sh ./examples/air-quality-sensor-app/silabs/ ./out/air-quality-sensor-app BRD4187C
108+
cd ~/connectedhomeip
109+
./scripts/examples/gn_silabs_example.sh ./examples/air-quality-sensor-app/silabs/ ./out/air-quality-sensor-app BRD4187C
108110

109111
- To delete generated executable, libraries and object files use:
110112

111-
$ cd ~/connectedhomeip
112-
$ rm -rf ./out/
113+
$ cd ~/connectedhomeip
114+
$ rm -rf ./out/
113115

114116
OR use GN/Ninja directly
115117

116-
$ cd ~/connectedhomeip/examples/air-quality-sensor-app/silabs
117-
$ git submodule update --init
118-
$ source third_party/connectedhomeip/scripts/activate.sh
119-
$ export SILABS_BOARD=BRD4187C
120-
$ gn gen out/debug
121-
$ ninja -C out/debug
118+
$ cd ~/connectedhomeip/examples/air-quality-sensor-app/silabs
119+
$ git submodule update --init
120+
$ source third_party/connectedhomeip/scripts/activate.sh
121+
$ export SILABS_BOARD=BRD4187C
122+
$ gn gen out/debug
123+
$ ninja -C out/debug
122124

123125
- To delete generated executable, libraries and object files use:
124126

125-
$ cd ~/connectedhomeip/examples/air-quality-sensor-app/silabs
126-
$ rm -rf out/
127+
$ cd ~/connectedhomeip/examples/air-quality-sensor-app/silabs
128+
$ rm -rf out/
127129

128130
* Build the example with Matter shell
129131

130-
./scripts/examples/gn_silabs_example.sh examples/air-quality-sensor-app/silabs/ out/air-quality-sensor-app-app BRD4187C chip_build_libshell=true
132+
./scripts/examples/gn_silabs_example.sh examples/air-quality-sensor-app/silabs/ out/air-quality-sensor-app-app BRD4187C chip_build_libshell=true
131133

132134
* Build the example as Intermittently Connected Device (ICD)
133135

134-
$ ./scripts/examples/gn_silabs_example.sh ./examples/air-quality-sensor-app/silabs/ ./out/air-quality-sensor-app-app_ICD BRD4187C --icd
136+
$ ./scripts/examples/gn_silabs_example.sh ./examples/air-quality-sensor-app/silabs/ ./out/air-quality-sensor-app-app_ICD BRD4187C --icd
135137

136138
or use gn as previously mentioned but adding the following arguments:
137139

138-
$ gn gen out/debug '--args=SILABS_BOARD="BRD4187C" enable_sleepy_device=true chip_openthread_ftd=false chip_build_libshell=true'
140+
$ gn gen out/debug '--args=SILABS_BOARD="BRD4187C" enable_sleepy_device=true chip_openthread_ftd=false chip_build_libshell=true'
139141

140142
* Build the example with pigweed RCP
141143

142-
$ ./scripts/examples/gn_silabs_example.sh examples/air-quality-sensor-app/silabs/ out/air-quality-sensor-app-app_rpc BRD4187C 'import("//with_pw_rpc.gni")'
144+
$ ./scripts/examples/gn_silabs_example.sh examples/air-quality-sensor-app/silabs/ out/air-quality-sensor-app-app_rpc BRD4187C 'import("//with_pw_rpc.gni")'
143145

144146
or use GN/Ninja Directly
145147

146-
$ cd ~/connectedhomeip/examples/air-quality-sensor-app/silabs
147-
$ git submodule update --init
148-
$ source third_party/connectedhomeip/scripts/activate.sh
149-
$ export SILABS_BOARD=BRD4187C
150-
$ gn gen out/debug --args='import("//with_pw_rpc.gni")'
151-
$ ninja -C out/debug
148+
$ cd ~/connectedhomeip/examples/air-quality-sensor-app/silabs
149+
$ git submodule update --init
150+
$ source third_party/connectedhomeip/scripts/activate.sh
151+
$ export SILABS_BOARD=BRD4187C
152+
$ gn gen out/debug --args='import("//with_pw_rpc.gni")'
153+
$ ninja -C out/debug
152154

153155
For more build options, help is provided when running the build script without
154156
arguments
@@ -159,15 +161,14 @@ arguments
159161

160162
- On the command line:
161163

162-
$ cd ~/connectedhomeip/examples/air-quality-sensor-app/silabs
163-
$ python3 out/debug/matter-silabs-air-quality-sensor-app-switch-example.flash.py
164+
$ cd ~/connectedhomeip/examples/air-quality-sensor-app/silabs
165+
$ python3 out/debug/matter-silabs-air-quality-sensor-app-switch-example.flash.py
164166

165167
- Or with the Ozone debugger, just load the .out file.
166168

167169
All EFR32 boards require a bootloader, see Silicon Labs documentation for more
168-
info. Pre-built bootloader binaries are available in the Assets section of the
169-
Releases page on
170-
[Silabs Matter Github](https://github.com/SiliconLabs/matter/releases) .
170+
info. Pre-built bootloader binaries are available on the
171+
[Matter Software Artifacts page](https://docs.silabs.com/matter/latest/matter-prerequisites/matter-artifacts#matter-bootloader-binaries).
171172

172173
## Viewing Logging Output
173174

@@ -193,14 +194,14 @@ after flashing the .out file.
193194

194195
* Install the J-Link software
195196

196-
$ cd ~/Downloads
197-
$ sudo dpkg -i JLink_Linux_V*_x86_64.deb
197+
$ cd ~/Downloads
198+
$ sudo dpkg -i JLink_Linux_V*_x86_64.deb
198199

199200
* In Linux, grant the logged in user the ability to talk to the development
200201
hardware via the linux tty device (/dev/ttyACMx) by adding them to the
201202
dialout group.
202203

203-
$ sudo usermod -a -G dialout ${USER}
204+
$ sudo usermod -a -G dialout ${USER}
204205

205206
Once the above is complete, log output can be viewed using the JLinkExe tool in
206207
combination with JLinkRTTClient as follows:
@@ -209,15 +210,15 @@ combination with JLinkRTTClient as follows:
209210

210211
For MG12 use:
211212

212-
$ JLinkExe -device EFR32MG12PXXXF1024 -if JTAG -speed 4000 -autoconnect 1
213+
$ JLinkExe -device EFR32MG12PXXXF1024 -if JTAG -speed 4000 -autoconnect 1
213214

214215
For MG21 use:
215216

216-
$ JLinkExe -device EFR32MG21AXXXF1024 -if SWD -speed 4000 -autoconnect 1
217+
$ JLinkExe -device EFR32MG21AXXXF1024 -if SWD -speed 4000 -autoconnect 1
217218

218219
- In a second terminal, run the JLinkRTTClient to view logs:
219220

220-
$ JLinkRTTClient
221+
$ JLinkRTTClient
221222

222223
### Console Log
223224

@@ -263,41 +264,41 @@ With any serial terminal application such as screen, putty, minicom etc.
263264
Code is be scanned by the CHIP Tool app For the Rendez-vous procedure over
264265
BLE
265266
266-
* On devices that do not have or support the LCD Display like the BRD4166A Thunderboard Sense 2,
267-
a URL can be found in the RTT logs.
267+
* On devices that do not have or support the LCD Display like the BRD4166A Thunderboard Sense 2,
268+
a URL can be found in the RTT logs.
268269
269-
<info > [SVR] Copy/paste the below URL in a browser to see the QR Code:
270-
<info > [SVR] https://project-chip.github.io/connectedhomeip/qrcode.html?data=CH%3AI34NM%20-00%200C9SS0
270+
<info > [SVR] Copy/paste the below URL in a browser to see the QR Code:
271+
<info > [SVR] https://project-chip.github.io/connectedhomeip/qrcode.html?data=CH%3AI34NM%20-00%200C9SS0
271272
272273
**LED 0** shows the overall state of the device and its connectivity. The
273274
following states are possible:
274275
275-
- Short Flash On (50 ms on/950 ms off): The device is in the
276-
unprovisioned (unpaired) state and is waiting for a commissioning
277-
application to connect.
276+
- Short Flash On (50 ms on/950 ms off): The device is in the
277+
unprovisioned (unpaired) state and is waiting for a commissioning
278+
application to connect.
278279
279-
- Rapid Even Flashing (100 ms on/100 ms off): The device is in the
280-
unprovisioned state and a commissioning application is connected through
281-
Bluetooth LE.
280+
- Rapid Even Flashing (100 ms on/100 ms off): The device is in the
281+
unprovisioned state and a commissioning application is connected through
282+
Bluetooth LE.
282283
283-
- Short Flash Off (950ms on/50ms off): The device is fully
284-
provisioned, but does not yet have full Thread network or service
285-
connectivity.
284+
- Short Flash Off (950ms on/50ms off): The device is fully
285+
provisioned, but does not yet have full Thread network or service
286+
connectivity.
286287
287-
- Solid On: The device is fully provisioned and has full Thread
288-
network and service connectivity.
288+
- Solid On: The device is fully provisioned and has full Thread
289+
network and service connectivity.
289290
290291
**Push Button 0**
291292
292-
- _Press and Release_ : Start, or restart, BLE advertisement in fast mode. It will advertise in this mode
293-
for 30 seconds. The device will then switch to a slower interval advertisement.
294-
After 15 minutes, the advertisement stops.
295-
Additionally, it will cycle through the QR code, application status screen and device status screen, respectively.
293+
- _Press and Release_ : Start, or restart, BLE advertisement in fast mode. It will advertise in this mode
294+
for 30 seconds. The device will then switch to a slower interval advertisement.
295+
After 15 minutes, the advertisement stops.
296+
Additionally, it will cycle through the QR code, application status screen and device status screen, respectively.
296297
297-
- _Pressed and hold for 6 s_ : Initiates the factory reset of the device.
298-
Releasing the button within the 6-second window cancels the factory reset
299-
procedure. **LEDs** blink in unison when the factory reset procedure is
300-
initiated.
298+
- _Pressed and hold for 6 s_ : Initiates the factory reset of the device.
299+
Releasing the button within the 6-second window cancels the factory reset
300+
procedure. **LEDs** blink in unison when the factory reset procedure is
301+
initiated.
301302
302303
* You can provision and control the Chip device using the python controller,
303304
[CHIPTool](https://github.com/project-chip/connectedhomeip/blob/master/examples/chip-tool/README.md)

0 commit comments

Comments
 (0)