Welcome to Waddle View Docs¶
This is the documentation for Waddle View — a local-first TV dashboard that runs on hardware you already own (Raspberry Pi, Linux desktop, Windows for development). Data stays on your network; operators configure displays through a browser controller or the embedded REST API.
It covers setup, daily operation, Pi deployment, API reference, and type catalogs. Contributions are welcome on GitHub.
Where to start¶
-
:octicons-rocket-24:{ .lg .middle } Getting started
What Waddle View is and how to run it locally for the first time.
-
:octicons-device-desktop-24:{ .lg .middle } Install on Raspberry Pi
One-line install, release tarballs, systemd, and upgrades.
-
:octicons-gear-24:{ .lg .middle } Operator controller
Pair a display, manage screens, integrations, and backups.
-
:octicons-plug-24:{ .lg .middle } REST API
Adoption pairing, roles, and endpoint reference.
-
:octicons-screen-full-24:{ .lg .middle } Screen & overlay types
Catalog of built-in slide and celebration overlay types.
-
:octicons-database-24:{ .lg .middle } Integrations
Weather, news, photos, calendars, stocks, and more.
About Waddle View¶
Waddle View is the successor to Quackview, rebuilt for better visual performance on Raspberry Pi. A single Flutter process rotates configurable slides, shows a bottom news ticker, layers scheduled overlays, and collects data from 30+ built-in integrations into SQLite.
| Component | Role |
|---|---|
| waddle_display | Always-on TV app (Flutter + Drift + Shelf REST) |
| waddle_controller | Operator web UI + optional BFF proxy |
| waddlectl | CLI backup/restore against the display database |