modem_info.h File Reference

API for retrieving modem information. More...

#include <modem/at_params.h>

Go to the source code of this file.

Data Structures
struct	lte_param
	LTE parameter data. More...
struct	network_param
	Network parameters. More...
struct	sim_param
	SIM card parameters. More...
struct	device_param
	Device parameters. More...
struct	modem_param_info
	Modem parameters. More...

Macros
#define	MODEM_INFO_MAX_RESPONSE_SIZE   100
#define	MODEM_INFO_JSON_STRING_SIZE   512
#define	MODEM_INFO_FWVER_SIZE   41
#define	BAND_UNAVAILABLE   0
#define	MODEM_INFO_SHORT_OP_NAME_SIZE   65
#define	SNR_UNAVAILABLE   127
#define	SNR_OFFSET_VAL   24
#define	RSRP_IDX_TO_DBM(rsrp)
	Converts RSRP index value returned by the modem to dBm.
#define	RSRQ_IDX_TO_DB(rsrq)
	Converts RSRQ index value returned by the modem to dB.

Typedefs
typedef void(*	rsrp_cb_t) (char rsrp_value)
	RSRP event handler function prototype.

Enumerations
enum	modem_info {   MODEM_INFO_RSRP , MODEM_INFO_CUR_BAND , MODEM_INFO_SUP_BAND , MODEM_INFO_AREA_CODE ,   MODEM_INFO_UE_MODE , MODEM_INFO_OPERATOR , MODEM_INFO_MCC , MODEM_INFO_MNC ,   MODEM_INFO_CELLID , MODEM_INFO_IP_ADDRESS , MODEM_INFO_UICC , MODEM_INFO_BATTERY ,   MODEM_INFO_TEMP , MODEM_INFO_FW_VERSION , MODEM_INFO_ICCID , MODEM_INFO_LTE_MODE ,   MODEM_INFO_NBIOT_MODE , MODEM_INFO_GPS_MODE , MODEM_INFO_IMSI , MODEM_INFO_IMEI ,   MODEM_INFO_DATE_TIME , MODEM_INFO_APN , MODEM_INFO_COUNT }
	LTE link information data. More...

Functions
int	modem_info_init (void)
	Initialize the modem information module.
int	modem_info_params_init (struct modem_param_info *modem_param)
	Initialize the structure that stores modem information.
int	modem_info_rsrp_register (rsrp_cb_t cb)
	Initialize the subscription of RSRP values.
int	modem_info_connectivity_stats_init (void)
	Initialize collection of connectivity statistics.
int	modem_info_connectivity_stats_disable (void)
	Disable collection of connectivity statistics.
int	modem_info_string_get (enum modem_info info, char *buf, const size_t buf_size)
	Request the current modem status of any predefined information value as a string.
int	modem_info_short_get (enum modem_info info, uint16_t *buf)
	Request the current modem status of any predefined information value as a short.
int	modem_info_name_get (enum modem_info info, char *name)
	Request the name of a modem information data type.
enum at_param_type	modem_info_type_get (enum modem_info info)
	Request the data type of the current modem information type.
int	modem_info_params_get (struct modem_param_info *modem_param)
	Obtain the modem parameters.
int	modem_info_get_fw_uuid (char *buf, size_t buf_size)
	Obtain the UUID of the modem firmware build.
int	modem_info_get_fw_version (char *buf, size_t buf_size)
	Obtain the short software identification.
int	modem_info_get_hw_version (char *buf, uint8_t buf_size)
	Obtain the hardware version string.
int	modem_info_get_svn (char *buf, size_t buf_size)
	Obtain the modem Software Version Number (SVN).
int	modem_info_get_batt_voltage (int *val)
	Obtain the battery voltage.
int	modem_info_get_temperature (int *val)
	Obtain the internal temperature.
int	modem_info_get_rsrp (int *val)
	Obtain the RSRP.
int	modem_info_get_connectivity_stats (int *tx_kbytes, int *rx_kbytes)
	Obtain the connectivity statistics.
int	modem_info_get_current_band (uint8_t *val)
	Obtain the current band.
int	modem_info_get_operator (char *buf, size_t buf_size)
	Obtain the operator name.
int	modem_info_get_snr (int *val)
	Obtain the signal-to-noise ratio.

Detailed Description

API for retrieving modem information.