rtic/examples/esp32c3/README.md

52 lines
1.6 KiB
Markdown
Raw Normal View History

### 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
Uncomment the
```runner = "espflash flash --monitor"```
line in ``.cargo/config.toml``
and comment out (or remove)
```runner = "./runner.sh"```
Now, running
```cargo run --example sw_and_hw --features=riscv-esp32c3-backend (--release)```
in the root of this crate should do the trick.
# Expected behavior
The example ``sw_and_hw``
- 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``
The example ``monotonic``
- Prints ``init``
- Spawns the ``foo``, ``bar``, ``baz`` tasks (because of hardware interrupt latency dispatch, the order here may vary).
- Each task prints ``hello from $TASK`` on entry
- The tasks wait for 1, 2, 3 seconds respectively
- Once the wait period is over, each task exits printing ``bye from $TASK`` (now in the proper order).