aboutsummaryrefslogtreecommitdiff
path: root/examples/stm32f411_rtc_interrupt/README.md
diff options
context:
space:
mode:
authorGravatar Milton Eduardo Sosa <31409391+snorkman88@users.noreply.github.com> 2023-12-04 17:19:24 +0000
committerGravatar GitHub <noreply@github.com> 2023-12-04 17:19:24 +0000
commit207f7dba4872f5f12cba5c0ce77caa0b4fde3eee (patch)
treeb051bebbe32dc6a79c8ff2c8155b4a72a823b644 /examples/stm32f411_rtc_interrupt/README.md
parent21191e1b234c9e62cc234ddb7cbe32e5f79671eb (diff)
downloadrtic-207f7dba4872f5f12cba5c0ce77caa0b4fde3eee.tar.gz
rtic-207f7dba4872f5f12cba5c0ce77caa0b4fde3eee.tar.zst
rtic-207f7dba4872f5f12cba5c0ce77caa0b4fde3eee.zip
Add RTC interrupt example for stm32f411 (#853)
* Add RTC example for stm32f411 * Remove svd file --------- Co-authored-by: Milton Eduardo Sosa <milton.eduardo.sosa@gmail.com, milton@switch-ev.com>
Diffstat (limited to '')
-rw-r--r--examples/stm32f411_rtc_interrupt/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/examples/stm32f411_rtc_interrupt/README.md b/examples/stm32f411_rtc_interrupt/README.md
new file mode 100644
index 00000000..55b7a7d6
--- /dev/null
+++ b/examples/stm32f411_rtc_interrupt/README.md
@@ -0,0 +1,12 @@
+# STM32F411CEU6 RTC interrup example
+
+Working example to configure the internal RTC of the STM32F411CEU6 present on the Blackpill board.
+After configured, it will listen to periodic wake-up interrupts happening every 10 seconds until the button on GPIO PA0 is pressed.
+
+## How-to
+
+### Build
+Run `cargo +nightly build` to compile the code. If you run it for the first time, it will take some time to download and compile dependencies.
+
+### Run
+Install `probe-rs` and configure it using the [debugging extension for VScode](https://probe.rs/docs/tools/debugger/).