aboutsummaryrefslogtreecommitdiff
path: root/examples/esp32c6/README.md
diff options
context:
space:
mode:
authorWouter Geraedts <git@woutergeraedts.nl>2024-04-09 15:01:27 +0200
committerHenrik Tjäder <henrik@tjaders.com>2025-04-07 21:11:21 +0000
commitb97bc791260554edfd79dbd84c05815bef26b636 (patch)
treea0ba46cb89b1a86c545e1be3ad9312efd92a8046 /examples/esp32c6/README.md
parent5a8ff70f854c0d6fef3e5b7be12b750aab37b9f2 (diff)
Added esp32c6 support and example
Diffstat (limited to 'examples/esp32c6/README.md')
-rw-r--r--examples/esp32c6/README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/examples/esp32c6/README.md b/examples/esp32c6/README.md
new file mode 100644
index 0000000..ac57914
--- /dev/null
+++ b/examples/esp32c6/README.md
@@ -0,0 +1,33 @@
+### ESP32-C3 RTIC template
+This crate showcases a simple RTIC application for the ESP32-C6.
+
+## Prerequisites
+
+# Nightly Rust
+The ESP32-C6 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 riscv32imac-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-esp32c6-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``
+