Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nordicsemiconductor/asset-tracker-cloud-memfault-aws-js

Memfault integration for AWS IoT developed using AWS CDK in TypeScript.
https://github.com/nordicsemiconductor/asset-tracker-cloud-memfault-aws-js

aws cdk iot memfault nrf-asset-tracker

Last synced: about 1 month ago
JSON representation

Memfault integration for AWS IoT developed using AWS CDK in TypeScript.

Awesome Lists containing this project

README 

        
> [!NOTE]  

>

> This repository has been archived, because [it is considered feature-complete](https://github.com/NordicSemiconductor/asset-tracker-cloud-docs/discussions/1068). ✔️ 



# Memfault integration for AWS IoT



[![GitHub Actions](https://github.com/NordicSemiconductor/asset-tracker-cloud-memfault-aws-js/workflows/Test%20and%20Release/badge.svg)](https://github.com/NordicSemiconductor/asset-tracker-cloud-memfault-aws-js/actions)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

[![Renovate](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com)

[![@commitlint/config-conventional](https://img.shields.io/badge/%40commitlint-config--conventional-brightgreen)](https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-conventional)

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier/)

[![ESLint: TypeScript](https://img.shields.io/badge/ESLint-TypeScript-blue.svg)](https://github.com/typescript-eslint/typescript-eslint)



Memfault integration for AWS IoT developed using AWS CDK in

[TypeScript](https://www.typescriptlang.org/).



### Device information



Meta information about devices is populated by cloud when devices report their

values



- board type

  ([`hardware_version`](https://api-docs.memfault.com/#f2acc282-23f9-409b-a99b-41da759b82f9))

  is inferred cloud side from

  [`dev.v.brdV`](https://github.com/NordicSemiconductor/asset-tracker-cloud-docs/blob/84da0a8c790bb789dfbcf43050be4cb5f0e65171/docs/cloud-protocol/state.reported.schema.json#L139-L144)

  Thing shadow property.

- [`nickname`](https://api-docs.memfault.com/#f2acc282-23f9-409b-a99b-41da759b82f9)

  is inferred from the user's name setting for the device using the `name` Thing

  attribute.



### Chunks



The Memfault SDK

[packages the data from all modules in _chunks_](https://docs.memfault.com/docs/mcu/data-from-firmware-to-the-cloud/).

They are received via MQTT and forwared to the Memfault chunks API.



Memfault embeds offset information in each chunk so they can re-assemble data

that arrives out of order, so there is no need to buffer the chunks on the

cloudside.



Devices publish the chunks via MQTT to a configurable topic. Right now the

`asset_tracker_v2`

[uses `/memfault/`](https://github.com/nrfconnect/sdk-nrf/blob/5ed65dc037426206b103cc7ce3274de98b6cc93d/applications/asset_tracker_v2/src/cloud/aws_iot_integration.c#L35-L38),

however `deviceId` and `Memfault project key` are superfluous because they can

be inferred on the cloud side from the MQTT connection.



To support devices publishing to a MQTT topic named `memfault` directly, the

Memfault project key

[needed for chunks API](https://api-docs.memfault.com/#a8d3e36f-62f0-4120-9fc6-544ee04f3bb5)

is stored on the cloud side in an SSM parameter.



This also allows for changing the project key on the fly if needed without

needing deploy a new firmware to devices. However, note that the project key is

not a secret and does not need rotation.



It is also useful to have the Memfault project key on the device to directly

publish to the Memfault HTTP API to be able to debug problems with the MQTT

connections.



This can however also be solved by setting up an API endpoint the accepts

requests signed with JWT tokens created using the devices keypair. This would

allow to remove the Memfault project key entirely from the firmware. Right now

however this is not supported in nRF Connect SDK. Please reach out if you would

like to see this feature.



## Installation in your AWS account



### Setup



[Provide your AWS credentials](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-authentication.html).



Install `zip`.



Install the dependencies:



    npm ci



Optionally,

[enable `THING` events](https://docs.aws.amazon.com/iot/latest/developerguide/iot-events.html#iot-events-enable)

for your AWS IoT Hub to automatically sync your devices' `name` attribute with

the Memfault device `nickname` property.



### Deploy



    npx cdk deploy



## Configure memfault settings



You can retrieve the project settings from the settings page of the Memfault

dashboard of your organization.



    aws ssm put-parameter --type String --name /${STACK_NAME:-nrf-memfault}/thirdParty/memfault/projectKey --value 

    aws ssm put-parameter --type String --name /${STACK_NAME:-nrf-memfault}/thirdParty/memfault/organization --value 

    aws ssm put-parameter --type String --name /${STACK_NAME:-nrf-memfault}/thirdParty/memfault/project --value 



The organization auth token can be accessed and managed by Administrators at

Admin → Organization Auth Tokens in the Memfault UI.



    aws ssm put-parameter --type String --name /${STACK_NAME:-nrf-memfault}/thirdParty/memfault/authToken --value 



## Configure stack settings



The topic devices use to publish Memfault chunks can be configured through the

[CDK context variable](https://docs.aws.amazon.com/cdk/v2/guide/context.html)

`memfaultTopic`. It defaults to `+/memfault/#`.