Create awesome e-paper dashboards within minutes! Modularity? Check! Python3? Check? Works on Raspberry Pi Zero W? Check! Support for own modules? Check!
Create awesome e-paper dashboards within minutes! Modularity? Check! Python3? Check? Works on Raspberry Pi Zero W? Check! Support for own modules? Check!
InkyCal is a small dashboard for e-paper screens. It shows calendars, weather, tasks, photos, and custom modules on a Raspberry Pi. **Two paths, one project:** - **InkyCal v3** = the ready-made product/customer setup - **Inkycal** = the open-source software you can install yourself ## Where should I go? - **I bought InkyCal v3** → start at the customer hub: [inkycal.aceinnolab.com](https://inkycal.aceinnolab.com/) - **I want to configure `settings.json`** → use the Web UI generator: [inkycal.aceinnolab.com/ui](https://inkycal.aceinnolab.com/ui) - **I want to install manually** → read the docs installation guide: [aceinnolab.github.io/Inkycal/installation](https://aceinnolab.github.io/Inkycal/installation/) - **I want the source code** → this repository: [github.com/aceinnolab/Inkycal](https://github.com/aceinnolab/Inkycal) - **I need help** → [Discord](https://discord.gg/sHYKeSM) or [GitHub Issues](https://github.com/aceinnolab/Inkycal/issues) ## Quick start 1. Pick your display model. 2. Create `settings.json` in the Web UI. 3. Follow the installation guide in the docs. 4. Run InkyCal on your Pi. ## What InkyCal can do - Calendars and schedules - Weather forecasts - Tasks and reminders - Photos and slideshows - Custom Python modules - Local web UI for settings and display tools ## Documentation - **Canonical docs:** [aceinnolab.github.io/Inkycal](https://aceinnolab.github.io/Inkycal/) - **Quickstart:** [aceinnolab.github.io/Inkycal/quickstart](https://aceinnolab.github.io/Inkycal/quickstart/) - **InkycalOS-Lite:** [aceinnolab.github.io/Inkycal/inkycalos-lite](https://aceinnolab.github.io/Inkycal/inkycalos-lite/) - **Local Web UI:** [aceinnolab.github.io/Inkycal/webui](https://aceinnolab.github.io/Inkycal/webui/) - **Support:** [Discord](https://discord.gg/sHYKeSM) ## Hardware and community - **Assembled hardware:** [Tindie store](https://www.tindie.com/stores/aceinnolab/) - **Printable cases:** [3D-printable cases](https://aceinnolab.github.io/Inkycal/3d-printable-files/) - **Community gallery:** [Hall of Fame](https://aceinnolab.github.io/Inkycal/hall-of-fame/) InkyCal is meant to be easy to start with, but flexible enough to grow with you. ## ❤️ Support the project InkyCal is maintained in spare time. If it saves you hours of setup or powers your daily dashboard, consider sponsoring — it covers hardware costs, display testing, and keeps development going. [Sponsor on GitHub](https://github.com/sponsors/aceisace) — one-time or monthly, any amount helps. Sponsors also get access to **InkycalOS-Lite**: a pre-built SD card image with everything already configured, so you can skip the installation entirely.
No open issues yet, or sync has not completed.