Rugix: Quickstart Template for Memfault

This template showcases how to set up a Rugix project for use with Memfault.

Check out the corresponding Interrupt article to find out more.

Usage

Setup

Install just to be able to use the Justfile.

Copy the file env.template to .env and set the following variables:

• MEMFAULT_PROJECT_KEY: Memfault project key for inclusion in the system.
• DEV_SSH_KEYS: Public SSH keys for connecting via SSH to the system.

If you want to be able to upload OTA updates, also set the following variables:

• MEMFAULT_ORG_SLUG: Slug of your Memfault organization.
• MEMFAULT_ORG_TOKEN: Access token for your Memfault organization.
• MEMFAULT_PROJECT_SLUG: Project to upload OTA updates to.

Tasks

Running a VM

To run a VM based on the customized-efi-arm64 system:

just run

Connect to VM via SSH

To connect to a running VM via SSH:

just ssh

Note that this requires DEV_SSH_KEYS to be set appropriately.

Building an Image and Bundle

To build an image and an update bundle for a given system:

just build <system> [--without-compression]

Use --without-compression to speed up the build.

Upload an OTA Payload

To upload the update bundle as a Memfault OTA payload:

just upload <system>

Updating via OTA

The template uses Rugix Ctrl >=1.0. Part of the update includes the update being signed, or a hash being provided. Using the -h flag with memfault-ota-rugix and providing the generated hash at the end of a bake job will allow checking a hash for testing purposes. This should look something like (with hash sha5120256:<SOME_HASH>):

INFO Creating bundle, this may take a while...
sha512-256:<SOME_HASH>

It can also be found at build/<system>/system.rugixb-hash.

Please check the Rugix documentation for signed updates to determine the best option for rolling out updates with Rugix's mandatory package verification.

Support

This repository is covered by Tier 3: Example Integration of the Rugix Support Commitment.