eink_waveshare_rs 0.1.0

An embedded-hal based driver for ePaper displays from Waveshare

eink-waveshare-rs Build Status

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

Support for more than the 4.2in EPD (especially the smaller and faster ones) is in the work.

The 2.9in (A) and 1.54 (A) variant should both work but aren't tested yet.

(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

4.2 Inch E-Ink Black/White

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

  • [1]: 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.

Interface

Interface Description
VCC 3.3V
GND GND
DIN SPI MOSI
CLK SPI SCK
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)

TODO's

  • add more examples (e.g. for f3)
  • improve the partial drawing/check the timings/timing improvements/....
  • for later: add support for the smaller waveshare epds
  • License: Stay with ISC (=MIT) or go to the Apache+MIT Dual License as used in many other projects?

Graphics/Drawing

Supports:

  • Lines
  • Squares
  • Circles
  • Pixels
  • Chars
  • Strings

Chars and Strings work with a 8x8-Font.

Support for bigger sized/independent Fonts is in work.

Examples

There is an example for Raspberry Pi in the example folder.