InkyPi is an open-source, customizable E-Ink display powered by a Raspberry Pi. Designed for simplicity and flexibility, it allows you to effortlessly display the content you care about, with a simple web interface that makes setup and configuration effortless.
Features:
- Natural paper-like aethetic: crisp, minimalist visuals that are easy on the eyes, with no glare or backlight
- Web Interface allows you to update and configure the display from any device on your network
- Minimize distractions: no LEDS, noise, or notifications, just the content you care about
- Easy installation and configuration, perfect for beginners and makers alike
- Open source project allowing you to modify, customize, and create your own plugins
- Set up scheduled playlists to display different plugins at designated times
Plugins:
- Image Upload: Upload and display any image from your browser
- Newspaper: Show daily front pages of major newspapers from around the world
- Clock: Customizable clock faces for displaying time
- AI Image: Generate images from text prompts using OpenAI's DALL·E
- AI Text: Display dynamic text content using OpenAI's GPT-4o text models
And additional plugins coming soon! For documentation on building custom plugins, see Building InkyPi Plugins.
- Raspberry Pi (4 | 3 | Zero 2 W)
- Recommended to get 40 pin Pre Soldered Header
- MicroSD Card (min 8 GB)
- E-Ink Display: Pimoroni Inky Impression, available in 3 sizes:
- Picture Frame or 3D Stand
To install InkyPi, follow these steps:
- Clone the repository:
git clone https://github.com/fatihak/InkyPi.git
- Navigate to the project directory:
cd InkyPi - Run the installation script with sudo:
sudo bash install/install.sh
After the installation is complete, the script will prompt you to reboot your Raspberry Pi. Once rebooted, the display will update to show the InkyPi splash screen.
Note:
- The installation script requires sudo privileges to install and run the service. We recommend starting with a fresh installation of Raspberry Pi OS to avoid potential conflicts with existing software or configurations.
- The installation process will automatically enable the required SPI and I2C interfaces on your Raspberry Pi.
For more details, including instructions on how to image your microSD with Raspberry Pi OS, refer to installation.md. You can also checkout this YouTube tutorial.
To update your InkyPi with the latest code changes, follow these steps:
- Navigate to the project directory:
cd InkyPi - Fetch the latest changes from the repository:
git pull
- Run the update script with sudo:
sudo bash install/update.sh
This process ensures that any new updates, including code changes and additional dependencies, are properly applied without requiring a full reinstallation.
To install InkyPi, simply run the following command:
sudo bash install/uninstall.shThe InkyPi project is constantly evolving, with many exciting features and improvements planned for the future.
- Plugins, plugins, plugins
- Modular layouts to mix and match plugins
- Support for buttons with customizable action bindings
- Improved Web UI on mobile devices
- Support for Waveshare devices
Check out the public trello board to explore upcoming features and vote on what you'd like to see next!
Distributed under the GPL 3.0 License, see LICENSE for more information.
Check out the troubleshooting guide. If you're still having trouble, feel free to create an issue on the GitHub Issues page.
If you're using a Pi Zero W, note that there are known issues during the installation process. See Known Issues during Pi Zero W Installation section in the troubleshooting guide for additional details..
InkyPi is maintained and developed with the help of sponsors. If you enjoy the project or find it useful, consider supporting its continued development.
Check out these similar projects:
