Move reset to DisplayModeTrait (#126)

* Move reset to DisplayModeTrait

The functionality is common, so the implementation can be as well.

* Added changelog entry and a missing space

* Update CHANGELOG.md

Co-authored-by: James Waples <[email protected]>

Co-authored-by: James Waples <[email protected]>

Author: bugadani

CHANGELOG.md

@@ -12,7 +12,8 @@
 
 ### Changed
 
--**(breaking)** [#119](https://github.com/jamwaffles/ssd1306/pull/119) Remove `DisplayMode` and `RawMode`
+- **(breaking)** [#126](https://github.com/jamwaffles/ssd1306/pull/126) Moved `reset` method to `DisplayModeTrait`. If the prelude is not used, add either `use ssd1306::prelude::*` or `ssd1306::mode::displaymode::DisplayModeTrait` to your imports.
+- **(breaking)** [#119](https://github.com/jamwaffles/ssd1306/pull/119) Remove `DisplayMode` and `RawMode`
 - [#120](https://github.com/jamwaffles/ssd1306/pull/120) Update to v0.4 [`display-interface`](https://crates.io/crates/display-interface)
 - **(breaking)** [#118](https://github.com/jamwaffles/ssd1306/pull/118) Change `release` method to return the display interface instead of the `DisplayProperties`.
 - **(breaking)** [#116](https://github.com/jamwaffles/ssd1306/pull/116) Replace custom I2C and SPI interfaces by generic [`display-interface`](https://crates.io/crates/display-interface)

src/mode/displaymode.rs

@@ -1,6 +1,8 @@
 //! Abstraction of different operating modes for the SSD1306
 
 use crate::properties::DisplayProperties;
+use crate::Error;
+use hal::{blocking::delay::DelayMs, digital::v2::OutputPin};
 
 /// Trait with core functionality for display mode switching
 pub trait DisplayModeTrait<DI>: Sized {
@@ -14,4 +16,21 @@ pub trait DisplayModeTrait<DI>: Sized {
     fn release(self) -> DI {
         self.into_properties().release()
     }
+
+    /// Reset the display
+    fn reset<RST, DELAY, PinE>(
+        &mut self,
+        rst: &mut RST,
+        delay: &mut DELAY,
+    ) -> Result<(), Error<(), PinE>>
+    where
+        RST: OutputPin<Error = PinE>,
+        DELAY: DelayMs<u8>,
+    {
+        rst.set_high().map_err(Error::Pin)?;
+        delay.delay_ms(1);
+        rst.set_low().map_err(Error::Pin)?;
+        delay.delay_ms(10);
+        rst.set_high().map_err(Error::Pin)
+    }
 }

src/mode/graphics.rs

@@ -56,11 +56,10 @@
 //! [embedded_graphics]: https://crates.io/crates/embedded_graphics
 
 use display_interface::{DisplayError, WriteOnlyDataCommand};
-use hal::{blocking::delay::DelayMs, digital::v2::OutputPin};
 
 use crate::{
     displayrotation::DisplayRotation, mode::displaymode::DisplayModeTrait,
-    properties::DisplayProperties, Error,
+    properties::DisplayProperties,
 };
 
 // TODO: Add to prelude
@@ -93,26 +92,6 @@ impl<DI> DisplayModeTrait<DI> for GraphicsMode<DI> {
     }
 }
 
-impl<DI> GraphicsMode<DI> {
-    /// Reset display
-    // TODO: Move to a more appropriate place
-    pub fn reset<RST, DELAY, PinE>(
-        &mut self,
-        rst: &mut RST,
-        delay: &mut DELAY,
-    ) -> Result<(), Error<(), PinE>>
-    where
-        RST: OutputPin<Error = PinE>,
-        DELAY: DelayMs<u8>,
-    {
-        rst.set_high().map_err(Error::Pin)?;
-        delay.delay_ms(1);
-        rst.set_low().map_err(Error::Pin)?;
-        delay.delay_ms(10);
-        rst.set_high().map_err(Error::Pin)
-    }
-}
-
 impl<DI> GraphicsMode<DI>
 where
     DI: WriteOnlyDataCommand,

src/mode/terminal.rs

@@ -36,10 +36,8 @@ use crate::{
         terminal::TerminalModeError::{InterfaceError, OutOfBounds, Uninitialized},
     },
     properties::DisplayProperties,
-    Error,
 };
 use core::{cmp::min, fmt};
-use hal::{blocking::delay::DelayMs, digital::v2::OutputPin};
 
 /// Contains the new row that the cursor has wrapped around to
 struct CursorWrapEvent(u8);
@@ -159,25 +157,6 @@ where
     }
 }
 
-impl<DI> TerminalMode<DI> {
-    /// Reset display
-    pub fn reset<RST, DELAY, PinE>(
-        &mut self,
-        rst: &mut RST,
-        delay: &mut DELAY,
-    ) -> Result<(), Error<(), PinE>>
-    where
-        RST: OutputPin<Error = PinE>,
-        DELAY: DelayMs<u8>,
-    {
-        rst.set_high().map_err(Error::Pin)?;
-        delay.delay_ms(1);
-        rst.set_low().map_err(Error::Pin)?;
-        delay.delay_ms(10);
-        rst.set_high().map_err(Error::Pin)
-    }
-}
-
 impl<DI> TerminalMode<DI>
 where
     DI: WriteOnlyDataCommand,