EPD support

Cargo.toml

@@ -16,6 +16,7 @@ ratatui = { version = "0.29", default-features = false, features = ["all-widgets
 embedded-graphics = "0.8.1"
 embedded-graphics-simulator = { version = "0.7.0", optional = true }
 embedded-graphics-unicodefonts = { version = "0.0.3", optional = true }
+weact-studio-epd = { version = "0.1.2", features = ["blocking"], optional = true }
 
 [dev-dependencies]
 rstest = "0.25.0"
@@ -25,6 +26,7 @@ paste = "1.0.15"
 default = ["fonts"]
 simulator = ["dep:embedded-graphics-simulator"]
 fonts = ["dep:embedded-graphics-unicodefonts"]
+epd-weact = ["dep:weact-studio-epd"]
 
 [lints.rust]
 missing_docs = "warn"

README.md

@@ -38,7 +38,7 @@ fn main() -> Result<(), std::io::Error> {
     // Any embedded_graphics DrawTarget
     let mut display = MyDrawTarget::new();
 
-    let backend = EmbeddedBackend::new(&mut display);
+    let backend = EmbeddedBackend::new(&mut display, EmbeddedBackendConfig::default());
     let mut terminal = Terminal::new(backend)?;
 
     loop {
@@ -100,6 +100,40 @@ fn main() -> Result<(), std::io::Error> {
 }
 ```
 
+### EPD support
+
+<div align="center">
+
+![WeAct epd demo](https://github.com/j-g00da/mousefood/blob/fa70cdd46567a51895caf10c44fff4104602e880/assets/epd-weact.jpg?raw=true)
+
+</div>
+
+Support for EPD (e-ink displays) produced by WeAct Studio
+(`weact-studio-epd` driver) can be enabled using `epd-weact` feature.
+This driver requires some additional configuration:
+
+```rust
+use mousefood::prelude::*;
+use weact_studio_epd::graphics::Display290BlackWhite;
+use weact_studio_epd::WeActStudio290BlackWhiteDriver;
+
+// Configure SPI
+// (...)
+
+let mut driver = WeActStudio290BlackWhiteDriver::new(spi_interface, busy, rst, delay);
+let mut display = Display290BlackWhite::new();
+
+driver.init().unwrap();
+
+let config = EmbeddedBackendConfig {
+    flush_callback: Box::new(move |d| { driver.full_update(d).unwrap(); }),
+    ..Default::default()
+};
+let backend = EmbeddedBackend::new(&mut display, config);
+```
+
+Support for `epd_waveshare` driver is planned in the future.
+
 ## Performance and hardware support
 
 Flash memory on most embedded devices is very limited. Additionally,

examples/simulator.rs

@@ -1,3 +1,5 @@
+//! Example using a simulator.
+
 extern crate mousefood;
 
 use mousefood::embedded_graphics::geometry;
@@ -7,7 +9,8 @@ use mousefood::simulator::SimulatorDisplay;
 
 fn main() -> Result<(), std::io::Error> {
     let mut display = SimulatorDisplay::<Bgr565>::new(geometry::Size::new(128, 64));
-    let backend: EmbeddedBackend<SimulatorDisplay<_>, _> = EmbeddedBackend::new(&mut display);
+    let backend: EmbeddedBackend<SimulatorDisplay<_>, _> =
+        EmbeddedBackend::new(&mut display, EmbeddedBackendConfig::default());
     let mut terminal = Terminal::new(backend)?;
 
     loop {