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
Doing small updates:
- Add doc building
- Add missing Kconfig description to Configuration page
- Improvements to logging
- Remove release plan before v1.0.0
Signed-off-by: Tommi Rantanen <tommi.rantanen@nordicsemi.no>
Copy file name to clipboardExpand all lines: doc/app/sm_build_and_run.rst
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -215,7 +215,7 @@ Using the LwM2M carrier library
215
215
The application supports the |NCS| `LwM2M carrier`_ library that you can use to connect to the operator's device management platform.
216
216
See the library's documentation for more information and configuration options.
217
217
218
-
To enable the LwM2M carrier library, add the parameter ``-DOVERLAY_CONFIG=overlay-carrier.conf`` to your build command.
218
+
To enable the LwM2M carrier library, add the parameter ``-DEXTRA_CONF_FILE=overlay-carrier.conf`` to your build command.
219
219
220
220
The CA root certificates that are needed for modem FOTA are not provisioned in the |SM| application.
221
221
You can flash the `Cellular: LwM2M carrier`_ sample to write the certificates to modem before flashing the |SM| application, or use the `Cellular: AT Client`_ sample as explained in `preparing the Cellular: LwM2M Client sample for production <lwm2m_client_provisioning_>`_.
Copy file name to clipboardExpand all lines: doc/app/sm_logging.rst
+29-4Lines changed: 29 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,20 +31,45 @@ To switch to ``UART0`` output for application logs, change the following options
31
31
CONFIG_LOG_BACKEND_RTT=n
32
32
CONFIG_LOG_BACKEND_UART=y
33
33
34
+
The default logging level for the |SM| is ``CONFIG_SM_LOG_LEVEL_INF``.
35
+
You can get more verbose logs by setting the ``CONFIG_SM_LOG_LEVEL_DBG`` Kconfig option.
36
+
37
+
TF-M logging must use the same UART as the application. For more details, see `shared TF-M logging`_.
38
+
34
39
Modem traces
35
40
************
36
41
37
42
To send modem traces over UART on an nRF91 Series DK, configuration must be added for the UART device in the devicetree and Kconfig.
38
-
This is done by adding the `modem trace UART snippet`_ when building and programming.
43
+
This is done by adding the `modem trace UART snippet`_ (``-Dapp_SNIPPET=nrf91-modem-trace-uart``) when building and programming.
39
44
40
45
Use the `Cellular Monitor app`_ for capturing and analyzing modem traces.
41
46
42
-
TF-M logging must use the same UART as the application. For more details, see `shared TF-M logging`_.
47
+
.. note::
48
+
49
+
Modem traces captured through UART are corrupted if application logs through RTT are simultaneously captured.
50
+
When capturing modem traces through UART with the `Cellular Monitor app`_ and simultaneously capturing RTT logs, for example, with J-Link RTT Viewer, the modem trace misses packets, and captured packets might have incorrect information.
51
+
52
+
If you need to capture modem traces and RTT logs at the same time, enable HW flow control for modem trace UART.
53
+
This can be done for the `nRF9151 DK <nrf9151dk_>`_ by adding the following change to :file:`app/boards/nrf9151dk_nrf9151_ns.overlay`:
54
+
55
+
.. parsed-literal::
56
+
:class: highlight
57
+
58
+
&uart1 {
59
+
hw-flow-control;
60
+
};
61
+
62
+
Otherwise, you can choose not to capture RTT logs.
63
+
Having only RTT logs enabled does not cause this issue.
64
+
65
+
HW flow control prevents the trace UART from sending, when there is no reader for the data.
66
+
This in turn prevents the trace UART from suspending as it cannot empty it's buffers.
67
+
This increases the overall power consumption by ~700uA even when |SM| is in sleep mode.
43
68
44
69
.. _sm_modem_trace_cmux:
45
70
46
-
Collecting modem traces through CMUX backend
47
-
********************************************
71
+
Modem traces through CMUX
72
+
*************************
48
73
49
74
The |SM| application supports collecting modem traces through the CMUX multiplexer.
50
75
When enabled, modem traces are sent through a dedicated CMUX channel, allowing simultaneous AT commands, PPP data, and trace collection over the same serial port.
Copy file name to clipboardExpand all lines: doc/gsg_guide.rst
+34Lines changed: 34 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -70,6 +70,10 @@ Complete the following steps for building and running:
70
70
71
71
west build -p -b nrf9151dk/nrf9151/ns
72
72
73
+
To build the application with Kconfig and DTC overlays and extra Kconfig options, the following command gives an example of how they are passed as build arguments::
74
+
75
+
west build -p -b nrf9151dk/nrf9151/ns -- -DEXTRA_CONF_FILE="overlay-ppp.conf;overlay-cmux.conf" -DEXTRA_DTC_OVERLAY_FILE="overlay-external-mcu.overlay" -DCONFIG_SM_LOG_LEVEL_DBG=y
76
+
73
77
#. To program the application, run the following command::
74
78
75
79
west flash
@@ -90,3 +94,33 @@ The default baud rate is 115200.
90
94
To set the manifest path for |SM|, run the following command::
91
95
92
96
west config manifest.path ncs-serial-modem
97
+
98
+
Documentation
99
+
*************
100
+
101
+
You only need to build the documentation if you modify the documentation source files, and want to provide the documentation to others.
102
+
103
+
A minimal documentation setup is provided for Doxygen and Sphinx.
104
+
Before continuing, check if you have Doxygen installed.
105
+
It is recommended to use the same Doxygen version used in [CI](.github/workflows/doc-build-pr.yml).
106
+
107
+
Complete the following steps for building the documentation:
108
+
109
+
#. Change to the ``doc`` folder::
110
+
111
+
cd doc
112
+
113
+
#. To install Sphinx, make sure you have a Python installation in place and run::
114
+
115
+
pip install -r requirements.txt
116
+
117
+
#. Build API documentation::
118
+
119
+
doxygen
120
+
121
+
#. Build HTML documentation::
122
+
123
+
make html
124
+
125
+
The output will be stored in the ``doc/_build_sphinx/html/index.html`` file.
126
+
You may check for other output formats other than HTML by running ``make help``.
0 commit comments