inkplate-dashboard

Project to display a simple dashboard on an Inkplate 10 displaying articles from an RSS feed and the current weather, provided by the MET Weather API.

Server

The server generates the dashboard as an HTML page, and uses Chromium to screenshot it and generate a PNG which can be sent to the Inkplate 10.

Docker quickstart

An image is provided on dockerhub:

docker run \
    --pull always \
    -v $(pwd)/config.example.toml:/app/config.toml:ro \
    -p 8000:8000 \
    ugomeda/inkplate-dashboard:latest

Then access:

• Live HTML version: http://localhost:8000/live/html
• Live PNG version: http://localhost:8000/live/png

Run locally

To run the server:

• Create a stub configuration by copying config.example.toml to config.toml
• Setup your poetry environment
• Install Chromium
• Run the application

cp config.exemple.toml config.toml
poetry shell
poetry install
playwright install chromium --no-shell --with-deps
uvicorn inkplate_dashboard.app:app

You should be able to access the dashboard on the following URLs:

• Live HTML version: http://localhost:8000/live/html
• Live PNG version: http://localhost:8000/live/png

ESP32 firmware

You will need PlatformIO to compile and flash your Inkplate.

• Create a firmware/src/config.h based on the config.h.example provided
• Use pio run -t upload to flash the Inkplate from the firmware folder

Assets

This projets uses:

• Weather icons: https://github.com/nrkno/yr-weather-symbols
• Icons: https://github.com/lucide-icons/lucide
• textFit: https://github.com/STRML/textFit
• Fonts: https://github.com/fontsource