Add LTE metrics

Author: gminn

applications/asset_tracker_v2/configuration/memfault/memfault_metrics_heartbeat_config.def

@@ -2,6 +2,6 @@
  * Please refer to https://docs.memfault.com/docs/embedded/metrics-api for more details.
  */
 
-MEMFAULT_METRICS_KEY_DEFINE(GnssTimeToFix, kMemfaultMetricType_Unsigned)
-MEMFAULT_METRICS_KEY_DEFINE(GnssSatellitesTracked, kMemfaultMetricType_Unsigned)
-MEMFAULT_METRICS_KEY_DEFINE(LocationTimeoutSearchTime, kMemfaultMetricType_Unsigned)
+MEMFAULT_METRICS_KEY_DEFINE(gnss_time_to_fix_ms, kMemfaultMetricType_Unsigned)
+MEMFAULT_METRICS_KEY_DEFINE(gnss_satellites_tracked_count, kMemfaultMetricType_Unsigned)
+MEMFAULT_METRICS_KEY_DEFINE(location_timeout_search_time_ms, kMemfaultMetricType_Unsigned)

applications/asset_tracker_v2/doc/debug_module.rst

@@ -25,9 +25,9 @@ Memfault
 The debug module uses `Memfault SDK`_ to track |NCS| specific metrics such as LTE and stack metrics.
 In addition, the following types of custom Memfault metrics are defined and tracked when compiling in the debug module:
 
- * ``GnssTimeToFix`` - Time duration between the start of a GNSS search and obtaining a fix.
- * ``GnssSatellitesTracked`` - Number of satellites tracked during a GNSS search window.
- * ``LocationTimeoutSearchTime`` - Time duration between the start of a location search and a search timeout.
+ * ``gnss_time_to_fix_ms`` - Time duration between the start of a GNSS search and obtaining a fix.
+ * ``gnss_satellites_tracked_count`` - Number of satellites tracked during a GNSS search window.
+ * ``location_timeout_search_time_ms`` - Time duration between the start of a location search and a search timeout.
 
 The debug module also implements `Memfault SDK`_ software watchdog, which is designed to trigger an assert before an actual watchdog timeout.
 This enables the application to be able to collect coredump data before a reboot occurs.

applications/asset_tracker_v2/src/modules/debug_module.c

@@ -264,30 +264,26 @@ static void add_location_metrics(uint8_t satellites, uint32_t search_time,
 
 	switch (event) {
 	case LOCATION_MODULE_EVT_GNSS_DATA_READY:
-		err = memfault_metrics_heartbeat_set_unsigned(
-						MEMFAULT_METRICS_KEY(GnssTimeToFix),
-						search_time);
+		err = MEMFAULT_METRIC_SET_UNSIGNED(gnss_time_to_fix_ms, search_time);
 		if (err) {
-			LOG_ERR("Failed updating GnssTimeToFix metric, error: %d", err);
+			LOG_ERR("Failed updating gnss_time_to_fix_ms metric, error: %d", err);
 		}
 		break;
 	case LOCATION_MODULE_EVT_TIMEOUT:
-		err = memfault_metrics_heartbeat_set_unsigned(
-						MEMFAULT_METRICS_KEY(LocationTimeoutSearchTime),
-						search_time);
+		err = MEMFAULT_METRIC_SET_UNSIGNED(location_timeout_search_time_ms, search_time);
 		if (err) {
-			LOG_ERR("Failed updating LocationTimeoutSearchTime metric, error: %d", err);
+			LOG_ERR("Failed updating location_timeout_search_time_ms metric, error: %d",
+				err);
 		}
 		break;
 	default:
 		LOG_ERR("Unknown location module event.");
 		return;
 	}
 
-	err = memfault_metrics_heartbeat_set_unsigned(MEMFAULT_METRICS_KEY(GnssSatellitesTracked),
-						      satellites);
+	err = MEMFAULT_METRIC_SET_UNSIGNED(gnss_satellites_tracked_count, satellites);
 	if (err) {
-		LOG_ERR("Failed updating GnssSatellitesTracked metric, error: %d", err);
+		LOG_ERR("Failed updating gnss_satellites_tracked_count metric, error: %d", err);
 	}
 
 	memfault_metrics_heartbeat_debug_trigger();

applications/asset_tracker_v2/tests/debug_module/src/debug_module_test.c

@@ -114,11 +114,9 @@ void test_memfault_trigger_metric_sampling_on_gnss_fix(void)
 	setup_debug_module_in_init_state();
 
 	__cmock_memfault_metrics_heartbeat_set_unsigned_ExpectAndReturn(
-						MEMFAULT_METRICS_KEY(GnssTimeToFix),
-						60000,
-						0);
+		MEMFAULT_METRICS_KEY(gnss_time_to_fix_ms), 60000, 0);
 	__cmock_memfault_metrics_heartbeat_set_unsigned_ExpectAndReturn(
-						MEMFAULT_METRICS_KEY(GnssSatellitesTracked),
+						MEMFAULT_METRICS_KEY(gnss_satellites_tracked_count),
 						4,
 						0);
 	__cmock_memfault_metrics_heartbeat_debug_trigger_Expect();
@@ -144,11 +142,11 @@ void test_memfault_trigger_metric_sampling_on_location_timeout(void)
 
 	/* Update this function to expect the search time and number of satellites. */
 	__cmock_memfault_metrics_heartbeat_set_unsigned_ExpectAndReturn(
-						MEMFAULT_METRICS_KEY(LocationTimeoutSearchTime),
+						MEMFAULT_METRICS_KEY(location_timeout_search_time_ms),
 						30000,
 						0);
 	__cmock_memfault_metrics_heartbeat_set_unsigned_ExpectAndReturn(
-						MEMFAULT_METRICS_KEY(GnssSatellitesTracked),
+						MEMFAULT_METRICS_KEY(gnss_satellites_tracked_count),
 						2,
 						0);
 	__cmock_memfault_metrics_heartbeat_debug_trigger_Ignore();

include/modem/modem_info.h

@@ -43,6 +43,20 @@ extern "C" {
 /** Modem firmware version string can be up to 40 characters long. */
 #define MODEM_INFO_FWVER_SIZE 41
 
+/** Band unavailable value. */
+#define BAND_UNAVAILABLE 0
+
+/** Short operator size can be up to 64 characters long.
+ * Matches value in nrf/samples/cellular/modem_shell/src/link/link_api.h.
+ */
+#define MODEM_INFO_SHORT_OP_NAME_SIZE 65
+
+/** SNR unavailable value. */
+#define SNR_UNAVAILABLE	 127
+
+/** SNR offset value. */
+#define SNR_OFFSET_VAL 24
+
 /** Modem returns RSRP and RSRQ as index values which require
  * a conversion to dBm and dB respectively. See modem AT
  * command reference guide for more information.
@@ -161,6 +175,25 @@ int modem_info_params_init(struct modem_param_info *modem_param);
  */
 int modem_info_rsrp_register(rsrp_cb_t cb);
 
+/**
+ * @brief Initialize collection of connectivity stats
+ *
+ * @note The function will reset stats if connectivity stats
+ *       are already initialized/enabled.
+ *
+ * @return 0 If the operation was successful.
+ *           Otherwise, a (negative) error code is returned.
+ */
+int modem_info_connectivity_stats_init(void);
+
+/**
+ * @brief Disable collection of connectivity stats
+ *
+ * @return 0 If the operation was successful.
+ *           Otherwise, a (negative) error code is returned.
+ */
+int modem_info_connectivity_stats_disable(void);
+
 /** @brief Request the current modem status of any predefined
  *         information value as a string.
  *
@@ -320,6 +353,56 @@ int modem_info_get_temperature(int *val);
  */
 int modem_info_get_rsrp(int *val);
 
+/**
+ * @brief Obtain the connectivity statistics.
+ *
+ * Get the total amount of data transmitted and receievd during the collection
+ * period.
+ *
+ * @note Will return bytes = 0 until connectivity stats collection has been
+ * enabled via AT%XCONNSTAT=1, or with modem_info_connectivity_stats_init().
+ *
+ * @param tx_kbytes Pointer to the target variable.
+ * @param rx_kbytes Pointer to the target variable.
+ *
+ * @return 0 if the operation was successful.
+ *         Otherwise, a (negative) error code is returned.
+ */
+int modem_info_get_connectivity_stats(int *tx_kbytes, int *rx_kbytes);
+
+/**
+ * @brief Obtain the current band.
+ *
+ * @param val Pointer to the target variable.
+ *
+ * @return 0 if the operation was successful.
+ * @return -ENOENT if there is no valid band.
+ *          Otherwise, a (negative) error code is returned.
+ */
+int modem_info_get_current_band(uint8_t *val);
+
+/**
+ * @brief Obtain the operator name.
+ *
+ * @param buf Pointer to the target buffer.
+ * @param buf_size Size of target buffer.
+ *
+ * @return 0 if  the operation was successful.
+ *          Otherwise, a (negative) error code is returned.
+ */
+int modem_info_get_operator(char *buf, size_t buf_size);
+
+/**
+ * @brief Obtain the signal-to-noise ratio.
+ *
+ * @param val Pointer to the target variable.
+ *
+ * @return 0 if the operation was successful.
+ * @return -ENOENT if there is no valid SNR.
+ *          Otherwise, a (negative) error code is returned.
+ */
+int modem_info_get_snr(int *val);
+
 /** @} */
 
 #ifdef __cplusplus

lib/modem_info/modem_info.c

@@ -13,6 +13,7 @@
 #include <modem/modem_info.h>
 #include <nrf_errno.h>
 #include <zephyr/net/socket.h>
+#include <zephyr/toolchain.h>
 #include <stdint.h>
 #include <stdio.h>
 #include <string.h>
@@ -43,6 +44,10 @@ LOG_MODULE_REGISTER(modem_info);
 #define AT_CMD_IMSI		"AT+CIMI"
 #define AT_CMD_IMEI		"AT+CGSN"
 #define AT_CMD_DATE_TIME	"AT+CCLK?"
+#define AT_CMD_XCONNSTAT	"AT%XCONNSTAT?"
+#define AT_CMD_XCONNSTAT_ON	"AT%%XCONNSTAT=1"
+#define AT_CMD_XCONNSTAT_OFF	"AT%%XCONNSTAT=0"
+#define AT_CMD_XMONITOR		"AT%%XMONITOR"
 #define AT_CMD_SUCCESS_SIZE	5
 
 #define RSRP_DATA_NAME		"rsrp"
@@ -144,6 +149,10 @@ LOG_MODULE_REGISTER(modem_info);
 #define HWVER_CMD_STR "HWVERSION"
 #define HWVER_FMT_STR "%%%%" HWVER_CMD_STR ": %%%d[^" AT_CMD_RSP_DELIM "]"
 
+#define SHORT_OP_NAME_SIZE_WITHOUT_NULL_TERM 64
+BUILD_ASSERT(SHORT_OP_NAME_SIZE_WITHOUT_NULL_TERM == (MODEM_INFO_SHORT_OP_NAME_SIZE - 1),
+	     "Short operator size macros must match");
+
 struct modem_info_data {
 	const char *cmd;
 	const char *data_name;
@@ -750,6 +759,30 @@ int modem_info_rsrp_register(rsrp_cb_t cb)
 	return 0;
 }
 
+int modem_info_connectivity_stats_init(void)
+{
+	int err = nrf_modem_at_printf(AT_CMD_XCONNSTAT_ON);
+
+	if (err != 0) {
+		if (err > 0) {
+			err = nrf_modem_at_err_type(err);
+		}
+	}
+	return err;
+}
+
+int modem_info_connectivity_stats_disable(void)
+{
+	int err = nrf_modem_at_printf(AT_CMD_XCONNSTAT_OFF);
+
+	if (err != 0) {
+		if (err > 0) {
+			err = nrf_modem_at_err_type(err);
+		}
+	}
+	return err;
+}
+
 int modem_info_get_fw_uuid(char *buf, size_t buf_size)
 {
 	int ret;
@@ -888,6 +921,92 @@ int modem_info_get_rsrp(int *val)
 	return 0;
 }
 
+int modem_info_get_connectivity_stats(int *tx_kbytes, int *rx_kbytes)
+{
+	if (tx_kbytes == NULL || rx_kbytes == NULL) {
+		return -EINVAL;
+	}
+
+	int ret = nrf_modem_at_scanf(AT_CMD_XCONNSTAT, "%%XCONNSTAT: %*d,%*d,%d,%d,%*d,%*d",
+				     tx_kbytes, rx_kbytes);
+
+	if (ret != 2) {
+		LOG_ERR("Could not get connectivity stats, error: %d", ret);
+		return map_nrf_modem_at_scanf_error(ret);
+	}
+
+	return 0;
+}
+
+int modem_info_get_current_band(uint8_t *val)
+{
+	if (val == NULL) {
+		return -EINVAL;
+	}
+
+	int ret = nrf_modem_at_scanf("AT%XCBAND", "%%XCBAND: %u", val);
+
+	if (ret != 1) {
+		LOG_ERR("Could not get band, error: %d", ret);
+		return map_nrf_modem_at_scanf_error(ret);
+	}
+
+	if (*val == BAND_UNAVAILABLE) {
+		LOG_WRN("No valid band");
+		return -ENOENT;
+	}
+
+	return 0;
+}
+
+int modem_info_get_operator(char *buf, size_t buf_size)
+{
+	if (buf == NULL || buf_size < MODEM_INFO_SHORT_OP_NAME_SIZE) {
+		return -EINVAL;
+	}
+
+	int ret = nrf_modem_at_scanf(
+		"AT%XMONITOR",
+		"%%XMONITOR: "
+		"%*u,"	  /* <reg_status> ignored */
+		"%*[^,]," /* <full_name> ignored */
+		"\"%" STRINGIFY(SHORT_OP_NAME_SIZE_WITHOUT_NULL_TERM) "[^\"]\",", /* <short_name> */
+				buf);
+
+	if (ret != 1) {
+		// Warning instead of error because it is not always reported
+		LOG_WRN("No valid operator");
+		return map_nrf_modem_at_scanf_error(ret);
+	}
+
+	buf[buf_size - 1] = '\0'; // Null terminate
+
+	return 0;
+}
+
+int modem_info_get_snr(int *val)
+{
+	if (val == NULL) {
+		return -EINVAL;
+	}
+
+	int ret = nrf_modem_at_scanf("AT%XSNRSQ?", "%%XSNRSQ: %d,%*d,%*d", val);
+
+	if (ret != 1) {
+		LOG_ERR("Could not get SNR, error: %d", ret);
+		return map_nrf_modem_at_scanf_error(ret);
+	}
+
+	if (*val == SNR_UNAVAILABLE) {
+		LOG_WRN("No valid SNR");
+		return -ENOENT;
+	}
+
+	*val -= SNR_OFFSET_VAL;
+
+	return 0;
+}
+
 int modem_info_init(void)
 {
 	int err = 0;

modules/memfault-firmware-sdk/config/memfault_metrics_heartbeat_extra.def

@@ -5,28 +5,36 @@
 #endif /* defined(CONFIG_MODEM_INFO) */
 
 #ifdef CONFIG_MEMFAULT_NCS_STACK_METRICS
-MEMFAULT_METRICS_KEY_DEFINE(Ncs_ConnectionPollUnusedStack, kMemfaultMetricType_Unsigned)
-MEMFAULT_METRICS_KEY_DEFINE(NcsBtRxUnusedStack, kMemfaultMetricType_Unsigned)
-MEMFAULT_METRICS_KEY_DEFINE(NcsBtTxUnusedStack, kMemfaultMetricType_Unsigned)
+MEMFAULT_METRICS_KEY_DEFINE(ncs_connection_poll_unused_stack, kMemfaultMetricType_Unsigned)
+MEMFAULT_METRICS_KEY_DEFINE(ncs_bt_rx_unused_stack, kMemfaultMetricType_Unsigned)
+MEMFAULT_METRICS_KEY_DEFINE(ncs_bt_tx_unused_stack, kMemfaultMetricType_Unsigned)
 #endif /* CONFIG_MEMFAULT_NCS_STACK_METRICS */
 
 #ifdef CONFIG_MEMFAULT_NCS_LTE_METRICS
 
 #if defined(CONFIG_MODEM_INFO)
-MEMFAULT_METRICS_STRING_KEY_DEFINE(Ncs_LteModemFwVersion, MODEM_INFO_FWVER_SIZE)
+MEMFAULT_METRICS_STRING_KEY_DEFINE(ncs_lte_modem_fw_version, MODEM_INFO_FWVER_SIZE)
+MEMFAULT_METRICS_STRING_KEY_DEFINE(ncs_lte_operator, MODEM_INFO_SHORT_OP_NAME_SIZE)
+MEMFAULT_METRICS_KEY_DEFINE(ncs_lte_snr_decibels, kMemfaultMetricType_Signed)
+MEMFAULT_METRICS_KEY_DEFINE(ncs_lte_rsrp_dbm, kMemfaultMetricType_Signed)
+MEMFAULT_METRICS_KEY_DEFINE(ncs_lte_tx_kilobytes, kMemfaultMetricType_Unsigned)
+MEMFAULT_METRICS_KEY_DEFINE(ncs_lte_rx_kilobytes, kMemfaultMetricType_Unsigned)
+MEMFAULT_METRICS_KEY_DEFINE(ncs_lte_band, kMemfaultMetricType_Unsigned)
 #endif /* defined(CONFIG_MODEM_INFO) */
 
-MEMFAULT_METRICS_KEY_DEFINE(Ncs_LteTimeToConnect, kMemfaultMetricType_Timer)
-MEMFAULT_METRICS_KEY_DEFINE(Ncs_LteConnectionLossCount, kMemfaultMetricType_Unsigned)
-MEMFAULT_METRICS_KEY_DEFINE(Ncs_LtePsmTauSec, kMemfaultMetricType_Signed)
-MEMFAULT_METRICS_KEY_DEFINE(Ncs_LtePsmActiveTimeSec, kMemfaultMetricType_Signed)
-MEMFAULT_METRICS_KEY_DEFINE(Ncs_LteEdrxIntervalMsec, kMemfaultMetricType_Unsigned)
-MEMFAULT_METRICS_KEY_DEFINE(Ncs_LteEdrxPtwMsec, kMemfaultMetricType_Unsigned)
-MEMFAULT_METRICS_KEY_DEFINE(Ncs_LteMode, kMemfaultMetricType_Unsigned)
+MEMFAULT_METRICS_KEY_DEFINE(ncs_lte_time_to_connect_ms, kMemfaultMetricType_Timer)
+MEMFAULT_METRICS_KEY_DEFINE(ncs_lte_connection_loss_count, kMemfaultMetricType_Unsigned)
+MEMFAULT_METRICS_KEY_DEFINE(ncs_lte_psm_tau_seconds, kMemfaultMetricType_Signed)
+MEMFAULT_METRICS_KEY_DEFINE(ncs_lte_psm_active_time_seconds, kMemfaultMetricType_Signed)
+MEMFAULT_METRICS_KEY_DEFINE(ncs_lte_edrx_interval_ms, kMemfaultMetricType_Unsigned)
+MEMFAULT_METRICS_KEY_DEFINE(ncs_lte_edrx_ptw_ms, kMemfaultMetricType_Unsigned)
+MEMFAULT_METRICS_KEY_DEFINE(ncs_lte_mode, kMemfaultMetricType_Unsigned)
+MEMFAULT_METRICS_KEY_DEFINE(ncs_lte_on_time_ms, kMemfaultMetricType_Timer)
+MEMFAULT_METRICS_KEY_DEFINE(ncs_lte_reset_loop_detected_count, kMemfaultMetricType_Unsigned)
 #endif /* CONFIG_MEMFAULT_NCS_LTE_METRICS */
 
 #ifdef CONFIG_MEMFAULT_NCS_BT_METRICS
-MEMFAULT_METRICS_KEY_DEFINE(Ncs_BtConnectionTime, kMemfaultMetricType_Timer)
-MEMFAULT_METRICS_KEY_DEFINE(Ncs_BtConnectionCount, kMemfaultMetricType_Unsigned)
-MEMFAULT_METRICS_KEY_DEFINE(Ncs_BtBondCount, kMemfaultMetricType_Unsigned)
+MEMFAULT_METRICS_KEY_DEFINE(ncs_bt_connection_time_ms, kMemfaultMetricType_Timer)
+MEMFAULT_METRICS_KEY_DEFINE(ncs_bt_connection_count, kMemfaultMetricType_Unsigned)
+MEMFAULT_METRICS_KEY_DEFINE(ncs_bt_bond_count, kMemfaultMetricType_Unsigned)
 #endif /* CONFIG_MEMFAULT_NCS_BT_METRICS */