use epd2in9bc as base for implementing support epd2in13bc
parent
6679869bc3
commit
e1aada3b38
|
|
@ -0,0 +1,38 @@
|
|||
//! SPI Commands for the Waveshare 2.9" (B/C) E-Ink Display
|
||||
use crate::traits;
|
||||
|
||||
#[allow(dead_code)]
|
||||
#[derive(Copy, Clone)]
|
||||
pub(crate) enum Command {
|
||||
PanelSetting = 0x00,
|
||||
|
||||
PowerSetting = 0x01,
|
||||
PowerOff = 0x02,
|
||||
PowerOn = 0x04,
|
||||
BoosterSoftStart = 0x06,
|
||||
DeepSleep = 0x07,
|
||||
DataStartTransmission1 = 0x10,
|
||||
DisplayRefresh = 0x12,
|
||||
DataStartTransmission2 = 0x13,
|
||||
|
||||
LutForVcom = 0x20,
|
||||
LutWhiteToWhite = 0x21,
|
||||
LutBlackToWhite = 0x22,
|
||||
LutWhiteToBlack = 0x23,
|
||||
LutBlackToBlack = 0x24,
|
||||
|
||||
PllControl = 0x30,
|
||||
TemperatureSensor = 0x40,
|
||||
TemperatureSensorSelection = 0x41,
|
||||
VcomAndDataIntervalSetting = 0x50,
|
||||
ResolutionSetting = 0x61,
|
||||
VcmDcSetting = 0x82,
|
||||
PowerSaving = 0xE3,
|
||||
}
|
||||
|
||||
impl traits::Command for Command {
|
||||
/// Returns the address of the command
|
||||
fn address(self) -> u8 {
|
||||
self as u8
|
||||
}
|
||||
}
|
||||
|
|
@ -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<BinaryColor> for Display2in9bc {
|
||||
type Error = core::convert::Infallible;
|
||||
|
||||
fn draw_pixel(&mut self, pixel: Pixel<BinaryColor>) -> 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
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,389 @@
|
|||
//! 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, &mut delay)?;
|
||||
//!
|
||||
//!// Set the EPD to sleep
|
||||
//!epd.sleep(&mut spi, &mut delay)?;
|
||||
//!# 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<SPI, CS, BUSY, DC, RST, DELAY> {
|
||||
interface: DisplayInterface<SPI, CS, BUSY, DC, RST, DELAY>,
|
||||
color: Color,
|
||||
}
|
||||
|
||||
impl<SPI, CS, BUSY, DC, RST, DELAY> InternalWiAdditions<SPI, CS, BUSY, DC, RST, DELAY>
|
||||
for Epd2in9bc<SPI, CS, BUSY, DC, RST, DELAY>
|
||||
where
|
||||
SPI: Write<u8>,
|
||||
CS: OutputPin,
|
||||
BUSY: InputPin,
|
||||
DC: OutputPin,
|
||||
RST: OutputPin,
|
||||
DELAY: DelayMs<u8>,
|
||||
{
|
||||
fn init(&mut self, spi: &mut SPI, delay: &mut DELAY) -> Result<(), SPI::Error> {
|
||||
// Values taken from datasheet and sample code
|
||||
|
||||
self.interface.reset(delay, 10);
|
||||
|
||||
// start the booster
|
||||
self.interface
|
||||
.cmd_with_data(spi, Command::BoosterSoftStart, &[0x17, 0x17, 0x17])?;
|
||||
|
||||
// power on
|
||||
self.command(spi, Command::PowerOn)?;
|
||||
delay.delay_ms(5);
|
||||
self.wait_until_idle();
|
||||
|
||||
// set the panel settings
|
||||
self.cmd_with_data(spi, Command::PanelSetting, &[0x8F])?;
|
||||
|
||||
self.cmd_with_data(
|
||||
spi,
|
||||
Command::VcomAndDataIntervalSetting,
|
||||
&[WHITE_BORDER | VCOM_DATA_INTERVAL],
|
||||
)?;
|
||||
|
||||
// set resolution
|
||||
self.send_resolution(spi)?;
|
||||
|
||||
self.cmd_with_data(spi, Command::VcmDcSetting, &[0x0A])?;
|
||||
|
||||
self.wait_until_idle();
|
||||
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
impl<SPI, CS, BUSY, DC, RST, DELAY> WaveshareThreeColorDisplay<SPI, CS, BUSY, DC, RST, DELAY>
|
||||
for Epd2in9bc<SPI, CS, BUSY, DC, RST, DELAY>
|
||||
where
|
||||
SPI: Write<u8>,
|
||||
CS: OutputPin,
|
||||
BUSY: InputPin,
|
||||
DC: OutputPin,
|
||||
RST: OutputPin,
|
||||
DELAY: DelayMs<u8>,
|
||||
{
|
||||
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::DataStartTransmission1)?;
|
||||
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::DataStartTransmission2)?;
|
||||
self.interface.data(spi, chromatic)?;
|
||||
|
||||
self.wait_until_idle();
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
impl<SPI, CS, BUSY, DC, RST, DELAY> WaveshareDisplay<SPI, CS, BUSY, DC, RST, DELAY>
|
||||
for Epd2in9bc<SPI, CS, BUSY, DC, RST, DELAY>
|
||||
where
|
||||
SPI: Write<u8>,
|
||||
CS: OutputPin,
|
||||
BUSY: InputPin,
|
||||
DC: OutputPin,
|
||||
RST: OutputPin,
|
||||
DELAY: DelayMs<u8>,
|
||||
{
|
||||
type DisplayColor = Color;
|
||||
fn new(
|
||||
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 color = DEFAULT_BACKGROUND_COLOR;
|
||||
|
||||
let mut epd = Epd2in9bc { interface, color };
|
||||
|
||||
epd.init(spi, delay)?;
|
||||
|
||||
Ok(epd)
|
||||
}
|
||||
|
||||
fn sleep(&mut self, spi: &mut SPI, _delay: &mut DELAY) -> Result<(), SPI::Error> {
|
||||
// Section 8.2 from datasheet
|
||||
self.interface.cmd_with_data(
|
||||
spi,
|
||||
Command::VcomAndDataIntervalSetting,
|
||||
&[FLOATING_BORDER | VCOM_DATA_INTERVAL],
|
||||
)?;
|
||||
|
||||
self.command(spi, Command::PowerOff)?;
|
||||
// The example STM code from Github has a wait after PowerOff
|
||||
self.wait_until_idle();
|
||||
|
||||
self.cmd_with_data(spi, Command::DeepSleep, &[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],
|
||||
_delay: &mut DELAY,
|
||||
) -> Result<(), SPI::Error> {
|
||||
self.interface.cmd(spi, Command::DataStartTransmission1)?;
|
||||
|
||||
self.interface.data(spi, &buffer)?;
|
||||
|
||||
// Clear the chromatic layer
|
||||
let color = self.color.get_byte_value();
|
||||
|
||||
self.interface.cmd(spi, Command::DataStartTransmission2)?;
|
||||
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, _delay: &mut DELAY) -> Result<(), SPI::Error> {
|
||||
self.command(spi, Command::DisplayRefresh)?;
|
||||
|
||||
self.wait_until_idle();
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn update_and_display_frame(
|
||||
&mut self,
|
||||
spi: &mut SPI,
|
||||
buffer: &[u8],
|
||||
delay: &mut DELAY,
|
||||
) -> Result<(), SPI::Error> {
|
||||
self.update_frame(spi, buffer, delay)?;
|
||||
self.display_frame(spi, delay)?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn clear_frame(&mut self, spi: &mut SPI, _delay: &mut DELAY) -> Result<(), SPI::Error> {
|
||||
self.send_resolution(spi)?;
|
||||
|
||||
let color = DEFAULT_BACKGROUND_COLOR.get_byte_value();
|
||||
|
||||
// Clear the black
|
||||
self.interface.cmd(spi, Command::DataStartTransmission1)?;
|
||||
|
||||
self.interface.data_x_times(spi, color, NUM_DISPLAY_BITS)?;
|
||||
|
||||
// Clear the chromatic
|
||||
self.interface.cmd(spi, Command::DataStartTransmission2)?;
|
||||
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<RefreshLut>,
|
||||
) -> Result<(), SPI::Error> {
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn is_busy(&self) -> bool {
|
||||
self.interface.is_busy(IS_BUSY_LOW)
|
||||
}
|
||||
}
|
||||
|
||||
impl<SPI, CS, BUSY, DC, RST, DELAY> Epd2in9bc<SPI, CS, BUSY, DC, RST, DELAY>
|
||||
where
|
||||
SPI: Write<u8>,
|
||||
CS: OutputPin,
|
||||
BUSY: InputPin,
|
||||
DC: OutputPin,
|
||||
RST: OutputPin,
|
||||
DELAY: DelayMs<u8>,
|
||||
{
|
||||
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) {
|
||||
let _ = 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::ResolutionSetting)?;
|
||||
|
||||
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::VcomAndDataIntervalSetting,
|
||||
&[border | VCOM_DATA_INTERVAL],
|
||||
)
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue