Memfault Firmware SDK 1.4.4 (Build 4488)

Author: Memfault Inc

CHANGES.md renamed to CHANGELOG.md

@@ -1,5 +1,31 @@
 # Memfault Firmware SDK Changelog
 
+## [1.4.4] - 2023-11-13
+
+### :chart_with_upwards_trend: Improvements
+
+- General:
+
+  - Rename this file from [`CHANGES.md`] to [`CHANGELOG.md`].
+
+  - For FreeRTOS, add a warning when `configRECORD_STACK_HIGH_ADDRESS` is not
+    enabled. Memfault uses this to show stack sizes in the coredump view for
+    coredumps on FreeRTOS systems. The warning can be disabled by enabling the
+    `configRECORD_STACK_HIGH_ADDRESS` FreeRTOS config flag, or by setting
+    `#define MEMFAULT_FREERTOS_WARN_STACK_HIGH_ADDRESS_UNAVAILABLE 0`.
+
+  - Make `memfault_packetizer_get_chunk()` return `false` if the buffer was too
+    small to load a full chunk. Previously the function would return `true` but
+    with `0` bytes loaded into the output buffer and `*buf_len` set to `0`.
+
+  - Update all example Metrics implementations to use the new API from v1.4.3
+    (eg `MEMFAULT_HEARTBEAT_SET_UNSIGNED` instead of
+    `memfault_metrics_heartbeat_set_unsigned`).
+
+  - Fix compilation for systems not integrating the
+    [Metrics](https://mflt.io/embedded-metrics) component but using the Demo CLI
+    (this regressed in v1.4.3).
+
 ## [1.4.3] - 2023-11-08
 
 ### :rocket: New Features

README.md

@@ -87,7 +87,7 @@ This makes it easy to track the history of the Memfault SDK. You should not need
 to make modifications to the Memfault SDK. The typical update flow is:
 
 - `git pull` the latest upstream
-- check [CHANGES.md](CHANGES.md) to see if any modifications are needed
+- check [CHANGELOG.md](CHANGELOG.md) to see if any modifications are needed
 - update to the new submodule commit in your repo.
 
 Alternatively, the Memfault SDK may be added to a project as a git subtree or by

VERSION

@@ -1,3 +1,3 @@
-BUILD ID: 4437
-GIT COMMIT: 3453c1402
-VERSION: 1.4.3
+BUILD ID: 4488
+GIT COMMIT: 7744b8176
+VERSION: 1.4.4

components/core/src/memfault_data_packetizer.c

@@ -293,6 +293,7 @@ eMemfaultPacketizerStatus memfault_packetizer_get_next(void *buf, size_t *buf_le
   if (*buf_len == 0) {
     MEMFAULT_LOG_ERROR("Buffer of %d bytes too small to packetize data",
                        (int)original_size);
+    return kMemfaultPacketizerStatus_NoMoreData;
   }
 
   if (!md) {

components/demo/src/memfault_demo_shell_commands.c

@@ -42,6 +42,17 @@ int memfault_demo_cli_cmd_export(MEMFAULT_UNUSED int argc, MEMFAULT_UNUSED char
   return 0;
 }
 
+// Provide weak implementations in the case where the metrics component is not enabled
+MEMFAULT_WEAK
+void memfault_metrics_heartbeat_debug_print(void) {
+  MEMFAULT_LOG_RAW("Disabled. metrics component integration required");
+}
+
+MEMFAULT_WEAK
+void memfault_metrics_heartbeat_debug_trigger(void) {
+  MEMFAULT_LOG_RAW("Disabled. metrics component integration required");
+}
+
 int memfault_demo_cli_cmd_heartbeat_dump(MEMFAULT_UNUSED int argc, MEMFAULT_UNUSED char *argv[]) {
   memfault_metrics_heartbeat_debug_print();
   return 0;

components/include/memfault/version.h

@@ -19,8 +19,8 @@ typedef struct {
   uint8_t patch;
 } sMfltSdkVersion;
 
-#define MEMFAULT_SDK_VERSION   { .major = 1, .minor = 4, .patch = 3 }
-#define MEMFAULT_SDK_VERSION_STR "1.4.3"
+#define MEMFAULT_SDK_VERSION   { .major = 1, .minor = 4, .patch = 4 }
+#define MEMFAULT_SDK_VERSION_STR "1.4.4"
 
 #ifdef __cplusplus
 }

components/metrics/src/memfault_metrics.c

@@ -586,8 +586,7 @@ static void prv_reset_metrics(void) {
   // This must be explicitly set because we use 0 to track number of operational hours
   // Without setting to 0, this defaults to null and will not be counted in the sum
   // of total operational hours
-  memfault_metrics_heartbeat_set_unsigned(
-    MEMFAULT_METRICS_KEY(MemfaultSdkMetric_UnexpectedRebootDidOccur), 0);
+  MEMFAULT_HEARTBEAT_SET_UNSIGNED(MemfaultSdkMetric_UnexpectedRebootDidOccur, 0);
 }
 
 static void prv_heartbeat_timer_update(void) {
@@ -869,8 +868,8 @@ static int prv_init_unexpected_reboot_metric(void) {
     return -1;
   }
 
-  return memfault_metrics_heartbeat_set_unsigned(
-    MEMFAULT_METRICS_KEY(MemfaultSdkMetric_UnexpectedRebootDidOccur), unexpected_reboot ? 1 : 0);
+  return MEMFAULT_HEARTBEAT_SET_UNSIGNED(MemfaultSdkMetric_UnexpectedRebootDidOccur,
+                                         unexpected_reboot ? 1 : 0);
 }
 
 int memfault_metrics_boot(const sMemfaultEventStorageImpl *storage_impl,
@@ -893,14 +892,13 @@ int memfault_metrics_boot(const sMemfaultEventStorageImpl *storage_impl,
     return MEMFAULT_METRICS_STORAGE_TOO_SMALL;
   }
 
-  int rv = memfault_metrics_heartbeat_timer_start(
-      MEMFAULT_METRICS_KEY(MemfaultSdkMetric_IntervalMs));
+  int rv = MEMFAULT_HEARTBEAT_TIMER_START(MemfaultSdkMetric_IntervalMs);
   if (rv != 0) {
     return rv;
   }
 
-  rv = memfault_metrics_heartbeat_set_unsigned(
-      MEMFAULT_METRICS_KEY(MemfaultSdkMetric_UnexpectedRebootCount), info->unexpected_reboot_count);
+  rv = MEMFAULT_HEARTBEAT_SET_UNSIGNED(MemfaultSdkMetric_UnexpectedRebootCount,
+                                       info->unexpected_reboot_count);
   if (rv != 0) {
     return rv;
   }

examples/esp32/apps/memfault_demo_app/main/app_memfault_transport_mqtt.c

@@ -59,7 +59,7 @@ static void prv_close_client(void) {
   if (rv) {
     ESP_LOGW(TAG, "Failed to destroy client[%d]", rv);
   }
-  memfault_metrics_heartbeat_timer_stop(MEMFAULT_METRICS_KEY(mqtt_conn_uptime));
+  MEMFAULT_HEARTBEAT_TIMER_STOP(mqtt_conn_uptime);
 
   s_mqtt_client = NULL;
 }
@@ -91,14 +91,14 @@ static int prv_create_client(void) {
   rv = xSemaphoreTake(s_mqtt_connected, (1000 * 10) / portTICK_PERIOD_MS);
   if (rv != pdTRUE) {
     ESP_LOGE(TAG, "MQTT client failed to connect[%d]", rv);
-    memfault_metrics_heartbeat_timer_start(MEMFAULT_METRICS_KEY(mqtt_conn_downtime));
+    MEMFAULT_HEARTBEAT_TIMER_START(mqtt_conn_downtime);
     prv_close_client();
     return -1;
   }
 
   // Update connection metrics when connected
-  memfault_metrics_heartbeat_timer_stop(MEMFAULT_METRICS_KEY(mqtt_conn_downtime));
-  memfault_metrics_heartbeat_timer_start(MEMFAULT_METRICS_KEY(mqtt_conn_uptime));
+  MEMFAULT_HEARTBEAT_TIMER_STOP(mqtt_conn_downtime);
+  MEMFAULT_HEARTBEAT_TIMER_START(mqtt_conn_uptime);
 
   // Set topic alias before publishing
   rv = esp_mqtt5_client_set_publish_property(s_mqtt_client, &s_publish_property);
@@ -161,8 +161,8 @@ int app_memfault_transport_send_chunks(void) {
       break;
     }
 
-    memfault_metrics_heartbeat_add(MEMFAULT_METRICS_KEY(mqtt_publish_bytes), chunk_size);
-    memfault_metrics_heartbeat_add(MEMFAULT_METRICS_KEY(mqtt_publish_count), 1);
+    MEMFAULT_HEARTBEAT_ADD(mqtt_publish_bytes, chunk_size);
+    MEMFAULT_HEARTBEAT_ADD(mqtt_publish_count, 1);
     ESP_LOGD(TAG, "chunk[%d], len[%zu] published to %s", rv, chunk_size, s_topic_string);
   }
 

examples/esp32/apps/memfault_demo_app/main/console_example_main.c

@@ -232,7 +232,7 @@ static void prv_poster_task(void *args) {
 
   while (true) {
     // count the number of times this task has run
-    memfault_metrics_heartbeat_add(MEMFAULT_METRICS_KEY(PosterTaskNumSchedules), 1);
+    MEMFAULT_HEARTBEAT_ADD(PosterTaskNumSchedules, 1);
     // attempt to autojoin wifi, if configured
     memfault_esp_port_wifi_autojoin();
 

examples/freertos/Makefile

@@ -61,19 +61,24 @@ FREERTOS_SRCS = \
 
 # Add application sources
 SRCS += \
-	main.c \
-	compact_log.cpp \
+	src/main.c \
+	src/compact_log.cpp \
+	src/console.c \
+	src/heap_task.c \
+	src/metrics.c \
+	src/memfault/memfault_platform_port.c \
 	$(BOARD_DIR)/startup.c \
-	console.c \
 	$(BOARD_DIR)/memfault_platform_impl.c \
-	memfault/memfault_platform_port.c \
 	$(FREERTOS_SRCS) \
 
 # Use Memfault SDK worker to gather initial Memfault SDK sources and include dirs
 MEMFAULT_SDK_ROOT := ../..
-MEMFAULT_COMPONENTS := core util panics metrics demo
+MEMFAULT_COMPONENTS ?= core util panics metrics demo
 include $(MEMFAULT_SDK_ROOT)/makefiles/MemfaultWorker.mk
 
+# Add CFLAGS defines for each of the memfault components enabled above
+CFLAGS += $(foreach each, $(MEMFAULT_COMPONENTS), -DMEMFAULT_COMPONENT_$(each)_)
+
 # Add additional SDK sources to project for FreeRTOS and RAM-backed coredump.
 # Intentionally using a wildcard to trap any new features added- it's nice to
 # have them enabled in this example app.
@@ -88,7 +93,8 @@ OBJS := $(subst $(MEMFAULT_SDK_ROOT),memfault-firmware-sdk,$(SRCS:%=$(BUILD_DIR)
 INCLUDE_PATHS += \
   -I$(FREERTOS_DIR)/include \
   -I. \
-  -I./memfault \
+  -Isrc \
+  -Isrc/memfault \
   -I$(MEMFAULT_COMPONENTS_INC_FOLDERS) \
   -I$(MEMFAULT_SDK_ROOT)/ports/include \
   -I$(MEMFAULT_SDK_ROOT) \