Merge pull request #4806 from xoviat/frontpage

doc: use frontpage example

Author: lulf

docs/examples/basic/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 authors = ["Dario Nieuwenhuis <[email protected]>"]
-edition = "2018"
+edition = "2024"
 name = "embassy-basic-example"
 version = "0.1.0"
 license = "MIT OR Apache-2.0"

docs/examples/basic/src/main.rs

@@ -3,24 +3,41 @@
 
 use defmt::*;
 use embassy_executor::Spawner;
-use embassy_nrf::gpio::{Level, Output, OutputDrive};
-use embassy_time::{Duration, Timer};
-use {defmt_rtt as _, panic_probe as _}; // global logger
+use embassy_nrf::Peri;
+use embassy_nrf::gpio::{AnyPin, Input, Level, Output, OutputDrive, Pull};
+use embassy_time::Timer;
+use {defmt_rtt as _, panic_probe as _};
 
+// Declare async tasks
 #[embassy_executor::task]
-async fn blinker(mut led: Output<'static>, interval: Duration) {
+async fn blink(pin: Peri<'static, AnyPin>) {
+    let mut led = Output::new(pin, Level::Low, OutputDrive::Standard);
+
     loop {
+        // Timekeeping is globally available, no need to mess with hardware timers.
         led.set_high();
-        Timer::after(interval).await;
+        Timer::after_millis(150).await;
         led.set_low();
-        Timer::after(interval).await;
+        Timer::after_millis(150).await;
     }
 }
 
+// Main is itself an async task as well.
 #[embassy_executor::main]
 async fn main(spawner: Spawner) {
+    // Initialize the embassy-nrf HAL.
     let p = embassy_nrf::init(Default::default());
 
-    let led = Output::new(p.P0_13, Level::Low, OutputDrive::Standard);
-    spawner.spawn(unwrap!(blinker(led, Duration::from_millis(300))));
+    // Spawned tasks run in the background, concurrently.
+    spawner.spawn(blink(p.P0_13.into()).unwrap());
+
+    let mut button = Input::new(p.P0_11, Pull::Up);
+    loop {
+        // Asynchronously wait for GPIO events, allowing other tasks
+        // to run, or the core to sleep.
+        button.wait_for_low().await;
+        info!("Button pressed!");
+        button.wait_for_high().await;
+        info!("Button released!");
+    }
 }