Go to file
Chris 4feeecf444
Update README.md
Updated readme to represent the current status of the project better
2018-08-03 09:30:41 +02:00
ci added ci 2018-05-11 14:02:55 +02:00
examples/embedded_linux Stablised traits and interfaces, converted epd4in2 to it, and started real work on epd2in9 2018-07-19 16:46:15 +02:00
src improved documenation 2018-07-26 15:57:07 +02:00
.gitignore some changes 2018-05-09 16:50:54 +02:00
.travis.yml another try at the travis.yml 2018-05-24 15:08:18 +02:00
Cargo.toml added a comment 2018-07-23 14:33:55 +02:00
License.md Create License.md 2018-05-04 13:25:57 +02:00
README.md Update README.md 2018-08-03 09:30:41 +02:00

README.md

eink-waveshare-rs Build Status

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

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

(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)

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.