You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Go to file
Chris 91b723d30e
Merge pull request #23 from caemor/test-codecov
test codecov
5 years ago
ci added ci 5 years ago
examples Fix wrongly named dep in examples 5 years ago
src Prepare release 5 years ago
.gitignore some changes 5 years ago
.travis.yml ci update 5 years ago - Renaming to epd-waveshare 5 years ago
Cargo.toml Fix repository name 5 years ago Create 5 years ago Prepare release 5 years ago

Build Status

This library contains a driver for E-Paper Modules from Waveshare.

It uses the embedded graphics library for the optional graphics support.


There are multiple examples in the examples folder. For more infos about the examples see the seperate Readme there.

// Setup the epd
let mut epd = EPD4in2::new(&mut spi, cs, busy, dc, rst, &mut delay)?;

// Setup the graphics
let mut buffer = Buffer4in2::default();
let mut display = Display::new(epd.width(), epd.height(), &mut buffer.buffer);

// Draw some text
    Font12x16::render_str("Hello Rust!")
        .translate(Coord::new(5, 50))

// Transfer the frame data to the epd
epd.update_frame(&mut spi, &display.buffer())?;

// Display the frame on the epd
epd.display_frame(&mut spi)?;

(Supported) Devices

Device (with Link) Colors Flexible Display Partial Refresh Supported Tested
4.2 Inch B/W (A) Black, White Not officially [1]
1.54 Inch B/W (A) Black, White
2.13 Inch B/W (A) Black, White
2.9 Inch B/W (A) Black, White ✔ [2]

[1]: 4.2 Inch E-Ink Black/White - Partial Refresh

Out of the Box the original driver from Waveshare only supports full updates.

That means: Be careful with the quick refresh updates:
It's possible with this driver but might lead to ghosting / burn-in effects therefore it's hidden behind a feature.

[2]: 2.9 Inch E-Ink Black/White - Tests

Since my 2.9 Inch Display has some blurring issues I am not absolutly sure if everything was working correctly as it should :-)


Interface Description
VCC 3.3V
CS SPI chip select (Low active)
DC Data/Command control pin (High for data, and low for command)
RST External reset pin (Low for reset)
BUSY Busy state output pin (Low for busy)

Display Configs

There are two types of Display Configurations used in Wavedshare EPDs, which also needs to be set on the "new" E-Paper Driver HAT. They are also called A and B, but you shouldn't get confused and mix it with the Type A,B,C and D of the various Displays, which just describe different types (colored variants) or new versions. In the Display Config the seperation is most likely due to included fast partial refresh of the displays. In a Tabular form:

Type A Tybe B
1.54in (A) 1.54in (B)
2.13in (A) 1.54in (C)
2.13in (D) 2.13in (B)
2.9in (A) 2.13in (C)
2.7in (A)
2.7in (B)
2.9in (B)
2.9in (C)
4.2in (A)
4.2in (B)
4.2in (C)
7.5in (A)
7.5in (B)
7.5in (C)


  • improve the partial drawing/check the timings/timing improvements/....