Start with the SDK overview and PlatformIO setup. Device build flags and dependencies are in platformio.sample.ini.
| Guide | Covers |
|---|---|
| ESP-IDF | Building the display and FreeInkUI as an ESP-IDF component, without arduino-esp32 |
| FreeInkUI | UI runtime, components, themes, input adapters, and adoption |
| FreeInkBook | EPUB parsing, layout, fonts, rendering, and caches |
| Grayscale capabilities | Overlay and absolute encodings, uploads, and recovery |
| Deferred refresh migration | Split refresh interface and consumer migration |
| MCU portability | Runtime profiles, GPIO wakeup, and C3/S3 differences |
| BLE keyboard host | Enabling and using BLE HID input |
| Haptic feedback | Consumer-triggered vibration, PWM intensity and asynchronous patterns |
| Adding touch | Every place to register a new touch device or controller |
| Testing | Local host regression suites and validation limits |
These notes distinguish implemented support, firmware-derived findings, and hardware validation. See the supported-device table for the full device list.
- Xteink X3 UC8279 variant
- Xteink X4 Pro
- Xteink X4 Classic
- EEGO A4
- LilyGo T5 S3
- M5Stack PaperS3
- Metalio E-Ink 4
- OnePage ESP32-C61
- Waveshare ESP32-S3-ePaper-3.97
- Display driver reference coverage: source hierarchy and change policy.
- X4 Pro Licorice firmware audit: findings tied to specific OEM firmware images.
- Attribution and license.