first finished draft of the common app behavior

mkardous-silabs · Nov 24, 2023 · 09a2c79 · 09a2c79
1 parent 06feba5
commit 09a2c79
Show file tree

Hide file tree

Showing 2 changed files with 72 additions and 23 deletions.
diff --git a/docs/guides/silabs_common_app_behavior.md b/docs/guides/silabs_common_app_behavior.md
@@ -10,10 +10,10 @@ You can cycle between the three windows by pressing `BTN0`.  When the applicatio
 
 ### QR Code
 
-QR Code is the default QR code that can be used to commission the device over BLE and when using the Basic Commissioining Mode. See the Matter specification to understand what is encoded in the QR code.
+[QR Code](https://project-chip.github.io/connectedhomeip/qrcode.html?data=MT%3A6FCJ142C00KA0648G00) is the default QR code that can be used to commission the device over BLE and when using the Basic Commissioining Mode. See the Matter specification to understand what is encoded in the QR code.
 
-> **Note**: The Basic Commissioining Mode is not recommended since it is less secure than the Enhanced Commissioining Mode.
-> See the Matter specification for more details.
+>**Note**: The Basic Commissioining Mode is not recommended since it is less secure than the Enhanced Commissioining Mode.
+>See the Matter specification for more details.
 
 ### Application UI
 
@@ -22,7 +22,7 @@ Each sample has an application UI that helps visualize the samples apps state. S
 ### Status Screen
 
 The status screen is used to visualize the state of the device. 
-> **Note:**  The support of the status screen for ICDs is yet to be done.
+>**Note:**  The support of the status screen for ICDs is yet to be done.
 
 The following list explicits the information that is common for Openthread and Wi-Fi devices.
 | LCD UI | Description | 
@@ -37,10 +37,72 @@ The following list explicits the information that is unique to Openthread device
 | :----: | :---------- | 
 | PANID | Indicates the panid of the configured openthread network |
 | OT Type | Indicates the openthread device type (FTD / MTD) |
-> **Note:**  The PANID information is not yet printed on the LCD.
+>**Note:**  The PANID information is not yet printed on the LCD.
 
 The following list explicits the information that is unique to Wi-Fi devices.
 | LCD UI | Description | 
 | :----: | :---------- | 
 | SSID | SSID of the connected Wi-Fi network |
-> **Note:**  The SSID information is not yet printed on the LCD.
+>**Note:**  The SSID information is not yet printed on the LCD.
+
+## Buttons
+
+All sample applications are designed to work with two buttons : the application button and the operation button.
+Button 0, BTN0, is the operation button and Button 1, BTN1 is the application button.
+>**Note:** Sparkfun dev kit (BRD2704A) does not have any buttons. The [Matter Shell](.) is required to leverage button functionnalities.
+
+### Opreation Button
+
+The following list explicits all the actions that can be executed with the operation button.
+
+
+<table>
+    <tr>
+        <th>Execution</th>
+        <th>Description</th>
+    </tr>
+    <tr>
+        <td>Press and Release</td>
+        <td>
+            <ul>
+                <li>If the device is not already commissionned, it will start advertising in fast mode for 30 seconds. <br/>After 30 seconds, the device will then switch to a slower interval advertisement After 15 minutes, the advertisement stops.</li>
+                <li>Prints initial and BCM commissioining QR code in the Logs</li>
+            </ul>
+        </td>
+    </tr>
+    <tr>
+        <td>Press and hold for 6 seconds</td>
+        <td>
+            <ul>
+                <li>Factory Reset device</li>
+            </ul>
+        </td>
+    </tr>
+</table>
+
+### Application Button 
+
+See the sample app documentation for more information on the application button.
+
+## LEDs
+
+All sample applications are designed to work with two LEDs : the application LED and the status LED.
+LED0 is the status LED and the LED1 is the application LED.
+>**Note:** Some dev kits can only support the buttons or the LEDs. The button support is the default configuration. <br/>
+> For dev kits with only LED, the application LED is the default configuration.
+
+### Status LED
+
+The following list explicits all the states of the status LED.
+
+| State | Description | 
+| :----: | :---------- | 
+| Short Flash On (50ms on / 950ms off) | The device is in the unprovisioned (unpaired) state and is waiting for a commissioning application to connect. |
+| Rapid Even Flashing (100ms on / 100ms 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 provisioned, but does not yet have full Thread network or service connectivity. |
+| Solid On | The device is fully provisioned and has full Thread network and service connectivity. |
+| Long Even Flashing (500ms on / 500ms off) | Factory Reset procedure has been started. |
+
+### Application LED 
+
+See the sample app documentation for more information on the application LED.
diff --git a/docs/guides/silabs_getting_started.md b/docs/guides/silabs_getting_started.md
@@ -6,7 +6,7 @@ The Silabs Matter Solution Guide explains how to use the Silabs Matter offering.
 It explains how to set up the development environment, build and flash a Silabs
 sample app.
 
-![Silabs logo](./images/logo.png)
+![Silabs logo](./images/silabs_logo.png)
 
 > **NOTE:** Silicon Laboratories now maintains a public Matter GitHub repo with
 > frequent releases thoroughly tested and validated. Developers looking to
@@ -28,6 +28,7 @@ sample app.
     -   [Build Arguments](#device-tracing)
 -   [Flashing](#Flashing)
     - [Flasher Arguments](#Flasher-Arguments)
+-   [Standard Application Behavior](#standard-application-behavior)
 
 ## Requirements
 
@@ -80,7 +81,7 @@ Additionally, the <a href="https://github.com/SiliconLabs/matter">Silabs Matter
                 <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>
                 <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>
             </ul>
-        </td>
+          </td>
         </tr>
     </tbody>
 </table>
@@ -218,18 +219,4 @@ Executing the flasher scripts with the `--help / -h` arguments will print a help
 
 ## Standard Application Behavior
 
-This section discusses application behavior that is common to all Silabs sample apps.
-
-### LCD Screens
-
-When using a developement kit that supports the LCD, the application has three disctint windows.
-You can cycle between the three windows by pressing `BTN0`.  When the application UI is updated while on another window, the LCD will automatically switch to it.
-
-#### Window 1 - QR Code
-
-The first, shown at boot, is the default QR code that can be used to commission the device over BLE and when using the Basic Commissioining Mode.
-
-> **Note**: The Basic Commissioining Mode is not recommended since it is less secure than the Enhanced Commissioining Mode.
-> See the Matter specification for more details.
-
-#### Window 2 - Application UI
+See [Standard Application documentation](./silabs_common_app_behavior.md) for behaviors that are common to all sample apps.