Skip to content

Commit def6f55

Browse files
Update README.md
1 parent cd11316 commit def6f55

File tree

1 file changed

+24
-22
lines changed

1 file changed

+24
-22
lines changed

README.md

+24-22
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,17 @@ This will be a series of `embedded Rust tutorials` using the [Olimex ESP32-C3 De
44

55
We tutorial below has a `YouTube video` link where I will start with a blank project and implement a peripherals using the latest [esp-idf-hal](https://github.com/esp-rs/esp-idf-hal) version.
66

7-
## Tutorials
7+
## Project 0: Data Logger
8+
This inroductory project will cover basic peripheral usage for the ESP32-C3 to implement the following features:
9+
10+
- 4 ADC's
11+
- 16 Digital IO
12+
- SD card logging
13+
- UART CLI Shell
14+
- Neopixel status indicator
15+
- Unit tests
16+
17+
### Peripheral Tutorials
818
- [p0-output](https://youtu.be/vUSHaogHs1s): Make the "Hellow World" of embedded systems: a `Blinky application` to periodically turn an LED on and off
919
- [p1-input](https://youtu.be/2IY27b9TT2k): Add a button to turn the blinking logic on and off
1020
- [p2-threads](https://youtu.be/ht5t39dEa4E): Move the button logic and LED logic to their own thread and pass messages between threads with [crossbeams channel](https://docs.rs/crossbeam/latest/crossbeam/channel/index.html)
@@ -14,17 +24,6 @@ We tutorial below has a `YouTube video` link where I will start with a blank pro
1424
- [p6-spi](https://youtu.be/PUL8ehH6eUg): Write a string to a uSD card over SPI using [embedded-sdmmc](https://github.com/rust-embedded-community/embedded-sdmmc-rs) crate
1525
- [p7-uart](tbd): Receiver characters from the UART and send them back when we detect a [carriage return](https://developer.mozilla.org/en-US/docs/Glossary/CRLF)
1626

17-
18-
## Project 0: Data Logger Application
19-
This project will use the ESP32-C3 to gather analog and digital data.
20-
21-
- 4 ADC's
22-
- 16 Digital IO
23-
- SD card logging
24-
- UART CLI Shell
25-
- Neopixel status indicator
26-
27-
2827
<details>
2928
<summary>Development environment setup</summary>
3029

@@ -56,18 +55,21 @@ espmonitor /dev/ttyACM0
5655

5756
<details>
5857
<summary>Roadmap</summary>
59-
60-
- Logging (https://github.com/knurling-rs/defmt)
61-
- Debug project (https://github.com/knurling-rs/probe-run)
62-
- MQTT transfer
63-
- Pub/sub (https://github.com/jakmeier/nuts)
64-
- Timer to generate blinky
65-
- DMA
58+
59+
For the second project I'm thinking to add in more advanced features and ideas listed below. Any input is welcome.
60+
- Debugging
61+
- Logging
62+
- FSM/HSM
63+
- Wifi
64+
- MQTT
6665
- OTA
67-
- CLI
68-
- UART
69-
- Crash dumps and diagnostics
66+
- Pub/sub
67+
- Crash dumps & diagnostics
7068

69+
Other features I'd like to add but don't have a clear example for yet:
70+
- DMA
71+
- Timer usage
72+
7173
</details>
7274

7375

0 commit comments

Comments
 (0)