nrf_modem_monitor APIs

nrf_modem_monitor API More...

Data Structures
struct	lte_cell
struct	lte_psm_cfg
	Power Saving Mode (PSM) configuration. More...
struct	lte_edrx_cfg
	eDRX configuration. More...
struct	lte_modem_network_state
struct	lte_modem_monitor_config
	Configuration options for the modem monitor. More...

Enumerations
enum	lte_rrc_mode { LTE_RRC_MODE_IDLE = 0 , LTE_RRC_MODE_CONNECTED = 1 }
	LTE "Radio Resource Control" state. More...

Functions
void	lte_modem_monitor_configure (const struct lte_modem_monitor_config *config)
	Configure the modem monitor.
bool	lte_modem_monitor_is_at_safe (void)
	Query whether it is currently safe to send AT commands.
bool	lte_modem_monitor_is_registered (void)
	Check if modem is currently registered to a network.
void	lte_modem_monitor_network_state (struct lte_modem_network_state *state)
	Get current network state.
int	lte_modem_monitor_signal_quality (int16_t *rsrp, int8_t *rsrq, bool cached)
	Get current signal quality.
int	lte_modem_monitor_connectivity_stats (int *tx_kbytes, int *rx_kbytes)
	Get current connectivity statistics.

Detailed Description

nrf_modem_monitor API

Enumeration Type Documentation

lte_rrc_mode

enum lte_rrc_mode

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/lib/lte_modem_monitor.h>

LTE "Radio Resource Control" state.

Enumerator
LTE_RRC_MODE_IDLE	Idle.
LTE_RRC_MODE_CONNECTED	Connected.

Function Documentation

lte_modem_monitor_configure()

void lte_modem_monitor_configure

(

const struct lte_modem_monitor_config *

config

)

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/lib/lte_modem_monitor.h>

Configure the modem monitor.

Parameters

config

Configuration options

lte_modem_monitor_connectivity_stats()

int lte_modem_monitor_connectivity_stats	(	int *	tx_kbytes,
		int *	rx_kbytes )

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/lib/lte_modem_monitor.h>

Get current connectivity statistics.

Parameters

tx_kbytes	Storage for number of kilobytes transmitted.
rx_kbytes	Storage for number of kilobytes received.

Return values

0	on success
-errno	on error

lte_modem_monitor_is_at_safe()

bool lte_modem_monitor_is_at_safe

(

void

)

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/lib/lte_modem_monitor.h>

Query whether it is currently safe to send AT commands.

The nRF modem can be unresponsive to AT commands while a PDN connectivity request is ongoing. Non-critical AT commands should be skipped in this state.

This command will always return true on nRF9160 devices due to legacy modem firmware limitations (No ability to monitor PDN status).

Return values

true	AT command interface can be used
false	AT command interface should not be used

lte_modem_monitor_is_registered()

bool lte_modem_monitor_is_registered

(

void

)

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/lib/lte_modem_monitor.h>

Check if modem is currently registered to a network.

Return values

true	Modem is registered to a home or roaming network
false	Modem is not registered

lte_modem_monitor_network_state()

void lte_modem_monitor_network_state

(

struct lte_modem_network_state *

state

)

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/lib/lte_modem_monitor.h>

Get current network state.

Parameters

state

Network state

lte_modem_monitor_signal_quality()

int lte_modem_monitor_signal_quality	(	int16_t *	rsrp,
		int8_t *	rsrq,
		bool	cached )

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/lib/lte_modem_monitor.h>

Get current signal quality.

Parameters

rsrp	Reference signal received power
rsrq	Reference signal received quality
cached	Return cached signal quality from previous run if modem can no longer determine the parameters. Cached values are reset when the cell tower changes

Return values

0	on success
-errno	on error