Skip to content
Field

A dashboard for Home Assistant

Field

A hardware panel for your house: keys you press, faders you slide, screens you read. Laid out for you, room by room.

It runs live on a demo house: press, slide and scroll it.

Installed in three steps

All of it in Home Assistant 2026.5 or newer, in your browser, as an administrator. Nothing to install on your computer, no token to copy, and it never changes a dashboard you already have.

Open in Home Assistant (opens in a new tab, so these steps stay here)Settings

Prefer a terminal, or deploying from CI? Deploy from the command line instead. Pick one way: both at once would load Field twice.

  1. Download itOpen Field in your Home Assistant's Marketplace and press Download. Before Home Assistant 2026.11 it opens in HACS, which you install first. If it asks, add it as a custom repository of type Dashboard.
  2. Reload the tabSo Home Assistant loads what it just installed.
  3. Add the dashboardSettings, Dashboards, Add dashboard: pick Field under Community dashboards and press Create. It opens from the sidebar, laid out by area.

How it looks

Section titled “How it looks”

Each module is a plate with a key you press, a fader you slide and an always-dark screen you read, with printed labels in capitals. A small orange mark shows what a control sets. Field opens more in a panel from the module’s name.

It comes in two finishes, light grey Alloy and Black, and follows Home Assistant’s light or dark mode by default. It reads the same on a phone in your hand and a wall panel across the room: a module never changes height when its state changes. The tablet below is live, on a demo house.

Open in Storybook

Tablet layout. It is 1180 px wide, so it shows on a larger screen. Open it in Storybook

What it draws

Controls

  • Light

    On and off, brightness, colour temperature and colour.

  • Toggle

    A switch or input_boolean used as a mode: Guest mode, Do Not Disturb.

  • Cover

    Curtains, blinds, shades, garage doors and gates.

  • Sound

    A sound machine: the switch that plays it and its volume.

  • Vacuum

    A robot vacuum: what it is doing, its battery and fan speed, and one press to pause, start or send it home.

  • Media player

    Now playing on a speaker or a TV: the title and its artwork, how far in, and one press to pause, play or turn it on.

  • Climate

    A thermostat, heat pump or air conditioner, its setpoints and modes.

  • Humidifier

    On and off, a target humidity and a mode. Dehumidifiers too.

  • Fan

    On and off, its speed, presets, oscillation and a ceiling fan's direction.

  • Alarm

    Its state, arm modes, the code and the exit and entry delays.

  • Lock

    A door lock and its battery: one tap locks, unlocking always asks first.

Readings

  • Sensor

    A room's temperature, read with its device's humidity and battery.

  • Numeric

    Any number a sensor measures, such as CO₂, power or energy, in its own words and unit.

  • Weather

    Outdoor conditions, air quality, the sun and the forecast.

  • Guest Wi-Fi

    A guest network, its code or password and its join QR code; refresh it or make a new one.

  • Calendar

    What's next and when: the next event, today's, and what's coming.

  • Sun

    When the sun next sets or rises, and its path through today.

  • Binary sensor

    A door, a window, a leak or smoke, in its own words; smoke, leaks and an open garage door warn.

  • Owlet

    A sock's sleep state, heart rate, oxygen, alerts and base station.

  • Camera

    A doorbell or a nursery camera: its still, fetched only while seen, and a press for its live stream.

An entity without a card isn’t drawn. Warnings and alarms shows how Field tells you something is wrong.

Every Field card in every state, in Storybook

Settings

Section titled “Settings”

Open the dashboard and press Edit dashboard (the pencil, or ⋮). Its dialog opens on the dashboard’s configuration in YAML; add to it and save:

A wall panel, in Black
# Field's dashboard, as Add dashboard → Field saves it, plus the options you can add.
strategy:
  type: custom:field-dashboard
  viewing: far    # near (default) for a phone or tablet, far for a wall panel
  finish: black   # home-assistant (default), auto, alloy or black
Key What it does
viewing near (default): a phone or tablet in the hand. far: a wall panel read from across the room.
finish home-assistant (default): Alloy in Home Assistant’s light mode, Black in its dark mode. auto follows the device; alloy and black hold one.
title The title the page prints in its header. Home by default.

To lay out your own cards and rows instead, take control of the dashboard (the same dialog’s ⋮ → Take control), which keeps Field’s card as it is now, and edit it; Lay it out in YAML shows how. A dashboard you take control of no longer lays itself out.

From a terminal or CI, @dashhaus/field and the deploy tool create Field’s dashboard and one of your own rows in one command: Deploy from the command line. Pick one way: each loads its own copy of Field.

If something goes wrong

Section titled “If something goes wrong”

If Add dashboard has no Field under Community dashboards, or the dashboard says Custom element doesn't exist or Timeout waiting for strategy element, Home Assistant hasn’t loaded Field yet. Reload the tab. If that doesn’t help, open Settings → Dashboards → ⋮ → Resources and check there’s a JavaScript module at /hacsfiles/field-dashboard/field-dashboard.js.

Community dashboards are listed from Home Assistant 2026.5. On an older version, or one that keeps its dashboards in YAML, create a dashboard yourself and give it strategy: { type: custom:field-dashboard } as its whole configuration.

Update

Section titled “Update”

The Marketplace (or HACS) tells you when there’s a new version of Field. Update it there, then reload the tab. Your dashboard follows; Release notes say what changed and anything to do first.

Ask an assistant to do it

Section titled “Ask an assistant to do it”

An assistant that can use your browser can follow this page on its own. Give it the page’s address, or this:

Install the Field dashboard in my Home Assistant. I'm signed in as an administrator.
1. Open https://my.home-assistant.io/redirect/hacs_repository/?owner=Krystosterone&repository=field-dashboard&category=plugin
   and download Field (type: Dashboard; add it as a custom repository if asked). Keep the defaults.
2. Reload the browser tab.
3. Settings → Dashboards → Add dashboard → under Community dashboards, pick "Field" → Create.
4. Open the new Field dashboard from the sidebar and check it draws.
   Don't change any other dashboard, and never ask me for a password or token.