Add documentation

embedded-hal-1.0
Johan Kristell 2019-12-26 12:44:42 +01:00
parent d0b7f162fe
commit b170e34028
3 changed files with 6 additions and 0 deletions

View File

@ -45,6 +45,7 @@ epd.display_frame(&mut spi)?;
| [1.54 Inch B/W (A)](https://www.waveshare.com/1.54inch-e-Paper-Module.htm) | Black, White | ✕ | ✔ | ✔ | ✔ |
| [2.13 Inch B/W (A)](https://www.waveshare.com/product/2.13inch-e-paper-hat.htm) | Black, White | ✕ | ✔ | | |
| [2.9 Inch B/W (A)](https://www.waveshare.com/product/2.9inch-e-paper-module.htm) | Black, White | ✕ | ✔ | ✔ | ✔ [[2](#2-29-inch-e-ink-blackwhite---tests)] |
| [1.54 Inch B/W/R (B)](https://www.waveshare.com/product/modules/oleds-lcds/e-paper/1.54inch-e-paper-module-b.htm) | Black, White, Red | ✕ | ✕ | ✔ | ✔ |
### [1]: 4.2 Inch E-Ink Black/White - Partial Refresh

View File

@ -1,3 +1,5 @@
//! A simple Driver for the Waveshare 1.54" (B) E-Ink Display via SPI
use embedded_hal::{
blocking::{delay::*, spi::Write},
digital::*,

View File

@ -52,6 +52,8 @@ where
) -> Result<(), SPI::Error>;
}
/// Functions to interact with two color panels
pub trait WaveshareTwoColorDisplay<SPI, CS, BUSY, DC, RST>:
WaveshareDisplay<SPI, CS, BUSY, DC, RST>
where
@ -61,6 +63,7 @@ where
DC: OutputPin,
RST: OutputPin,
{
/// Update both color planes
fn update_both_planes(
&mut self,
spi: &mut SPI,