Memfault Firmware SDK 0.28.2 (Build 384364)

Author: Memfault Inc

.circleci/config.yml

@@ -49,7 +49,9 @@ commands:
       - run:
           name: Install lcov 1.14
           command: |
-            wget http://downloads.sourceforge.net/ltp/lcov-1.14.tar.gz -O ~/lcov.tar.gz
+            LCOV_SHA256SUM=14995699187440e0ae4da57fe3a64adc0a3c5cf14feab971f8db38fb7d8f071a
+            wget https://github.com/linux-test-project/lcov/releases/download/v1.14/lcov-1.14.tar.gz -O ~/lcov.tar.gz
+            echo "${LCOV_SHA256SUM}  ${HOME}/lcov.tar.gz" | shasum --algorithm=256 --check
             cd ~ && tar zvxf ~/lcov.tar.gz
 
   prepare:

CHANGES.md

@@ -1,3 +1,13 @@
+### Changes between Memfault SDK 0.28.2 and SDK 0.28.1 - Feb 1, 2022
+
+#### :house: Internal
+
+- Updated
+  [nRF91 sample test app](examples/nrf-connect-sdk/nrf9160/memfault_demo_app) to
+  be compatible with nRF Connect SDK 1.9 release
+- Updated python scripts to be compatible with new flake8 linter options
+- Updated where `lcov` is sourced from when running unit tests in CI
+
 ### Changes between Memfault SDK 0.28.1 and SDK 0.28.0 - Jan 20, 2022
 
 #### :chart_with_upwards_trend: Improvements

VERSION

@@ -1,2 +1,2 @@
-BUILD ID: 378789
-GIT COMMIT: 9d890e8cc
+BUILD ID: 384364
+GIT COMMIT: 73cde73c3

components/include/memfault/version.h

@@ -19,7 +19,7 @@ typedef struct {
   uint8_t patch;
 } sMfltSdkVersion;
 
-#define MEMFAULT_SDK_VERSION   { .major = 0, .minor = 28, .patch = 1 }
+#define MEMFAULT_SDK_VERSION   { .major = 0, .minor = 28, .patch = 2 }
 
 #ifdef __cplusplus
 }

examples/nrf-connect-sdk/nrf9160/memfault_demo_app/CMakeLists.txt

@@ -37,6 +37,24 @@ if (NCS_VERSION_MAJOR)
 
     set(CONFIG_NEWLIB_LIBC y CACHE INTERNAL "")
   endif()
+
+  # These were removed in NCS 1.9, but are needed prior to that.
+  if (${NCS_VERSION_MAJOR} LESS_EQUAL 1 AND ${NCS_VERSION_MINOR} LESS 9 AND ${NCS_VERSION_PATCH} LESS 99)
+    set(CONFIG_BSD_LIBRARY y CACHE INTERNAL "")
+    set(CONFIG_BSD_LIBRARY_SYS_INIT n CACHE INTERNAL "")
+    # ^ Note: CONFIG_BSD_ were renamed to _NRF_MODEM_ in
+    # nRF Connect SDK v1.5. We use the legacy names for now
+    # so this app can continue to compile on older targets
+    #
+    # CONFIG_NRF_MODEM_LIB
+    # CONFIG_NRF_MODEM_LIB_SYS_INIT
+
+    # For nRF Connect SDK v1.5 default value changed here
+    set(CONFIG_AT_CMD_SYS_INIT n CACHE INTERNAL "")
+  else()
+    # in v1.9+, use the modem_info library to get the IMEI for device_serial
+    set(CONFIG_MODEM_INFO y CACHE INTERNAL "")
+  endif()
 endif()
 
 find_package(Zephyr HINTS $ENV{ZEPHYR_BASE})

examples/nrf-connect-sdk/nrf9160/memfault_demo_app/prj.conf

@@ -67,21 +67,10 @@ CONFIG_FOTA_DOWNLOAD_PROGRESS_EVT=y
 CONFIG_MEMFAULT_HTTP_MAX_POST_SIZE=256
 
 # Manually bring up LTE stack
-CONFIG_BSD_LIBRARY=y
-CONFIG_BSD_LIBRARY_SYS_INIT=n
-# ^ Note: CONFIG_BSD_ were renamed to _NRF_MODEM_ in
-# nRF Connect SDK v1.5. We use the legacy names for now
-# so this app can continue to compile on older targets
-#
-# CONFIG_NRF_MODEM_LIB
-# CONFIG_NRF_MODEM_LIB_SYS_INIT
-
-# For nRF Connect SDK v1.5 default value changed here
 CONFIG_LTE_AUTO_INIT_AND_CONNECT=n
-CONFIG_AT_CMD_SYS_INIT=n
 
 CONFIG_WATCHDOG=y
 
 # Note: See ./CMakeLists.txt for additional Kconfig variables settings as not all variables can be
 # set in a single prj.conf for backward compatibility with older versions of the nRF Connect SDK /
-# Zephyr
+# Zephyr

examples/nrf-connect-sdk/nrf9160/memfault_demo_app/src/main.c

@@ -24,25 +24,10 @@
 #include "memfault/core/platform/device_info.h"
 #include "memfault/http/http_client.h"
 #include "memfault/nrfconnect_port/http.h"
+#include "memfault/ports/ncs/version.h"
+#include <modem/modem_info.h>
 
-// NCS Version was introduced in nRF SDK >= 1.4
-#if __has_include("ncs_version.h")
-
-#include "ncs_version.h"
-
-#elif __has_include("modem/bsdlib.h")
-
-#define NCS_VERSION_MAJOR 1
-#define NCS_VERSION_MINOR 3
-
-#else
-
-// A nrf connect sdk version < 1.3
-#define NCS_VERSION_MAJOR 1
-#define NCS_VERSION_MINOR 0
-
-#endif
-
+// nRF Connect SDK < 1.3
 #if (NCS_VERSION_MAJOR == 1) && (NCS_VERSION_MINOR < 3)
 
 #include <lte_lc.h>
@@ -51,13 +36,20 @@
 #include <modem_key_mgmt.h>
 #include <net/bsdlib.h>
 
-#else /* nRF Connect SDK >= 1.3 */
+// nRF Connect SDK < 1.9
+#elif (NCS_VERSION_MAJOR == 1) && (NCS_VERSION_MINOR < 9) && (NCS_PATCHLEVEL < 99)
 
 #include <modem/lte_lc.h>
 #include <modem/at_cmd.h>
 #include <modem/at_notif.h>
 #include <modem/modem_key_mgmt.h>
 
+// nRF Connect SDK >= 1.9
+#else
+
+#include <modem/lte_lc.h>
+#include <nrf_modem_at.h>
+
 #endif
 
 #if (NCS_VERSION_MAJOR == 1) && (NCS_VERSION_MINOR <= 2)
@@ -107,8 +99,6 @@ sMfltHttpClientConfig g_mflt_http_client_config = {
 };
 
 void memfault_platform_get_device_info(sMemfaultDeviceInfo *info) {
-  static bool s_init = false;
-
   // platform specific version information
   *info = (sMemfaultDeviceInfo) {
     .device_serial = s_device_serial,
@@ -125,30 +115,46 @@ static int memfault_ncs_device_id_set(const char *device_id, size_t len) {
 
 #endif
 
+#if !MEMFAULT_NCS_VERSION_GT(1, 8)
 static int query_modem(const char *cmd, char *buf, size_t buf_len) {
   enum at_cmd_state at_state;
   int ret = at_cmd_write(cmd, buf, buf_len, &at_state);
-
   if (ret != 0) {
-    printk("at_cmd_write [%s] error:%d, at_state: %d",
-            cmd, ret, at_state);
+    printk("at_cmd_write [%s] error: %d, at_state: %d\n", cmd, ret, at_state);
   }
 
   return ret;
 }
+#endif
 
-static void prv_init_device_info(void) {
-  // we'll use the IMEI as the device serial
-  char imei_buf[IMEI_LEN + 2 /* for \r\n */ + 1 /* \0 */];
-  if (query_modem("AT+CGSN", imei_buf, sizeof(imei_buf)) != 0) {
-    strcat(s_device_serial, "Unknown");
-    return;
+static int prv_get_imei(char *buf, size_t buf_len) {
+#if MEMFAULT_NCS_VERSION_GT(1, 8)
+  // use the cached modem info to fetch the IMEI
+  int err = modem_info_init();
+  if (err != 0) {
+    printk("Modem info Init error: %d\n", err);
+  } else {
+    modem_info_string_get(MODEM_INFO_IMEI, buf, buf_len);
   }
+  return err;
+#else
+  // use an AT command to read IMEI
+  return query_modem("AT+CGSN", buf, buf_len);
+#endif
+}
 
-  imei_buf[IMEI_LEN] = '\0';
-  strcat(s_device_serial, imei_buf);
+static void prv_init_device_info(void) {
+  // we'll use the IMEI as the device serial
+  char modem_info[MODEM_INFO_MAX_RESPONSE_SIZE];
 
-  printk("Device Serial: %s\n", s_device_serial);
+  int ret = prv_get_imei(modem_info, sizeof(modem_info));
+  if (ret != 0) {
+    printk("Failed to get IMEI\n\r");
+  } else {
+    modem_info[IMEI_LEN] = '\0';
+    strcpy(s_device_serial, modem_info);
+    printk("IMEI: %s\n", s_device_serial);
+  }
 
   // register the device id with memfault port so it is used for reporting
   memfault_ncs_device_id_set(s_device_serial, IMEI_LEN);
@@ -169,10 +175,12 @@ void main(void) {
 
   int err = prv_init_modem_lib();
   if (err) {
-    printk("Failed to initialize bsdlib!");
+    printk("Failed to initialize modem!");
     return;
   }
 
+  // These libraries were removed in ncs 1.9
+#if !MEMFAULT_NCS_VERSION_GT(1, 8)
   err = at_cmd_init();
   if (err) {
     printk("Failed to initialize AT commands, err %d\n", err);
@@ -184,6 +192,7 @@ void main(void) {
     printk("Failed to initialize AT notifications, err %d\n", err);
     return;
   }
+#endif
 
   // requires AT modem interface to be up
   prv_init_device_info();

scripts/eclipse_patch.py

@@ -67,7 +67,7 @@ def get_file_element(file_name, virtual_dir, common_prefix, parent_dir, path_typ
 
     # Note: We replace '\' with '/' because eclipse on windows expects '/' for paths
     path = os.path.join(parent_dir, relative_path).replace("\\", "/")
-    logging.debug("Adding {}".format(name))
+    logging.debug("Adding %s", name)
     return generate_link_element(name, path, path_type=path_type)
 
 
@@ -137,9 +137,9 @@ def patch_project(
         parent_dir = os.path.join(location_prefix[0], relative_path)
 
     logging.debug("===Determined Path Information===")
-    logging.debug("Project Path:               {}".format(project_dir))
-    logging.debug("Memfault Firmware SDK Path: {}".format(memfault_sdk_dir))
-    logging.debug("Eclipse Memfault Root:      {}".format(parent_dir))
+    logging.debug("Project Path:               %s", project_dir)
+    logging.debug("Memfault Firmware SDK Path: %s", memfault_sdk_dir)
+    logging.debug("Eclipse Memfault Root:      %s", parent_dir)
 
     tree = ET.parse(project_file)
     root = tree.getroot()
@@ -221,7 +221,7 @@ def patch_project(
                 linked_resources.append(ele)
 
     output_location = project_file if output_dir is None else os.path.join(output_dir, ".project")
-    logging.info("Writing result to {}".format(output_location))
+    logging.info("Writing result to %s", output_location)
     tree.write(output_location)
 
 
@@ -301,7 +301,7 @@ def _find_linker_flags(option):
     #
 
     output_location = cproject_file if output_dir is None else os.path.join(output_dir, ".cproject")
-    logging.info("Writing result to {}".format(output_location))
+    logging.info("Writing result to %s", output_location)
     tree.write(output_location)
 
     with open(output_location, "r") as out_f:

scripts/mflt-build-id/pyproject.toml

@@ -24,7 +24,7 @@ wasmer = "0.3.0"
 
 [tool.black]
 line-length = 100
-target-version = ['py36']
+target-version = ['py38']
 include = '\.pyi?$'
 
 [tool.isort]