Skip to content

Commit 2d8bf6b

Browse files
Ruth Fuchsscarlescufi
authored andcommitted
doc: Create applications section
Split up the samples into samples and applications and add documentation to distinguish between the two. Signed-off-by: Ruth Fuchss <[email protected]>
1 parent 0805bea commit 2d8bf6b

File tree

6 files changed

+57
-21
lines changed

6 files changed

+57
-21
lines changed

applications/asset_tracker/README.rst

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@
33
nRF9160: Asset Tracker
44
######################
55

6-
The Asset Tracker sample demonstrates how to use the :ref:`lib_nrf_cloud` to connect an nRF9160 DK to the `nRF Cloud`_ via LTE and transmit GPS and sensor data.
6+
The Asset Tracker demonstrates how to use the :ref:`lib_nrf_cloud` to connect an nRF9160 DK to the `nRF Cloud`_ via LTE and transmit GPS and sensor data.
77

88

99
Overview
1010
********
1111

12-
The sample sends GPS position, temperature, and accelerometer data that is collected by an nRF9160 DK to Nordic Semiconductor's cloud solution, `nRF Cloud`_, where the data is visualized.
12+
The application sends GPS position, temperature, and accelerometer data that is collected by an nRF9160 DK to Nordic Semiconductor's cloud solution, `nRF Cloud`_, where the data is visualized.
1313
The accelerometer data is used to infer the device's physical orientation, which is sent as the nRF Cloud sensor data type "FLIP".
1414
Temperature data is sent as the nRF Cloud sensor type "TEMP".
1515

16-
By default, the sample uses simulated sensor and GPS data, but it can be configured with Kconfig options to use real sensors to collect data.
16+
By default, the application uses simulated sensor and GPS data, but it can be configured with Kconfig options to use real sensors to collect data.
1717
The LTE link control driver is used to establish the LTE link automatically.
1818
When the device is connected to the nRF Cloud, you can use the LTE Link Monitor to send AT commands and receive the response.
1919

@@ -27,7 +27,7 @@ Requirements
2727

2828
* :ref:`secure_boot` must be programmed on the board.
2929

30-
The sample is configured to compile and run as a non-secure application on nRF91's Cortex-M33.
30+
The applications is configured to compile and run as a non-secure application on nRF91's Cortex-M33.
3131
Therefore, it requires the :ref:`secure_boot` bootloader that prepares the required peripherals to be available for the application.
3232

3333
.. _asset_tracker_user_interface:
@@ -53,7 +53,7 @@ LED 3 and LED 4:
5353
* LED 4 blinking: Pattern sent - Pattern has been entered and sent to nRF Cloud for verification.
5454
* LED 4 ON: Connected - The device is ready for sensor data transfer.
5555

56-
.. figure:: ../../../doc/nrf/images/nrf_cloud_led_states.svg
56+
.. figure:: ../../doc/nrf/images/nrf_cloud_led_states.svg
5757
:alt: Application state indicated by LEDs
5858

5959
Application state indicated by LEDs
@@ -66,13 +66,13 @@ All LEDs (1-4):
6666
Building and running
6767
********************
6868

69-
This sample can be found under :file:`samples/nrf9160/asset_tracker` in the |NCS| folder structure.
69+
This application can be found under :file:`applications/asset_tracker` in the |NCS| folder structure.
7070

71-
The sample is built as a non-secure firmware image for the nrf9160_pca10090ns board.
71+
The application is built as a non-secure firmware image for the nrf9160_pca10090ns board.
7272
It can be programmed independently from the secure boot firmware.
7373

7474
See :ref:`gs_programming` for information about how to build and program the application.
75-
The Kconfig file of the sample contains options to configure the sample.
75+
The Kconfig file of the application contains options to configure the application.
7676
For example, configure ``CONFIG_POWER_OPTIMIZATION_ENABLE`` to enable power optimization or ``CONFIG_TEMP_USE_EXTERNAL`` to use an external temperature sensor instead of simulated temperature data.
7777
In |SES|, select **Project** > **Configure nRF Connect SDK project** to browse and configure these options.
7878
Alternatively, use the command line tool ``menuconfig`` or configure the options directly in ``prj.conf``.
@@ -82,8 +82,7 @@ Alternatively, use the command line tool ``menuconfig`` or configure the options
8282
Power optimization
8383
******************
8484

85-
The Asset Tracker sample can run in three power modes that are configured in the
86-
Kconfig file of the sample.
85+
The Asset Tracker can run in three power modes that are configured in the Kconfig file of the application.
8786

8887
Demo mode
8988
This is the default setting.
@@ -102,7 +101,7 @@ Request Power Saving Mode (PSM)
102101
Testing
103102
=======
104103

105-
After programming the :ref:`secure_boot` to your board, test the Asset Tracker sample by performing the following steps:
104+
After programming the :ref:`secure_boot` sample to your board, test the Asset Tracker application by performing the following steps:
106105

107106
1. Connect the board to the computer using a USB cable.
108107
The board is assigned a COM port (Windows) or ttyACM device (Linux), which is visible in the Device Manager.
@@ -111,7 +110,7 @@ After programming the :ref:`secure_boot` to your board, test the Asset Tracker s
111110
Follow the instructions to set up your account and add an LTE device.
112111
A pattern of switch and button actions is displayed.
113112
#. Make sure that the :ref:`secure_boot` sample is programmed to the board.
114-
#. Compile and program the Asset Tracker sample to the board.
113+
#. Compile and program the Asset Tracker application to the board.
115114
#. Observe in the terminal window that the board starts up in secure boot and that the application starts.
116115
This is indicated by output similar to the following lines::
117116

@@ -121,7 +120,7 @@ After programming the :ref:`secure_boot` to your board, test the Asset Tracker s
121120

122121
#. Observe that LED 3 starts blinking as the LTE link is established. This may take several minutes.
123122
#. Observe in the terminal window that connection to nRF Cloud is established.
124-
#. The first time you start the sample, pair the device to your account:
123+
#. The first time you start the application, pair the device to your account:
125124

126125
a. Observe that both LED 3 and 4 start blinking, indicating that the pairing procedure has been initiated.
127126
#. Follow the instructions on `nRF Cloud`_ and enter the displayed pattern.
@@ -141,7 +140,7 @@ After programming the :ref:`secure_boot` to your board, test the Asset Tracker s
141140
Dependencies
142141
************
143142

144-
This sample uses the following |NCS| libraries and drivers:
143+
This application uses the following |NCS| libraries and drivers:
145144

146145
* :ref:`lib_nrf_cloud`
147146
* ``drivers/gps_sim``

doc/CMakeLists.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,9 +108,11 @@ set(NRF_EXTRACT_CONTENT_COMMAND
108108
--outputs ${NRF_CONTENT_OUTPUTS}
109109
--ignore ${CMAKE_CURRENT_BINARY_DIR}
110110
"*:doc:${NRF_RST_OUT}"
111+
"*.rst:applications:${NRF_RST_OUT}"
111112
"*.rst:samples:${NRF_RST_OUT}"
112113
"*.rst:boards:${NRF_RST_OUT}"
113114
"*.rst:include:${NRF_RST_OUT}"
115+
"*.rst:applications:${NRF_RST_OUT}/doc/nrf"
114116
"*.rst:samples:${NRF_RST_OUT}/doc/nrf"
115117
"*.rst:boards:${NRF_RST_OUT}/doc/nrf"
116118
"release-notes*.rst:doc:${NRF_RST_OUT}/doc/nrf"

doc/nrf/applications.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
.. _applications:
2+
3+
Applications
4+
############
5+
6+
Applications typically include a fully integrated software stack and can serve as a starting point for developing your product.
7+
They use interface drivers and libraries from the |NCS| and its set of repositories to implement a specific use case.
8+
9+
Some applications target custom hardware designed for a specific use case.
10+
They can also be run on different hardware like a generic development kit, but with limited functionality.
11+
12+
The following applications are available:
13+
14+
.. toctree::
15+
:maxdepth: 1
16+
:glob:
17+
18+
../../applications/*/README

doc/nrf/examples.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
.. _examples:
2+
3+
Samples and applications
4+
########################
5+
6+
The `Zephyr Project`_ contains a variety of application samples and demos.
7+
Documentation for those is available in the :ref:`zephyr:samples-and-demos` section.
8+
9+
Nordic Semiconductor provides additional examples that specifically target Nordic Semiconductor devices and show how to implement typical use cases with our libraries and drivers.
10+
Samples showcase a single feature or library, while applications include a variety of libraries to implement a specific use case.
11+
12+
.. toctree::
13+
:maxdepth: 2
14+
15+
samples
16+
applications

doc/nrf/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Documentation for different versions of the |NCS| is available at the following
2424
release_notes
2525
getting_started
2626
user_guides
27-
samples
27+
examples
2828
libraries
2929
reference/kconfig/index
3030

doc/nrf/samples.rst

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
11
.. _samples:
22

3-
Samples and demos
4-
#################
3+
Samples
4+
#######
55

6-
The `Zephyr Project`_ contains a variety of application sample and demos.
7-
Documentation for those is available in the :ref:`zephyr:samples-and-demos` section.
6+
For very simple samples, see the :ref:`zephyr:basic-sample` in Zephyr.
7+
Those samples are a good starting point for understanding how to put together your own application.
88

9-
Nordic Semiconductor provides additional examples that specifically target Nordic Semiconductor devices and show how to implement typical use cases with our libraries and drivers.
10-
The following demo applications are available:
9+
In addition, the |NCS| provides the following samples that showcase the use of a single feature or library:
1110

1211
.. toctree::
1312
:maxdepth: 1
@@ -32,3 +31,5 @@ The following demo applications are available:
3231
:glob:
3332

3433
../../samples/*/README
34+
35+
For more complex examples, see :ref:`applications`.

0 commit comments

Comments
 (0)