From 20a01a25bf16b4ab4328501b02eb24bc3644a9a9 Mon Sep 17 00:00:00 2001 From: Michael Beaumont Date: Tue, 24 Mar 2020 23:30:02 +0100 Subject: [PATCH 1/4] Add epd2in9b support --- Cargo.toml | 3 +- src/color.rs | 11 ++ src/epd2in9b/command.rs | 39 +++++ src/epd2in9b/graphics.rs | 45 ++++++ src/epd2in9b/mod.rs | 322 +++++++++++++++++++++++++++++++++++++++ src/lib.rs | 5 +- 6 files changed, 423 insertions(+), 2 deletions(-) create mode 100644 src/epd2in9b/command.rs create mode 100644 src/epd2in9b/graphics.rs create mode 100644 src/epd2in9b/mod.rs diff --git a/Cargo.toml b/Cargo.toml index 677ac97..3828456 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -18,12 +18,13 @@ edition = "2018" travis-ci = { repository = "caemor/epd-waveshare" } [features] -default = ["epd1in54", "epd1in54b", "epd2in9", "epd4in2", "epd7in5", "epd7in5_v2", "graphics"] +default = ["epd1in54", "epd1in54b", "epd2in9", "epd2in9b", "epd4in2", "epd7in5", "epd7in5_v2", "graphics"] graphics = ["embedded-graphics"] epd1in54 = [] epd1in54b = [] epd2in9 = [] +epd2in9b = [] epd4in2 = [] epd7in5 = [] epd7in5_v2 = [] diff --git a/src/color.rs b/src/color.rs index e9223de..a7d882c 100644 --- a/src/color.rs +++ b/src/color.rs @@ -9,6 +9,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, + /// Red color + Red, +} + //TODO: Rename get_bit_value to bit() and get_byte_value to byte() ? impl Color { diff --git a/src/epd2in9b/command.rs b/src/epd2in9b/command.rs new file mode 100644 index 0000000..a268fa7 --- /dev/null +++ b/src/epd2in9b/command.rs @@ -0,0 +1,39 @@ +//! SPI Commands for the Waveshare 2.9" red 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/epd2in9b/graphics.rs b/src/epd2in9b/graphics.rs new file mode 100644 index 0000000..cc7b761 --- /dev/null +++ b/src/epd2in9b/graphics.rs @@ -0,0 +1,45 @@ +use crate::epd2in9b::{DEFAULT_BACKGROUND_COLOR, HEIGHT, NUM_DISPLAY_BITS, WIDTH}; +use crate::graphics::{Display, DisplayRotation}; +use crate::prelude::*; +use embedded_graphics::prelude::*; + +pub struct Display2in9b { + buffer: [u8; NUM_DISPLAY_BITS as usize], + rotation: DisplayRotation, +} + +impl Default for Display2in9b { + fn default() -> Self { + Display2in9b { + buffer: [DEFAULT_BACKGROUND_COLOR.get_byte_value(); NUM_DISPLAY_BITS as usize], + rotation: DisplayRotation::default(), + } + } +} + +impl Drawing for Display2in9b { + fn draw(&mut self, item_pixels: T) + where + T: IntoIterator>, + { + self.draw_helper(WIDTH, HEIGHT, item_pixels); + } +} + +impl Display for Display2in9b { + 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/epd2in9b/mod.rs b/src/epd2in9b/mod.rs new file mode 100644 index 0000000..a567ecc --- /dev/null +++ b/src/epd2in9b/mod.rs @@ -0,0 +1,322 @@ +//! A simple Driver for the Waveshare 2.9" (B) E-Ink Display via SPI + +use embedded_hal::{ + blocking::{delay::*, spi::Write}, + digital::v2::*, +}; + +use crate::interface::DisplayInterface; +use crate::traits::{ + InternalWiAdditions, RefreshLUT, WaveshareDisplay, WaveshareThreeColorDisplay, +}; + +pub const WIDTH: u32 = 128; +pub const HEIGHT: u32 = 296; +pub const NUM_DISPLAY_BITS: u32 = WIDTH * HEIGHT / 8; +pub const DEFAULT_BACKGROUND_COLOR: Color = Color::White; + +const IS_BUSY_LOW: bool = true; +const VCOM_DATA_INTERVAL: u8 = 0x07; +const WHITE_BORDER: u8 = 0x70; +const BLACK_BORDER: u8 = 0x30; +const RED_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::Display2in9b; + + +/// EPD2in9b driver +pub struct EPD2in9b { + interface: DisplayInterface, + color: Color, +} + +impl InternalWiAdditions + for EPD2in9b +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 EPD2in9b +where + SPI: Write, + CS: OutputPin, + BUSY: InputPin, + DC: OutputPin, + RST: OutputPin, +{ + fn update_color_frame( + &mut self, + spi: &mut SPI, + black: &[u8], + red: &[u8], + ) -> Result<(), SPI::Error> { + self.update_mono_frame(spi, black)?; + self.update_red_frame(spi, red) + } +} + +impl WaveshareDisplay + for EPD2in9b +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 = EPD2in9b { 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 red 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 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 red + 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 EPD2in9b +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::Red => RED_BORDER, + }; + self.cmd_with_data( + spi, + Command::VCOM_AND_DATA_INTERVAL_SETTING, + &[border | VCOM_DATA_INTERVAL], + ) + } + + /// Update only the black/white data of the display. + /// + /// Finish by calling `update_red_frame`. + pub fn update_mono_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 red data of the display. + /// + /// This data takes precedence over the black/white data. + pub fn update_red_frame(&mut self, spi: &mut SPI, red: &[u8]) -> Result<(), SPI::Error> { + self.interface + .cmd(spi, Command::DATA_START_TRANSMISSION_2)?; + self.interface.data(spi, red)?; + + self.wait_until_idle(); + Ok(()) + } +} diff --git a/src/lib.rs b/src/lib.rs index 00e8183..ea23b5d 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -81,11 +81,14 @@ pub mod epd1in54b; #[cfg(feature = "epd2in9")] pub mod epd2in9; +#[cfg(feature = "epd2in9b")] +pub mod epd2in9b; + #[cfg(any(feature = "epd1in54", feature = "epd2in9"))] pub(crate) mod type_a; pub mod prelude { - pub use crate::color::Color; + pub use crate::color::{Color, TriColor}; pub use crate::traits::{RefreshLUT, WaveshareDisplay, WaveshareThreeColorDisplay}; #[cfg(feature = "epd7in5_v2")] From 7a5472f73a16bca09e078e4c7a387fba45dfed17 Mon Sep 17 00:00:00 2001 From: Michael Beaumont Date: Fri, 27 Mar 2020 18:50:33 +0100 Subject: [PATCH 2/4] Update epd2in9b after embedded-graphics update --- src/epd2in9b/graphics.rs | 20 +++++++++++++------- src/epd2in9b/mod.rs | 13 +++++++++++-- 2 files changed, 24 insertions(+), 9 deletions(-) diff --git a/src/epd2in9b/graphics.rs b/src/epd2in9b/graphics.rs index cc7b761..f354e96 100644 --- a/src/epd2in9b/graphics.rs +++ b/src/epd2in9b/graphics.rs @@ -1,8 +1,11 @@ use crate::epd2in9b::{DEFAULT_BACKGROUND_COLOR, HEIGHT, NUM_DISPLAY_BITS, WIDTH}; use crate::graphics::{Display, DisplayRotation}; -use crate::prelude::*; +use embedded_graphics::pixelcolor::BinaryColor; use embedded_graphics::prelude::*; +/// Full size buffer for use with the 2in9b EPD +/// +/// Can also be manually constructed and be used together with VarDisplay pub struct Display2in9b { buffer: [u8; NUM_DISPLAY_BITS as usize], rotation: DisplayRotation, @@ -17,12 +20,15 @@ impl Default for Display2in9b { } } -impl Drawing for Display2in9b { - fn draw(&mut self, item_pixels: T) - where - T: IntoIterator>, - { - self.draw_helper(WIDTH, HEIGHT, item_pixels); +impl DrawTarget for Display2in9b { + 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) } } diff --git a/src/epd2in9b/mod.rs b/src/epd2in9b/mod.rs index a567ecc..6327530 100644 --- a/src/epd2in9b/mod.rs +++ b/src/epd2in9b/mod.rs @@ -10,11 +10,15 @@ use crate::traits::{ InternalWiAdditions, RefreshLUT, WaveshareDisplay, WaveshareThreeColorDisplay, }; +/// Width of epd2in9b in pixels pub const WIDTH: u32 = 128; +/// Height of epd2in9b in pixels pub const HEIGHT: u32 = 296; -pub const NUM_DISPLAY_BITS: u32 = WIDTH * HEIGHT / 8; +/// Default background color (white) of epd2in9b 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; @@ -32,7 +36,6 @@ mod graphics; #[cfg(feature = "graphics")] pub use self::graphics::Display2in9b; - /// EPD2in9b driver pub struct EPD2in9b { interface: DisplayInterface, @@ -211,6 +214,12 @@ where 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)?; From b5e647b0d01e32be62862c32eb0c00c14e32333f Mon Sep 17 00:00:00 2001 From: Michael Beaumont Date: Fri, 27 Mar 2020 18:38:39 +0100 Subject: [PATCH 3/4] Rename red to chromatic, rename epd2in9b to epd2in9bc --- src/color.rs | 4 +- src/epd1in54b/mod.rs | 16 ++++- src/{epd2in9b => epd2in9bc}/command.rs | 2 +- src/{epd2in9b => epd2in9bc}/graphics.rs | 14 ++-- src/{epd2in9b => epd2in9bc}/mod.rs | 87 +++++++++++++------------ src/lib.rs | 2 +- src/traits.rs | 14 +++- 7 files changed, 83 insertions(+), 56 deletions(-) rename src/{epd2in9b => epd2in9bc}/command.rs (93%) rename src/{epd2in9b => epd2in9bc}/graphics.rs (77%) rename src/{epd2in9b => epd2in9bc}/mod.rs (86%) diff --git a/src/color.rs b/src/color.rs index 3f70397..a1e5ec7 100644 --- a/src/color.rs +++ b/src/color.rs @@ -24,8 +24,8 @@ pub enum TriColor { Black, /// White color White, - /// Red color - Red, + /// Chromatic color + Chromatic, } //TODO: Rename get_bit_value to bit() and get_byte_value to byte() ? 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/epd2in9b/command.rs b/src/epd2in9bc/command.rs similarity index 93% rename from src/epd2in9b/command.rs rename to src/epd2in9bc/command.rs index a268fa7..a389a6f 100644 --- a/src/epd2in9b/command.rs +++ b/src/epd2in9bc/command.rs @@ -1,4 +1,4 @@ -//! SPI Commands for the Waveshare 2.9" red E-Ink Display +//! SPI Commands for the Waveshare 2.9" (B/C) E-Ink Display use crate::traits; #[allow(dead_code)] diff --git a/src/epd2in9b/graphics.rs b/src/epd2in9bc/graphics.rs similarity index 77% rename from src/epd2in9b/graphics.rs rename to src/epd2in9bc/graphics.rs index f354e96..16d12d1 100644 --- a/src/epd2in9b/graphics.rs +++ b/src/epd2in9bc/graphics.rs @@ -1,26 +1,26 @@ -use crate::epd2in9b::{DEFAULT_BACKGROUND_COLOR, HEIGHT, NUM_DISPLAY_BITS, WIDTH}; +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 EPD +/// Full size buffer for use with the 2in9b/c EPD /// /// Can also be manually constructed and be used together with VarDisplay -pub struct Display2in9b { +pub struct Display2in9bc { buffer: [u8; NUM_DISPLAY_BITS as usize], rotation: DisplayRotation, } -impl Default for Display2in9b { +impl Default for Display2in9bc { fn default() -> Self { - Display2in9b { + Display2in9bc { buffer: [DEFAULT_BACKGROUND_COLOR.get_byte_value(); NUM_DISPLAY_BITS as usize], rotation: DisplayRotation::default(), } } } -impl DrawTarget for Display2in9b { +impl DrawTarget for Display2in9bc { type Error = core::convert::Infallible; fn draw_pixel(&mut self, pixel: Pixel) -> Result<(), Self::Error> { @@ -32,7 +32,7 @@ impl DrawTarget for Display2in9b { } } -impl Display for Display2in9b { +impl Display for Display2in9bc { fn buffer(&self) -> &[u8] { &self.buffer } diff --git a/src/epd2in9b/mod.rs b/src/epd2in9bc/mod.rs similarity index 86% rename from src/epd2in9b/mod.rs rename to src/epd2in9bc/mod.rs index 6327530..a857f69 100644 --- a/src/epd2in9b/mod.rs +++ b/src/epd2in9bc/mod.rs @@ -1,5 +1,4 @@ -//! A simple Driver for the Waveshare 2.9" (B) E-Ink Display via SPI - +//! A simple Driver for the Waveshare 2.9" (B/C) E-Ink Display via SPI use embedded_hal::{ blocking::{delay::*, spi::Write}, digital::v2::*, @@ -10,11 +9,11 @@ use crate::traits::{ InternalWiAdditions, RefreshLUT, WaveshareDisplay, WaveshareThreeColorDisplay, }; -/// Width of epd2in9b in pixels +/// Width of epd2in9bc in pixels pub const WIDTH: u32 = 128; -/// Height of epd2in9b in pixels +/// Height of epd2in9bc in pixels pub const HEIGHT: u32 = 296; -/// Default background color (white) of epd2in9b display +/// Default background color (white) of epd2in9bc display pub const DEFAULT_BACKGROUND_COLOR: Color = Color::White; const NUM_DISPLAY_BITS: u32 = WIDTH * HEIGHT / 8; @@ -23,7 +22,7 @@ const IS_BUSY_LOW: bool = true; const VCOM_DATA_INTERVAL: u8 = 0x07; const WHITE_BORDER: u8 = 0x70; const BLACK_BORDER: u8 = 0x30; -const RED_BORDER: u8 = 0xb0; +const CHROMATIC_BORDER: u8 = 0xb0; const FLOATING_BORDER: u8 = 0xF0; use crate::color::{Color, TriColor}; @@ -34,16 +33,16 @@ use self::command::Command; #[cfg(feature = "graphics")] mod graphics; #[cfg(feature = "graphics")] -pub use self::graphics::Display2in9b; +pub use self::graphics::Display2in9bc; -/// EPD2in9b driver -pub struct EPD2in9b { +/// EPD2in9bc driver +pub struct EPD2in9bc { interface: DisplayInterface, color: Color, } impl InternalWiAdditions - for EPD2in9b + for EPD2in9bc where SPI: Write, CS: OutputPin, @@ -90,7 +89,7 @@ where } impl WaveshareThreeColorDisplay - for EPD2in9b + for EPD2in9bc where SPI: Write, CS: OutputPin, @@ -102,15 +101,41 @@ where &mut self, spi: &mut SPI, black: &[u8], - red: &[u8], + chromatic: &[u8], ) -> Result<(), SPI::Error> { - self.update_mono_frame(spi, black)?; - self.update_red_frame(spi, red) + 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 EPD2in9b + for EPD2in9bc where SPI: Write, CS: OutputPin, @@ -129,7 +154,7 @@ where let interface = DisplayInterface::new(cs, busy, dc, rst); let color = DEFAULT_BACKGROUND_COLOR; - let mut epd = EPD2in9b { interface, color }; + let mut epd = EPD2in9bc { interface, color }; epd.init(spi, delay)?; @@ -183,7 +208,7 @@ where self.interface.data(spi, &buffer)?; - // Clear the red layer + // Clear the chromatic layer let color = self.color.get_byte_value(); self.interface @@ -231,7 +256,7 @@ where self.interface.data_x_times(spi, color, NUM_DISPLAY_BITS)?; - // Clear the red + // Clear the chromatic self.interface .cmd(spi, Command::DATA_START_TRANSMISSION_2)?; self.interface.data_x_times(spi, color, NUM_DISPLAY_BITS)?; @@ -253,7 +278,7 @@ where } } -impl EPD2in9b +impl EPD2in9bc where SPI: Write, CS: OutputPin, @@ -298,7 +323,7 @@ where let border = match color { TriColor::Black => BLACK_BORDER, TriColor::White => WHITE_BORDER, - TriColor::Red => RED_BORDER, + TriColor::Chromatic => CHROMATIC_BORDER, }; self.cmd_with_data( spi, @@ -306,26 +331,4 @@ where &[border | VCOM_DATA_INTERVAL], ) } - - /// Update only the black/white data of the display. - /// - /// Finish by calling `update_red_frame`. - pub fn update_mono_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 red data of the display. - /// - /// This data takes precedence over the black/white data. - pub fn update_red_frame(&mut self, spi: &mut SPI, red: &[u8]) -> Result<(), SPI::Error> { - self.interface - .cmd(spi, Command::DATA_START_TRANSMISSION_2)?; - self.interface.data(spi, red)?; - - self.wait_until_idle(); - Ok(()) - } } diff --git a/src/lib.rs b/src/lib.rs index 52edc10..0d65364 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -75,7 +75,7 @@ mod interface; pub mod epd1in54; pub mod epd1in54b; pub mod epd2in9; -pub mod epd2in9b; +pub mod epd2in9bc; pub mod epd4in2; pub mod epd7in5; pub mod epd7in5_v2; 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 From 9167c643f916930d48f0cfc024381f25e2d44e9a Mon Sep 17 00:00:00 2001 From: Michael Beaumont Date: Fri, 27 Mar 2020 19:08:35 +0100 Subject: [PATCH 4/4] Add epd2in9bc to README, add example --- README.md | 1 + src/epd1in54/mod.rs | 2 +- src/epd2in9bc/mod.rs | 54 ++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 56 insertions(+), 1 deletion(-) 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/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/epd2in9bc/mod.rs b/src/epd2in9bc/mod.rs index a857f69..e3bc43d 100644 --- a/src/epd2in9bc/mod.rs +++ b/src/epd2in9bc/mod.rs @@ -1,4 +1,58 @@ //! 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::*,