Skip to content

Commit

Permalink
lib: lte_link_control: Misc doc updates
Browse files Browse the repository at this point in the history
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]>
  • Loading branch information
trantanen authored and nordicjm committed Jan 13, 2025
1 parent d077ab6 commit f823635
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 3 deletions.
11 changes: 9 additions & 2 deletions doc/nrf/libraries/modem/lte_lc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ You can set the timer values requested by the modem using the following options:
Connection pre-evaluation
=========================

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.
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.
Based on the parameters received in the function call, the application can decide whether to send application data or not.
To enable this module, use the :kconfig:option:`CONFIG_LTE_LC_CONN_EVAL_MODULE` Kconfig option.
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.
Expand Down Expand Up @@ -227,7 +227,7 @@ The :c:struct:`lte_lc_conn_eval_params` structure lists all information that is
Modem sleep and TAU pre-warning notifications
=============================================

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

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.
Expand All @@ -243,6 +243,13 @@ To enable modem sleep and TAU pre-warning notifications, use the following optio

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

Limitations
***********

The LTE link control library and the :ref:`nrfxlib:nrf_modem_at` interface should be used at the same time with caution,
because the library also uses the same interface.
As a general rule, do not use the AT commands for features that the LTE link control library supports.

Dependencies
************

Expand Down
8 changes: 7 additions & 1 deletion include/modem/lte_lc.h
Original file line number Diff line number Diff line change
Expand Up @@ -1303,6 +1303,10 @@ int lte_lc_deregister_handler(lte_lc_evt_handler_t handler);
/**
* Connect to LTE network.
*
* This function sets the modem to online mode using @ref lte_lc_normal.
* The client does not need to do anything to re-connect if the connection is lost but
* the modem will handle it automatically.
*
* @note After initialization, the system mode will be set to the default mode selected with Kconfig
* and LTE preference set to automatic selection.
*
Expand All @@ -1319,7 +1323,9 @@ int lte_lc_connect(void);
*
* The function returns immediately.
*
* @note The library must be initialized before this function is called.
* This function sets the modem to online mode using @ref lte_lc_normal.
* The client does not need to do anything to re-connect if the connection is lost but
* the modem will handle it automatically.
*
* @param[in] handler Event handler for receiving LTE events. The parameter can be @c NULL if an
* event handler is already registered.
Expand Down

0 comments on commit f823635

Please sign in to comment.