From 20a01a25bf16b4ab4328501b02eb24bc3644a9a9 Mon Sep 17 00:00:00 2001 From: Michael Beaumont Date: Tue, 24 Mar 2020 23:30:02 +0100 Subject: [PATCH] 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")]