From 10703dab70b152f2767734a97a34e0c42da17f76 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christoph=20Gro=C3=9F?= Date: Wed, 30 May 2018 15:53:01 +0200 Subject: [PATCH 1/5] Improved and updated Readme --- README.md | 40 +++++++++++++++++++++++----------------- 1 file changed, 23 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 53dce45..cae4649 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,38 @@ -[![Build Status](https://travis-ci.com/Caemor/eink-waveshare-rs.svg?branch=master)](https://travis-ci.com/Caemor/eink-waveshare-rs) +# eink-waveshare-rs [![Build Status](https://travis-ci.com/Caemor/eink-waveshare-rs.svg?branch=master)](https://travis-ci.com/Caemor/eink-waveshare-rs) -# eink-waveshare-rs +This library contains a driver for the [4.2 Inch E-Paper Moduel](https://www.waveshare.com/wiki/4.2inch_e-Paper_Module) from Waveshare. -IN WORK! Drivers for various EPDs from Waveshare. +Support for more (especially the smaller and faster ones) should follow after the library around the 4.2" EInk is stable and tested enough. + + +## 4.2 Inch E-Ink + +Out of the Box the original driver from Waveshare supported only full updates. Currently only support for the 4.2 Black/White one Be careful with the partial updates! It was only tested in a mBED implementation, the rust one wasn't tested enough yet!!! +### 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 example (e.g. for f3) +- [ ] 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 Apache+MIT Dual Version as used in many other projects? - +- [ ] License: Stay with ISC (=MIT) or go to the Apache+MIT Dual License as used in many other projects? ## Graphics/Drawing @@ -31,17 +48,6 @@ Chars and Strings work with a 8x8-Font. Support for bigger sized/independent Fonts is in work. - -### With a Buffer - -- Chars, Strings and filled circles are still missing -- maybe work with traits here for line_drawing and so on? - -### Without a Buffer - -Maybe add support for Non-Buffer drawing from the https://crates.io/crates/embedded-graphics Crate later on. - - ## Examples There is an example for Raspberry Pi in the example folder. From ac3eca75486defacb51acb3375d9b6f7727aea8d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christoph=20Gro=C3=9F?= Date: Mon, 16 Jul 2018 13:35:20 +0200 Subject: [PATCH 2/5] Added a few more devices to the overview in the readme --- README.md | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index cae4649..b480912 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,28 @@ # eink-waveshare-rs [![Build Status](https://travis-ci.com/Caemor/eink-waveshare-rs.svg?branch=master)](https://travis-ci.com/Caemor/eink-waveshare-rs) -This library contains a driver for the [4.2 Inch E-Paper Moduel](https://www.waveshare.com/wiki/4.2inch_e-Paper_Module) from Waveshare. +This library contains a driver for the [4.2 Inch E-Paper Module](https://www.waveshare.com/wiki/4.2inch_e-Paper_Module) from Waveshare. Support for more (especially the smaller and faster ones) should follow after the library around the 4.2" EInk is stable and tested enough. +# (Supported) Devices -## 4.2 Inch E-Ink +| Device | Colors | Partial Refresh | Supported | Tested | +| :---: | --- | :---: | :---: | :---: | +| 4.2 Inch B/W | Black, White | Not officially [1] | ✔ | ✔ | +| 1.54 Inch B/W | Black, White | ✔ | | | +| 2.13 Inch B/W | Black, White | ✔ | | | +| 2.9 Inch B/W | Black, White | ✔ | | | -Out of the Box the original driver from Waveshare supported only full updates. -Currently only support for the 4.2 Black/White one +## 4.2 Inch E-Ink Black/White -Be careful with the partial updates! +Out of the Box the original driver from Waveshare only supports full updates. + +But behind Be careful with the partial updates! It was only tested in a mBED implementation, the rust one wasn't tested enough yet!!! +[1]: It's possible with this driver but might lead to ghosting / burn-in effects therefore it's hidden behind a feature. + ### Interface | Interface | Description | @@ -52,3 +61,6 @@ Support for bigger sized/independent Fonts is in work. There is an example for Raspberry Pi in the example folder. + + + From 4690dd70a4d888462613bc81b5239e8499c3dfae Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christoph=20Gro=C3=9F?= Date: Mon, 16 Jul 2018 13:40:52 +0200 Subject: [PATCH 3/5] further improvments --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b480912..9267dc1 100644 --- a/README.md +++ b/README.md @@ -4,29 +4,29 @@ This library contains a driver for the [4.2 Inch E-Paper Module](https://www.wav Support for more (especially the smaller and faster ones) should follow after the library around the 4.2" EInk is stable and tested enough. -# (Supported) Devices +## (Supported) Devices | Device | Colors | Partial Refresh | Supported | Tested | | :---: | --- | :---: | :---: | :---: | -| 4.2 Inch B/W | Black, White | Not officially [1] | ✔ | ✔ | +| 4.2 Inch B/W | Black, White | Not officially [1](#42-inch-e-ink-blackwhite) | ✔ | ✔ | | 1.54 Inch B/W | Black, White | ✔ | | | | 2.13 Inch B/W | Black, White | ✔ | | | | 2.9 Inch B/W | Black, White | ✔ | | | -## 4.2 Inch E-Ink Black/White +### 4.2 Inch E-Ink Black/White Out of the Box the original driver from Waveshare only supports full updates. But behind Be careful with the partial updates! -It was only tested in a mBED implementation, the rust one wasn't tested enough yet!!! +It was only tested in a Mbed implementation, the rust one wasn't tested enough yet!!! [1]: 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 | From e61792eb2a658ba486cbd362575a5341d435e1f0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christoph=20Gro=C3=9F?= Date: Mon, 16 Jul 2018 13:42:46 +0200 Subject: [PATCH 4/5] further improvements --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9267dc1..f726d0e 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Support for more (especially the smaller and faster ones) should follow after th | Device | Colors | Partial Refresh | Supported | Tested | | :---: | --- | :---: | :---: | :---: | -| 4.2 Inch B/W | Black, White | Not officially [1](#42-inch-e-ink-blackwhite) | ✔ | ✔ | +| 4.2 Inch B/W | Black, White | Not officially [[1](#42-inch-e-ink-blackwhite)] | ✔ | ✔ | | 1.54 Inch B/W | Black, White | ✔ | | | | 2.13 Inch B/W | Black, White | ✔ | | | | 2.9 Inch B/W | Black, White | ✔ | | | @@ -18,9 +18,7 @@ Support for more (especially the smaller and faster ones) should follow after th Out of the Box the original driver from Waveshare only supports full updates. -But behind Be careful with the partial updates! -It was only tested in a Mbed implementation, the rust one wasn't tested enough yet!!! - +Be careful with the quick refresh updates: [1]: It's possible with this driver but might lead to ghosting / burn-in effects therefore it's hidden behind a feature. ### Interface From a47e965b836c534af6818a05d9bc5bdf8f09e9ab Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christoph=20Gro=C3=9F?= Date: Mon, 16 Jul 2018 14:03:49 +0200 Subject: [PATCH 5/5] further small readme improvements --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f726d0e..9b7834c 100644 --- a/README.md +++ b/README.md @@ -18,8 +18,8 @@ Support for more (especially the smaller and faster ones) should follow after th Out of the Box the original driver from Waveshare only supports full updates. -Be careful with the quick refresh updates: -[1]: It's possible with this driver but might lead to ghosting / burn-in effects therefore it's hidden behind a feature. +- [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