Skip to content

Commit

Permalink
LCD section for the common app
Browse files Browse the repository at this point in the history
  • Loading branch information
mkardous-silabs committed Nov 16, 2023
1 parent 1d25be5 commit b10e2d8
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions docs/guides/silabs_common_app_behavior.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Standard Application Behavior

This section discusses the application behaviour that is common to all Silabs sample apps.
The source files that implement the common functionnality can be found in the [example platform](../../examples/platform/silabs/) directory.

## LCD Screens

When using a developement kit that supports the LCD, the application has three disctint windows.

Check failure on line 8 in docs/guides/silabs_common_app_behavior.md

View workflow job for this annotation

GitHub Actions / misspell

[misspell] docs/guides/silabs_common_app_behavior.md#L8

"developement" is a misspelling of "development"
Raw output
./docs/guides/silabs_common_app_behavior.md:8:13: "developement" is a misspelling of "development"
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.

### 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.

> **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

Each sample has an application UI that helps visualize the samples apps state. See the sample app documentation for more information.

### 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.
The following list explicits the information that is common for Openthread and Wi-Fi devices.
| LCD UI | Description |
| :----: | :---------- |
| # fabrics | Indicates the number of commissioned fabrics on the device |
| Connected | Indicates if the device is connected to the Openthread or Wi-Fi network |
| Advertising | Indicates if the devices is currently advertising an open commissioning window |
| Is ICD | Indicates if the device is an Intermittently Connected device |

The following list explicits the information that is unique to Openthread devices.
| LCD UI | Description |
| :----: | :---------- |
| 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.
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.

0 comments on commit b10e2d8

Please sign in to comment.