Skip to content

Configuration

jv edited this page Jun 3, 2026 · 4 revisions

Configuration

First-time setup (connect to Home Assistant)

The dashboard talks to HA directly over WebSocket from the browser, and the add-on does not store your token. On first open:

  1. Click the gear / Settings icon in the dashboard.
  2. Under Home Assistant, enter your Server URL (e.g. http://homeassistant.local:8123) and a Long-Lived Access Token.
    • Create a token in HA → your Profile → Long-Lived Access Tokens.
  3. Click Test connection, then Save & reload.

The token is kept in that browser's localStorage only — never written to disk or baked into the image.

Make sure the Server URL is reachable from the device viewing the dashboard.

Connection resolution order (local dev)

Values resolve: Settings (localStorage) → Vite env → default.

Source Key
Settings modal HA URL + long-lived token
.env VITE_HA_URL, VITE_HA_TOKEN
Hard default http://homeassistant.local:8123

Appearance

  • Themes — Midnight, Slate, OLED Black, Light.
  • Accent color — 8 swatches + a custom color picker. The accent recolors the whole UI (driven by an --accent-rgb triplet).
  • Ambient effects — toggle the weather-reactive backdrop (rain/snow particles, lightning in thunderstorms) and time-of-day tint.

All animations respect prefers-reduced-motion: reduce.


Settings persistence

  • App settings (HA URL, token, theme, accent) → localStorage (per browser/device).
  • Dashboard layout → server-side layouts.json via the Vite middleware (shared across devices on the same host); on the add-on it persists to /data/layouts.json and survives restarts/updates.

Cross-device settings sync is a future consideration — see TODO.md in the repo.


Dev preview overrides

AmbientBackdrop reads URL query params to preview ambient effects regardless of real conditions:

Param Values Effect
?precip= rain snow none Force the precipitation layer
?tod= dawn day dusk night Force the time-of-day tint

Example: http://localhost:3000/?precip=snow&tod=dusk. No params = real weather/clock.

Clone this wiki locally