Memfault Firmware SDK 1.2.1 (Build 3382)

Author: Memfault Inc

CHANGES.md

@@ -1,3 +1,20 @@
+### Changes between Memfault SDK 1.2.0 and 1.2.1 - Sept 1, 2023
+
+#### :chart_with_upwards_trend: Improvements
+
+- ESP-IDF:
+  - Add a `heartbeat` cli command to the ESP-IDF port that does the same thing
+    as in Memfault's default demo console + Zephyr's console.
+- Zephyr:
+  - Add a new Kconfig option to the Zephyr port,
+    `CONFIG_MEMFAULT_PLATFORM_EXTRA_CONFIG_FILE=y`, which causes
+    `memfault_platform_config_extra.h` to be included in platform
+    configurations. This can be utilized by a third party consumer of Zephyr to
+    more easily extend the platform configurations set by Zephyr and avoid
+    potentially losing a user's platform configurations set in
+    `memfault_platform_config.h`, which
+    [happened in the nRF Connect SDK recently](https://devzone.nordicsemi.com/f/nordic-q-a/103188/memfault-sdk-integration-missing-user-memfault_platform_config).
+
 ### Changes between Memfault SDK 1.1.3 and 1.2.0 - Aug 30, 2023
 
 #### :chart_with_upwards_trend: Improvements
@@ -6,14 +23,24 @@
   - Eliminate several build warnings for our example app
 - FreeRTOS:
   - Fix a build error in our QEMU example when building on macOS
+- Modus Toolbox:
+  - Update port to handle user override of SDK configs, metrics, trace_reasons,
+    etc
+  - Update port to fix errors when disabling built-in WiFi metrics
 - nRF Connect SDK:
   - Enable mcuboot & NCS 1.4 with our example apps
 - Silicon Labs:
-  - Add a demo CLI component for the emblib port. Check out our [Simplicity Studio example app](https://github.com/memfault/simplicity-studio-example) for usage
+  - Add a demo CLI component for the emblib port. Check out our
+    [Simplicity Studio example app](https://github.com/memfault/simplicity-studio-example)
+    for usage
   - Fix a build warning in emblib port flash storage (MSC) module
 - Zephyr:
-  - Fix a :bug: when building with LOG_MODE_DEFERRED that prevent log messages from flushing during a coredump
-  - Fix a :bug: and warnings involving older Zephyr header paths. Resolves [#62](https://github.com/memfault/memfault-firmware-sdk/issues/62) and [#57](https://github.com/memfault/memfault-firmware-sdk/issues/57). Thanks @JordanYates and @YHusain1 for reporting these issues.
+  - Fix a :bug: when building with LOG_MODE_DEFERRED that prevent log messages
+    from flushing during a coredump
+  - Fix a :bug: and warnings involving older Zephyr header paths. Resolves
+    [#62](https://github.com/memfault/memfault-firmware-sdk/issues/62) and
+    [#57](https://github.com/memfault/memfault-firmware-sdk/issues/57). Thanks
+    @JordanYates and @YHusain1 for reporting these issues.
 
 ### Changes between Memfault SDK 1.1.2 and 1.1.3 - Aug 8, 2023
 

VERSION

@@ -1,2 +1,2 @@
-BUILD ID: 3361
-GIT COMMIT: d427c1e05
+BUILD ID: 3382
+GIT COMMIT: b1e62a17a

components/include/memfault/version.h

@@ -19,8 +19,8 @@ typedef struct {
   uint8_t patch;
 } sMfltSdkVersion;
 
-#define MEMFAULT_SDK_VERSION   { .major = 1, .minor = 2, .patch = 0 }
-#define MEMFAULT_SDK_VERSION_STR "1.2.0"
+#define MEMFAULT_SDK_VERSION   { .major = 1, .minor = 2, .patch = 1 }
+#define MEMFAULT_SDK_VERSION_STR "1.2.1"
 
 #ifdef __cplusplus
 }

components/metrics/src/memfault_metrics.c

@@ -814,29 +814,29 @@ static bool prv_heartbeat_debug_print(MEMFAULT_UNUSED void *ctx,
 
   switch (metric_info->type) {
     case kMemfaultMetricType_Timer:
-      MEMFAULT_LOG_DEBUG("  %s: %" PRIu32, key_name, value->u32);
+      MEMFAULT_LOG_INFO("  %s: %" PRIu32, key_name, value->u32);
       break;
     case kMemfaultMetricType_Unsigned:
       if (metric_info->is_set) {
-        MEMFAULT_LOG_DEBUG("  %s: %" PRIu32, key_name, value->u32);
+        MEMFAULT_LOG_INFO("  %s: %" PRIu32, key_name, value->u32);
       } else {
-        MEMFAULT_LOG_DEBUG("  %s: null", key_name);
+        MEMFAULT_LOG_INFO("  %s: null", key_name);
       }
       break;
     case kMemfaultMetricType_Signed:
       if (metric_info->is_set) {
-        MEMFAULT_LOG_DEBUG("  %s: %" PRIi32, key_name, value->i32);
+        MEMFAULT_LOG_INFO("  %s: %" PRIi32, key_name, value->i32);
       } else {
-        MEMFAULT_LOG_DEBUG("  %s: null", key_name);
+        MEMFAULT_LOG_INFO("  %s: null", key_name);
       }
       break;
     case kMemfaultMetricType_String:
-      MEMFAULT_LOG_DEBUG("  %s: \"%s\"", key_name, (const char *)value->ptr);
+      MEMFAULT_LOG_INFO("  %s: \"%s\"", key_name, (const char *)value->ptr);
       break;
 
     case kMemfaultMetricType_NumTypes: // To silence -Wswitch-enum
     default:
-      MEMFAULT_LOG_DEBUG("  %s: <unknown type>", key_name);
+      MEMFAULT_LOG_INFO("  %s: <unknown type>", key_name);
       break;
   }
 
@@ -845,7 +845,7 @@ static bool prv_heartbeat_debug_print(MEMFAULT_UNUSED void *ctx,
 
 void memfault_metrics_heartbeat_debug_print(void) {
   prv_heartbeat_timer_update();
-  MEMFAULT_LOG_DEBUG("Heartbeat keys/values:");
+  MEMFAULT_LOG_INFO("Heartbeat keys/values:");
   memfault_metrics_heartbeat_iterate(prv_heartbeat_debug_print, NULL);
 }
 

ports/esp_idf/memfault/common/memfault_platform_demo_cli_cmds.c

@@ -167,6 +167,11 @@ static int prv_esp32_crash_example(int argc, char** argv) {
   return 0;
 }
 
+static int prv_esp32_memfault_heartbeat(int argc, char **argv) {
+  memfault_metrics_heartbeat_debug_trigger();
+  return 0;
+}
+
 static int prv_esp32_memfault_heartbeat_dump(int argc, char** argv) {
   memfault_metrics_heartbeat_debug_print();
   return 0;
@@ -311,6 +316,13 @@ void memfault_register_cli(void) {
       .func = prv_chunk_data_export,
   }));
 
+  ESP_ERROR_CHECK(esp_console_cmd_register(&(esp_console_cmd_t){
+    .command = "heartbeat",
+    .help = "trigger an immediate capture of all heartbeat metrics",
+    .hint = NULL,
+    .func = prv_esp32_memfault_heartbeat,
+  }));
+
   ESP_ERROR_CHECK( esp_console_cmd_register(&(esp_console_cmd_t) {
       .command = "heartbeat_dump",
       .help = "Dump current Memfault metrics heartbeat state",

ports/esp_idf/memfault/common/memfault_platform_http_client.c

@@ -420,6 +420,7 @@ int memfault_esp_port_http_client_post_data(void) {
 
   // Check for data available first as nothing else matters if not.
   if (!memfault_esp_port_data_available()) {
+    MEMFAULT_LOG_INFO("No new data found");
     return 0;
   }
 

ports/zephyr/Kconfig

@@ -376,6 +376,14 @@ config MEMFAULT_CATCH_ZEPHYR_ASSERT
          from __ASSERT() macro call sites, unless assert_post_action() contains
          a MEMFAULT_ASSERT() invocation.
 
+config MEMFAULT_PLATFORM_EXTRA_CONFIG_FILE
+       bool "Enable inclusion of additional platform config file"
+       default n
+       help
+        Enables inclusion of an additional platform config file,
+        'memfault_platform_config_extra.h'. This can be useful for third party
+        libraries that want to include additional default platform configs.
+
 menuconfig MEMFAULT_USE_GNU_BUILD_ID
         default y
         bool "Use a GNU build ID in an image"

ports/zephyr/config/memfault_zephyr_platform_config.h

@@ -74,8 +74,13 @@ extern "C" {
 
 #endif /* CONFIG_MEMFAULT_USER_CONFIG_SILENT_FAIL */
 
-#else
+#else /* ! CONFIG_MEMFAULT_USER_CONFIG_ENABLE */
 #define MEMFAULT_DISABLE_USER_TRACE_REASONS 1
+#endif /* CONFIG_MEMFAULT_USER_CONFIG_ENABLE */
+
+// Pick up any extra configuration settings
+#if defined(CONFIG_MEMFAULT_PLATFORM_EXTRA_CONFIG_FILE)
+#include "memfault_platform_config_extra.h"
 #endif
 
 #ifdef __cplusplus

tests/src/test_memfault_heartbeat_metrics_debug.cpp

@@ -109,7 +109,7 @@ TEST(MemfaultHeartbeatMetricsDebug, Test_DebugPrints) {
     "  test_key_timer: 0",
     "  test_key_string: \"\"",
   };
-  prv_debug_print_expectations(kMemfaultPlatformLogLevel_Debug, heartbeat_debug_print_on_boot,
+  prv_debug_print_expectations(kMemfaultPlatformLogLevel_Info, heartbeat_debug_print_on_boot,
                                MEMFAULT_ARRAY_SIZE(heartbeat_debug_print_on_boot));
   memfault_metrics_heartbeat_debug_print();
   mock().checkExpectations();
@@ -130,7 +130,7 @@ TEST(MemfaultHeartbeatMetricsDebug, Test_DebugPrints) {
     "  test_key_timer: 5000",
     "  test_key_string: \"heyo!\"",
   };
-  prv_debug_print_expectations(kMemfaultPlatformLogLevel_Debug, heartbeat_debug_print_after_collected,
+  prv_debug_print_expectations(kMemfaultPlatformLogLevel_Info, heartbeat_debug_print_after_collected,
                                MEMFAULT_ARRAY_SIZE(heartbeat_debug_print_after_collected));
   mock().expectOneCall("memfault_metrics_heartbeat_serialize");
   memfault_metrics_heartbeat_debug_trigger();
@@ -148,7 +148,7 @@ TEST(MemfaultHeartbeatMetricsDebug, Test_DebugPrints) {
     "  test_key_timer: 0",
     "  test_key_string: \"\"",
   };
-  prv_debug_print_expectations(kMemfaultPlatformLogLevel_Debug, heartbeat_debug_print_reset,
+  prv_debug_print_expectations(kMemfaultPlatformLogLevel_Info, heartbeat_debug_print_reset,
                                MEMFAULT_ARRAY_SIZE(heartbeat_debug_print_reset));
   memfault_metrics_heartbeat_debug_print();
   mock().checkExpectations();
@@ -166,7 +166,7 @@ TEST(MemfaultHeartbeatMetricsDebug, Test_DebugPrints) {
     "  test_key_timer: 0",
     "  test_key_string: \"\"",
   };
-  prv_debug_print_expectations(kMemfaultPlatformLogLevel_Debug, heartbeat_add_non_null,
+  prv_debug_print_expectations(kMemfaultPlatformLogLevel_Info, heartbeat_add_non_null,
                                MEMFAULT_ARRAY_SIZE(heartbeat_add_non_null));
   // call add on this metric alone and confirm it is set
   memfault_metrics_heartbeat_add(MEMFAULT_METRICS_KEY(test_key_unsigned), 123);