[Silabs] Update Silabs ICD status LED functionality description withi…

…n 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>
project-chip · May 15, 2024 · 1158656 · 1158656
1 parent fdf728d
commit 1158656
Show file tree

Hide file tree

Showing 6 changed files with 45 additions and 21 deletions.
diff --git a/docs/QUICK_START.md b/docs/QUICK_START.md
@@ -19,7 +19,7 @@ combination listed below.
 
 | <div style="width:200px">Border Router</div>                                                                   | <div style="width:200px">Node</div>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Description                                                                                                                                                         |
 | -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [**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. |
+| [**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. |
 | [**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.                                                                                  |
 
 ## Controllers

diff --git a/docs/guides/silabs_efr32_software_update.md b/docs/guides/silabs_efr32_software_update.md
@@ -8,7 +8,7 @@ all of the EFR32 example applications.
 ## Running the OTA Download scenario
 
 -   For Matter with OpenThread: Bring up the OpenThread Border Router as
-    discussed in examples/lighting-app/efr32/README.md and get its operational
+    discussed in examples/lighting-app/silabs/README.md and get its operational
     dataset.
 
 -   On a Linux or Darwin platform build the chip-tool and the ota-provider-app

diff --git a/examples/light-switch-app/silabs/README.md b/examples/light-switch-app/silabs/README.md
@@ -254,22 +254,30 @@ combination with JLinkRTTClient as follows:
           <info  > [SVR] Copy/paste the below URL in a browser to see the QR Code:
           <info  > [SVR] https://project-chip.github.io/connectedhomeip/qrcode.html?data=CH%3AI34NM%20-00%200C9SS0
 
-    **LED 0** shows the overall state of the device and its connectivity. The
-    following states are possible:
+    **LED 0**
 
-        -   Short Flash On (50 ms on/950 ms off): The device is in the
+        -   ICD Configuration (Default) - LED is only active under two circumstances:
+
+            1. Factory reset sequence - LED will blink when initiated upon press and hold of
+            Button 0 after 3 seconds
+            2. An Identify command was received
+
+        -   Non-ICD Configuration - shows the overall state of the device and its connectivity. The
+            following states are possible:
+
+            Short Flash On (50 ms on/950 ms off): The device is in the
             unprovisioned (unpaired) state and is waiting for a commissioning
             application to connect.
 
-        -   Rapid Even Flashing (100 ms on/100 ms off): The device is in the
+            Rapid Even Flashing (100 ms on/100 ms off): The device is in the
             unprovisioned state and a commissioning application is connected through
             Bluetooth LE.
 
-        -   Short Flash Off (950ms on/50ms off): The device is fully
+            Short Flash Off (950ms on/50ms off): The device is fully
             provisioned, but does not yet have full Thread network or service
             connectivity.
 
-        -   Solid On: The device is fully provisioned and has full Thread
+            Solid On: The device is fully provisioned and has full Thread
             network and service connectivity.
 
     **Push Button 0**

diff --git a/examples/lit-icd-app/silabs/README.md b/examples/lit-icd-app/silabs/README.md
@@ -241,22 +241,30 @@ combination with JLinkRTTClient as follows:
           <info  > [SVR] Copy/paste the below URL in a browser to see the QR Code:
           <info  > [SVR] https://project-chip.github.io/connectedhomeip/qrcode.html?data=CH%3AI34NM%20-00%200C9SS0
 
-    **LED 0** shows the overall state of the device and its connectivity. The
-    following states are possible:
+    **LED 0**
 
-        -   Short Flash On (50 ms on/950 ms off): The device is in the
+        -   ICD Configuration (Default) - LED is only active under two circumstances:
+
+            1. Factory reset sequence - LED will blink when initiated upon press and hold of
+            Button 0 after 3 seconds
+            2. An Identify command was received
+
+        -   Non-ICD Configuration - shows the overall state of the device and its connectivity. The
+            following states are possible:
+
+            Short Flash On (50 ms on/950 ms off): The device is in the
             unprovisioned (unpaired) state and is waiting for a commissioning
             application to connect.
 
-        -   Rapid Even Flashing (100 ms on/100 ms off): The device is in the
+            Rapid Even Flashing (100 ms on/100 ms off): The device is in the
             unprovisioned state and a commissioning application is connected through
             Bluetooth LE.
 
-        -   Short Flash Off (950ms on/50ms off): The device is fully
+            Short Flash Off (950ms on/50ms off): The device is fully
             provisioned, but does not yet have full Thread network or service
             connectivity.
 
-        -   Solid On: The device is fully provisioned and has full Thread
+            Solid On: The device is fully provisioned and has full Thread
             network and service connectivity.
 
     **Push Button 0**

diff --git a/examples/lock-app/silabs/README.md b/examples/lock-app/silabs/README.md
@@ -262,22 +262,30 @@ combination with JLinkRTTClient as follows:
           <info  > [SVR] Copy/paste the below URL in a browser to see the QR Code:
           <info  > [SVR] https://project-chip.github.io/connectedhomeip/qrcode.html?data=CH%3AI34NM%20-00%200C9SS0
 
-    **LED 0** shows the overall state of the device and its connectivity. The
-    following states are possible:
+    **LED 0**
 
-        -   _Short Flash On (50 ms on/950 ms off)_ ; The device is in the
+        -   ICD Configuration (Default) - LED is only active under two circumstances:
+
+            1. Factory reset sequence - LED will blink when initiated upon press and hold of
+            Button 0 after 3 seconds
+            2. An Identify command was received
+
+        -   Non-ICD Configuration - shows the overall state of the device and its connectivity. The
+            following states are possible:
+
+            Short Flash On (50 ms on/950 ms off): The device is in the
             unprovisioned (unpaired) state and is waiting for a commissioning
             application to connect.
 
-        -   _Rapid Even Flashing_ ; (100 ms on/100 ms off)_ &mdash; The device is in the
+            Rapid Even Flashing (100 ms on/100 ms off): The device is in the
             unprovisioned state and a commissioning application is connected through
             Bluetooth LE.
 
-        -   _Short Flash Off_ ; (950ms on/50ms off)_ &mdash; The device is fully
+            Short Flash Off (950ms on/50ms off): The device is fully
             provisioned, but does not yet have full Thread network or service
             connectivity.
 
-        -   _Solid On_ ; The device is fully provisioned and has full Thread
+            Solid On: The device is fully provisioned and has full Thread
             network and service connectivity.
 
     **LED 1** Simulates the Lock The following states are possible:

diff --git a/scripts/examples/gn_silabs_example.sh b/scripts/examples/gn_silabs_example.sh
@@ -48,7 +48,7 @@ if [ "$#" == "0" ]; then
     $USAGE
 
     <AppRootFolder>
-        Root Location of the app e.g: examples/lighting-app/efr32/
+        Root Location of the app e.g: examples/lighting-app/silabs/
 
     <outputFolder>
         Desired location for the output files