diff options
Diffstat (limited to 'examples/esp32c3/README.md')
| -rw-r--r-- | examples/esp32c3/README.md | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/examples/esp32c3/README.md b/examples/esp32c3/README.md new file mode 100644 index 0000000..37d0167 --- /dev/null +++ b/examples/esp32c3/README.md @@ -0,0 +1,33 @@ +### ESP32-C3 RTIC template +This crate showcases a simple RTIC application for the ESP32-C3. + +## Prerequisites + +# Nightly Rust +The ESP32-C3 HAL requires a nightly build of Rust. +Following the example of the (Espressif no_std book)[https://docs.esp-rs.org/no_std-training/02_2_software.html], we use this specific build: +```rustup toolchain install nightly-2023-11-14 --component rust-src --target riscv32imc-unknown-none-elf``` + +# Espressif toolchain + +This crate uses the most convenient option in ``cargo-espflash`` and ``espflash`` +```cargo install cargo-espflash espflash``` + +## Running the crate + +```cargo run --example sw_and_hw --features=riscv-esp32c3-backend (--release)``` + +should do the trick. + +# Expected behavior +The program +- Prints ``init`` +- Enters a high prio task +- During the execution of the high prio task, the button should be non-functional +- Pends a low prio task +- Exits the high prio task +- Enters the low prio task +- During the execution of the low prio task, the button should be functional. +- Exits the low prio task +- Prints ``idle`` + |