Skip to content

Commit 9104a2a

Browse files
committed
update readme
1 parent ee9ce72 commit 9104a2a

File tree

1 file changed

+72
-0
lines changed

1 file changed

+72
-0
lines changed

README.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,75 @@ This repository contains tooling for building sample firmware images for
44
nRF-Connect SDK quickstart. See more here:
55

66
https://docs.memfault.com/docs/category/quickstart
7+
8+
## Using the Payloads
9+
10+
Find the latest release
11+
[here](https://github.com/memfault/memfault-ncs-quickstart-fw/releases/latest).
12+
Download the ZIP file for your board and extract it. You should find two folders
13+
inside, `0.0.1` and `0.0.2`, each containing assets for that firmware version.
14+
15+
1. Flash the `0.0.1` image to your board using `nrfutil` or the nRF Connect
16+
Programmer app. Note: flashing the `nrf54h20dk` is different, you'll need to
17+
flash the 4 hex files separately.
18+
19+
```bash
20+
nrfutil device program --options chip_erase_mode=ERASE_ALL,reset=RESET_DEFAULT --firmware <path-to-extracted-folder>/0.0.1/merged.hex
21+
```
22+
23+
2. Write the Memfault Project Key to the device: go to
24+
https://app.memfault.com/organizations/-/projects/-/settings and copy the
25+
project key. Then, use a serial terminal to connect to the board's virtual
26+
COM port (baud rate 115200), and use this command to set the project key:
27+
28+
```bash
29+
uart:~$ config set_project_key <project-key>
30+
Memfault project key saved to settings successfully
31+
```
32+
33+
3. Create a `0.0.2` release in Memfault
34+
[here](https://app.memfault.com/organizations/-/projects/-/releases?new), and
35+
add the `0.0.2` payload:
36+
37+
- Name the release `0.0.2`
38+
- When adding the payload ("Add OTA Payload to Release"):
39+
- Hardware Version: this is the board name, eg `nrf54l15`. Use `mflt
40+
get_device_info` in the serial terminal to confirm the value to use here:
41+
42+
```bash
43+
uart:~$ mflt get_device_info
44+
[00:44:37.079,012] <inf> mflt: S/N: 59699E41B038
45+
[00:44:37.079,045] <inf> mflt: SW type: app
46+
[00:44:37.079,068] <inf> mflt: SW version: 0.0.1
47+
[00:44:37.079,103] <inf> mflt: HW version: nrf54l15dk
48+
```
49+
50+
- Software Type: `app`
51+
- The payload file to upload is `<path-to-extracted-folder>/0.0.2/dfu_application.zip`
52+
53+
4. Deploy the release to the `default` cohort
54+
[here](https://app.memfault.com/organizations/-/projects/-/cohorts).
55+
56+
5. Install the nRF Connect Device Manager iOS or Android app:
57+
58+
- 🍎 [iOS - Apple App Store](https://apps.apple.com/no/app/nrf-connect-device-manager/id1519423539)
59+
60+
![iOS QR Code](https://qr-generator.noahp.workers.dev/?url=https://apps.apple.com/no/app/nrf-connect-device-manager/id1519423539)
61+
62+
- 🤖 [Android - Google Play Store](https://play.google.com/store/apps/details?id=no.nordicsemi.android.nrfconnectdevicemanager)
63+
64+
![Android QR Code](https://qr-generator.noahp.workers.dev/?url=https://play.google.com/store/apps/details?id=no.nordicsemi.android.nrfconnectdevicemanager)
65+
66+
6. Use the nRF Connect Device Manager app to scan for and connect to your
67+
device. Use the "Image" tab on the device page, select "Check for Update",
68+
and "Download" to download the FOTA package.
69+
70+
7. Once the download is complete, select "Start", "Confirm only" to install the
71+
update. The app will upload the new image to the device, and it will restart.
72+
You can see the new image version printed in the serial console when the
73+
device restarts:
74+
75+
```bash
76+
I: Image version: v0.0.2
77+
*** Booting My Application v0.0.2-fd967e4ec918 ***
78+
```

0 commit comments

Comments
 (0)