PinState

Author: burrbull

CHANGELOG.md

@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Added
 
+- `PinState` and `get/set_state`.
+- Inherent methods for infallible digital operations.
 - Generic `into_alternate` and `into_alternate_open_drain`. Non-generic ones are deprecated
 - Internal implementation of GPIO Pin API changed to use Const Generics
 - `PinExt` trait. Make `ExtiPin` implementation generic

src/gpio.rs

@@ -81,6 +81,15 @@ pub struct PushPull;
 /// Analog mode (type state)
 pub struct Analog;
 
+/// Digital output pin state
+#[derive(Debug, PartialEq, Eq, Clone, Copy)]
+pub enum PinState {
+    /// Low pin state
+    Low,
+    /// High pin state
+    High,
+}
+
 /// GPIO Pin speed selection
 pub enum Speed {
     Low = 0,
@@ -240,6 +249,23 @@ impl<MODE, const P: char> PXx<Output<MODE>, P> {
         }
     }
 
+    #[inline(always)]
+    pub fn get_state(&self) -> PinState {
+        if self.is_set_low() {
+            PinState::Low
+        } else {
+            PinState::High
+        }
+    }
+
+    #[inline(always)]
+    pub fn set_state(&mut self, state: PinState) {
+        match state {
+            PinState::Low => self.set_low(),
+            PinState::High => self.set_high(),
+        }
+    }
+
     #[inline(always)]
     pub fn is_set_high(&self) -> bool {
         !self.is_set_low()
@@ -846,6 +872,23 @@ impl<MODE, const P: char, const N: u8> PX<Output<MODE>, P, N> {
         }
     }
 
+    #[inline(always)]
+    pub fn get_state(&self) -> PinState {
+        if self.is_set_low() {
+            PinState::Low
+        } else {
+            PinState::High
+        }
+    }
+
+    #[inline(always)]
+    pub fn set_state(&mut self, state: PinState) {
+        match state {
+            PinState::Low => self.set_low(),
+            PinState::High => self.set_high(),
+        }
+    }
+
     #[inline(always)]
     pub fn is_set_high(&self) -> bool {
         !self.is_set_low()
@@ -1286,6 +1329,23 @@ impl<MODE> Pin<Output<MODE>> {
         };
     }
 
+    #[inline(always)]
+    pub fn get_state(&self) -> PinState {
+        if self.is_set_low() {
+            PinState::Low
+        } else {
+            PinState::High
+        }
+    }
+
+    #[inline(always)]
+    pub fn set_state(&mut self, state: PinState) {
+        match state {
+            PinState::Low => self.set_low(),
+            PinState::High => self.set_high(),
+        }
+    }
+
     #[inline(always)]
     pub fn is_set_high(&self) -> bool {
         !self.is_set_low()