+1
日增长
300
stars
216
forks
6
watchers
199
prs
16
issues
0
releases
README
FreeInk SDK A hardware-independent SDK for building e-paper reader firmware. FreeInk abstracts every device-specific detail — display controller, waveforms/LUTs, GPIOs, bus speeds, input style, touch, frontlight, audio — behind small, injectable interfaces, so the firmware calls one generic API and gets device-specific behavior. Adding a new device means adding data (a board profile + a driver config), not editing the generic code. It is drop-in compatible with firmware written against the original EInkDisplay / InputManager / BatteryMonitor / SDCardManager / BoardConfig API: switching to FreeInk is a matter of repointing the library path. Start with PlatformIO integration, browse the documentation index, or run the host tests. What's included - Display facade and panel drivers for SSD1677, UC8179, UC8253, UC8279, ED2208, IT8951, and external-library-backed panels. - Board profiles and capability gates for display, input, touch, SD, frontlight, audio, microphone, RTC, sensors, buzzer, LEDs, and TLS networking. - Device managers that keep firmware code stable across different boards: input, battery, SD, frontlight, LEDs, audio, microphone, RTC, sensors, and IMU. - FreeInkUI, an optional immediate-mode UI layer for e-paper reader screens, dialogs, settings, keyboards, library views, and future GUI-builder previews. - FreeInkBook, a complete EPUB reading engine — streaming parse, CSS, UAX 14 layout with hyphenation/justification/ligatures, page caching with exact position anchors, TTF fonts with per-codepoint fallback, image dithering, links/footnotes — freestanding, arena-allocated, host-tested (see docs/freeink-book.md). - Icon and asset tooling for crisp 1-bpp Lucide-derived icons and generated C/C++ assets. Credit & lineage FreeInk is an MIT-licensed re-architecture derived from the OpenX4 E-Paper Community SDK (open-x4-epaper/community-sdk, MIT) and its contributors — in particular CidVonHighwind for the original EInkDisplay driver and the X3/X4 waveform work, and the community device ports (M5Stack PaperColor, Murphy M3, and the community-sdk-de-link ESP32-S3 port). The register sequences and waveform LUTs for the SSD1677 and UC8253 panels are derived from that project — i.e. carried over and adapted, not reverse-engineered independently — so the community's panel tuning is preserved. Attribution is in NOTICE. Huge thanks to everyone who reverse-engineered and tuned those panels. See display driver reference coverage for the source hierarchy and the limits of matching GxEPD2 implementations. What FreeInk changes is the structure, not the panel work: where the upstream interleaves every device in one monolithic driver, FreeInk splits each controller into a standalone, compile-time-selectable driver behind a stable facade, with per-device behavior supplied as injectable config. It is not a fork and has no build-time or runtime dependency on the upstream repository — its own history and architecture — but the inheri
Top issues
#21M5 Paper S3 Support16 comments · 2026-07-25#13wolfSSL TLS handshake fails intermittently on ESP32-C37 comments · 2026-07-13#54X4 Pro: viewableInsets likely overestimate real bezel overlap (measured ~0px on all edges)3 comments · 2026-08-23#143X3: GPIO13 LOW does not cut power to the SD card on my unit2 comments · 2026-10-19#209OPDS: support bounded parsing of SD-staged feeds1 comments · 2026-11-13#2Question: expected setup for LilyGo T5 S3 EPD path1 comments · 2026-06-19#198PaperMono: M5IOE1 output writes are an unlocked read-modify-write shared across tasks0 comments · 2026-11-11#169JsonListParser capture budget counts rows the consumer drops0 comments · 2026-11-03