Skip to content

Commit

Permalink
doc: Fix factory reset description in Matter samples
Browse files Browse the repository at this point in the history
We missed the proper instructions on how to factory reset
the device.

Signed-off-by: Marcin Kajor <[email protected]>
  • Loading branch information
markaj-nordic authored and nordicjm committed Apr 10, 2024
1 parent c27c4e7 commit 8206081
Show file tree
Hide file tree
Showing 7 changed files with 20 additions and 14 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ Button 1:
* If pressed for less than three seconds:

* If the device is not provisioned to the Matter network, it initiates the SMP server (Simple Management Protocol) and Bluetooth LE advertising for Matter commissioning.
After that, the Direct Firmware Update (DFU) over Bluetooth Low Energy can be started.
After that, the Device Firmware Update (DFU) over Bluetooth Low Energy can be started.
(See `Updating the device firmware`_.)
Bluetooth LE advertising makes the device discoverable over Bluetooth LE for the predefined period of time (15 minutes by default).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,7 @@ To check if the sensor device is working, complete the following steps:

.. include:: ../../../../../samples/matter/template/README.rst
:start-after: matter_template_sample_testing_start
:end-before: #. Press **Button 1**
:end-before: #. Keep the **Button 1**

#. Activate the sensor by running the following command on the On/off cluster with the correct *node_ID* assigned during commissioning:

Expand Down
2 changes: 1 addition & 1 deletion samples/matter/light_bulb/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ After building the sample and programming it to your development kit, complete t
I: Turn Off Action has been initiated
I: Turn Off Action has been completed
#. Press **Button 1** to initiate the factory reset of the device.
#. Keep the **Button 1** pressed for more than six seconds to initiate factory reset of the device.

.. _matter_light_bulb_sample_light_switch_tests:

Expand Down
22 changes: 14 additions & 8 deletions samples/matter/lock/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -307,13 +307,19 @@ LED 2:
Button 1:
Depending on how long you press the button:

* If the device is not provisioned to the Matter network, it initiates the SMP server (Simple Management Protocol) and Bluetooth LE advertising for Matter commissioning.
After that, the Direct Firmware Update (DFU) over Bluetooth Low Energy can be started.
(See `Upgrading the device firmware`_.)
Bluetooth LE advertising makes the device discoverable over Bluetooth LE for the predefined period of time (15 minutes by default).
* If the device is already provisioned to the Matter network it re-enables the SMP server.
After that, the DFU over Bluetooth Low Energy can be started.
(See `Upgrading the device firmware`_.)
* If pressed for less than three seconds:

* If the device is not provisioned to the Matter network, it initiates the SMP server (Simple Management Protocol) and Bluetooth LE advertising for Matter commissioning.
After that, the Device Firmware Update (DFU) over Bluetooth Low Energy can be started.
(See `Upgrading the device firmware`_.)
Bluetooth LE advertising makes the device discoverable over Bluetooth LE for the predefined period of time (15 minutes by default).

* If the device is already provisioned to the Matter network it re-enables the SMP server.
After that, the DFU over Bluetooth Low Energy can be started.
(See `Upgrading the device firmware`_.)

* If pressed for more than three seconds, it initiates the factory reset of the device.
Releasing the button within a 3-second window of the initiation cancels the factory reset procedure.

.. matter_door_lock_sample_button1_end
Expand Down Expand Up @@ -376,7 +382,7 @@ After building the sample and programming it to your development kit, complete t
I: Lock Action has been initiated
I: Lock Action has been completed
#. Press **Button 1** to initiate factory reset of the device.
#. Keep the **Button 1** pressed for more than six seconds to initiate factory reset of the device.

The device reboots after all its settings are erased.

Expand Down
2 changes: 1 addition & 1 deletion samples/matter/template/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ To test the sample in a Matter-enabled Thread network, complete the following st

At the end of this procedure, **LED 1** of the Matter device programmed with the sample starts flashing in the Short Flash Off state.
This indicates that the device is fully provisioned, but does not yet have full IPv6 network connectivity.
#. Press **Button 1** for six seconds to initiate the factory reset of the device.
#. Keep the **Button 1** pressed for more than six seconds to initiate factory reset of the device.

The device reboots after all its settings are erased.

Expand Down
2 changes: 1 addition & 1 deletion samples/matter/thermostat/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ After building the sample and programming it to your development kit, complete t
#. Observe the UART terminal.
The sample starts automatically printing the simulated temperature data to the terminal with 30-second intervals.
#. Press **Button 2** to print the most recent temperature data to the terminal.
#. Press **Button 1** for six seconds to initiate the factory reset of the device.
#. Keep the **Button 1** pressed for more than six seconds to initiate factory reset of the device.

The device reboots after all its settings are erased.

Expand Down
2 changes: 1 addition & 1 deletion samples/matter/window_covering/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ After building the sample and programming it to your development kit, complete t
**LED 3** light up and its brightness increases with each button press until it reaches full brightness.
#. Press **Button 2** 20 times to fully tilt the cover into the open position.
The brightness of **LED 3** decreases with each button press until the LED turns off.
#. Press **Button 1** to initiate the factory reset of the device.
#. Keep the **Button 1** pressed for more than six seconds to initiate factory reset of the device.

The device reboots after all its settings are erased.

Expand Down

0 comments on commit 8206081

Please sign in to comment.