Memfault Firmware SDK 0.34.0 (Build 320)

Author: Memfault Inc

.cyignore

@@ -6,6 +6,7 @@ ports/dialog
 ports/emlib
 ports/esp8266_sdk
 ports/esp_idf
+ports/mbedtls
 ports/mynewt
 ports/nrf5_sdk
 ports/nxp

.gitignore

@@ -1,2 +1,4 @@
 build
+/examples/mbedtls
+/examples/modus
 __pycache__/

CHANGES.md

@@ -1,3 +1,34 @@
+### Changes between Memfault SDK 0.34.0 and SDK 0.33.5 - Nov 1, 2022
+
+#### :chart_with_upwards_trend: Improvements
+
+- Misc ESP32 [port](ports/esp_idf) &
+  [example app](examples/esp32/apps/memfault_demo_app) improvements
+  - Added diagnostic print line containing Build Id at boot up
+  - Improved messaging displayed when using `memfault_ota_check` test command
+  - Example app now prints device info on bootup
+  - Fix an issue where incremental build (`idf.py build && idf.py build`) would
+    report a nuisance failure.
+  - Flatten + simplify the directory structure of the QEMU based example project
+- A new [`ports/mbedtls`](ports/mbedtls) is available, which implements a basic
+  Mbed TLS client for performing Memfault data upload.
+- Zephyr: Collect sysheap stats using the
+  [Memfault Heap Tracking](https://mflt.io/mcu-heap-stats) component. This is
+  configured with the `CONFIG_MEMFAULT_HEAP_STATS` Kconfig option (enabled by
+  default), and will track allocations done with `k_malloc()`.
+- Fix an enum-mismatch warning in `memfault_metrics.c` when using the ARMCC v5
+  compiler.
+
+#### :boom: Breaking Changes
+
+- If you are using the ESP32 HTTP Client, the Memfault Project Key is now
+  configured directly via the
+  [ESP32 Project Configuration System](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/kconfig.html).
+  You need to do the following:
+  1. Remove the `g_mflt_http_client_config` in your platform port
+  2. Add `CONFIG_MEMFAULT_PROJECT_KEY="YOUR_PROJECT_KEY"` to your projects
+     `sdkconfig.defaults`
+
 ### Changes between Memfault SDK 0.33.4 and SDK 0.33.5 - Oct 19, 2022
 
 #### :chart_with_upwards_trend: Improvements

VERSION

@@ -1,2 +1,2 @@
-BUILD ID: 161
-GIT COMMIT: d4c377659
+BUILD ID: 320
+GIT COMMIT: 0b70734d8

components/include/memfault/metrics/metrics.h

@@ -185,6 +185,15 @@ int memfault_metrics_heartbeat_read_signed(MemfaultMetricId key, int32_t *read_v
 int memfault_metrics_heartbeat_timer_read(MemfaultMetricId key, uint32_t *read_val);
 int memfault_metrics_heartbeat_read_string(MemfaultMetricId key, char *read_val, size_t read_val_len);
 
+//! Collect built-in metrics as part of default ports in memfault-firmware-sdk.
+//!
+//! It can (optionally) be overridden by a port to collect a set of built-in metrics
+//! as configured by the port/application.
+//!
+//! @note By default, a weak version of this function is implemented which is empty
+//! @note This API is for internal use only and should never be called by an end user
+void memfault_metrics_heartbeat_collect_sdk_data(void);
+
 #ifdef __cplusplus
 }
 #endif

components/include/memfault/version.h

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

components/metrics/src/memfault_metrics.c

@@ -156,7 +156,7 @@ typedef enum MfltMetricStringKeyToIndex {
 // Now generate a table mapping the canonical key ID to the index in s_memfault_heartbeat_values
 static const eMfltMetricStringKeyToIndex s_memfault_heartbeat_string_key_to_index[] = {
   #define MEMFAULT_METRICS_KEY_DEFINE(key_name, value_type) \
-    0,  // 0 for the placeholder so it's safe to index with
+    (eMfltMetricStringKeyToIndex)0,  // 0 for the placeholder so it's safe to index with
   #define MEMFAULT_METRICS_STRING_KEY_DEFINE(key_name, max_length) \
     kMfltMetricStringKeyToIndex_##key_name,
 
@@ -260,6 +260,8 @@ static struct {
 MEMFAULT_WEAK
 void memfault_metrics_heartbeat_collect_data(void) { }
 
+MEMFAULT_WEAK
+void memfault_metrics_heartbeat_collect_sdk_data(void) { }
 
 // Returns NULL if not a timer type or out of bounds index.
 static sMemfaultMetricValueMetadata *prv_find_timer_metadatap(eMfltMetricsIndex metric_index) {
@@ -532,6 +534,7 @@ static void prv_heartbeat_timer_update(void) {
 //! Trigger an update of heartbeat metrics, serialize out to storage, and reset.
 static void prv_heartbeat_timer(void) {
   prv_heartbeat_timer_update();
+  memfault_metrics_heartbeat_collect_sdk_data();
   memfault_metrics_heartbeat_collect_data();
 
   memfault_metrics_heartbeat_serialize(s_memfault_metrics_ctx.storage_impl);

examples/esp32/README.md

@@ -74,7 +74,27 @@ We assume you have a working setup for the
 
 That's it! You should be good to go!
 
-### Building the demo app:
+### Memfault Project Key
+
+An API key will need to be configured for Memfault HTTP client to communicate
+with Memfault's web services. Go to https://app.memfault.com/, navigate to the
+project you want to use and select 'Settings'. Copy the 'Project Key', and
+configure it; either by running `idf.py menuconfig` and setting the
+`MEMFAULT_PROJECT_KEY` config value, or by inserting to `sdkconfig.defaults`:
+
+```kconfig
+CONFIG_MEMFAULT_PROJECT_KEY="<YOUR PROJECT KEY>"
+```
+
+> Note: when doing a clean build, or a build in CI, another option is to place
+> the Project Key in a second `sdkconfig.defaults` file, for example:
+>
+> ```bash
+> ❯ echo CONFIG_MEMFAULT_PROJECT_KEY=\"<YOUR PROJECT KEY>\" > sdkconfig.extra
+> ❯ idf.py build -DSDKCONFIG_DEFAULTS="sdkconfig.defaults;sdkconfig.extra"
+> ```
+
+### Building the demo app
 
 using pyinvoke:
 
@@ -183,8 +203,13 @@ I (77840) mflt: Has coredump with size: 768
 #### Uploading Symbols
 
 Memfault needs the symbols for the firmware in order to analyze the coredump.
-The ESP32 SDK demo app symbol file can be found at:
-`/path/to/examples/esp32/apps/memfault_demo_app/build/memfault-esp32-demo-app.elf`
+The ESP32 SDK demo app symbol file can be found in the build folder:
+
+`apps/memfault_demo_app/build/memfault-esp32-demo-app.elf.memfault_log_fmt`
+
+> Note: the file to be uploaded is
+> `memfault-esp32-demo-app.elf.memfault_log_fmt`, _not_
+> `memfault-esp32-demo-app.elf`, when using compact logs!
 
 This ELF file contains the symbols (debug information) amongst other things.
 

examples/esp32/apps/memfault_demo_app/.gitignore

@@ -0,0 +1,3 @@
+/sdkconfig
+/sdkconfig.extra
+/sdkconfig.old

examples/esp32/apps/memfault_demo_app/CMakeLists.txt

@@ -21,15 +21,9 @@ add_custom_command(TARGET ${IDF_PROJECT_EXECUTABLE}
   # Compute and insert the build id
   COMMAND python ${memfault_firmare_sdk_dir}/scripts/fw_build_id.py ${IDF_PROJECT_EXECUTABLE}
   # Save a copy of the ELF that includes the 'log_fmt' section
-  COMMAND ${CMAKE_COMMAND} -E copy ${IDF_PROJECT_EXECUTABLE} ${IDF_PROJECT_EXECUTABLE}.memfault
+  BYPRODUCTS ${IDF_PROJECT_EXECUTABLE}.memfault_log_fmt
+  COMMAND ${CMAKE_COMMAND} -E copy ${IDF_PROJECT_EXECUTABLE} ${IDF_PROJECT_EXECUTABLE}.memfault_log_fmt
+  COMMAND ${CMAKE_COMMAND} -E echo "*** NOTE: the symbol file to upload to app.memfault.com is ${IDF_PROJECT_EXECUTABLE}.memfault_log_fmt ***"
   # Remove the 'log_fmt' compact log section, which confuses elf2image
   COMMAND ${CMAKE_OBJCOPY} --remove-section log_fmt ${IDF_PROJECT_EXECUTABLE}
 )
-
-# Add a custom target to swap over the stashed complete elf above after
-# elf2image runs
-add_custom_target(swap_original_memfault_elf ALL
-  COMMAND ${CMAKE_COMMAND} -E rename ${IDF_PROJECT_EXECUTABLE}.memfault ${IDF_PROJECT_EXECUTABLE}
-  DEPENDS app
-  COMMENT "Copy over original ELF for Memfault uploading"
-)