lte_lc_neighbor_cell_measurement()

int lte_lc_neighbor_cell_measurement

(

struct lte_lc_ncellmeas_params *

params

)

#include <include/modem/lte_lc.h>

Initiate a neighbor cell measurement.

The result of the measurement is reported back as an event of the type LTE_LC_EVT_NEIGHBOR_CELL_MEAS, meaning that an event handler must be registered to receive the information. Depending on the network conditions, LTE connection state and requested search type, it may take a while before the measurement result is ready and reported back. After the event is received, the neighbor cell measurements are automatically stopped. If the function returns successfully, the LTE_LC_EVT_NEIGHBOR_CELL_MEAS event is always reported.

In receive only functional mode, it is recommended to wait for the modem to complete the network selection before calling this function. This can be determined from the LTE_LC_EVT_MODEM_EVENT event with modem event LTE_LC_MODEM_EVT_SEARCH_DONE.

Note

In LTE_LC_FUNC_MODE_RX_ONLY functional mode, this is only supported by the following modem firmware:

• mfw_nrf91x1 v2.0.3 or later
• mfw_nrf9151-ntn

Requires CONFIG_LTE_LC_NEIGHBOR_CELL_MEAS_MODULE to be enabled.

Parameters

[in]

params

Search type parameters or NULL to initiate a measurement with the default parameters. See lte_lc_ncellmeas_params for more information.

Return values

0	if neighbor cell measurement was successfully initiated.
-EFAULT	if AT command failed.
-EINVAL	if parameters are invalid.
-EINPROGRESS	if a neighbor cell measurement is already in progress.