il0373 0.2.0

Driver for the IL0373 e-Paper display (EPD) controller, for use with embedded-graphics
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

#![no_std]

//! IL0373 ePaper Display Driver
//!
//! For a complete example see
//! [the nucleo-f103rb example](https://github.com/gpgreen/il0373/tree/main/examples/stm32-eink).
//!
//! ### Usage
//!
//! To control a display you will need:
//!
//! * An [Interface] to the controller
//! * A [display configuration][Config]
//! * A [Display]
//!
//! The [Interface] captures the details of the hardware connection to
//! the IL0373 controller. This includes an SPI device and some GPIO
//! pins. The IL0373 can control many different displays that vary in
//! dimensions, rotation, and driving characteristics. The [Config]
//! captures these details.  To aid in constructing the [Config] there
//! is a [Builder] interface. Finally when you have an interface and a
//! [Config] a [Display] instance can be created.
//!
//!
//! Optionally the [Display] can be promoted to a [GraphicDisplay],
//! which allows it to use the functionality from the
//! [embedded-graphics crate][embedded-graphics]. The plain display
//! only provides the ability to update the display by passing
//! black/white and red buffers.
//!
//!
//! This driver can work with an SRAM device, to store the display
//! buffer on that device, to reduce the memory footprint on the
//! MCU. The SRAM device must be on the the same SPI port as the
//! il0373. For this option, use the feature `sram`. Instead of using
//! a [Interface] and [GraphicDisplay], use a [SpiSramBus], and an
//! associated [SramDisplayInterface], then a [SramGraphicDisplay].
//!
//!
//! To update the display you will typically follow this flow:
//!
//! 1. [reset](display/struct.Display.html#method.reset)
//! 1. [clear](graphics/struct.GraphicDisplay.html#method.clear)
//! 1. [update](graphics/struct.GraphicDisplay.html#method.update)
//! 1. [sleep](display/struct.Display.html#method.deep_sleep)
//!
//! [Interface]: interface/struct.Interface.html
//! [SpiSramBus]: interface/struct.SpiSramBus.html
//! [SramDisplayInterface]: interface/struct.SramDisplayInterface.html
//! [Display]: display/struct.Display.html
//! [GraphicDisplay]: display/struct.GraphicDisplay.html
//! [SramGraphicDisplay]: display/struct.SramGraphicDisplay.html
//! [Config]: config/struct.Config.html
//! [Builder]: config/struct.Builder.html
//! [embedded-graphics]: https://crates.io/crates/embedded-graphics

#[cfg(test)]
extern crate embedded_graphics;

extern crate embedded_graphics_core;
extern crate embedded_hal as hal;

#[cfg(test)]
#[macro_use]
extern crate std;

mod color;
pub mod command;
pub mod config;
pub mod display;
pub mod graphics;
pub mod interface;

pub use color::Color;
pub use config::Builder;
pub use display::{Dimensions, Display, Rotation};
pub use graphics::GraphicDisplay;
#[cfg(feature = "sram")]
pub use graphics::SramGraphicDisplay;
pub use interface::DisplayInterface;
pub use interface::Interface;
#[cfg(feature = "sram")]
pub use interface::SpiSramBus;
#[cfg(feature = "sram")]
pub use interface::SramDisplayInterface;