FreeInk: An Open Ecosystem for E-Readers

FreeInk is an open-source collective providing a full-stack approach to e-paper readers, encompassing software, firmware, and hardware. By open-sourcing every layer of the stack, the project aims to create a foundation where users can build, extend, and repair their own reading devices without being locked into proprietary ecosystems like Amazon Kindle or Kobo.

The CrossPoint Reader Firmware

CrossPoint is the community-built, open-source firmware designed for budget e-paper readers. It focuses on high-performance rendering and user control over the typography and connectivity.

Key Features

• EPUB Rendering: Supports EPUB 2 and 3 standards. To ensure near-instant re-opening of books, pages are cached to the SD card upon first open.
• Typography Control: Includes Noto Serif and Noto Sans, with support for custom fonts loaded from an SD card. Users can adjust spacing, margins, hyphenation, alignment, and anti-aliasing.
• Connectivity and Sync: The reader operates an upload server over WiFi, allowing users to drop EPUBs via a browser or Calibre. It also supports KOReader sync to maintain reading progress across devices.
• Focus Reading: A specialized reading mode that bolds the front of each word to guide the eye and set the pace.
• Internationalization: Full right-to-left (RTL) layout support for Hebrew and Arabic, with translated menus in over 10 languages including Spanish, French, and German.

The FreeInk SDK: Hardware Independence

FreeInk provides a hardware-independent SDK that abstracts the controller, waveforms, pins, and peripherals. This allows a single generic codebase to drive multiple different e-paper devices, making the addition of new boards a matter of configuration rather than a rewrite.

SDK Architecture

• Injectable Interfaces: Device-specific details (display controllers, GPIOs, bus speeds, touch, and frontlight) are handled via small injectable interfaces. The firmware calls a generic API, ensuring the firmware remains decoupled from the hardware.
• Composable Builds: Binaries are kept lean by gating capabilities like touch, frontlight, color, and audio via flags. These features are only included in the build if the device requires them.
• Networking: The SDK includes SecureNet, which bundles wolfSSL for TLS 1.3 + PSA support, bypassing standard mbedTLS stubs to allow connections to TLS-1.3-only servers.

de-link: Open Hardware Core

For those who want to build their own device, de-link is the open-hardware core of the project. It is a compact, hand-solderable ESP32-S3 board with published KiCad schematics and a full bill of materials (BOM).

Hardware Specifications

• Compute: ESP32-S3 (240 MHz, dual-core) with WiFi and BLE, 16 MB flash, and optional PSRAM.
• Display: 24-pin SPI e-paper interface compatible with GoodDisplay panels (ranging from 3.97" to 7.5" and larger).
• Storage: 4-bit SDMMC interface for microSD storage.
• Power: USB-C (OTG) charging with a bring-your-own LiPo battery, featuring overcharge and overdischarge protection.
• Frontlight: Optional PWM-controlled series LED frontlight with warm/cool temperature control.

Supported Devices

FreeInk currently supports a variety of ESP32-based devices, including:

Device	MCU	Controller	Panel	Status
Xteink X4	ESP32-C3	SSD1677	800×480 B/W + 4-level gray	Full
Xteink X3	ESP32-C3	UC8253	792×528 B/W + 4-level gray	Full
de-link	ESP32-S3	SSD1677	800×480 B/W + gray, frontlight	Full
M5Stack PaperColor	ESP32-S3	ED2208	400×600 Spectra-6 color	Full
Murphy M3	ESP32-S3	UC8253	240×416 B/W, touch + frontlight	Full
LilyGo T5 S3	ESP32-S3	ED047TC1	960×540 16-gray, touch, I²C gauge	Full
Sticky	ESP32-S3	SSD1677	800×480 B/W, GT911 touch	Full
M5Paper v1.1	ESP32 (classic)	IT8951E	540×960 16-gray, GT911 touch	Full

Community Insights and Considerations

While the project is highly praised for its commitment to open standards, community discussion highlights several practical considerations for users:

• Hardware Availability: Some users noted that several supported devices are relatively small in screen size. While larger screen support is expanded in the roadmap (with 7.5" panels mentioned for de-link v2.0), current off-the-shelf options are limited.
• Chipset Compatibility: The firmware is specifically built for the ESP32 chipset. Consequently, it cannot be ported to older Kindles or Kobos, which use different hardware architectures.
• Chipset Limitations: Some developers have noted the difficulty of optimizing content for the extremely limited CPU and memory of these budget e-paper devices.
• Pricing: The cost to build a de-link board is estimated at ~$60, though some users pointed out that this is the only cost for the PCB and components, and does not include the cost of the screen or a casing.
• Syncing: The project addresses the reading progress sync issue via KOReader sync, which is a critical feature for users transitioning between multiple devices.