From 491ef3ce09ca8946b6daae810ef1b838bc939a0e Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Tue, 21 Dec 2021 00:06:50 +0100 Subject: [PATCH] update example documentation --- examples/uart-irq-rtic.rs | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/examples/uart-irq-rtic.rs b/examples/uart-irq-rtic.rs index cf16b7a..a67989c 100644 --- a/examples/uart-irq-rtic.rs +++ b/examples/uart-irq-rtic.rs @@ -1,5 +1,12 @@ -//! UART example application. Sends a test string over a UART and then enters -//! echo mode +//! More complex UART application +//! +//! Uses the IRQ capabilities of the VA10820 peripheral and the RTIC framework to poll the UART in +//! a non-blocking way. You can send variably sized strings to the VA10820 which will be echoed +//! back to the sender. +//! +//! This script was tested with an Arduino Due. You can find the test script in the +//! [`/test/DueSerialTest`](https://egit.irs.uni-stuttgart.de/rust/va108xx-hal/src/branch/main/test/DueSerialTest) +//! folder, #![no_main] #![no_std]