Skip to content

Commit b989fb3

Browse files
[Silabs] Update Silabs ICD status LED functionality description within README.md's (#31888)
* Updated Silabs ICD status LED functionality description * Restyled by prettier-markdown * Updated style and spelling * Updated style and spelling * Updated to include ICD vs. non-ICD LED behavior description * Removed unnecessary underscores * Correct description/documentation to refactored location of Silabs lighting example * Restyled by prettier-markdown * Restyled by shfmt --------- Co-authored-by: Restyled.io <commits@restyled.io>
1 parent 7d8823a commit b989fb3

File tree

6 files changed

+45
-21
lines changed

6 files changed

+45
-21
lines changed

docs/QUICK_START.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ combination listed below.
1919

2020
| <div style="width:200px">Border Router</div> | <div style="width:200px">Node</div> | Description |
2121
| -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
22-
| [**ot-br**](https://openthread.io/guides/border-router/build)<br>Thread Border Router <li>RasPi <li>BeagleBone | **lighting-app** <li>[Nordic nRF5x](https://github.com/project-chip/connectedhomeip/tree/master/examples/lighting-app/nrfconnect/README.md) <li> [NXP K32W](https://github.com/project-chip/connectedhomeip/tree/master/examples/lighting-app/nxp/k32w/k32w0/README.md) <li> [Qorvo QPG6100](https://github.com/project-chip/connectedhomeip/tree/master/examples/lighting-app/qpg) <li> [Silicon Labs EFR32](https://github.com/project-chip/connectedhomeip/tree/master/examples/lighting-app/efr32/README.md) | The Lighting example is supported by many of the available Thread platforms. See the chip-tool controller instructions for how to actuate the light on/off cluster. |
22+
| [**ot-br**](https://openthread.io/guides/border-router/build)<br>Thread Border Router <li>RasPi <li>BeagleBone | **lighting-app** <li>[Nordic nRF5x](https://github.com/project-chip/connectedhomeip/tree/master/examples/lighting-app/nrfconnect/README.md) <li> [NXP K32W](https://github.com/project-chip/connectedhomeip/tree/master/examples/lighting-app/nxp/k32w/k32w0/README.md) <li> [Qorvo QPG6100](https://github.com/project-chip/connectedhomeip/tree/master/examples/lighting-app/qpg) <li> [Silicon Labs EFR32](https://github.com/project-chip/connectedhomeip/tree/master/examples/lighting-app/silabs/README.md) | The Lighting example is supported by many of the available Thread platforms. See the chip-tool controller instructions for how to actuate the light on/off cluster. |
2323
| [**ot-br**](https://openthread.io/guides/border-router/build)<br>Thread Border Router <li>RasPi <li>BeagleBone | **lock-app** <li>[Nordic nRF5x](https://github.com/project-chip/connectedhomeip/tree/master/examples/lock-app/nrfconnect/README.md) <li> [NXP K32W](https://github.com/project-chip/connectedhomeip/tree/master/examples/lock-app/nxp/k32w/k32w0/README.md) <li> [Qorvo QPG6100](https://github.com/project-chip/connectedhomeip/tree/master/examples/lock-app/qpg) <li> [Silicon Labs EFR32](https://github.com/project-chip/connectedhomeip/tree/master/examples/lock-app/efr32/README.md) <li> [TI CC13x2x7](https://github.com/project-chip/connectedhomeip/tree/master/examples/lock-app/cc13x2x7_26x2x7/README.md) | The Lock example is supported by many of the available Thread and Wi-Fi platforms. |
2424

2525
## Controllers

docs/guides/silabs_efr32_software_update.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ all of the EFR32 example applications.
88
## Running the OTA Download scenario
99

1010
- For Matter with OpenThread: Bring up the OpenThread Border Router as
11-
discussed in examples/lighting-app/efr32/README.md and get its operational
11+
discussed in examples/lighting-app/silabs/README.md and get its operational
1212
dataset.
1313

1414
- On a Linux or Darwin platform build the chip-tool and the ota-provider-app

examples/light-switch-app/silabs/README.md

+14-6
Original file line numberDiff line numberDiff line change
@@ -254,22 +254,30 @@ combination with JLinkRTTClient as follows:
254254
<info > [SVR] Copy/paste the below URL in a browser to see the QR Code:
255255
<info > [SVR] https://project-chip.github.io/connectedhomeip/qrcode.html?data=CH%3AI34NM%20-00%200C9SS0
256256

257-
**LED 0** shows the overall state of the device and its connectivity. The
258-
following states are possible:
257+
**LED 0**
259258

260-
- Short Flash On (50 ms on/950 ms off): The device is in the
259+
- ICD Configuration (Default) - LED is only active under two circumstances:
260+
261+
1. Factory reset sequence - LED will blink when initiated upon press and hold of
262+
Button 0 after 3 seconds
263+
2. An Identify command was received
264+
265+
- Non-ICD Configuration - shows the overall state of the device and its connectivity. The
266+
following states are possible:
267+
268+
Short Flash On (50 ms on/950 ms off): The device is in the
261269
unprovisioned (unpaired) state and is waiting for a commissioning
262270
application to connect.
263271

264-
- Rapid Even Flashing (100 ms on/100 ms off): The device is in the
272+
Rapid Even Flashing (100 ms on/100 ms off): The device is in the
265273
unprovisioned state and a commissioning application is connected through
266274
Bluetooth LE.
267275

268-
- Short Flash Off (950ms on/50ms off): The device is fully
276+
Short Flash Off (950ms on/50ms off): The device is fully
269277
provisioned, but does not yet have full Thread network or service
270278
connectivity.
271279

272-
- Solid On: The device is fully provisioned and has full Thread
280+
Solid On: The device is fully provisioned and has full Thread
273281
network and service connectivity.
274282

275283
**Push Button 0**

examples/lit-icd-app/silabs/README.md

+14-6
Original file line numberDiff line numberDiff line change
@@ -241,22 +241,30 @@ combination with JLinkRTTClient as follows:
241241
<info > [SVR] Copy/paste the below URL in a browser to see the QR Code:
242242
<info > [SVR] https://project-chip.github.io/connectedhomeip/qrcode.html?data=CH%3AI34NM%20-00%200C9SS0
243243

244-
**LED 0** shows the overall state of the device and its connectivity. The
245-
following states are possible:
244+
**LED 0**
246245

247-
- Short Flash On (50 ms on/950 ms off): The device is in the
246+
- ICD Configuration (Default) - LED is only active under two circumstances:
247+
248+
1. Factory reset sequence - LED will blink when initiated upon press and hold of
249+
Button 0 after 3 seconds
250+
2. An Identify command was received
251+
252+
- Non-ICD Configuration - shows the overall state of the device and its connectivity. The
253+
following states are possible:
254+
255+
Short Flash On (50 ms on/950 ms off): The device is in the
248256
unprovisioned (unpaired) state and is waiting for a commissioning
249257
application to connect.
250258

251-
- Rapid Even Flashing (100 ms on/100 ms off): The device is in the
259+
Rapid Even Flashing (100 ms on/100 ms off): The device is in the
252260
unprovisioned state and a commissioning application is connected through
253261
Bluetooth LE.
254262

255-
- Short Flash Off (950ms on/50ms off): The device is fully
263+
Short Flash Off (950ms on/50ms off): The device is fully
256264
provisioned, but does not yet have full Thread network or service
257265
connectivity.
258266

259-
- Solid On: The device is fully provisioned and has full Thread
267+
Solid On: The device is fully provisioned and has full Thread
260268
network and service connectivity.
261269

262270
**Push Button 0**

examples/lock-app/silabs/README.md

+14-6
Original file line numberDiff line numberDiff line change
@@ -262,22 +262,30 @@ combination with JLinkRTTClient as follows:
262262
<info > [SVR] Copy/paste the below URL in a browser to see the QR Code:
263263
<info > [SVR] https://project-chip.github.io/connectedhomeip/qrcode.html?data=CH%3AI34NM%20-00%200C9SS0
264264

265-
**LED 0** shows the overall state of the device and its connectivity. The
266-
following states are possible:
265+
**LED 0**
267266

268-
- _Short Flash On (50 ms on/950 ms off)_ ; The device is in the
267+
- ICD Configuration (Default) - LED is only active under two circumstances:
268+
269+
1. Factory reset sequence - LED will blink when initiated upon press and hold of
270+
Button 0 after 3 seconds
271+
2. An Identify command was received
272+
273+
- Non-ICD Configuration - shows the overall state of the device and its connectivity. The
274+
following states are possible:
275+
276+
Short Flash On (50 ms on/950 ms off): The device is in the
269277
unprovisioned (unpaired) state and is waiting for a commissioning
270278
application to connect.
271279

272-
- _Rapid Even Flashing_ ; (100 ms on/100 ms off)_ &mdash; The device is in the
280+
Rapid Even Flashing (100 ms on/100 ms off): The device is in the
273281
unprovisioned state and a commissioning application is connected through
274282
Bluetooth LE.
275283

276-
- _Short Flash Off_ ; (950ms on/50ms off)_ &mdash; The device is fully
284+
Short Flash Off (950ms on/50ms off): The device is fully
277285
provisioned, but does not yet have full Thread network or service
278286
connectivity.
279287

280-
- _Solid On_ ; The device is fully provisioned and has full Thread
288+
Solid On: The device is fully provisioned and has full Thread
281289
network and service connectivity.
282290

283291
**LED 1** Simulates the Lock The following states are possible:

scripts/examples/gn_silabs_example.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ if [ "$#" == "0" ]; then
4848
$USAGE
4949
5050
<AppRootFolder>
51-
Root Location of the app e.g: examples/lighting-app/efr32/
51+
Root Location of the app e.g: examples/lighting-app/silabs/
5252
5353
<outputFolder>
5454
Desired location for the output files

0 commit comments

Comments
 (0)