Documentation
Set it up, then build your screens.
28 pages: installing Magic Frame, building a layout, connecting your Home Assistant, your photos and your calendars, and running the whole thing on your own machine.
Let an assistant read this for you
Paste this into ChatGPT, Claude or any assistant that can fetch a URL. It pulls the whole documentation in one request and answers from it.
Read https://magicframe.dev/llms-full.txt — that is the complete Magic Frame documentation. Use it to answer my questions about setting up and running Magic Frame, and use the exact names it gives for widgets, settings and API paths instead of guessing. /llms.txt is the short index, if you would rather point it at one page at a time.
Every page here is also served as its own markdown source — the same
address with .md instead
of the trailing slash, for example /docs/getting-started.md.
Starting
Getting started
install it, sign in, put something on a screen
Concepts
the nouns this product is made of, and how they nest
Installation
every way to install, and which one to pick
The Home Assistant add-on
repository URL, install, options, what differs
Updating and backups
updating, what a backup contains, restoring, rolling back
Using it
The editor
control centre, the view list, the grid, the inspector, saving
Views and displays
one view per display, the public `/view` URL, kiosk setup
Wallpapers
every source, fit modes, split view, the photo info bar
Widgets
the catalogue, and the behaviour every widget shares
Time and weather widgets
Clock, Weather, Environment
The calendar widget
list, agenda and month views, and every feed type
Home Assistant widgets
Entity, Notification, Camera, Sensor, Button
Media and photo widgets
Image, Media player, RSS, QR, Status
Family widgets
Timer, Messages, Shopping list, Todos
Stacking and visibility
overlapping widgets, and showing them by state
Themes and styling
light and dark, glass, colours, fonts, corners
Connecting things
Home Assistant
connecting, entities, lists, actions, live state
Immich
the global connection, albums, people, favourites, memories
Calendars
iCal, Google, Microsoft, Home Assistant calendars
Weather providers
Open-Meteo, DWD, OpenWeatherMap, a Home Assistant entity
Other sources
WebDAV folders, Todoist, RSS feeds
Running it
Something wrong on a page?
The wiki lives in the product repo, next to the code it describes. Corrections go there.
Documents Magic Frame v1.5.2