Skip to content

remixer-dec/PocketInkOS

Repository files navigation

PocketInkOS

PocketInkOS is an e-ink-first operating system currently avaiable for the Waveshare ESP32-S3-ePaper-1.54 with touch. The firmware includes its own shell, apps, file viewers, extension runtimes, power management, and hardware drivers. The project is in pre-release stage and some APIs may change.

Firmware features

Built-in software includes a few apps and games such as calendar, file manager, alarm clock, qr encoder, chess, sudoku, and many more. Apps can also run from an SD card in two forms: compiled .pink executables, or .js files interpreted by PocketInkJS, a JavaScript runtime written from scratch for this project.

The shell supports touch, two hardware buttons, SD storage, environmental sensors, audio recording, and audio playback. A shell-wide status bar and control panel provide Wi-Fi, Bluetooth, CPU frequency, volume, and screenshot controls. Persistent options live in the Settings app.

Partial e-paper refresh is part of the UI path, including reusable components: buttons, lists, selectors, keyboards, dialogs, and pickers written for the 200 by 200 display. Deep-sleep clock mode wakes once per minute to update the lock screen, then returns to sleep. In this mode the device battery can last for weeks.

The Files app opens each supported format through a viewer interface. Format decoders were written for this firmware from scratch; raster rendering produce 1-bit output directly, with scaling and selectable dithering for the e-ink panel. Decoders are available for general purpose image rendering APIs and can be used among all types of supported apps.

Edition File formats
Standard PNG, JPEG, SVG, WebP, WBMP, TXT, JSON, EPUB, MIDI, and partial PDF
Extended Standard formats plus WAV, MP3, and AAC-LC

The AI chat app has text and audio modes, including microphone recording. External apps receive bounded APIs for drawing, files, networking, sensors, GPIO, audio, system input, and periodic tasks while the firmware retains ownership of hardware and cleanup.

Development and testing

Most of the code was implemented with assistance from Codex using GPT-5.5, and GPT-5.6-Sol. I specified the requirements and constraints, reviewed the code, tested it on hardware, and fixed the failures found during testing. The project is human-directed and AI-assisted; manual hardware testing has caught many bugs that have been fixed.

License

This PocketInkOS code is licensed under CC BY-NC-SA 4.0. The extended edition has a separate license that allows commercial use.

Third-party code

Thanks to the authors of the Waveshare ESP32-S3 e-Paper demo and epy-paper-host. Their work helped this project get started.

About

A firmware for Waveshare ESP32-S3-ePaper-1.54

Topics

Resources

Stars

3 stars

Watchers

0 watching

Forks

Releases

No releases published

Contributors