Repolode
Submit
fatihak

fatihak/InkyPi

Open-source software for a Raspberry Pi that drives e-ink displays and shows customizable content like clocks, weather, calendars and AI images via a web interface.

View on GitHub
Stars
4,262
Forks
588
Open issues
90
Last commit
9 days ago

What is it?

InkyPi turns a Raspberry Pi and a compatible e-ink display into a low-distraction screen for information you care about. It runs as a service on the Pi, and you configure and update what appears from any device on your network through a built-in web interface.

The project ships with plugins for image upload, daily comics and newspaper front pages, customizable clock faces, weather with multi-day forecasts, calendars from Google, Outlook or Apple Calendar, and AI-generated images or text using OpenAI models. Scheduled playlists can rotate different plugins at set times. Developers can write their own plugins, and the docs cover the plugin-building process.

Supported hardware includes Pimoroni Inky Impression and wHAT displays, plus a range of Waveshare e-Paper models that need a model-specific driver passed to the install script. Displays based on the IT8951 controller are not supported.

Key features

  • 01Web interface to update and configure the display from any device on the network
  • 02Scheduled playlists that rotate plugins at set times
  • 03Plugins for images, comics, clocks, weather, calendars and AI content
  • 04Support for Pimoroni Inky and multiple Waveshare e-Paper models
  • 05Open source, with documentation for writing custom plugins

Use cases

  • Running a wall-mounted weather and calendar dashboard that needs no backlight
  • Displaying rotating family photos or art in a picture frame
  • Building a low-distraction desk clock or news display
  • Experimenting with generated images on a physical e-ink screen

Quick start

  1. 1

    Clone the repository

    git clone https://github.com/fatihak/InkyPi.git
  2. 2

    Go to the project directory

    cd InkyPi
  3. 3

    Run the installation script with sudo (add -W with your Waveshare model only for Waveshare displays)

    sudo bash install/install.sh
  4. 4

    Reboot the Raspberry Pi when the script prompts you

Things to know

  • Requires a Raspberry Pi and a compatible e-ink display, so it is not a general-purpose app.
  • Waveshare displays based on the IT8951 controller are not supported.
  • Screens smaller than 4 inches are not recommended due to limited resolution.
  • Licensed under GPL-3.0, a copyleft license that requires derivative works to be open source too.

Topics

#eink#raspberry-pi#e-paper#python#display#smart-display#plugins#epaper#inkypi

FAQ

What is InkyPi?
Open-source software for a Raspberry Pi that drives e-ink displays and shows customizable content like clocks, weather, calendars and AI images via a web interface. InkyPi turns a Raspberry Pi and a compatible e-ink display into a low-distraction screen for information you care about. It runs as a service on the Pi, and you configure and update what appears from any device on your network through a built-in web interface.
Is InkyPi free to use? What license does it have?
InkyPi is open source under the GPL-3.0 license. Check the license terms before using it in commercial products.
Is InkyPi still maintained?
Actively maintained. The last commit to InkyPi was on Oct 13, 2026.
What can I use InkyPi for?
Running a wall-mounted weather and calendar dashboard that needs no backlight Displaying rotating family photos or art in a picture frame Building a low-distraction desk clock or news display Experimenting with generated images on a physical e-ink screen
How do I install InkyPi?
Clone the repository: git clone https://github.com/fatihak/InkyPi.git Go to the project directory: cd InkyPi Run the installation script with sudo (add -W with your Waveshare model only for Waveshare displays): sudo bash install/install.sh Reboot the Raspberry Pi when the script prompts you
Where can I get InkyPi?
The source code and installation instructions are on GitHub: https://github.com/fatihak/InkyPi

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects