Documentation

How every part of Mirra works, what each setting does, and the steps for the things people do most often.

Getting started

From an empty account to something on a wall.

Getting your first screen on the wallThe whole path from a new account to a working display: create a household, show the pairing code, enter it in the portal, and edit what appears.
The first-run checklistThe Getting set up card on your Screens page lists five things worth doing and one optional extra, ticks each one off by itself, and can be put away for good.
What Mirra isMirra turns any screen that can run a web browser into a wall display and, when you speak to it, into an assistant with a face — managed from a portal in your browser.

Screens & scenes

Pairing displays, designing what they show, scheduling it.

Pairing a screenHow a display joins your household: the six-character code it shows, what to type into Mirra, what pairing creates, and what happens when you unpair.
Screen settingsEvery setting on a screen's own page that belongs to the screen rather than to a scene — its shape, which way up it is, its camera and gestures, the commands you can send it, and unpairing.
Screen types, and what a screen can doWhat hardware can act as a Mirra screen, what each display reports about itself, and exactly what the capability record does and does not cover.
The scene editorThe scene editor is where you arrange a screen's widgets on a twelve-column grid, watch the real widgets render behind them, and push the result to the wall.
Floor plansDraw the building once and everything has a place in it: rooms, doors, screens and lights, a standing-up cutaway view, a read-only view to leave open, and a Floor plan tile that shows a wall display where it is.
The schedulerSchedule rules say which scene a screen shows from a given time on given days, and the Scheduler draws every screen's day as a timeline you can drag scenes onto.
Widget appearanceEvery widget carries its own appearance settings — the layer it sits on, the surface behind it, how its contents are aligned, how large and how solid — and these are what make overlays possible.

Widgets

Every tile that can go on a screen, and what each one needs.

Every widget there isThe complete list of widgets Mirra ships with, grouped the way the scene editor groups them, with what each one shows and what it needs before it will show anything.
The agenda widgetWhat the agenda draws from, how far ahead it looks, how it picks between your calendars and a meeting room's, and why an empty agenda is not the same as a broken one.
The photo frameHow to build an album, point a screen's photo frame at it, control how photos are cropped and dimmed, and turn one into a full-bleed background for the rest of a scene.
The tasks widgetOne household task list, kept in the portal or by talking to the assistant, shown on any screen with the tasks widget.
The Insights widgetA panel for what the house has noticed — a window open with rain coming, lights on in an empty house, a freezer warming up — on a wall with no camera and no microphone.

Integrations

Calendars, Home Assistant, lights, cameras, music.

CamerasHow to add a camera to Mirra by address or through Home Assistant, write an alert that puts it on chosen mirrors when the doorbell rings, and work out why a camera rectangle is blank.
DoorbellsA link that rings your screens. Set one up in a couple of minutes, point an alert at it, and have the mirror show your door when somebody presses the bell — with or without Home Assistant.
Connecting calendarsEvery calendar source Mirra can read — an iCal link, a CalDAV account, Google, Microsoft 365 — with the steps for each, what actually syncs, and what quietly breaks it.
Philips HueYour Hue bulbs on a screen, talking straight to the bridge on your shelf — no Hue account, no cloud, and one requirement worth knowing before you start.
Govee lightsPut Govee lamps, strips and light bars on a mirror without running Home Assistant — including the one thing no other light integration can do, which is work while every screen in the house is asleep.
Hive heatingPut British Gas Hive thermostats and hot water on a mirror — what the house is, what it is set to, and boost — including the honest explanation of why this one asks for your account password.
Home AssistantHow Mirra reaches Home Assistant through a screen on your own network, what it syncs, what it notices, and what each failure message means.
Integrations: what they are, and turning them onAn integration is an outside source that several widgets draw on — this explains what turning one on and off does, and why Mirra refuses to turn one off while its widgets are still on a scene.
Lights, light rules and WLEDOne light model across Home Assistant bulbs, WLED strips, Govee lamps and Hue bulbs: adding a controller, what a rule can do, how a segment becomes a light, and which of the four leave your network at all.
Meeting rooms and room panelsA door panel can read a room mailbox's own calendar through one administrator consent — this covers the consent, the Exchange grant that actually gives access, adding rooms, and what is and is not built.
SpotifyConnect a Spotify account so a mirror can show what is playing, skip a track with a wave, and start music when you ask for it out loud.
Twinview: an office boardPut a Twinview project's tickets, issues and maintenance jobs on a wall — and decide, deliberately, what your building calls late.

The assistant

Talking to the mirror: voice, identity, memory, safety.

Letting the assistant look things upHow to switch web search on for your assistant, what a search costs, and why a conversation that reads the web can no longer change anything in your home.
Naming your assistant, and choosing its voice and faceEverything on the Voice & appearance page: what your mirror is called, the wake word, the seven voices it can speak in, the four personalities, and the ten faces it can wear.
The assistant: how a conversation worksHow you summon Mirra, what happens between hearing you and answering you, which tools it can reach, where the transcript goes, and what a conversation costs against your monthly allowance.
What Mirra remembers, and how to see or delete itMirra stores only the facts somebody asked it out loud to remember, shows every one of them in the words that produced them, and can be told to stop remembering altogether.
What the assistant will and will not doThe limits built into Mirra's assistant: locks off by default, quiet hours, the greeting cooldown, and the requests it refuses outright.

Household & presence

People, faces, greetings and who the screen is for.

GreetingsHow Mirra greets people — the greeting widget on the glass, the spoken greeting when a screen recognises somebody, and the rules, quiet hours and cooldown that decide what is said and when.
Moments — messages left for peopleA moment is a short message left with the mirror for somebody in your household, passed on out loud the next time that person is recognised.
People and presenceHow to add a household member, enrol their face on a screen, and understand what Mirra stores about them and where recognition actually happens.

Reception & visitors

Signing people in, contractor compliance, permits, and knowing who is in the building.

The visitor guestbookTurn a screen into a reception sign-in book: visitors sign themselves in, hosts are told, a badge prints, and when the alarm goes everyone who needs it is sent the list of visitors who are still signed in.
Buildings with more than one company in themOne reception desk, several companies upstairs: name the occupiers, give each their own sign-in that sees only their visitors, and the evacuation roll call goes out to each company's own fire wardens as well as to you.
Your company's reception sign-inFor a company in a building let to several: what your sign-in shows, what you can do with it, who receives your fire-warden list, and why some of the building's things are not on your page.
Contractors, permits and site rulesMake a building's own rules part of signing in: site rules a visitor accepts, insurance and method statements that have to be current, permits to work that get signed off, and a blocked list with a reason and an end date.

Menus, art & broadcast

The other features built for premises rather than houses.

Emergency broadcastHow to take every screen on the account at once with one message, using a template and a two-step confirmation — and how to wire a physical button to a screen to do the same thing.
Menu boardsHow to build a menu in Mirra — sections, dishes, prices and photographs — put it on a screen through the menu board widget, and give kitchen staff a sign-in that reaches nothing else.
Selling your work on MirraFor artists: applying to sell, the two gates between applying and earning, submitting a collection for listing, and exactly how the money reaches you.
Recommending Mirra, and being paid for itMirra Partners: how a referral is credited without any tracking cookies, what the share is and how long it lasts, when money becomes available, and the limits worth knowing before you apply.
The art frameHow the art widget turns a screen into a picture frame — collections of your own, our curated catalogue, framing and mats, and what a household actually chooses to hang on the wall.

Account, plans & data

Billing, allowances, team, retention, privacy.

BillingHow to subscribe, change plan, find your invoices and cancel — and what Mirra does on an install where payments were never configured.
Plans and allowancesWhat each Mirra plan includes — screens, household members and assistant credits — how credits are metered, and what happens when you reach a limit.
Sign-ins and rolesHow to give somebody their own password for your Mirra account, and exactly what each of the two roles — full access and menus only — can reach.
Your dataSet how long Mirra keeps assistant transcripts, presence and the activity log, take a copy of everything held about your household, and close the account for good.

API & self-hosting

Keys, webhooks, single sign-on, running it yourself.

Running Mirra yourselfWhat the three parts of Mirra are, the environment variables they need, what production refuses to start without, and how to turn a Raspberry Pi into a screen.
Single sign-on with OpenID ConnectConnect Mirra to your own identity provider so people sign in with their work account, using OpenID Connect and email-domain matching.
The REST API and your keysHow to create an API key, what a single key is allowed to reach, and every endpoint the public v1 API exposes.
WebhooksHow to give a widget its own web address so another service can push a value straight onto a screen, and what Mirra does and does not send back.

Troubleshooting

When something on the wall is wrong.

A calendar is empty or out of dateWhy a calendar widget shows nothing — an expired authorisation, a changed password, the wrong kind of URL, a date range with nothing in it, or a refresh that has not come round yet.
A screen is blank or showing old informationHow to tell a screen that has lost its connection from one that is doing exactly what its schedule and scenes tell it to, and what to check in which order.
Getting help and raising a ticketHow to raise a support ticket inside Mirra, what to put in it so it can be answered on the first read, where the support documents live, and how to suggest something for the roadmap.
The assistant does not answerThe five things that stop a Mirra assistant replying — a spent allowance, the microphone, the wake word, the connection, and a model provider that is not configured — and the symptom each one produces.

Still stuck?

If the answer is not here, raise a ticket and we will look at it — and then the answer will be here next time.

Raise a ticket Support documents Suggest something