Skip to content

Commit 814b087

Browse files
umapraseedarlubos
authored andcommitted
doc: General doc fixes
General doc fixes Signed-off-by: UMA PRASEEDA <uma.praseeda@nordicsemi.no>
1 parent ebac490 commit 814b087

File tree

162 files changed

+669
-665
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

162 files changed

+669
-665
lines changed

applications/asset_tracker_v2/doc/cloud_module.rst

+2-6
Original file line numberDiff line numberDiff line change
@@ -98,14 +98,10 @@ For additional documentation on the various FOTA implementations, refer to the r
9898

9999
Full modem FOTA updates are only supported by nRF Cloud.
100100
This application implements full modem FOTA only for the nRF9160 development kit version 1.0.1 and higher.
101-
To enable full modem FOTA, add the following parameter to your build command:
102-
103-
``-DOVERLAY_CONFIG=overlay-full_modem_fota.conf``
101+
To enable full modem FOTA, add the ``-DOVERLAY_CONFIG=overlay-full_modem_fota.conf`` parameter to your build command.
104102

105103
Also, specify your development kit version by appending it to the board name.
106-
For example, if your development kit version is 1.0.1, use the following board name in your build command:
107-
108-
``nrf9160dk_nrf9160_ns@1_0_1``
104+
For example, if your development kit version is 1.0.1, use the board name ``nrf9160dk_nrf9160_ns@1_0_1`` in your build command.
109105

110106
Connection awareness
111107
====================

applications/machine_learning/README.rst

+25-25
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,18 @@ It also displays results of the machine learning model on LEDs.
1313
The Edge Impulse platform collects data from sensors, trains machine learning model, and deploys the model to your Nordic Semiconductor's device.
1414
To learn more about Edge Impulse support in the |NCS| see :ref:`ug_edge_impulse`.
1515

16+
Requirements
17+
************
18+
19+
The application supports the following development kits:
20+
21+
.. table-from-sample-yaml::
22+
23+
The available configurations use only built-in sensors or the simulated sensor signal.
24+
You do not need to connect any additional components to the board.
25+
26+
.. include:: /includes/tfm.txt
27+
1628
Overview
1729
********
1830

@@ -28,12 +40,12 @@ This approach allows to use any sensor available in Zephyr.
2840

2941
By default, the following sensors are used by the application:
3042

31-
* Thingy:52 - built-in accelerometer (``LIS2DH``).
32-
* Thingy:53 - built-in accelerometer (``ADXL362``).
33-
* nRF52840 Development Kit - simulated sensor (:ref:`sensor_sim`).
43+
* Thingy:52 - Built-in accelerometer (``LIS2DH``).
44+
* Thingy:53 - Built-in accelerometer (``ADXL362``).
45+
* nRF52840 Development Kit - Simulated sensor (:ref:`sensor_sim`).
3446
The simulated sensor generates predefined waves as acceleration.
3547
This development kit does not have a built-in accelerometer.
36-
* nRF5340 Development Kit - simulated sensor (:ref:`sensor_sim`).
48+
* nRF5340 Development Kit - Simulated sensor (:ref:`sensor_sim`).
3749
The simulated sensor generates predefined waves as acceleration.
3850
This development kit does not have a built-in accelerometer.
3951

@@ -60,10 +72,10 @@ By default, the application uses pretrained machine leaning models deployed in `
6072
* Both Thingy:52 and Thingy:53 use the `NCS hardware accelerometer machine learning model`_.
6173
The model uses the data from the built-in accelerometer to recognize the following gestures:
6274

63-
* ``idle`` - the device is placed on a flat surface.
64-
* ``updown`` - the device is moved in updown direction.
65-
* ``rotate`` - the device is rotated.
66-
* ``tap`` - the device is tapped while placed on a flat surface.
75+
* ``idle`` - The device is placed on a flat surface.
76+
* ``updown`` - The device is moved in updown direction.
77+
* ``rotate`` - The device is rotated.
78+
* ``tap`` - The device is tapped while placed on a flat surface.
6779

6880
Unknown gestures, such as shaking the device, are recognized as anomaly.
6981
* Both the nRF52840 Development Kit and nRF5340 Development Kit use the `NCS simulated sensor machine learning model`_.
@@ -126,18 +138,6 @@ For example, the :ref:`caf_ble_state` and :ref:`caf_ble_adv` modules are not ena
126138

127139
See :ref:`nrf_machine_learning_app_internal_modules` for detailed information about every module used by the nRF Machine Learning application.
128140

129-
Requirements
130-
************
131-
132-
The application supports the following development kits:
133-
134-
.. table-from-sample-yaml::
135-
136-
The available configurations use only built-in sensors or the simulated sensor signal.
137-
There is no need to connect any additional components to the board.
138-
139-
.. include:: /includes/tfm.txt
140-
141141
Programming Thingy:52
142142
=====================
143143

@@ -162,7 +162,7 @@ If you build this application for the nRF53 DK, it enables additional features s
162162
See :ref:`ug_thingy53` for detailed information about the mentioned features.
163163

164164
The nRF53 DK has a J-Link debug IC that can be used to program the firmware.
165-
Alternatively, firmware can be updated over MCUBoot serial recovery or DFU over-ther-air using Simple Management Protocol over Bluetooth.
165+
Alternatively, firmware can be updated over MCUBoot serial recovery or DFU over-the-air using Simple Management Protocol over Bluetooth.
166166
Keep in mind that if you use bootloader to update firmware, the new firmware must be compatible with used bootloader and partition map.
167167

168168
The nRF53 Development Kit uses RTT as logger's backend.
@@ -270,10 +270,10 @@ By default, the application uses the following LED effects:
270270

271271
* If the device is returning the machine learning prediction results, the LED uses following predefined colors:
272272

273-
* ``rotate`` - red
274-
* ``updown`` - green
275-
* ``tap`` - blue
276-
* Anomaly - purple
273+
* ``rotate`` - Red
274+
* ``updown`` - Green
275+
* ``tap`` - Blue
276+
* Anomaly - Purple
277277

278278
If the machine learning model is running, but it has not detected anything yet or the ``idle`` state is detected, the LED is blinking.
279279
After a successful detection, the LED is set to the predefined color.

applications/matter_weather_station/README.rst

+22-21
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,26 @@ You can use this application as a reference for creating your own application.
1515
.. note::
1616
The Matter protocol is in an early development stage and must be treated as an experimental feature.
1717

18+
Requirements
19+
************
20+
21+
The application supports the following development kits:
22+
23+
.. table-from-sample-yaml::
24+
25+
To commission the weather station device and control it remotely through a Thread network, you also need a Matter controller device :ref:`configured on PC or smartphone <ug_matter_configuring>`.
26+
This requires additional hardware depending on your setup.
27+
The recommended way of getting measurement values is using the mobile Matter controller application that comes with a graphical interface, performs measurements automatically and visualizes the data.
28+
29+
To program a Thingy:53 device where the preprogrammed MCUboot bootloader has been erased, you need the external J-Link programmer.
30+
If you have an nRF5340 DK that has an onboard J-Link programmer, you can also use it for this purpose.
31+
32+
If the Thingy:53 is programmed with Thingy:53-compatible sample or application, you can also update the firmware using MCUboot's serial recovery or DFU over Bluetooth LE.
33+
See :ref:`thingy53_app_guide` for details.
34+
35+
.. note::
36+
|matter_gn_required_note|
37+
1838
Overview
1939
********
2040

@@ -68,32 +88,13 @@ If a board has other configuration files, for example associated with partition
6888
Before you start testing the application, you can select one of the build types supported by Matter weather station application, depending on the building method.
6989
This application supports the following build types:
7090

71-
* ``debug`` -- Debug version of the application - can be used to enable additional features for verifying the application behavior, such as logs or command-line shell.
72-
* ``release`` -- Release version of the application - can be used to enable only the necessary application functionalities to optimize its performance.
91+
* ``debug`` - Debug version of the application. You can use this version to enable additional features for verifying the application behavior, such as logs or command-line shell.
92+
* ``release`` - Release version of the application. You can use this version to enable only the necessary application functionalities to optimize its performance.
7393

7494
.. note::
7595
`Selecting a build type`_ is optional.
7696
The ``debug`` build type is used by default if no build type is explicitly selected.
7797

78-
Requirements
79-
************
80-
81-
The application supports the following development kits:
82-
83-
.. table-from-sample-yaml::
84-
85-
To commission the weather station device and control it remotely through a Thread network, you also need a Matter controller device :ref:`configured on PC or smartphone <ug_matter_configuring>` (which requires additional hardware depending on which setup you choose).
86-
The recommended way of getting measurement values is using the mobile Matter controller application that comes with a neat graphical interface, performs measurements automatically and visualizes the data.
87-
88-
To program a Thingy:53 device where the preprogrammed MCUboot bootloader has been erased, you need the external J-Link programmer.
89-
If you own an nRF5340 DK that has an onboard J-Link programmer, you can also use it for this purpose.
90-
91-
If the Thingy:53 is programmed with Thingy:53-compatible sample or application, then you can also update the firmware using MCUboot's serial recovery or DFU over Bluetooth LE.
92-
See :ref:`thingy53_app_guide` for details.
93-
94-
.. note::
95-
|matter_gn_required_note|
96-
9798
User interface
9899
**************
99100

0 commit comments

Comments
 (0)