diff --git a/README.md b/README.md index d7a0489..6bbc916 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,7 @@ epd.update_and_display_frame(&mut spi, &display.buffer())?; | [2.13 Inch B/W (A)](https://www.waveshare.com/product/2.13inch-e-paper-hat.htm) | Black, White | ✕ | ✔ | | | | [2.9 Inch B/W (A)](https://www.waveshare.com/product/2.9inch-e-paper-module.htm) | Black, White | ✕ | ✔ | ✔ | ✔ | | [1.54 Inch B/W/R (B)](https://www.waveshare.com/product/modules/oleds-lcds/e-paper/1.54inch-e-paper-module-b.htm) | Black, White, Red | ✕ | ✕ | ✔ | ✔ | +| [2.9 Inch B/W/R (B/C)](https://www.waveshare.com/product/displays/e-paper/epaper-2/2.9inch-e-paper-module-b.htm) | Black, White, Red | ✕ | ✕ | ✔ | ✔ | ### [1]: 7.5 Inch B/W V2 (A) diff --git a/src/color.rs b/src/color.rs index 92b9f41..a1e5ec7 100644 --- a/src/color.rs +++ b/src/color.rs @@ -17,6 +17,17 @@ pub enum Color { White, } +/// Only for the Black/White/Color-Displays +#[derive(Clone, Copy, PartialEq, Debug)] +pub enum TriColor { + /// Black color + Black, + /// White color + White, + /// Chromatic color + Chromatic, +} + //TODO: Rename get_bit_value to bit() and get_byte_value to byte() ? impl Color { diff --git a/src/epd1in54/mod.rs b/src/epd1in54/mod.rs index bc5cd5b..d532106 100644 --- a/src/epd1in54/mod.rs +++ b/src/epd1in54/mod.rs @@ -30,7 +30,7 @@ //! .into_styled(PrimitiveStyle::with_stroke(Black, 1)) //! .draw(&mut display); //! -//! // Display updated frame +//!// Display updated frame //!epd.update_frame(&mut spi, &display.buffer())?; //!epd.display_frame(&mut spi)?; //! diff --git a/src/epd1in54b/mod.rs b/src/epd1in54b/mod.rs index 9244093..dd74a19 100644 --- a/src/epd1in54b/mod.rs +++ b/src/epd1in54b/mod.rs @@ -101,8 +101,13 @@ where &mut self, spi: &mut SPI, black: &[u8], - red: &[u8], + chromatic: &[u8], ) -> Result<(), SPI::Error> { + self.update_achromatic_frame(spi, black)?; + self.update_chromatic_frame(spi, chromatic) + } + + fn update_achromatic_frame(&mut self, spi: &mut SPI, black: &[u8]) -> Result<(), SPI::Error> { self.wait_until_idle(); self.send_resolution(spi)?; @@ -113,10 +118,17 @@ where let expanded = expand_bits(*b); self.interface.data(spi, &expanded)?; } + Ok(()) + } + fn update_chromatic_frame( + &mut self, + spi: &mut SPI, + chromatic: &[u8], + ) -> Result<(), SPI::Error> { self.interface .cmd(spi, Command::DATA_START_TRANSMISSION_2)?; - self.interface.data(spi, red)?; + self.interface.data(spi, chromatic)?; Ok(()) } } diff --git a/src/epd2in9bc/command.rs b/src/epd2in9bc/command.rs new file mode 100644 index 0000000..a389a6f --- /dev/null +++ b/src/epd2in9bc/command.rs @@ -0,0 +1,39 @@ +//! SPI Commands for the Waveshare 2.9" (B/C) E-Ink Display +use crate::traits; + +#[allow(dead_code)] +#[allow(non_camel_case_types)] +#[derive(Copy, Clone)] +pub(crate) enum Command { + PANEL_SETTING = 0x00, + + POWER_SETTING = 0x01, + POWER_OFF = 0x02, + POWER_ON = 0x04, + BOOSTER_SOFT_START = 0x06, + DEEP_SLEEP = 0x07, + DATA_START_TRANSMISSION_1 = 0x10, + DISPLAY_REFRESH = 0x12, + DATA_START_TRANSMISSION_2 = 0x13, + + LUT_FOR_VCOM = 0x20, + LUT_WHITE_TO_WHITE = 0x21, + LUT_BLACK_TO_WHITE = 0x22, + LUT_WHITE_TO_BLACK = 0x23, + LUT_BLACK_TO_BLACK = 0x24, + + PLL_CONTROL = 0x30, + TEMPERATURE_SENSOR_COMMAND = 0x40, + TEMPERATURE_SENSOR_SELECTION = 0x41, + VCOM_AND_DATA_INTERVAL_SETTING = 0x50, + RESOLUTION_SETTING = 0x61, + VCM_DC_SETTING = 0x82, + POWER_SAVING = 0xE3, +} + +impl traits::Command for Command { + /// Returns the address of the command + fn address(self) -> u8 { + self as u8 + } +} diff --git a/src/epd2in9bc/graphics.rs b/src/epd2in9bc/graphics.rs new file mode 100644 index 0000000..16d12d1 --- /dev/null +++ b/src/epd2in9bc/graphics.rs @@ -0,0 +1,51 @@ +use crate::epd2in9bc::{DEFAULT_BACKGROUND_COLOR, HEIGHT, NUM_DISPLAY_BITS, WIDTH}; +use crate::graphics::{Display, DisplayRotation}; +use embedded_graphics::pixelcolor::BinaryColor; +use embedded_graphics::prelude::*; + +/// Full size buffer for use with the 2in9b/c EPD +/// +/// Can also be manually constructed and be used together with VarDisplay +pub struct Display2in9bc { + buffer: [u8; NUM_DISPLAY_BITS as usize], + rotation: DisplayRotation, +} + +impl Default for Display2in9bc { + fn default() -> Self { + Display2in9bc { + buffer: [DEFAULT_BACKGROUND_COLOR.get_byte_value(); NUM_DISPLAY_BITS as usize], + rotation: DisplayRotation::default(), + } + } +} + +impl DrawTarget for Display2in9bc { + type Error = core::convert::Infallible; + + fn draw_pixel(&mut self, pixel: Pixel) -> Result<(), Self::Error> { + self.draw_helper(WIDTH, HEIGHT, pixel) + } + + fn size(&self) -> Size { + Size::new(WIDTH, HEIGHT) + } +} + +impl Display for Display2in9bc { + fn buffer(&self) -> &[u8] { + &self.buffer + } + + fn get_mut_buffer(&mut self) -> &mut [u8] { + &mut self.buffer + } + + fn set_rotation(&mut self, rotation: DisplayRotation) { + self.rotation = rotation; + } + + fn rotation(&self) -> DisplayRotation { + self.rotation + } +} diff --git a/src/epd2in9bc/mod.rs b/src/epd2in9bc/mod.rs new file mode 100644 index 0000000..e3bc43d --- /dev/null +++ b/src/epd2in9bc/mod.rs @@ -0,0 +1,388 @@ +//! A simple Driver for the Waveshare 2.9" (B/C) E-Ink Display via SPI +//! +//! # Example for the 2.9" E-Ink Display +//! +//!```rust, no_run +//!# use embedded_hal_mock::*; +//!# fn main() -> Result<(), MockError> { +//!use embedded_graphics::{ +//! pixelcolor::BinaryColor::On as Black, prelude::*, primitives::Line, style::PrimitiveStyle, +//!}; +//!use epd_waveshare::{epd2in9bc::*, prelude::*}; +//!# +//!# let expectations = []; +//!# let mut spi = spi::Mock::new(&expectations); +//!# let expectations = []; +//!# let cs_pin = pin::Mock::new(&expectations); +//!# let busy_in = pin::Mock::new(&expectations); +//!# let dc = pin::Mock::new(&expectations); +//!# let rst = pin::Mock::new(&expectations); +//!# let mut delay = delay::MockNoop::new(); +//! +//!// Setup EPD +//!let mut epd = EPD2in9bc::new(&mut spi, cs_pin, busy_in, dc, rst, &mut delay)?; +//! +//!// Use display graphics from embedded-graphics +//!// This display is for the black/white pixels +//!let mut mono_display = Display2in9bc::default(); +//! +//!// Use embedded graphics for drawing +//!// A black line +//!let _ = Line::new(Point::new(0, 120), Point::new(0, 200)) +//! .into_styled(PrimitiveStyle::with_stroke(Black, 1)) +//! .draw(&mut mono_display); +//! +//!// Use a second display for red/yellow +//!let mut chromatic_display = Display2in9bc::default(); +//! +//!// We use `Black` but it will be shown as red/yellow +//!let _ = Line::new(Point::new(15, 120), Point::new(15, 200)) +//! .into_styled(PrimitiveStyle::with_stroke(Black, 1)) +//! .draw(&mut chromatic_display); +//! +//!// Display updated frame +//!epd.update_color_frame( +//! &mut spi, +//! &mono_display.buffer(), +//! &chromatic_display.buffer() +//!)?; +//!epd.display_frame(&mut spi)?; +//! +//!// Set the EPD to sleep +//!epd.sleep(&mut spi)?; +//!# Ok(()) +//!# } +//!``` +use embedded_hal::{ + blocking::{delay::*, spi::Write}, + digital::v2::*, +}; + +use crate::interface::DisplayInterface; +use crate::traits::{ + InternalWiAdditions, RefreshLUT, WaveshareDisplay, WaveshareThreeColorDisplay, +}; + +/// Width of epd2in9bc in pixels +pub const WIDTH: u32 = 128; +/// Height of epd2in9bc in pixels +pub const HEIGHT: u32 = 296; +/// Default background color (white) of epd2in9bc display +pub const DEFAULT_BACKGROUND_COLOR: Color = Color::White; + +const NUM_DISPLAY_BITS: u32 = WIDTH * HEIGHT / 8; + +const IS_BUSY_LOW: bool = true; +const VCOM_DATA_INTERVAL: u8 = 0x07; +const WHITE_BORDER: u8 = 0x70; +const BLACK_BORDER: u8 = 0x30; +const CHROMATIC_BORDER: u8 = 0xb0; +const FLOATING_BORDER: u8 = 0xF0; + +use crate::color::{Color, TriColor}; + +pub(crate) mod command; +use self::command::Command; + +#[cfg(feature = "graphics")] +mod graphics; +#[cfg(feature = "graphics")] +pub use self::graphics::Display2in9bc; + +/// EPD2in9bc driver +pub struct EPD2in9bc { + interface: DisplayInterface, + color: Color, +} + +impl InternalWiAdditions + for EPD2in9bc +where + SPI: Write, + CS: OutputPin, + BUSY: InputPin, + DC: OutputPin, + RST: OutputPin, +{ + fn init>( + &mut self, + spi: &mut SPI, + delay: &mut DELAY, + ) -> Result<(), SPI::Error> { + // Values taken from datasheet and sample code + + self.interface.reset(delay); + + // start the booster + self.interface + .cmd_with_data(spi, Command::BOOSTER_SOFT_START, &[0x17, 0x17, 0x17])?; + + // power on + self.command(spi, Command::POWER_ON)?; + delay.delay_ms(5); + self.wait_until_idle(); + + // set the panel settings + self.cmd_with_data(spi, Command::PANEL_SETTING, &[0x8F])?; + + self.cmd_with_data( + spi, + Command::VCOM_AND_DATA_INTERVAL_SETTING, + &[WHITE_BORDER | VCOM_DATA_INTERVAL], + )?; + + // set resolution + self.send_resolution(spi)?; + + self.cmd_with_data(spi, Command::VCM_DC_SETTING, &[0x0A])?; + + self.wait_until_idle(); + + Ok(()) + } +} + +impl WaveshareThreeColorDisplay + for EPD2in9bc +where + SPI: Write, + CS: OutputPin, + BUSY: InputPin, + DC: OutputPin, + RST: OutputPin, +{ + fn update_color_frame( + &mut self, + spi: &mut SPI, + black: &[u8], + chromatic: &[u8], + ) -> Result<(), SPI::Error> { + self.update_achromatic_frame(spi, black)?; + self.update_chromatic_frame(spi, chromatic) + } + + /// Update only the black/white data of the display. + /// + /// Finish by calling `update_chromatic_frame`. + fn update_achromatic_frame(&mut self, spi: &mut SPI, black: &[u8]) -> Result<(), SPI::Error> { + self.interface + .cmd(spi, Command::DATA_START_TRANSMISSION_1)?; + self.interface.data(spi, black)?; + Ok(()) + } + + /// Update only chromatic data of the display. + /// + /// This data takes precedence over the black/white data. + fn update_chromatic_frame( + &mut self, + spi: &mut SPI, + chromatic: &[u8], + ) -> Result<(), SPI::Error> { + self.interface + .cmd(spi, Command::DATA_START_TRANSMISSION_2)?; + self.interface.data(spi, chromatic)?; + + self.wait_until_idle(); + Ok(()) + } +} + +impl WaveshareDisplay + for EPD2in9bc +where + SPI: Write, + CS: OutputPin, + BUSY: InputPin, + DC: OutputPin, + RST: OutputPin, +{ + fn new>( + spi: &mut SPI, + cs: CS, + busy: BUSY, + dc: DC, + rst: RST, + delay: &mut DELAY, + ) -> Result { + let interface = DisplayInterface::new(cs, busy, dc, rst); + let color = DEFAULT_BACKGROUND_COLOR; + + let mut epd = EPD2in9bc { interface, color }; + + epd.init(spi, delay)?; + + Ok(epd) + } + + fn sleep(&mut self, spi: &mut SPI) -> Result<(), SPI::Error> { + // Section 8.2 from datasheet + self.interface.cmd_with_data( + spi, + Command::VCOM_AND_DATA_INTERVAL_SETTING, + &[FLOATING_BORDER | VCOM_DATA_INTERVAL], + )?; + + self.command(spi, Command::POWER_OFF)?; + // The example STM code from Github has a wait after POWER_OFF + self.wait_until_idle(); + + self.cmd_with_data(spi, Command::DEEP_SLEEP, &[0xA5])?; + + Ok(()) + } + + fn wake_up>( + &mut self, + spi: &mut SPI, + delay: &mut DELAY, + ) -> Result<(), SPI::Error> { + self.init(spi, delay) + } + + fn set_background_color(&mut self, color: Color) { + self.color = color; + } + + fn background_color(&self) -> &Color { + &self.color + } + + fn width(&self) -> u32 { + WIDTH + } + + fn height(&self) -> u32 { + HEIGHT + } + + fn update_frame(&mut self, spi: &mut SPI, buffer: &[u8]) -> Result<(), SPI::Error> { + self.interface + .cmd(spi, Command::DATA_START_TRANSMISSION_1)?; + + self.interface.data(spi, &buffer)?; + + // Clear the chromatic layer + let color = self.color.get_byte_value(); + + self.interface + .cmd(spi, Command::DATA_START_TRANSMISSION_2)?; + self.interface.data_x_times(spi, color, NUM_DISPLAY_BITS)?; + + self.wait_until_idle(); + Ok(()) + } + + #[allow(unused)] + fn update_partial_frame( + &mut self, + spi: &mut SPI, + buffer: &[u8], + x: u32, + y: u32, + width: u32, + height: u32, + ) -> Result<(), SPI::Error> { + Ok(()) + } + + fn display_frame(&mut self, spi: &mut SPI) -> Result<(), SPI::Error> { + self.command(spi, Command::DISPLAY_REFRESH)?; + + self.wait_until_idle(); + Ok(()) + } + + fn update_and_display_frame(&mut self, spi: &mut SPI, buffer: &[u8]) -> Result<(), SPI::Error> { + self.update_frame(spi, buffer)?; + self.display_frame(spi)?; + Ok(()) + } + + fn clear_frame(&mut self, spi: &mut SPI) -> Result<(), SPI::Error> { + self.send_resolution(spi)?; + + let color = DEFAULT_BACKGROUND_COLOR.get_byte_value(); + + // Clear the black + self.interface + .cmd(spi, Command::DATA_START_TRANSMISSION_1)?; + + self.interface.data_x_times(spi, color, NUM_DISPLAY_BITS)?; + + // Clear the chromatic + self.interface + .cmd(spi, Command::DATA_START_TRANSMISSION_2)?; + self.interface.data_x_times(spi, color, NUM_DISPLAY_BITS)?; + + self.wait_until_idle(); + Ok(()) + } + + fn set_lut( + &mut self, + _spi: &mut SPI, + _refresh_rate: Option, + ) -> Result<(), SPI::Error> { + Ok(()) + } + + fn is_busy(&self) -> bool { + self.interface.is_busy(IS_BUSY_LOW) + } +} + +impl EPD2in9bc +where + SPI: Write, + CS: OutputPin, + BUSY: InputPin, + DC: OutputPin, + RST: OutputPin, +{ + fn command(&mut self, spi: &mut SPI, command: Command) -> Result<(), SPI::Error> { + self.interface.cmd(spi, command) + } + + fn send_data(&mut self, spi: &mut SPI, data: &[u8]) -> Result<(), SPI::Error> { + self.interface.data(spi, data) + } + + fn cmd_with_data( + &mut self, + spi: &mut SPI, + command: Command, + data: &[u8], + ) -> Result<(), SPI::Error> { + self.interface.cmd_with_data(spi, command, data) + } + + fn wait_until_idle(&mut self) { + self.interface.wait_until_idle(IS_BUSY_LOW) + } + + fn send_resolution(&mut self, spi: &mut SPI) -> Result<(), SPI::Error> { + let w = self.width(); + let h = self.height(); + + self.command(spi, Command::RESOLUTION_SETTING)?; + + self.send_data(spi, &[w as u8])?; + self.send_data(spi, &[(h >> 8) as u8])?; + self.send_data(spi, &[h as u8]) + } + + /// Set the outer border of the display to the chosen color. + pub fn set_border_color(&mut self, spi: &mut SPI, color: TriColor) -> Result<(), SPI::Error> { + let border = match color { + TriColor::Black => BLACK_BORDER, + TriColor::White => WHITE_BORDER, + TriColor::Chromatic => CHROMATIC_BORDER, + }; + self.cmd_with_data( + spi, + Command::VCOM_AND_DATA_INTERVAL_SETTING, + &[border | VCOM_DATA_INTERVAL], + ) + } +} diff --git a/src/lib.rs b/src/lib.rs index 754c790..0d65364 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -75,6 +75,7 @@ mod interface; pub mod epd1in54; pub mod epd1in54b; pub mod epd2in9; +pub mod epd2in9bc; pub mod epd4in2; pub mod epd7in5; pub mod epd7in5_v2; @@ -82,7 +83,7 @@ pub(crate) mod type_a; /// Includes everything important besides the chosen Display pub mod prelude { - pub use crate::color::Color; + pub use crate::color::{Color, TriColor}; pub use crate::traits::{RefreshLUT, WaveshareDisplay, WaveshareThreeColorDisplay}; pub use crate::SPI_MODE; diff --git a/src/traits.rs b/src/traits.rs index eed2672..52a7337 100644 --- a/src/traits.rs +++ b/src/traits.rs @@ -69,8 +69,20 @@ where &mut self, spi: &mut SPI, black: &[u8], - color: &[u8], + chromatic: &[u8], ) -> Result<(), SPI::Error>; + + /// Update only the black/white data of the display. + /// + /// This must be finished by calling `update_chromatic_frame`. + fn update_achromatic_frame(&mut self, spi: &mut SPI, black: &[u8]) -> Result<(), SPI::Error>; + + /// Update only the chromatic data of the display. + /// + /// This should be preceded by a call to `update_achromatic_frame`. + /// This data takes precedence over the black/white data. + fn update_chromatic_frame(&mut self, spi: &mut SPI, chromatic: &[u8]) + -> Result<(), SPI::Error>; } /// All the functions to interact with the EPDs