Skip to content

Commit f823635

Browse files
trantanennordicjm
authored andcommitted
lib: lte_link_control: Misc doc updates
Adding a note that LTE LC and nrf_modem_at APIs should be used together with caution. A comment in lte_lc_connect* that reconnection happens automatically. Signed-off-by: Tommi Rantanen <[email protected]>
1 parent d077ab6 commit f823635

File tree

2 files changed

+16
-3
lines changed

2 files changed

+16
-3
lines changed

doc/nrf/libraries/modem/lte_lc.rst

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ You can set the timer values requested by the modem using the following options:
185185
Connection pre-evaluation
186186
=========================
187187

188-
Modem firmware version 1.3.0 and higher supports connection a pre-evaluation feature that allows the application to get information about a cell that is likely to be used for an RRC connection.
188+
Modem firmware versions 1.3.0 and higher support a connection pre-evaluation feature that allows the application to get information about a cell that is likely to be used for an RRC connection.
189189
Based on the parameters received in the function call, the application can decide whether to send application data or not.
190190
To enable this module, use the :kconfig:option:`CONFIG_LTE_LC_CONN_EVAL_MODULE` Kconfig option.
191191
The function :c:func:`lte_lc_conn_eval_params_get` populates a structure of type :c:struct:`lte_lc_conn_eval_params` that includes information on the current consumption cost by the data transmission when utilizing the given cell.
@@ -227,7 +227,7 @@ The :c:struct:`lte_lc_conn_eval_params` structure lists all information that is
227227
Modem sleep and TAU pre-warning notifications
228228
=============================================
229229

230-
Modem firmware v1.3.0 and higher supports receiving callbacks from the modem related to Tracking Area Updates (TAU) and modem sleep.
230+
Modem firmware versions 1.3.0 and higher support receiving callbacks from the modem related to Tracking Area Updates (TAU) and modem sleep.
231231
Based on these notifications, the application can alter its behavior to optimize for a given metric.
232232

233233
For instance, TAU pre-warning notifications can be used to schedule data transfers before a TAU so that data transfer and TAU occurs within the same RRC connection window, thereby saving the potential overhead associated with the additional data exchange.
@@ -243,6 +243,13 @@ To enable modem sleep and TAU pre-warning notifications, use the following optio
243243

244244
For additional configurations related to these features, see the API documentation.
245245

246+
Limitations
247+
***********
248+
249+
The LTE link control library and the :ref:`nrfxlib:nrf_modem_at` interface should be used at the same time with caution,
250+
because the library also uses the same interface.
251+
As a general rule, do not use the AT commands for features that the LTE link control library supports.
252+
246253
Dependencies
247254
************
248255

include/modem/lte_lc.h

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1303,6 +1303,10 @@ int lte_lc_deregister_handler(lte_lc_evt_handler_t handler);
13031303
/**
13041304
* Connect to LTE network.
13051305
*
1306+
* This function sets the modem to online mode using @ref lte_lc_normal.
1307+
* The client does not need to do anything to re-connect if the connection is lost but
1308+
* the modem will handle it automatically.
1309+
*
13061310
* @note After initialization, the system mode will be set to the default mode selected with Kconfig
13071311
* and LTE preference set to automatic selection.
13081312
*
@@ -1319,7 +1323,9 @@ int lte_lc_connect(void);
13191323
*
13201324
* The function returns immediately.
13211325
*
1322-
* @note The library must be initialized before this function is called.
1326+
* This function sets the modem to online mode using @ref lte_lc_normal.
1327+
* The client does not need to do anything to re-connect if the connection is lost but
1328+
* the modem will handle it automatically.
13231329
*
13241330
* @param[in] handler Event handler for receiving LTE events. The parameter can be @c NULL if an
13251331
* event handler is already registered.

0 commit comments

Comments
 (0)