nrf_modem_monitor APIs

nrf_modem_monitor API More...

Data Structures
struct	nrf_modem_network_state

Functions
bool	nrf_modem_monitor_is_at_safe (void)
	Query whether it is currently safe to send AT commands.
void	nrf_modem_monitor_network_state (struct nrf_modem_network_state *state)
	Get current network state.
void	nrf_modem_monitor_network_state_log (uint8_t tdf_logger_mask)
	Configure the modem monitor to automatically log network state changes.
int	nrf_modem_monitor_signal_quality (int16_t *rsrp, int8_t *rsrq, bool cached)
	Get current signal quality.
int	nrf_modem_monitor_connectivity_stats (int *tx_kbytes, int *rx_kbytes)
	Get current connectivity statistics.

Detailed Description

nrf_modem_monitor API

Function Documentation

nrf_modem_monitor_connectivity_stats()

int nrf_modem_monitor_connectivity_stats	(	int *	tx_kbytes,
		int *	rx_kbytes )

#include <infuse/lib/nrf_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

nrf_modem_monitor_is_at_safe()

bool nrf_modem_monitor_is_at_safe

(

void

)

#include <infuse/lib/nrf_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

nrf_modem_monitor_network_state()

void nrf_modem_monitor_network_state

(

struct nrf_modem_network_state *

state

)

#include <infuse/lib/nrf_modem_monitor.h>

Get current network state.

Parameters

state

Network state

nrf_modem_monitor_network_state_log()

void nrf_modem_monitor_network_state_log

(

uint8_t

tdf_logger_mask

)

#include <infuse/lib/nrf_modem_monitor.h>

Configure the modem monitor to automatically log network state changes.

Logs TDF_LTE_CONN_STATUS on registration status and cell changes.

Parameters

tdf_logger_mask

TDF data logger mask to log state changes to

nrf_modem_monitor_signal_quality()

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

#include <infuse/lib/nrf_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