Use fallible OutputPin traits

Author: eldruin

Cargo.toml

@@ -16,7 +16,7 @@ branch = "master"
 repository = "jamwaffles/ssd1306"
 
 [dependencies]
-embedded-hal = "0.2.2"
+embedded-hal = "0.2.3"
 
 [dev-dependencies.stm32f1xx-hal]
 version = "0.2.0"

examples/graphics.rs

@@ -76,7 +76,7 @@ fn main() -> ! {
 
     let mut disp: GraphicsMode<_> = Builder::new().connect_spi(spi, dc).into();
 
-    disp.reset(&mut rst, &mut delay);
+    disp.reset(&mut rst, &mut delay).unwrap();
     disp.init().unwrap();
     disp.flush().unwrap();
 

examples/pixelsquare.rs

@@ -75,7 +75,7 @@ fn main() -> ! {
 
     let mut disp: GraphicsMode<_> = Builder::new().connect_spi(spi, dc).into();
 
-    disp.reset(&mut rst, &mut delay);
+    disp.reset(&mut rst, &mut delay).unwrap();
     disp.init().unwrap();
     disp.flush().unwrap();
 

src/builder.rs

@@ -41,7 +41,7 @@
 //! ```
 
 use hal;
-use hal::digital::OutputPin;
+use hal::digital::v2::OutputPin;
 
 use crate::displayrotation::DisplayRotation;
 use crate::displaysize::DisplaySize;
@@ -109,15 +109,15 @@ impl Builder {
     }
 
     /// Finish the builder and use SPI to communicate with the display
-    pub fn connect_spi<SPI, DC, CommE>(
+    pub fn connect_spi<SPI, DC, CommE, PinE>(
         &self,
         spi: SPI,
         dc: DC,
     ) -> DisplayMode<RawMode<SpiInterface<SPI, DC>>>
     where
         SPI: hal::blocking::spi::Transfer<u8, Error = CommE>
             + hal::blocking::spi::Write<u8, Error = CommE>,
-        DC: OutputPin,
+        DC: OutputPin<Error = PinE>,
     {
         let properties =
             DisplayProperties::new(SpiInterface::new(spi, dc), self.display_size, self.rotation);

src/interface/i2c.rs

@@ -26,7 +26,7 @@ impl<I2C, CommE> DisplayInterface for I2cInterface<I2C>
 where
     I2C: hal::blocking::i2c::Write<Error = CommE>,
 {
-    type Error = Error<CommE>;
+    type Error = Error<CommE, ()>;
 
     fn send_commands(&mut self, cmds: &[u8]) -> Result<(), Self::Error> {
         // Copy over given commands to new aray to prefix with command identifier

src/interface/spi.rs

@@ -1,7 +1,7 @@
 //! SSD1306 SPI interface
 
 use hal;
-use hal::digital::OutputPin;
+use hal::digital::v2::OutputPin;
 
 use super::DisplayInterface;
 use crate::Error;
@@ -15,38 +15,35 @@ pub struct SpiInterface<SPI, DC> {
     dc: DC,
 }
 
-impl<SPI, DC, CommE> SpiInterface<SPI, DC>
+impl<SPI, DC, CommE, PinE> SpiInterface<SPI, DC>
 where
     SPI: hal::blocking::spi::Write<u8, Error = CommE>,
-    DC: OutputPin,
+    DC: OutputPin<Error = PinE>,
 {
     /// Create new SPI interface for communciation with SSD1306
     pub fn new(spi: SPI, dc: DC) -> Self {
         Self { spi, dc }
     }
 }
 
-impl<SPI, DC, CommE> DisplayInterface for SpiInterface<SPI, DC>
+impl<SPI, DC, CommE, PinE> DisplayInterface for SpiInterface<SPI, DC>
 where
     SPI: hal::blocking::spi::Write<u8, Error = CommE>,
-    DC: OutputPin,
+    DC: OutputPin<Error = PinE>,
 {
-    type Error = Error<CommE>;
+    type Error = Error<CommE, PinE>;
 
     fn send_commands(&mut self, cmds: &[u8]) -> Result<(), Self::Error> {
-        self.dc.set_low();
+        self.dc.set_low().map_err(Error::Pin)?;
 
         self.spi.write(&cmds).map_err(Error::Comm)?;
 
-        self.dc.set_high();
-
-        Ok(())
+        self.dc.set_high().map_err(Error::Pin)
     }
 
     fn send_data(&mut self, buf: &[u8]) -> Result<(), Self::Error> {
         // 1 = data, 0 = command
-        self.dc.set_high();
-
+        self.dc.set_high().map_err(Error::Pin)?;
 
         self.spi.write(&buf).map_err(Error::Comm)
     }

src/lib.rs

@@ -168,9 +168,11 @@
 
 /// Errors in this crate
 #[derive(Debug)]
-pub enum Error<CommE> {
+pub enum Error<CommE, PinE> {
     /// Communication error
     Comm(CommE),
+    /// Pin setting error
+    Pin(PinE),
 }
 
 extern crate embedded_hal as hal;

src/mode/graphics.rs

@@ -16,13 +16,14 @@
 //! ```
 
 use hal::blocking::delay::DelayMs;
-use hal::digital::OutputPin;
+use hal::digital::v2::OutputPin;
 
 use crate::displayrotation::DisplayRotation;
 use crate::displaysize::DisplaySize;
 use crate::interface::DisplayInterface;
 use crate::mode::displaymode::DisplayModeTrait;
 use crate::properties::DisplayProperties;
+use crate::Error;
 
 // TODO: Add to prelude
 /// Graphics mode handler
@@ -63,16 +64,20 @@ where
 
     /// Reset display
     // TODO: Move to a more appropriate place
-    pub fn reset<RST, DELAY>(&mut self, rst: &mut RST, delay: &mut DELAY)
+    pub fn reset<RST, DELAY, PinE>(
+        &mut self,
+        rst: &mut RST,
+        delay: &mut DELAY,
+    ) -> Result<(), Error<(), PinE>>
     where
-        RST: OutputPin,
+        RST: OutputPin<Error = PinE>,
         DELAY: DelayMs<u8>,
     {
-        rst.set_high();
+        rst.set_high().map_err(Error::Pin)?;
         delay.delay_ms(1);
-        rst.set_low();
+        rst.set_low().map_err(Error::Pin)?;
         delay.delay_ms(10);
-        rst.set_high();
+        rst.set_high().map_err(Error::Pin)
     }
 
     /// Write out data to display

src/mode/terminal.rs

@@ -23,9 +23,10 @@ use crate::displaysize::DisplaySize;
 use crate::interface::DisplayInterface;
 use crate::mode::displaymode::DisplayModeTrait;
 use crate::properties::DisplayProperties;
+use crate::Error;
 use core::fmt;
 use hal::blocking::delay::DelayMs;
-use hal::digital::OutputPin;
+use hal::digital::v2::OutputPin;
 
 /// A trait to convert from a character to 8x8 bitmap
 pub trait CharacterBitmap<T> {
@@ -187,16 +188,20 @@ where
     }
 
     /// Reset display
-    pub fn reset<RST, DELAY>(&mut self, rst: &mut RST, delay: &mut DELAY)
+    pub fn reset<RST, DELAY, PinE>(
+        &mut self,
+        rst: &mut RST,
+        delay: &mut DELAY,
+    ) -> Result<(), Error<(), PinE>>
     where
-        RST: OutputPin,
+        RST: OutputPin<Error = PinE>,
         DELAY: DelayMs<u8>,
     {
-        rst.set_high();
+        rst.set_high().map_err(Error::Pin)?;
         delay.delay_ms(1);
-        rst.set_low();
+        rst.set_low().map_err(Error::Pin)?;
         delay.delay_ms(10);
-        rst.set_high();
+        rst.set_high().map_err(Error::Pin)
     }
 
     /// Write out data to display. This is a noop in terminal mode.