Overview

To use the memfault-firmware-sdk with mynewt add following lines to project.yml.

repository.memfault-firmware-sdk:
  type: github
  vers: 0.0.0
  user: memfault
  repo: memfault-firmware-sdk

Adding this dependency will allow you to pull in Memfault features

pkg.deps:
  - "@memfault-firmware-sdk/ports/mynewt"

You will also need to enable the following options in the syscfg.vals: section of your syscfg.yml file:

syscfg.vals:
[...]
    MEMFAULT_ENABLE: 1
    MEMFAULT_COREDUMP_CB: 1
    OS_COREDUMP: 1
    OS_COREDUMP_CB: 1

Other syscfgs you can configure can be found in syscfg.yml

Finally, on boot up initialize the Memfault subsystem from your main routine:

#include "memfault/components.h"

int
main(int argc, char **argv)
{
// ...

    memfault_platform_boot();
// ...
}

Using the GNU Build Id for Indexing

We recommend enabling the generation of a unique identifier for your project. See https://mflt.io/symbol-file-build-ids for more details.

To enable, add the following compilation flags to your pkg.yml:

pkg.lflags:
  - -Wl,--build-id
pkg.cflags:
  - -DMEMFAULT_USE_GNU_BUILD_ID=1

And add the following after the .text in your targets linker script:

    .note.gnu.build-id :
    {
        __start_gnu_build_id_start = .;
        KEEP(*(.note.gnu.build-id))
    } > FLASH

The Memfault demo shell commands can be included in the mynewt shell (useful for testing various Memfault features). To enable:

set MEMFAULT_CLI: 1 in the target's syscfg.yml.
enable the shell commands by calling mflt_shell_init() at the appropriate point in the application initialization (eg after sysinit()).