https://github.com/memfault/memfault-golioth-example
https://github.com/memfault/memfault-golioth-example
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/memfault/memfault-golioth-example
- Owner: memfault
- License: apache-2.0
- Created: 2024-06-17T16:55:05.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-07-07T19:56:49.000Z (11 months ago)
- Last Synced: 2025-07-07T23:17:27.727Z (11 months ago)
- Language: C
- Size: 41 KB
- Stars: 3
- Watchers: 12
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Golioth + Memfault Example
## Overview
This application demonstrates how to use the [Golioth Firmware
SDK](https://github.com/golioth/golioth-firmware-sdk) and [Golioth
Pipelines](https://docs.golioth.io/data-routing) to send observability data from
the [Memfault SDK](https://github.com/memfault/memfault-firmware-sdk) to
Memfault's cloud.
## Pipelines Setup
This documentation assumes you already have accounts with both
[Golioth](https://console.golioth.io/) and
[Memfault](https://app.memfault.com/). The [`pipelne.yml`](pipipeline.yml) file
in this repository contains the source for a pipeline that routes data on the
`/mflt` path to Memfault. Click the link below to configure it into your Golioth
project.
> [!NOTE]
>
> Make sure to also create a
> [secret](https://docs.golioth.io/data-routing/secrets/) named
> `MEMFAULT_PROJECT_KEY` with your Memfault [project
> key](https://docs.memfault.com/docs/platform/data-routes/) to ensure that
> your pipeline is able to authenticate.
## Application Setup
This is a Zephyr application managed and built using `west`. To setup your
environment for building Zephyr apps, follow the [Getting Started guide](https://docs.zephyrproject.org/latest/getting_started/index.html).
Then you can setup your workspace to build this application by running one of
the following:
For vanilla Zephyr:
```bash
west init -m https://github.com/golioth/golioth-memfault-zephyr-example.git
```
For nRF Connect SDK (NCS):
```bash
west init -m https://github.com/golioth/golioth-memfault-zephyr-example.git --mf west-ncs.yml
```
To build the application (see below for a list of supported boards):
```bash
west build -p -b app
```
### Supported Boards
| Board Name | OS |
| --------------- | --------------- |
| esp32s3_devkitm | Zephyr |
| MIMXRT1024-EVK | Zephyr |
| nRF7002DK | nRF-Connect SDK |
| nRF9160DK | nRF-Connect SDK |
## Running the Application
First flash the application to the board:
```bash
west flash
```
Next, set Golioth credentials through the serial terminal:
```bash
settings set golioth/psk-id
settings set golioth/psk
```
If your device is WiFi connected, use the serial terminal to connect to a
network:
```bash
wifi connect
```
The application is configured to capture Memfault heartbeat metrics once per
hour. Also once per hour, the application will upload that data to Golioth,
where it will be routed to Memfault.
### Memfault CLI
To test the application, you can use the `mflt` menu in the serial console. E.g.:
To trigger a coredump via a hardfault:
```bash
mflt test hardfault
```
To force an immediate heartbeat recording:
```bash
mflt test heartbeat
```
### Golioth RPCs
The application registers several RPCs with Golioth that can be used for
testing and debugging.
- `coredump` - This will remotely trigger an assert on the device to force
collection of a coredump.
- `memfault_upload` - This will remotely trigger an immediate upload of
Memfault data.
## Contributing
Pull requests and issues can be submitted at
https://github.com/golioth/golioth-memfault-zephyr-example. Code changes will
be mirrored to https://github.com/memfault/memfault-golioth-example.
### Developer Certificate of Origin Process
This project will only accept contributions using the Developer’s Certificate of Origin 1.1 located
at https://developercertificate.org (“DCO”). The DCO is a legally binding statement asserting that
you are the creator of your contribution, or that you otherwise have the authority to distribute
the contribution, and that you are intentionally making the contribution available under the
license associated with the Project ("License").
You can agree to the DCO in your contribution by using a “Signed-off-by” line at the end of your
commit message. You should only submit a contribution if you are willing to agree to the DCO terms.
If you are willing, just add a line to the end of every git commit message:
```
Signed-off-by: Jane Smith
```