epd-datafuri 0.1.1

Driver for Adafruit e-Paper display (EPD) controllers (SSD1680, IL0373), for use with embedded-hal
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127

# epd-datafuri

Rust driver for Adafruit e-Paper displays (EPD), for use with [embedded-hal].

## Supported Displays

| Display | Controller | Colors | Grayscale |
|---------|-----------|--------|-----------|
| Adafruit ThinkInk 2.9" EAAMFGN (2025 MagTag) | SSD1680 | BW | Gray2 (2-bit, 4-level) |
| Adafruit ThinkInk 2.9" T5 (original MagTag) | IL0373 | BW | Gray2 (2-bit, 4-level) |

[![crates.io](https://img.shields.io/crates/v/epd-datafuri.svg)](https://crates.io/crates/epd-datafuri)
[![Documentation](https://docs.rs/epd-datafuri/badge.svg)](https://docs.rs/epd-datafuri/)

Supported controllers:
- **SSD1680** (Solomon Systech): [datasheet][SSD1680]
- **IL0373** (Good Display):  [datasheet][IL0373]

[Documentation][MagTag]

## Description

Built using [embedded-hal] and optionally [embedded-graphics].

### Grayscale

2-bit, 4-level grayscale (Gray2) is supported for both displays. Each display module
exports its own `Display2in9Gray2` with the correct plane mapping for that
controller:

- `adafruit_thinkink_290_mfgn::Display2in9Gray2` for the ThinkInk 2.9" (SSD1680)
- `adafruit_thinkink_290_t5::Display2in9Gray2` for the MagTag 2.9" (IL0373)

### Partial Updates

Partial updates are not supported.

## Usage

### ThinkInk 2.9" — Monochrome (SSD1680)

```rust
use epd_datafuri::displays::adafruit_thinkink_290_mfgn::{ThinkInk2in9Mono, Display2in9Mono};
use epd_datafuri::prelude::*;

let mut driver = ThinkInk2in9Mono::new(spi, busy, dc, rst)?;
let mut display = Display2in9Mono::new();

// Draw using embedded-graphics
Text::new("Hello!", Point::new(10, 20), text_style).draw(&mut display)?;

driver.begin(&mut delay)?;
driver.update_and_display(display.buffer(), &mut delay)?;
```

### ThinkInk 2.9" — Grayscale (SSD1680)

```rust
use epd_datafuri::displays::adafruit_thinkink_290_mfgn::{ThinkInk2in9Gray2, Display2in9Gray2};
use epd_datafuri::prelude::*;
use embedded_graphics::pixelcolor::Gray2;

let mut driver = ThinkInk2in9Gray2::new(spi, busy, dc, rst)?;
let mut display = Display2in9Gray2::new();

// Draw using embedded-graphics with 4-level gray
Text::new("Hello!", Point::new(10, 20), text_style).draw(&mut display)?;
Rectangle::new(Point::new(50, 50), Size::new(40, 40))
    .into_styled(PrimitiveStyle::with_fill(Gray2::new(1)))
    .draw(&mut display)?;

driver.begin(&mut delay)?;
driver.update_gray2_and_display(display.high_buffer(), display.low_buffer(), &mut delay)?;
```

### MagTag 2.9" — Grayscale (IL0373)

```rust
use epd_datafuri::displays::adafruit_thinkink_290_t5::{ThinkInk2in9Gray2, Display2in9Gray2};
use epd_datafuri::prelude::*;
use embedded_graphics::pixelcolor::Gray2;

let mut driver = ThinkInk2in9Gray2::new(spi, busy, dc, rst)?;
let mut display = Display2in9Gray2::new();

// Draw using embedded-graphics with 4-level gray
Text::new("Hello!", Point::new(10, 20), text_style).draw(&mut display)?;
Rectangle::new(Point::new(50, 50), Size::new(40, 40))
    .into_styled(PrimitiveStyle::with_fill(Gray2::new(1)))
    .draw(&mut display)?;

driver.begin(&mut delay)?;
driver.update_gray2_and_display(display.high_buffer(), display.low_buffer(), &mut delay)?;
```

## Examples

- [ESP32-S2 MagTag examples](examples/)
  - `adafruit_magtag_bw`: black/white rendering (SSD1680)
  - `adafruit_magtag_gray2`: 4-level grayscale rendering (SSD1680)
  - `adafruit_magtag_legacy_gray2`: 4-level grayscale rendering (IL0373)
- [MagTag example project](https://github.com/ScottCUSA/magtag_weatherstation_rs)

## Credits

This crate was originally a fork of [ssd1680](https://crates.io/crates/ssd1680) by
[Konstantin Terekhov](https://github.com/mbv). It has been heavily modified 
to support the Adafruit MagTag EPD displays.

* [Arduino Display Library for SPI E-Paper Displays](https://github.com/ZinggJM/GxEPD2)
* [Adafruit ThinkInk Arduino library](https://github.com/adafruit/Adafruit_EPD)
* [SSD1681 EPD driver](https://github.com/afajl/ssd1681)
* [Waveshare EPD driver](https://github.com/caemor/epd-waveshare)

## License

`epd-datafuri` is dual licenced under:

- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) **or**
  http://www.apache.org/licenses/LICENSE-2.0)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

[embedded-hal]: https://crates.io/crates/embedded-hal
[embedded-graphics]: https://github.com/embedded-graphics/embedded-graphics
[SSD1680]: https://learn.adafruit.com/adafruit-2-9-eink-display-breakouts-and-featherwings/downloads
[IL0373]: https://www.smart-prototyping.com/image/data/9_Modules/EinkDisplay/GDEW0154T8/IL0373.pdf
[MagTag]: https://learn.adafruit.com/adafruit-magtag