Skip to content

Commit 93bf693

Browse files
committed
Update README.md
1 parent ead7113 commit 93bf693

File tree

1 file changed

+48
-1
lines changed

1 file changed

+48
-1
lines changed

README.md

Lines changed: 48 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,50 @@
11
# Platformio project for an ESP32 using ESP-IDF
22

3-
Under construction!
3+
This is a sample project for integrating Memfault with a PlatformIO project using the ESP-IDF framework.
4+
5+
## Setup
6+
7+
1. Install PlatformIO CLI using the instructions [here](https://docs.platformio.org/en/latest//core/installation.html#super-quick-mac-linux).
8+
9+
2. Initialize Memfault submodule:
10+
11+
```bash
12+
git submodule update --init
13+
```
14+
15+
3. Activate the PlatformIO virtual env
16+
17+
```bash
18+
source ~/.platformio/penv/bin/activate
19+
```
20+
21+
4. Install Memfault's dependencies
22+
23+
```bash
24+
pip install -r src/memfault/memfault-firmware-sdk/requirements.txt
25+
pip install memfault-cli
26+
```
27+
28+
## Testing
29+
30+
1. Build with the platformio CLI:
31+
32+
```bash
33+
pio run
34+
```
35+
36+
2. Upload the symbol file to Memfault:
37+
38+
```bash
39+
memfault \
40+
--org-token $MEMFAULT_AUTH_TOKEN \
41+
--org $MEMFAULT_ORG_SLUG \
42+
--project $MEMFAULT_PROJECT_SLUG \
43+
upload-mcu-symbols .pio/build/espidf/firmware.elf
44+
```
45+
46+
3. Flash the device and start the serial monitor
47+
48+
```bash
49+
pio run --target upload --target monitor
50+
```

0 commit comments

Comments
 (0)