Model or dataset
fatihak/InkyPi avatar
fatihak/InkyPi

InkyPi: a Raspberry Pi e-ink display driven from a browser

E-Ink Display with a Raspberry Pi and a Web Interface to customize and update the display with various plugins

4,286 stars599 forksPythonGPL-3.0

At a glance

What is it?
InkyPi turns a Raspberry Pi and a Pimoroni or Waveshare e-paper panel into a scheduled, plugin-driven display you configure over your local network. The install script is the easy part; picking a supported panel is where projects stall.
Who is it for?
Adopt InkyPi if you already own a Raspberry Pi 3, 4 or Zero 2 W and one of the Pimoroni Inky panels, or a Waveshare model whose driver is published in the waveshare_epd directory, and you want a scheduled display you configure from a browser instead of editing scripts. Skip it if your panel is IT8951 based, since the README states those models are not supported, or if you want a hosted service with no local hardware.
Can I use it commercially?
Yes, with conditions. GPL-3.0 is a copyleft licence: if you distribute software that includes it, you must release that software's source code under the same licence. Running it internally without distributing it does not trigger that obligation.
Is it still maintained?
Yes. The repository last received commits 11 days ago.
What is it written in?
Mainly Python, according to GitHub's language statistics.

Answers come from the project's GitHub data, last synced on November 15, 2026, and from our analysis. They are not legal advice.

From daily snapshots

Star history

  • fatihak/InkyPi4,286 ★ · +56
Star history
Repository2026-09-232026-11-15
fatihak/InkyPi4.2k4.3k

56 Stars in the last 53 days, measured from the daily GitHub snapshot. Compare with other projects

Editorial analysis

What InkyPi actually replaces

Most e-ink dashboard projects start as a single Python script that fetches one thing and writes it to a panel. That works until you want a different thing on Tuesday. InkyPi's answer is a plugin registry plus a scheduler: the repository ships plugins for image upload, daily newspaper and comic front pages, clock faces, OpenAI-generated images and text, weather with multi-day forecasts, and calendar views pulled from Google, Outlook or Apple. Each plugin renders to the panel, and playlists let you assign different plugins to designated times.

The intended user is someone with a Raspberry Pi already mounted behind a picture frame, not a library author. The README frames the project as beginner-friendly, and the install path reflects that: one shell script, a reboot, and a splash screen. The web interface is the real product. It runs on the Pi and is reachable from any device on the same network, so changing what the display shows does not mean SSHing in to edit a file.

How the plugin and playlist model fits together

The architecture visible in the repository is a Python application under src/ with a web front end, an install/ directory holding shell scripts, and a tests/ directory with pytest.ini at the top level. Plugins live as separate modules that the app loads and renders; the README points to docs/building_plugins.md for the plugin contract and to the project wiki for community-maintained third-party plugins.

Rendering is the part that constrains everything else. E-paper panels refresh slowly and, on colour models, cycle through colour phases, so a plugin that redraws every minute is the wrong shape for this hardware. Playlists sidestep that: you schedule a plugin for a time slot rather than polling continuously. The trade-off is granularity.

Hardware support splits into two paths. Pimoroni Inky displays auto-configure through the inky Python library. Waveshare panels do not; they need model-specific drivers from the upstream e-Paper repository, which is why the installer takes a model argument at all.

Installing InkyPi on a Raspberry Pi

The README recommends a fresh Raspberry Pi OS image to avoid conflicts with existing software, and notes that the installer enables the SPI and I2C interfaces itself. Clone the repository and move into it first.

bash
git clone https://github.com/fatihak/InkyPi.git
cd InkyPi

For a Pimoroni Inky panel, run the installer with no arguments. It needs sudo because it installs and runs a service.

bash
sudo bash install/install.sh

For a Waveshare panel, pass the model after -W. The README's example is epd7in3f.

bash
sudo bash install/install.sh -W epd7in3f

The README states that some Waveshare models are not published in the common driver directory and only ship under E-paper_Separate_Program. For those, you pass the path to the driver inside the waveshareteam/e-Paper repository rather than a bare model name.

bash
sudo bash install/install.sh -W E-paper_Separate_Program/3.6inch_e-Paper_E/RaspberryPi_JetsonNano/python/lib/waveshare_epd/epd3in6e.py

After the script finishes it prompts you to reboot. Once the Pi comes back, the display should show the InkyPi splash screen, and the web interface is what you open next from another device on the network. Updating later is a pull plus the update script.

bash
cd InkyPi
git pull
sudo bash install/update.sh

The README describes update.sh as applying code changes and additional dependencies without a full reinstall. Note the README's Uninstall section opens with "To install InkyPi" while showing uninstall.sh, which is a documentation slip worth knowing about before you go looking for a separate removal procedure.

Panel compatibility is the real gate

The README lists supported Pimoroni hardware as the Inky Impression in 13.3, 7.3, 5.7 and 4 inch sizes, plus the 4.2 inch Inky wHAT. On the Waveshare side it lists Spectra 6 (E6) full colour panels at 4, 7.3 and 13.3 inches, and black and white panels at 7.5 and 13.3 inches. It then states directly that some models, specifically IT8951 based displays, are not supported, and defers further detail to a compatibility section.

That sentence is the most important one in the README for anyone shopping. E-paper panels are not interchangeable at the driver level, and a panel bought before checking this list may simply not work. The Waveshare path is narrower still, because support depends on a driver existing in the upstream e-Paper library at a path you can name on the command line. If your model's driver is not there, the -W argument has nothing valid to point at.

There is also a hardware floor: Raspberry Pi 4, 3 or Zero 2 W. The README recommends a 40 pin pre-soldered header and a microSD card of at least 8 GB. The affiliate disclosure at the end of the hardware section is worth reading as disclosure rather than as a buying guide.

Where InkyPi is the wrong choice

The project's own roadmap lists plugins, modular layouts that mix plugins on one screen, button support with customizable action bindings, and a better mobile web UI as future work. Read that as a statement of current limits: there is no documented way to compose two plugins into a single layout today, and physical button input is not implemented. If your plan is a wall display with a hardware button to cycle views, InkyPi does not do that yet.

Refresh behaviour is the second limit. The calendar plugin is a good illustration of the intended cadence: a calendar changes slowly, so a slow panel suits it. A stock ticker does not.

Third, the AI Image/Text plugin depends on OpenAI's models, which means an API key and a network dependency.

How InkyPi differs from writing your own renderer

The obvious alternative is a small custom Python script built directly on the inky library or on Waveshare's waveshare_epd drivers. That approach gives you total control over layout and refresh timing, and it has no service, no web server and no plugin loader to debug. For a single fixed view, a script plus a cron entry is genuinely less machinery than InkyPi.

The difference in approach is where configuration lives. A custom script puts it in code and environment files on the Pi. InkyPi puts it in a web interface served from the Pi, with plugins as the unit of extension and playlists as the unit of scheduling. You pay for that with a service running under sudo, a dependency set the installer manages, and an upgrade path that runs install/update.sh rather than whatever your own script needs. If you want to change the display from a phone without touching the Pi, InkyPi's design is the reason. If you never want to change it, the script wins on surface area.

Licence, maintenance and upgrade cost

InkyPi is GPL-3.0. That matters if you plan to distribute a modified build: the licence carries copyleft obligations, and plugins you write and ship with the project are the question to raise with someone qualified to answer it. Running it on your own Pi for personal use is the ordinary case the licence is designed for. Nothing here is legal advice.

The repository is not archived, and its last push was on 2026-11-02, which is recent enough that the codebase is moving. The repository has no published GitHub releases, so there is no tagged version to pin to: the update path is git pull followed by install/update.sh, which means you track main. That is a real cost. A pull can bring dependency changes the update script applies on your behalf. If you need reproducible deployments, you would have to manage that yourself with git tags or a fork.

The roadmap is public on a Trello board, so planned work is visible, but roadmap items are not commitments. Treat the plugin list in the README as the supported set and the wiki as community territory.

Editorial conclusion

Adopt InkyPi if you already own a Raspberry Pi 3, 4 or Zero 2 W and one of the Pimoroni Inky panels, or a Waveshare model whose driver is published in the waveshare_epd directory, and you want a scheduled display you configure from a browser instead of editing scripts. Skip it if your panel is IT8951 based, since the README states those models are not supported, or if you want a hosted service with no local hardware. Before buying anything, confirm your exact panel model appears in the supported list and, for Waveshare, that its driver file exists in the upstream e-Paper repository, because that path is what the -W argument must point to.

Frequently asked questions

How do I install InkyPi on a Raspberry Pi?

Clone the repository, then run sudo bash install/install.sh for Pimoroni Inky panels, or add -W followed by your Waveshare model, for example epd7in3f. The installer enables SPI and I2C and prompts you to reboot, after which the display shows the InkyPi splash screen.

What is InkyPi?

InkyPi is an open-source E-Ink display project powered by a Raspberry Pi, with a web interface for configuring and updating the display through plugins such as clock, weather, calendar, comics and AI-generated images. It is licensed GPL-3.0 and written in Python.

Which e-ink displays does InkyPi support?

The README lists Pimoroni Inky Impression panels in 13.3, 7.3, 5.7 and 4 inch sizes, the 4.2 inch Inky wHAT, Waveshare Spectra 6 full colour panels at 4, 7.3 and 13.3 inches, and Waveshare black and white panels at 7.5 and 13.3 inches. It states that some models, including IT8951 based displays, are not supported.

Official sources

  1. fatihak/InkyPi on GitHub
  2. Issues
  3. License: GPL-3.0
  4. README
Add this badge to your README

If you maintain this project, the badge below links readers to this analysis and shows its maintenance status from the daily GitHub snapshot. Paste the markdown into your README; add ?metric=license or ?metric=stars to the image URL for a different field.

Add this badge to your README

markdown
[![Hysen Labs](https://hysenlabs.com/badge/fatihak-inkypi.svg)](https://hysenlabs.com/projects/fatihak-inkypi)

Star history chart for your README

markdown
[![Star history](https://hysenlabs.com/chart/fatihak-inkypi.svg)](https://hysenlabs.com/projects/fatihak-inkypi)

Was this useful?