Skip to content

Commit

Permalink
[nrfconnect] samples: docs revised by a technical writer.
Browse files Browse the repository at this point in the history
Signed-off-by: Marcin Kajor <marcin.kajor@nordicsemi.no>
  • Loading branch information
markaj-nordic committed Apr 28, 2022
1 parent 40f4191 commit 3af494d
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 36 deletions.
2 changes: 1 addition & 1 deletion examples/window-app/nrfconnect/Kconfig
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#
# Copyright (c) 2021 Project CHIP Authors
# Copyright (c) 2022 Project CHIP Authors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down
62 changes: 29 additions & 33 deletions examples/window-app/nrfconnect/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,10 +92,8 @@ with other Thread devices in the network.
### Device Firmware Upgrade

The example supports over-the-air (OTA) device firmware upgrade (DFU) using
available method:

- Matter OTA update that is mandatory for Matter-compliant devices and enabled
by default
the Matter OTA update, which is mandatory for Matter-compliant devices and enabled
by default.

For this method, the
[MCUboot](https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/mcuboot/index.html)
Expand Down Expand Up @@ -177,15 +175,16 @@ following states are possible:
- _Solid On_ &mdash; The device is fully provisioned and has full Thread
network and service connectivity.

**LED 2** brightness indicates the shutter lift position

- the brightness changes in range 0-255, where 0 means fully opened shutter
and 255 means fully closed shutter (lift)

**LED 3** brightness indicates the shutter tilt position
**LED 2** indicates the lift position of the shutter, which is represented by the
brightness of the LED. The brightness level ranges from 0 to 255, where the
switched off LED with brightness level 0 indicates a fully opened shutter (lifted)
and 255 indicates a fully closed shutter (lowered).

- the brightness changes in range 0-255, where 0 means fully opened shutter
and 255 means fully closed shutter (tilt)
**LED 3** indicates the tilt position of the shutter, which is represented by the
brightness of the LED. The brightness level ranges from 0 to 255, where the
switched off LED with brightness level 0 indicates a fully opened shutter (tilted
to a horizontal position) and 255 indicates a fully closed shutter (tilted
to a vertical position).

**Button 1** can be used for the following purposes:

Expand All @@ -200,29 +199,26 @@ following states are possible:
[Building with Device Firmware Upgrade support](#building-with-device-firmware-upgrade-support)
instruction.

**Button 2** and **Button 3** &mdash; pressed together at the same time switch
the mode of the shutter movement between lift and tilt; by default, after the
device reset, the mode is set to lift.
**Button 2** &mdash; Pressing the button once moves the shutter towards the open
position by one step. Depending on the current movement mode, the button decreases
the brightness of **LED2** for the lift mode and **LED3** for the tilt mode.

**Button 2** &mdash; pressed alone once, steps the shutter towards the open
position. Depending on the current movement mode, it decreases the brightness of
LED2 for lift mode and LED3 for tilt mode.
**Button 3** &mdash; Pressing the button once moves the shutter towards the closed
position by one step. Depending on the current movement mode, the button increases
the brightness of **LED2** for the lift mode and **LED3** for the tilt mode.

**Button 3** &mdash; pressed alone once, steps the shutter towards the close
position. Depending on the current movement mode, it increases the brightness of
LED3 for lift mode and LED3 for tilt mode.
**Button 2** and **Button 3** &mdash; Pressing both buttons at the same time toggles
the shutter movement mode between lift and tilt. After each device reset,
the mode is set to lift by default.

> **Note**:
>
> There are 20 steps needed to fully close the shutter from fully opened
> position, and vise versa (each step takes approximately 200 ms, which aims to
> simulate the real shutter movement). This means that, for instance, **Button
> 2** needs to be pressed 20 times to fully lift the shutter and to cover the
> whole range of **LED 2** brightness step by step. Note that the shutter
> positions and brightness of **LED 2** and **LED 3** are stored in non-volatile
> memory and are restored after every device reset. After the firmware update,
> by default both LEDs are switched off, which corresponds to the shutter being
> fully open, both lift-wise and tilt-wise.
> Completely opening and closing the shutter requires 20 button presses (steps).
> Each step takes approximately 200 ms to simulate the real shutter movement.
> The shutter position and LED brightness values are stored in non-volatile
> memory and are restored after every device reset. After the firmware update
> or factory reset both LEDs are switched off by default, which corresponds
> to the shutter being fully open, both lift-wise and tilt-wise.
**Button 4** &mdash; Pressing the button once starts the NFC tag emulation and
enables Bluetooth LE advertising for the predefined period of time (15 minutes
Expand Down Expand Up @@ -471,12 +467,12 @@ Before you start testing the application, you can select one of the build types
supported by the sample. This sample supports the following build types,
depending on the selected board:

- debug -- Debug version of the application - can be used to enable additional
- debug &mdash; Debug version of the application - can be used to enable additional
features for verifying the application behavior, such as logs or
command-line shell.
- release -- Release version of the application - can be used to enable only
- release &mdash; Release version of the application - can be used to enable only
the necessary application functionalities to optimize its performance.
- no_dfu -- Debug version of the application without Device Firmware Upgrade
- no_dfu &mdash; Debug version of the application without Device Firmware Upgrade
feature support - can be used only for the nRF52840 DK and nRF5340 DK, as
those platforms have DFU enabled by default.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2021 Project CHIP Authors
* Copyright (c) 2022 Project CHIP Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion examples/window-app/nrfconnect/overlay-low_power.conf
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#
# Copyright (c) 2021 Project CHIP Authors
# Copyright (c) 2022 Project CHIP Authors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down

0 comments on commit 3af494d

Please sign in to comment.