Skip to content

Commit 39e0ca1

Browse files
committed
[nrfconnect] samples: docs revised by a technical writer.
Signed-off-by: Marcin Kajor <marcin.kajor@nordicsemi.no>
1 parent 03177f4 commit 39e0ca1

File tree

4 files changed

+32
-36
lines changed

4 files changed

+32
-36
lines changed

examples/window-app/nrfconnect/Kconfig

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#
2-
# Copyright (c) 2021 Project CHIP Authors
2+
# Copyright (c) 2022 Project CHIP Authors
33
#
44
# Licensed under the Apache License, Version 2.0 (the "License");
55
# you may not use this file except in compliance with the License.

examples/window-app/nrfconnect/README.md

+29-33
Original file line numberDiff line numberDiff line change
@@ -92,10 +92,8 @@ with other Thread devices in the network.
9292
### Device Firmware Upgrade
9393

9494
The example supports over-the-air (OTA) device firmware upgrade (DFU) using
95-
available method:
96-
97-
- Matter OTA update that is mandatory for Matter-compliant devices and enabled
98-
by default
95+
the Matter OTA update, which is mandatory for Matter-compliant devices and enabled
96+
by default.
9997

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

180-
**LED 2** brightness indicates the shutter lift position
181-
182-
- the brightness changes in range 0-255, where 0 means fully opened shutter
183-
and 255 means fully closed shutter (lift)
184-
185-
**LED 3** brightness indicates the shutter tilt position
178+
**LED 2** indicates the lift position of the shutter, which is represented by the
179+
brightness of the LED. The brightness level ranges from 0 to 255, where the
180+
switched off LED with brightness level 0 indicates a fully opened shutter (lifted)
181+
and 255 indicates a fully closed shutter (lowered).
186182

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

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

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

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

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

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

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

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

examples/window-app/nrfconnect/boards/nrf5340dk_nrf5340_cpuapp.overlay

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2021 Project CHIP Authors
2+
* Copyright (c) 2022 Project CHIP Authors
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.

examples/window-app/nrfconnect/overlay-low_power.conf

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#
2-
# Copyright (c) 2021 Project CHIP Authors
2+
# Copyright (c) 2022 Project CHIP Authors
33
#
44
# Licensed under the Apache License, Version 2.0 (the "License");
55
# you may not use this file except in compliance with the License.

0 commit comments

Comments
 (0)