Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Tomasz Ty <[email protected]>
  • Loading branch information
ktaborowski and totyz authored Dec 5, 2023
1 parent aabe1f1 commit 1664134
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions samples/template/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,8 @@ The button assignment is as follows:

* Button 1 (long press):
Factory reset - The application informs the Sidewalk stack about the factory reset event.
The Sidewalk library clears its configuration from the non-volatile storage.
After a successful reset, the device needs to be registered with the cloud services again.
The Sidewalk library clears its configuration from the non-volatile storage and also saved initial link type.
After a successful sample restart, the device needs to be registered with the cloud services again.

* Button 2 (short press):
In BLE link type - toggle Connection Request - The device requests the Sidewalk Gateway to initiate a connection while the device is advertising through Bluetooth LE.
Expand All @@ -74,7 +74,7 @@ The button assignment is as follows:
The queue will be processed eventually, and all the queued messages will be sent.

* Button 4 (short press):
Change link type. There is a Circular link type change BLE -> FSK -> LoRa -> BLE ...
Change link type. There is a Circular link type change BLE -> FSK -> LoRa -> BLE ->. Selected link type is saved and set after sample restart. ``Button 1 (long press)`` reset link type to initial one defined by ``CONFIG_SIDEWALK_APP_LINK_TYPE_(BLE/LORA/FSK)``

* Button 4 (long press):
Enter DFU state - This action disables the Sidewalk stack and starts the Bluetooth LE SMP Server.
Expand Down Expand Up @@ -182,7 +182,7 @@ The SIDEWALK_CLI enables CLI compatible with sid_dut sample.
To get list of supported CLI commands, you can use `sid help`.


Power measurement test scenario
Power measurement application
===============================

The application may perform the common Sidewalk application steps such us:
Expand All @@ -192,7 +192,7 @@ The application may perform the common Sidewalk application steps such us:
#. Send hello message to cloud
#. Echo messages received from cloud

This application is especially useful to test release configuration, and can be set by the Kconfig
This application is especially useful in ``release`` configuration to check power consumption in different Sidewalk states. The states can be monitor by GPIO.

CONFIG_SIDEWALK_APP_ECHO

Expand Down

0 comments on commit 1664134

Please sign in to comment.