embedded-hal-async 1.0.0

An asynchronous Hardware Abstraction Layer (HAL) for embedded systems
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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

//! Asynchronous digital I/O.
//!
//! # Example
//!
//! ```rust
//! # use embedded_hal_async::digital::Wait;
//! /// Asynchronously wait until the `ready_pin` becomes high.
//! async fn wait_until_ready<P>(ready_pin: &mut P)
//! where
//!     P: Wait,
//! {
//!     ready_pin
//!         .wait_for_high()
//!         .await
//!         .expect("failed to await input pin")
//! }
//! ```

/// Asynchronously wait for GPIO pin state.
pub trait Wait: embedded_hal::digital::ErrorType {
    /// Wait until the pin is high. If it is already high, return immediately.
    ///
    /// # Note for implementers
    /// The pin may have switched back to low before the task was run after
    /// being woken. The future should still resolve in that case.
    async fn wait_for_high(&mut self) -> Result<(), Self::Error>;

    /// Wait until the pin is low. If it is already low, return immediately.
    ///
    /// # Note for implementers
    /// The pin may have switched back to high before the task was run after
    /// being woken. The future should still resolve in that case.
    async fn wait_for_low(&mut self) -> Result<(), Self::Error>;

    /// Wait for the pin to undergo a transition from low to high.
    ///
    /// If the pin is already high, this does *not* return immediately, it'll wait for the
    /// pin to go low and then high again.
    async fn wait_for_rising_edge(&mut self) -> Result<(), Self::Error>;

    /// Wait for the pin to undergo a transition from high to low.
    ///
    /// If the pin is already low, this does *not* return immediately, it'll wait for the
    /// pin to go high and then low again.
    async fn wait_for_falling_edge(&mut self) -> Result<(), Self::Error>;

    /// Wait for the pin to undergo any transition, i.e low to high OR high to low.
    async fn wait_for_any_edge(&mut self) -> Result<(), Self::Error>;
}

impl<T: Wait + ?Sized> Wait for &mut T {
    #[inline]
    async fn wait_for_high(&mut self) -> Result<(), Self::Error> {
        T::wait_for_high(self).await
    }

    #[inline]
    async fn wait_for_low(&mut self) -> Result<(), Self::Error> {
        T::wait_for_low(self).await
    }

    #[inline]
    async fn wait_for_rising_edge(&mut self) -> Result<(), Self::Error> {
        T::wait_for_rising_edge(self).await
    }

    #[inline]
    async fn wait_for_falling_edge(&mut self) -> Result<(), Self::Error> {
        T::wait_for_falling_edge(self).await
    }

    #[inline]
    async fn wait_for_any_edge(&mut self) -> Result<(), Self::Error> {
        T::wait_for_any_edge(self).await
    }
}