[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"project-72209":3},{"id":4,"name":5,"fullName":6,"owner":7,"repo":5,"description":8,"homepage":9,"htmlUrl":10,"language":11,"languages":10,"totalLinesOfCode":10,"stars":12,"forks":13,"watchers":14,"openIssues":15,"contributorsCount":16,"subscribersCount":16,"size":16,"stars1d":17,"stars7d":18,"stars30d":19,"stars90d":16,"forks30d":16,"starsTrendScore":18,"compositeScore":20,"rankGlobal":10,"rankLanguage":10,"license":21,"archived":22,"fork":22,"defaultBranch":23,"hasWiki":24,"hasPages":22,"topics":25,"createdAt":10,"pushedAt":10,"updatedAt":31,"readmeContent":32,"aiSummary":33,"trendingCount":16,"starSnapshotCount":16,"syncStatus":34,"lastSyncTime":35,"discoverSource":36},72209,"InkyPi","fatihak\u002FInkyPi","fatihak","E-Ink Display with a Raspberry Pi and a Web Interface to customize and update the display with various plugins","",null,"Python",4009,535,42,71,0,6,18,79,30.19,"GNU General Public License v3.0",false,"main",true,[26,27,28,29,30],"eink","epaper","inkypi","python","raspberry-pi","2026-06-12 02:03:00","# InkyPi \n\n\u003Cimg src=\".\u002Fdocs\u002Fimages\u002Finky_clock.jpg\" \u002F>\n\n\n## About InkyPi \nInkyPi 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.\n\n**Features**:\n- Natural paper-like aethetic: crisp, minimalist visuals that are easy on the eyes, with no glare or backlight\n- Web Interface allows you to update and configure the display from any device on your network\n- Minimize distractions: no LEDS, noise, or notifications, just the content you care about\n- Easy installation and configuration, perfect for beginners and makers alike\n- Open source project allowing you to modify, customize, and create your own plugins\n- Set up scheduled playlists to display different plugins at designated times\n\n**Plugins**:\n\n- Image Upload: Upload and display any image from your browser\n- Daily Newspaper\u002FComic: Show daily comics and front pages of major newspapers from around the world\n- Clock: Customizable clock faces for displaying time\n- AI Image\u002FText: Generate images and dynamic text from prompts using OpenAI's models\n- Weather: Display current weather conditions and multi-day forecasts with a customizable layout\n- Calendar: Visualize your calendar from Google, Outlook, or Apple Calendar with customizable layouts\n\nAnd additional plugins coming soon! For documentation on building custom plugins, see [Building InkyPi Plugins](.\u002Fdocs\u002Fbuilding_plugins.md).\n\nSee [the wiki](https:\u002F\u002Fgithub.com\u002Ffatihak\u002FInkyPi\u002Fwiki) for a list of community-maintained third-party plugins.\n\n## Hardware \n- Raspberry Pi (4 | 3 | Zero 2 W)\n    - Recommended to get 40 pin Pre Soldered Header\n- MicroSD Card (min 8 GB) like [this one](https:\u002F\u002Famzn.to\u002F3G3Tq9W)\n- E-Ink Display:\n    - Inky Impression by Pimoroni\n        - **[13.3 Inch Display](https:\u002F\u002Fcollabs.shop\u002Fq2jmza)**\n        - **[7.3 Inch Display](https:\u002F\u002Fcollabs.shop\u002Fq2jmza)**\n        - **[5.7 Inch Display](https:\u002F\u002Fcollabs.shop\u002Fns6m6m)**\n        - **[4 Inch Display](https:\u002F\u002Fcollabs.shop\u002Fcpwtbh)**\n    - Inky wHAT by Pimoroni\n        - **[4.2 Inch Display](https:\u002F\u002Fcollabs.shop\u002Fjrzqmf)**\n    - Waveshare e-Paper Displays\n        - Spectra 6 (E6) Full Color **[4 inch](https:\u002F\u002Fwww.waveshare.com\u002F4inch-e-paper-hat-plus-e.htm?&aff_id=111126)** **[7.3 inch](https:\u002F\u002Fwww.waveshare.com\u002F7.3inch-e-paper-hat-e.htm?&aff_id=111126)** **[13.3 inch](https:\u002F\u002Fwww.waveshare.com\u002F13.3inch-e-paper-hat-plus-e.htm?&aff_id=111126)**\n        - Black and White **[7.5 inch](https:\u002F\u002Fwww.waveshare.com\u002F7.5inch-e-paper-hat.htm?&aff_id=111126)** **[13.3 inch](https:\u002F\u002Fwww.waveshare.com\u002F13.3inch-e-paper-hat-k.htm?&aff_id=111126)**\n        - See [Waveshare e-paper displays](https:\u002F\u002Fwww.waveshare.com\u002Fproduct\u002Fraspberry-pi\u002Fdisplays\u002Fe-paper.htm?&aff_id=111126) or visit their [Amazon store](https:\u002F\u002Famzn.to\u002F3HPRTEZ) for additional models. Note that some models like the IT8951 based displays are not supported. See later section on [Waveshare e-Paper](#waveshare-display-support) compatibility for more information.\n- Picture Frame or 3D Stand\n    - See [community.md](.\u002Fdocs\u002Fcommunity.md) for 3D models, custom builds, and other submissions from the community\n\n**Disclosure:** The links above are affiliate links. I may earn a commission from qualifying purchases made through them, at no extra cost to you, which helps maintain and develop this project.\n\n## Installation\nTo install InkyPi, follow these steps:\n\n1. Clone the repository:\n    ```bash\n    git clone https:\u002F\u002Fgithub.com\u002Ffatihak\u002FInkyPi.git\n    ```\n2. Navigate to the project directory:\n    ```bash\n    cd InkyPi\n    ```\n3. Run the installation script with sudo:\n    ```bash\n    sudo bash install\u002Finstall.sh [-W \u003Cwaveshare device model>]\n    ``` \n     Option: \n    \n    * -W \\\u003Cwaveshare device model\\> - specify this parameter **ONLY** if installing for a Waveshare display.  After the -W option specify the Waveshare device model e.g. epd7in3f.\n\n    e.g. for Inky displays use:\n    ```bash\n    sudo bash install\u002Finstall.sh\n    ```\n\n    and for [Waveshare displays](#waveshare-display-support) use:\n    ```bash\n    sudo bash install\u002Finstall.sh -W epd7in3f\n    ```\n\n\nAfter 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.\n\nNote: \n- 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.\n- The installation process will automatically enable the required SPI and I2C interfaces on your Raspberry Pi.\n\nFor more details, including instructions on how to image your microSD with Raspberry Pi OS, refer to [installation.md](.\u002Fdocs\u002Finstallation.md). You can also checkout [this YouTube tutorial](https:\u002F\u002Fyoutu.be\u002FL5PvQj1vfC4).\n\n## Update\nTo update your InkyPi with the latest code changes, follow these steps:\n1. Navigate to the project directory:\n    ```bash\n    cd InkyPi\n    ```\n2. Fetch the latest changes from the repository:\n    ```bash\n    git pull\n    ```\n3. Run the update script with sudo:\n    ```bash\n    sudo bash install\u002Fupdate.sh\n    ```\nThis process ensures that any new updates, including code changes and additional dependencies, are properly applied without requiring a full reinstallation.\n\n## Uninstall\nTo install InkyPi, simply run the following command:\n\n```bash\nsudo bash install\u002Funinstall.sh\n```\n\n## Roadmap\nThe InkyPi project is constantly evolving, with many exciting features and improvements planned for the future.\n\n- Plugins, plugins, plugins\n- Modular layouts to mix and match plugins\n- Support for buttons with customizable action bindings\n- Improved Web UI on mobile devices\n\nCheck out the public [trello board](https:\u002F\u002Ftrello.com\u002Fb\u002FSWJYWqe4\u002Finkypi) to explore upcoming features and vote on what you'd like to see next!\n\n## Waveshare Display Support\n\nWaveshare offers a range of e-Paper displays, similar to the Inky screens from Pimoroni, but with slightly different requirements. While Inky displays auto-configure via the inky Python library, Waveshare displays require model-specific drivers from their [Python EPD library](https:\u002F\u002Fgithub.com\u002Fwaveshareteam\u002Fe-Paper\u002Ftree\u002Fmaster\u002FRaspberryPi_JetsonNano\u002Fpython\u002Flib\u002Fwaveshare_epd).\n\nThis project has been tested with several Waveshare models. **Displays based on the IT8951 controller are not supported**, and **screens smaller than 4 inches are not recommended** due to limited resolution.\n\nIf your display model has a corresponding driver in the link above, it’s likely to be compatible. When running the installation script, use the -W option to specify your display model (without the .py extension). The script will automatically fetch and install the correct driver.\n\n## License\n\nDistributed under the GPL 3.0 License, see [LICENSE](.\u002FLICENSE) for more information.\n\nThis project includes fonts and icons with separate licensing and attribution requirements. See [Attribution](.\u002Fdocs\u002Fattribution.md) for details.\n\n## Issues\n\nCheck out the [troubleshooting guide](.\u002Fdocs\u002Ftroubleshooting.md). If you're still having trouble, feel free to create an issue on the [GitHub Issues](https:\u002F\u002Fgithub.com\u002Ffatihak\u002FInkyPi\u002Fissues) page.\n\nIf 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](.\u002Fdocs\u002Ftroubleshooting.md#known-issues-during-pi-zero-w-installation) section in the troubleshooting guide for additional details..\n\n## Sponsoring\n\nInkyPi is maintained and developed with the help of sponsors. If you enjoy the project or find it useful, consider supporting its continued development.\n\n\u003Cp align=\"center\">\n\u003Ca href=\"https:\u002F\u002Fgithub.com\u002Fsponsors\u002Ffatihak\" target=\"_blank\">\u003Cimg src=\"https:\u002F\u002Fuser-images.githubusercontent.com\u002F345274\u002F133218454-014a4101-b36a-48c6-a1f6-342881974938.png\" alt=\"Become a Patreon\" height=\"35\" width=\"auto\">\u003C\u002Fa>\n\u003Ca href=\"https:\u002F\u002Fwww.patreon.com\u002Fakzdev\" target=\"_blank\">\u003Cimg src=\"https:\u002F\u002Fc5.patreon.com\u002Fexternal\u002Flogo\u002Fbecome_a_patron_button.png\" alt=\"Become a Patreon\" height=\"35\" width=\"auto\">\u003C\u002Fa>\n\u003Ca href=\"https:\u002F\u002Fwww.buymeacoffee.com\u002Fakzdev\" target=\"_blank\">\u003Cimg src=\"https:\u002F\u002Fcdn.buymeacoffee.com\u002Fbuttons\u002Fdefault-orange.png\" alt=\"Buy Me A Coffee\" height=\"35\" width=\"auto\">\u003C\u002Fa>\n\u003C\u002Fp>\n\n\n## Acknowledgements\n\nCheck out these similar projects:\n\n- [PaperPi](https:\u002F\u002Fgithub.com\u002Ftxoof\u002FPaperPi) - awesome project that supports waveshare devices\n    - shoutout to @txoof for assisting with InkyPi's installation process\n- [InkyCal](https:\u002F\u002Fgithub.com\u002Faceinnolab\u002FInkycal) - has modular plugins for building custom dashboards\n- [PiInk](https:\u002F\u002Fgithub.com\u002Ftlstommy\u002FPiInk) - inspiration behind InkyPi's flask web ui\n- [rpi_weather_display](https:\u002F\u002Fgithub.com\u002Fsjnims\u002Frpi_weather_display) - alternative eink weather dashboard with advanced power efficiency\n","InkyPi 是一个基于树莓派的开源可定制电子墨水屏项目，通过简单的网页界面实现内容的自定义和更新。其核心功能包括自然纸张般的视觉效果、无干扰显示、易于安装配置以及支持多种插件如天气预报、日历同步、时钟等。用户还可以通过开放源代码创建自己的插件或设置定时播放列表。该项目适用于需要长时间显示信息但不希望有背光干扰的场景，比如办公室公告板、家庭信息中心或者个人兴趣展示。采用Python编写，适合初学者及创客使用。",2,"2026-06-11 03:40:51","high_star"]