Skip to content
/ InkyPi Public

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

License

Notifications You must be signed in to change notification settings

fatihak/InkyPi

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

InkyPi

About InkyPi

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

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 ChatGPT's DALL·E

And additional plugins coming soon! For documentation on building custom plugins, see Building InkyPi Plugins.

Hardware

  • 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

Installation

To install InkyPi, follow these steps:

  1. Clone the repository:
    git clone https://github.com/fatihak/InkyPi.git
  2. Navigate to the project directory:
    cd InkyPi
  3. 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.

Uninstall

To install InkyPi, simply run the following command:

sudo bash install/uninstall.sh

Roadmap

The InkyPi project is constantly evolving, with many exciting features and improvements planned for the future.

  • Plugins, plugins, plugins
  • Enhanced scheduling functionality
  • Modular layouts to mix and match plugins
  • Support for buttons with customizable action bindings
  • Improved Web UI on mobile devices
  • Support for Waveshare devices

License

Distributed under the GPL 3.0 License, see LICENSE for more information.

Issues

Check out the troubleshooting guide. If you're still having trouble, feel free to create an issue on the GitHub Issues page.

Acknowledgements

Check out these similar projects:

  • PaperPi - awesome project that supports waveshare devices
    • shoutout to @txoof for assisting with InkyPi's installation process
  • InkyCal - has modular plugins for building custom dashboards
  • PiInk - inspiration behind InkyPi's flask web ui

About

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

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published