From 1158656f1f259d4fa35e4a21373dba2f83dd0d3a Mon Sep 17 00:00:00 2001 From: CuRahman <111998767+CuRahman@users.noreply.github.com> Date: Mon, 12 Feb 2024 22:33:47 -0500 Subject: [PATCH] [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 --- docs/QUICK_START.md | 2 +- docs/guides/silabs_efr32_software_update.md | 2 +- examples/light-switch-app/silabs/README.md | 20 ++++++++++++++------ examples/lit-icd-app/silabs/README.md | 20 ++++++++++++++------ examples/lock-app/silabs/README.md | 20 ++++++++++++++------ scripts/examples/gn_silabs_example.sh | 2 +- 6 files changed, 45 insertions(+), 21 deletions(-) diff --git a/docs/QUICK_START.md b/docs/QUICK_START.md index 5a4027e3dc7278..97f0f76b3b0436 100644 --- a/docs/QUICK_START.md +++ b/docs/QUICK_START.md @@ -19,7 +19,7 @@ combination listed below. |
Border Router
|
Node
| Description | | -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [**ot-br**](https://openthread.io/guides/border-router/build)
Thread Border Router
  • RasPi
  • BeagleBone | **lighting-app**
  • [Nordic nRF5x](https://github.com/project-chip/connectedhomeip/tree/master/examples/lighting-app/nrfconnect/README.md)
  • [NXP K32W](https://github.com/project-chip/connectedhomeip/tree/master/examples/lighting-app/nxp/k32w/k32w0/README.md)
  • [Qorvo QPG6100](https://github.com/project-chip/connectedhomeip/tree/master/examples/lighting-app/qpg)
  • [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)
    Thread Border Router
  • RasPi
  • BeagleBone | **lighting-app**
  • [Nordic nRF5x](https://github.com/project-chip/connectedhomeip/tree/master/examples/lighting-app/nrfconnect/README.md)
  • [NXP K32W](https://github.com/project-chip/connectedhomeip/tree/master/examples/lighting-app/nxp/k32w/k32w0/README.md)
  • [Qorvo QPG6100](https://github.com/project-chip/connectedhomeip/tree/master/examples/lighting-app/qpg)
  • [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)
    Thread Border Router
  • RasPi
  • BeagleBone | **lock-app**
  • [Nordic nRF5x](https://github.com/project-chip/connectedhomeip/tree/master/examples/lock-app/nrfconnect/README.md)
  • [NXP K32W](https://github.com/project-chip/connectedhomeip/tree/master/examples/lock-app/nxp/k32w/k32w0/README.md)
  • [Qorvo QPG6100](https://github.com/project-chip/connectedhomeip/tree/master/examples/lock-app/qpg)
  • [Silicon Labs EFR32](https://github.com/project-chip/connectedhomeip/tree/master/examples/lock-app/efr32/README.md)
  • [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 index ec57cc4acaa372..9f94753aa7d29f 100644 --- 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 index 615b27c7bc3cd9..401e9b88b41fac 100644 --- 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: [SVR] Copy/paste the below URL in a browser to see the QR Code: [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 index f359eacbd23cf4..07ec9c320bcb36 100644 --- 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: [SVR] Copy/paste the below URL in a browser to see the QR Code: [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 index 1bce8c431bee54..447fe3b9949995 100644 --- a/examples/lock-app/silabs/README.md +++ b/examples/lock-app/silabs/README.md @@ -262,22 +262,30 @@ combination with JLinkRTTClient as follows: [SVR] Copy/paste the below URL in a browser to see the QR Code: [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. **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 index c69f9d495fa975..9f7314c14010ad 100755 --- a/scripts/examples/gn_silabs_example.sh +++ b/scripts/examples/gn_silabs_example.sh @@ -48,7 +48,7 @@ if [ "$#" == "0" ]; then $USAGE - Root Location of the app e.g: examples/lighting-app/efr32/ + Root Location of the app e.g: examples/lighting-app/silabs/ Desired location for the output files