rmk 0.9.0

Keyboard firmware written in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

use embassy_time::{Duration, Timer};

use crate::core_traits::Runnable;

#[cfg(feature = "_esp_ble")]
mod esp32;
#[cfg(any(feature = "_nrf_ble", feature = "dfu_nrf"))]
#[cfg(not(any(feature = "nrf54l15_ble", feature = "nrf54lm20_ble")))]
mod nrf52;
#[cfg(feature = "rp2040")]
mod rp2040;

#[cfg(feature = "_esp_ble")]
pub use esp32::Esp32Watchdog;
#[cfg(any(feature = "_nrf_ble", feature = "dfu_nrf"))]
#[cfg(not(any(feature = "nrf54l15_ble", feature = "nrf54lm20_ble")))]
pub use nrf52::Nrf52Watchdog;
#[cfg(feature = "rp2040")]
pub use rp2040::Rp2040Watchdog;

/// Chip-agnostic watchdog feeding. Implement this for your platform's
/// watchdog peripheral, then pass it to [`WatchdogRunner`].
pub trait WatchdogFeed: Send {
    fn feed(&mut self);
}

/// A [`Runnable`] that periodically feeds a hardware watchdog.
///
/// Pass this to `run_all!` alongside your keyboard and matrix. Because
/// all runnables are joined cooperatively, a tight-loop stall in any
/// sibling task will block this runner too, letting the hardware
/// watchdog fire a reset.
pub struct WatchdogRunner<W: WatchdogFeed> {
    watchdog: W,
    interval: Duration,
}

impl<W: WatchdogFeed> WatchdogRunner<W> {
    pub fn new(watchdog: W, interval: Duration) -> Self {
        Self { watchdog, interval }
    }
}

impl<W: WatchdogFeed> Runnable for WatchdogRunner<W> {
    async fn run(&mut self) -> ! {
        loop {
            self.watchdog.feed();
            Timer::after(self.interval).await;
        }
    }
}