|
|
|
|
@ -5,7 +5,7 @@
|
|
|
|
|
//! # Example for the 2.9 in E-Ink Display
|
|
|
|
|
//!
|
|
|
|
|
//! ```ignore
|
|
|
|
|
//! use eink_waveshare_rs::{
|
|
|
|
|
//! use epd_waveshare::{
|
|
|
|
|
//! epd2in9::{EPD2in9, Buffer2in9},
|
|
|
|
|
//! graphics::{Display, DisplayRotation},
|
|
|
|
|
//! prelude::*,
|
|
|
|
|
@ -46,7 +46,7 @@ use hal::{
|
|
|
|
|
|
|
|
|
|
use type_a::{ |
|
|
|
|
command::Command, |
|
|
|
|
constants::{LUT_FULL_UPDATE, LUT_PARTIAL_UPDATE} |
|
|
|
|
constants::{LUT_FULL_UPDATE, LUT_PARTIAL_UPDATE}, |
|
|
|
|
}; |
|
|
|
|
|
|
|
|
|
use color::Color; |
|
|
|
|
@ -63,10 +63,10 @@ pub use epd2in9::graphics::Buffer2in9;
|
|
|
|
|
pub struct EPD2in9<SPI, CS, BUSY, DC, RST> { |
|
|
|
|
/// SPI
|
|
|
|
|
interface: DisplayInterface<SPI, CS, BUSY, DC, RST>, |
|
|
|
|
/// EPD (width, height)
|
|
|
|
|
//epd: EPD,
|
|
|
|
|
/// Color
|
|
|
|
|
background_color: Color, |
|
|
|
|
/// Refresh LUT
|
|
|
|
|
refresh: RefreshLUT, |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
impl<SPI, CS, BUSY, DC, RST> EPD2in9<SPI, CS, BUSY, DC, RST> |
|
|
|
|
@ -77,7 +77,11 @@ where
|
|
|
|
|
DC: OutputPin, |
|
|
|
|
RST: OutputPin, |
|
|
|
|
{ |
|
|
|
|
fn init<DELAY: DelayMs<u8>>(&mut self, spi: &mut SPI, delay: &mut DELAY) -> Result<(), SPI::Error> { |
|
|
|
|
fn init<DELAY: DelayMs<u8>>( |
|
|
|
|
&mut self, |
|
|
|
|
spi: &mut SPI, |
|
|
|
|
delay: &mut DELAY, |
|
|
|
|
) -> Result<(), SPI::Error> { |
|
|
|
|
self.interface.reset(delay); |
|
|
|
|
|
|
|
|
|
// 3 Databytes:
|
|
|
|
|
@ -85,34 +89,42 @@ where
|
|
|
|
|
// 0.. A[8]
|
|
|
|
|
// 0.. B[2:0]
|
|
|
|
|
// Default Values: A = Height of Screen (0x127), B = 0x00 (GD, SM and TB=0?)
|
|
|
|
|
self.interface.cmd_with_data(spi, Command::DRIVER_OUTPUT_CONTROL, &[0x27, 0x01, 0x00])?; |
|
|
|
|
self.interface |
|
|
|
|
.cmd_with_data(spi, Command::DRIVER_OUTPUT_CONTROL, &[0x27, 0x01, 0x00])?; |
|
|
|
|
|
|
|
|
|
// 3 Databytes: (and default values from datasheet and arduino)
|
|
|
|
|
// 1 .. A[6:0] = 0xCF | 0xD7
|
|
|
|
|
// 1 .. B[6:0] = 0xCE | 0xD6
|
|
|
|
|
// 1 .. C[6:0] = 0x8D | 0x9D
|
|
|
|
|
//TODO: test
|
|
|
|
|
self.interface.cmd_with_data(spi, Command::BOOSTER_SOFT_START_CONTROL, &[0xD7, 0xD6, 0x9D])?; |
|
|
|
|
self.interface.cmd_with_data( |
|
|
|
|
spi, |
|
|
|
|
Command::BOOSTER_SOFT_START_CONTROL, |
|
|
|
|
&[0xD7, 0xD6, 0x9D], |
|
|
|
|
)?; |
|
|
|
|
|
|
|
|
|
// One Databyte with value 0xA8 for 7V VCOM
|
|
|
|
|
self.interface.cmd_with_data(spi, Command::WRITE_VCOM_REGISTER, &[0xA8])?; |
|
|
|
|
self.interface |
|
|
|
|
.cmd_with_data(spi, Command::WRITE_VCOM_REGISTER, &[0xA8])?; |
|
|
|
|
|
|
|
|
|
// One Databyte with default value 0x1A for 4 dummy lines per gate
|
|
|
|
|
self.interface.cmd_with_data(spi, Command::SET_DUMMY_LINE_PERIOD, &[0x1A])?; |
|
|
|
|
self.interface |
|
|
|
|
.cmd_with_data(spi, Command::SET_DUMMY_LINE_PERIOD, &[0x1A])?; |
|
|
|
|
|
|
|
|
|
// One Databyte with default value 0x08 for 2us per line
|
|
|
|
|
self.interface.cmd_with_data(spi, Command::SET_GATE_LINE_WIDTH, &[0x08])?; |
|
|
|
|
self.interface |
|
|
|
|
.cmd_with_data(spi, Command::SET_GATE_LINE_WIDTH, &[0x08])?; |
|
|
|
|
|
|
|
|
|
// One Databyte with default value 0x03
|
|
|
|
|
// -> address: x increment, y increment, address counter is updated in x direction
|
|
|
|
|
self.interface.cmd_with_data(spi, Command::DATA_ENTRY_MODE_SETTING, &[0x03])?; |
|
|
|
|
self.interface |
|
|
|
|
.cmd_with_data(spi, Command::DATA_ENTRY_MODE_SETTING, &[0x03])?; |
|
|
|
|
|
|
|
|
|
self.set_lut(spi) |
|
|
|
|
self.set_lut(spi, None) |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
impl<SPI, CS, BUSY, DC, RST> |
|
|
|
|
WaveshareDisplay<SPI, CS, BUSY, DC, RST> |
|
|
|
|
impl<SPI, CS, BUSY, DC, RST> WaveshareDisplay<SPI, CS, BUSY, DC, RST> |
|
|
|
|
for EPD2in9<SPI, CS, BUSY, DC, RST> |
|
|
|
|
where |
|
|
|
|
SPI: Write<u8>, |
|
|
|
|
@ -130,13 +142,19 @@ where
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
fn new<DELAY: DelayMs<u8>>( |
|
|
|
|
spi: &mut SPI, cs: CS, busy: BUSY, dc: DC, rst: RST, delay: &mut DELAY, |
|
|
|
|
spi: &mut SPI, |
|
|
|
|
cs: CS, |
|
|
|
|
busy: BUSY, |
|
|
|
|
dc: DC, |
|
|
|
|
rst: RST, |
|
|
|
|
delay: &mut DELAY, |
|
|
|
|
) -> Result<Self, SPI::Error> { |
|
|
|
|
let interface = DisplayInterface::new(cs, busy, dc, rst); |
|
|
|
|
|
|
|
|
|
let mut epd = EPD2in9 { |
|
|
|
|
interface, |
|
|
|
|
background_color: DEFAULT_BACKGROUND_COLOR, |
|
|
|
|
refresh: RefreshLUT::FULL, |
|
|
|
|
}; |
|
|
|
|
|
|
|
|
|
epd.init(spi, delay)?; |
|
|
|
|
@ -144,25 +162,29 @@ where
|
|
|
|
|
Ok(epd) |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
fn sleep(&mut self, spi: &mut SPI) -> Result<(), SPI::Error> { |
|
|
|
|
// 0x00 for Normal mode (Power on Reset), 0x01 for Deep Sleep Mode
|
|
|
|
|
//TODO: is 0x00 needed here? (see also epd1in54)
|
|
|
|
|
self.interface.cmd_with_data(spi, Command::DEEP_SLEEP_MODE, &[0x00])?; |
|
|
|
|
self.interface |
|
|
|
|
.cmd_with_data(spi, Command::DEEP_SLEEP_MODE, &[0x00])?; |
|
|
|
|
|
|
|
|
|
self.wait_until_idle(); |
|
|
|
|
Ok(()) |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
fn wake_up<DELAY: DelayMs<u8>>(&mut self, spi: &mut SPI, delay: &mut DELAY) -> Result<(), SPI::Error> { |
|
|
|
|
fn wake_up<DELAY: DelayMs<u8>>( |
|
|
|
|
&mut self, |
|
|
|
|
spi: &mut SPI, |
|
|
|
|
delay: &mut DELAY, |
|
|
|
|
) -> Result<(), SPI::Error> { |
|
|
|
|
self.init(spi, delay) |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
fn update_frame(&mut self, spi: &mut SPI, buffer: &[u8]) -> Result<(), SPI::Error> { |
|
|
|
|
self.use_full_frame(spi)?; |
|
|
|
|
|
|
|
|
|
self.interface.cmd_with_data(spi, Command::WRITE_RAM, buffer) |
|
|
|
|
self.interface |
|
|
|
|
.cmd_with_data(spi, Command::WRITE_RAM, buffer) |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
//TODO: update description: last 3 bits will be ignored for width and x_pos
|
|
|
|
|
@ -178,13 +200,15 @@ where
|
|
|
|
|
self.set_ram_area(spi, x, y, x + width, y + height)?; |
|
|
|
|
self.set_ram_counter(spi, x, y)?; |
|
|
|
|
|
|
|
|
|
self.interface.cmd_with_data(spi, Command::WRITE_RAM, buffer) |
|
|
|
|
self.interface |
|
|
|
|
.cmd_with_data(spi, Command::WRITE_RAM, buffer) |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
fn display_frame(&mut self, spi: &mut SPI) -> Result<(), SPI::Error> { |
|
|
|
|
// enable clock signal, enable cp, display pattern -> 0xC4 (tested with the arduino version)
|
|
|
|
|
//TODO: test control_1 or control_2 with default value 0xFF (from the datasheet)
|
|
|
|
|
self.interface.cmd_with_data(spi, Command::DISPLAY_UPDATE_CONTROL_2, &[0xC4])?; |
|
|
|
|
self.interface |
|
|
|
|
.cmd_with_data(spi, Command::DISPLAY_UPDATE_CONTROL_2, &[0xC4])?; |
|
|
|
|
|
|
|
|
|
self.interface.cmd(spi, Command::MASTER_ACTIVATION)?; |
|
|
|
|
// MASTER Activation should not be interupted to avoid currption of panel images
|
|
|
|
|
@ -198,15 +222,10 @@ where
|
|
|
|
|
// clear the ram with the background color
|
|
|
|
|
let color = self.background_color.get_byte_value(); |
|
|
|
|
|
|
|
|
|
//TODO: this is using a big buffer atm, is it better to just loop over sending a single byte?
|
|
|
|
|
self.interface.cmd_with_data( |
|
|
|
|
spi, |
|
|
|
|
Command::WRITE_RAM, |
|
|
|
|
&[color; WIDTH as usize / 8 * HEIGHT as usize] |
|
|
|
|
) |
|
|
|
|
self.interface.cmd(spi, Command::WRITE_RAM)?; |
|
|
|
|
self.interface.data_x_times(spi, color, WIDTH / 8 * HEIGHT) |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
/// Sets the backgroundcolor for various commands like [WaveshareInterface::clear_frame()](clear_frame())
|
|
|
|
|
fn set_background_color(&mut self, background_color: Color) { |
|
|
|
|
self.background_color = background_color; |
|
|
|
|
} |
|
|
|
|
@ -214,6 +233,20 @@ where
|
|
|
|
|
fn background_color(&self) -> &Color { |
|
|
|
|
&self.background_color |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
fn set_lut( |
|
|
|
|
&mut self, |
|
|
|
|
spi: &mut SPI, |
|
|
|
|
refresh_rate: Option<RefreshLUT>, |
|
|
|
|
) -> Result<(), SPI::Error> { |
|
|
|
|
if let Some(refresh_lut) = refresh_rate { |
|
|
|
|
self.refresh = refresh_lut; |
|
|
|
|
} |
|
|
|
|
match self.refresh { |
|
|
|
|
RefreshLUT::FULL => self.set_lut_helper(spi, &LUT_FULL_UPDATE), |
|
|
|
|
RefreshLUT::QUICK => self.set_lut_helper(spi, &LUT_PARTIAL_UPDATE), |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
impl<SPI, CS, BUSY, DC, RST> EPD2in9<SPI, CS, BUSY, DC, RST> |
|
|
|
|
@ -228,7 +261,7 @@ where
|
|
|
|
|
self.interface.wait_until_idle(false); |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
pub(crate) fn use_full_frame(&mut self, spi: &mut SPI) -> Result<(), SPI::Error> { |
|
|
|
|
fn use_full_frame(&mut self, spi: &mut SPI) -> Result<(), SPI::Error> { |
|
|
|
|
// choose full frame/ram
|
|
|
|
|
self.set_ram_area(spi, 0, 0, WIDTH - 1, HEIGHT - 1)?; |
|
|
|
|
|
|
|
|
|
@ -236,7 +269,7 @@ where
|
|
|
|
|
self.set_ram_counter(spi, 0, 0) |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
pub(crate) fn set_ram_area( |
|
|
|
|
fn set_ram_area( |
|
|
|
|
&mut self, |
|
|
|
|
spi: &mut SPI, |
|
|
|
|
start_x: u32, |
|
|
|
|
@ -252,49 +285,46 @@ where
|
|
|
|
|
self.interface.cmd_with_data( |
|
|
|
|
spi, |
|
|
|
|
Command::SET_RAM_X_ADDRESS_START_END_POSITION, |
|
|
|
|
&[(start_x >> 3) as u8, (end_x >> 3) as u8] |
|
|
|
|
&[(start_x >> 3) as u8, (end_x >> 3) as u8], |
|
|
|
|
)?; |
|
|
|
|
|
|
|
|
|
// 2 Databytes: A[7:0] & 0..A[8] for each - start and end
|
|
|
|
|
self.interface.cmd_with_data(spi, Command::SET_RAM_Y_ADDRESS_START_END_POSITION, |
|
|
|
|
&[start_y as u8, (start_y >> 8) as u8, end_y as u8, (end_y >> 8) as u8] |
|
|
|
|
self.interface.cmd_with_data( |
|
|
|
|
spi, |
|
|
|
|
Command::SET_RAM_Y_ADDRESS_START_END_POSITION, |
|
|
|
|
&[ |
|
|
|
|
start_y as u8, |
|
|
|
|
(start_y >> 8) as u8, |
|
|
|
|
end_y as u8, |
|
|
|
|
(end_y >> 8) as u8, |
|
|
|
|
], |
|
|
|
|
) |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
pub(crate) fn set_ram_counter(&mut self, spi: &mut SPI, x: u32, y: u32) -> Result<(), SPI::Error> { |
|
|
|
|
fn set_ram_counter(&mut self, spi: &mut SPI, x: u32, y: u32) -> Result<(), SPI::Error> { |
|
|
|
|
// x is positioned in bytes, so the last 3 bits which show the position inside a byte in the ram
|
|
|
|
|
// aren't relevant
|
|
|
|
|
self.interface.cmd_with_data(spi, Command::SET_RAM_X_ADDRESS_COUNTER, &[(x >> 3) as u8])?; |
|
|
|
|
self.interface |
|
|
|
|
.cmd_with_data(spi, Command::SET_RAM_X_ADDRESS_COUNTER, &[(x >> 3) as u8])?; |
|
|
|
|
|
|
|
|
|
// 2 Databytes: A[7:0] & 0..A[8]
|
|
|
|
|
self.interface.cmd_with_data(spi, Command::SET_RAM_Y_ADDRESS_COUNTER, &[y as u8, (y >> 8) as u8])?; |
|
|
|
|
self.interface.cmd_with_data( |
|
|
|
|
spi, |
|
|
|
|
Command::SET_RAM_Y_ADDRESS_COUNTER, |
|
|
|
|
&[y as u8, (y >> 8) as u8], |
|
|
|
|
)?; |
|
|
|
|
|
|
|
|
|
self.wait_until_idle(); |
|
|
|
|
Ok(()) |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
/// Uses the slower full update
|
|
|
|
|
pub fn set_lut(&mut self, spi: &mut SPI) -> Result<(), SPI::Error> { |
|
|
|
|
self.set_lut_helper(spi, &LUT_FULL_UPDATE) |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
/// Uses the quick partial refresh
|
|
|
|
|
pub fn set_lut_quick(&mut self, spi: &mut SPI) -> Result<(), SPI::Error> { |
|
|
|
|
self.set_lut_helper(spi, &LUT_PARTIAL_UPDATE) |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
//TODO: assert length for LUT is exactly 30
|
|
|
|
|
//fn set_lut_manual(&mut self, buffer: &[u8]) -> Result<(), E> {
|
|
|
|
|
// self.set_lut_helper(buffer)
|
|
|
|
|
//}
|
|
|
|
|
|
|
|
|
|
fn set_lut_helper(&mut self, spi: &mut SPI, buffer: &[u8]) -> Result<(), SPI::Error> { |
|
|
|
|
assert!(buffer.len() == 30); |
|
|
|
|
self.interface.cmd_with_data(spi, Command::WRITE_LUT_REGISTER, buffer) |
|
|
|
|
self.interface |
|
|
|
|
.cmd_with_data(spi, Command::WRITE_LUT_REGISTER, buffer) |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#[cfg(test)] |
|
|
|
|
mod tests { |
|
|
|
|
use super::*; |
|
|
|
|
|
Chris
7 years ago
committed by
GitHub