aboutsummaryrefslogtreecommitdiff
path: root/examples/esp32c3/README.md
diff options
context:
space:
mode:
authoronsdagens <112828711+onsdagens@users.noreply.github.com>2024-04-04 11:35:41 +0200
committerGitHub <noreply@github.com>2024-04-04 09:35:41 +0000
commit906278e31026df8874b1b1593af8f92ce6d7e247 (patch)
treed77ade2744c2c13d2706831236e7904ffd183435 /examples/esp32c3/README.md
parent53ed7bf7edb21180cb18c0bf6a7dbe6168331879 (diff)
Adjust esp32c3 codegen, bump pac to 0.21.0 (#906)
* adjust esp32c3 codegen, bump pac to 0.21.0 * add esp32c3 example * adjust workflow flags * CI: Fix esp32c3 comment * esp32c3: Remove commented out git-dep * CI: Actually check the ESP32-C3 examples * Autoformat rtic/cargo.toml --------- Co-authored-by: Henrik Tjäder <henrik@tjaders.com>
Diffstat (limited to 'examples/esp32c3/README.md')
-rw-r--r--examples/esp32c3/README.md33
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``
+