You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Split up the samples into samples and applications and add documentation
to distinguish between the two.
Signed-off-by: Ruth Fuchss <[email protected]>
Copy file name to clipboardExpand all lines: applications/asset_tracker/README.rst
+13-14Lines changed: 13 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,17 +3,17 @@
3
3
nRF9160: Asset Tracker
4
4
######################
5
5
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.
7
7
8
8
9
9
Overview
10
10
********
11
11
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.
13
13
The accelerometer data is used to infer the device's physical orientation, which is sent as the nRF Cloud sensor data type "FLIP".
14
14
Temperature data is sent as the nRF Cloud sensor type "TEMP".
15
15
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.
17
17
The LTE link control driver is used to establish the LTE link automatically.
18
18
When the device is connected to the nRF Cloud, you can use the LTE Link Monitor to send AT commands and receive the response.
19
19
@@ -27,7 +27,7 @@ Requirements
27
27
28
28
* :ref:`secure_boot` must be programmed on the board.
29
29
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.
31
31
Therefore, it requires the :ref:`secure_boot` bootloader that prepares the required peripherals to be available for the application.
32
32
33
33
.. _asset_tracker_user_interface:
@@ -53,7 +53,7 @@ LED 3 and LED 4:
53
53
* LED 4 blinking: Pattern sent - Pattern has been entered and sent to nRF Cloud for verification.
54
54
* LED 4 ON: Connected - The device is ready for sensor data transfer.
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.
70
70
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.
72
72
It can be programmed independently from the secure boot firmware.
73
73
74
74
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.
76
76
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.
77
77
In |SES|, select **Project** > **Configure nRF Connect SDK project** to browse and configure these options.
78
78
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
82
82
Power optimization
83
83
******************
84
84
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.
87
86
88
87
Demo mode
89
88
This is the default setting.
@@ -102,7 +101,7 @@ Request Power Saving Mode (PSM)
102
101
Testing
103
102
=======
104
103
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:
106
105
107
106
1. Connect the board to the computer using a USB cable.
108
107
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
111
110
Follow the instructions to set up your account and add an LTE device.
112
111
A pattern of switch and button actions is displayed.
113
112
#. 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.
115
114
#. Observe in the terminal window that the board starts up in secure boot and that the application starts.
116
115
This is indicated by output similar to the following lines::
117
116
@@ -121,7 +120,7 @@ After programming the :ref:`secure_boot` to your board, test the Asset Tracker s
121
120
122
121
#. Observe that LED 3 starts blinking as the LTE link is established. This may take several minutes.
123
122
#. 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:
125
124
126
125
a. Observe that both LED 3 and 4 start blinking, indicating that the pairing procedure has been initiated.
127
126
#. 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
141
140
Dependencies
142
141
************
143
142
144
-
This sample uses the following |NCS| libraries and drivers:
143
+
This application uses the following |NCS| libraries and drivers:
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.
Copy file name to clipboardExpand all lines: doc/nrf/samples.rst
+7-6Lines changed: 7 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,12 @@
1
1
.. _samples:
2
2
3
-
Samples and demos
4
-
#################
3
+
Samples
4
+
#######
5
5
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.
8
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
-
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:
11
10
12
11
.. toctree::
13
12
:maxdepth:1
@@ -32,3 +31,5 @@ The following demo applications are available:
32
31
:glob:
33
32
34
33
../../samples/*/README
34
+
35
+
For more complex examples, see :ref:`applications`.
0 commit comments