Skip to content

Latest commit

 

History

History
184 lines (114 loc) · 10.4 KB

File metadata and controls

184 lines (114 loc) · 10.4 KB

Oriel Dashboard

English · Deutsch (coming soon — contributions welcome, see TRANSLATING.md)

A Lovelace strategy for Home Assistant. It generates your dashboard from your areas, devices, and entities, and lets you customise every part through a visual editor instead of editing YAML.

Built on the foundation simon42-dashboard-strategy established (auto-generated room views, summary tiles, area grid). Simon42 remains the focused, opinionated option; Oriel is for users who want more handles to pull. Switching is a one-shot YAML edit — see MIGRATION.md.

Oriel Dashboard

Oriel's auto-generated Overview, rendered against demo data.


Install

Via HACS (custom repository):

  1. HACS → Frontend → ⋮ → Custom repositories
  2. Add https://github.com/TheDave94/oriel-dashboard, category Dashboard
  3. Install Oriel Dashboard
  4. Reload Home Assistant when HACS prompts you

Minimum Home Assistant version: 2025.5.

Sprichst du Deutsch? Du kannst Issues gerne auf Deutsch eröffnen — die Vorlage ist auf Deutsch und der Maintainer ist deutschsprachig.


Quick start

Create a new dashboard (Settings → Dashboards → Add dashboard → New dashboard from scratch), then open its raw configuration (⋮ → Edit raw configuration) and replace the contents with:

strategy:
  type: custom:oriel

Reload the dashboard. Oriel generates an Overview view plus one view per area, with sensible defaults.

Everything else is reached through the strategy editor (Edit dashboard → ⚙ Strategy options). The editor is the canonical way to configure Oriel. The YAML config is a representation, not the source of truth — power users can still hand-edit, but the editor exposes every feature without requiring it.


What ships

Eleven custom cards and two tile features. Oriel emits them automatically where they fit; you can also place them by hand inside custom_cards or favorites.

Cards

  • oriel-summary-card — counts and quick controls for lights, covers, security, batteries, climate
  • oriel-lights-group-card — on/off light grouping with optional floor grouping
  • oriel-covers-group-card — open/closed cover grouping
  • oriel-zone-presence-card — who is in which zone, at a glance
  • oriel-sparkline-card — inline 24-hour trend, optionally backed by ApexCharts
  • oriel-routines-card — scenes and scripts ranked by last-used
  • oriel-notification-card — sticky banner for smoke, leak, doorbell, and other alerts
  • oriel-screensaver-card — wall-panel idle screen
  • oriel-voice-fab — floating Assist voice button
  • oriel-pollen-card — pollen levels, auto-detected from the PollenWatch integration (rendered as a first-party card, no manual config)
  • oriel-air-quality-card — multi-source air quality, auto-detected from the AirWatch integration: worst sub-index, per-pollutant consensus, an N-of-M source badge, and explicit divergence (rendered as a first-party card, no manual config)

Tile features

  • oriel-sticky-lock-feature — keep a room mode pinned
  • oriel-cost-overlay-feature — per-tile €/h reading from power × tariff

Optional components

Oriel generates a complete dashboard with zero optional dependencies. Install any of the six optional components it auto-detects and it lights up the matching surface — no manual card config — and every one has a built-in fallback, so nothing is ever broken.

Without optional components With them installed
Oriel dashboard with no optional components Oriel dashboard with the optional components installed

Same home, same config. The right tier adds PollenWatch's pollen-forecast tiles under Weather — the one optional component that contributes a new static section. The other five enhance interaction or data density rather than adding a card (see the table). Both tiers render Oriel's built-in SVG sparkline in Trends; with ApexCharts installed that becomes a richer chart in a live browser.

Optional component Type How Oriel detects it What it lights up Fallback when absent
PollenWatch HA integration any sensor.pollenwatch_* entity First-party pollen-forecast tiles (oriel-pollen-card) under Weather Pollen section omitted
Bubble Card HACS plugin bubble-card element registered Pop-up tile navigation / actionable tiles Standard more-info dialogs
ApexCharts (apexcharts-card) HACS plugin apexcharts-card element + per-card use_apexcharts Richer historical trend charts in the sparkline Built-in SVG sparkline
Floorplan (floorplan-card) HACS plugin floorplan-card element registered Dedicated interactive floorplan view View omitted; standard area cards
decluttering-card HACS plugin decluttering_templates defined in config Reusable card templates at the lovelace root Templates ignored; inline cards
search-card HACS plugin search-card element (+ card-tools), show_search_card Entity search card No search card; editor flags it missing

None is required; each has a clean fallback that works without it — less polished, never broken.


Configuration

The editor exposes everything. The notes below describe the main axes you will touch; the editor surfaces them with descriptions and HACS-install hints where relevant.

The Oriel strategy editor

Section toggles. Turn each overview section on or off — clock, search, weather, energy, summaries, favorites, areas. The summaries themselves are also individually toggleable (lights, covers, security, batteries, climate).

Layout. Choose a density preset (compact / cozy / comfortable) and a number of columns for the summary row (summaries_columns: 2 | 4). Group lights and covers by floor when your home has more than one.

Per-area control. Hide entire areas, reorder them, or override what shows inside one specific room without touching the rest. Entity-level hiding is also available per (area, domain) pair.

Visibility rules. Show or hide sections based on user role, time of day, your house_mode entity, viewport class (phone / tablet / wall), or composable any[]/all[] predicates.

Per-user dashboards. Different layouts per Home Assistant user or label.

HACS plugin enhancements. Oriel auto-detects optional components — PollenWatch, Bubble Card, ApexCharts, decluttering-card, floorplan-card, and search-card — and lights up richer variants, each with a clean fallback that works without it. See the full table under Optional components.

Plugin extension API. Third-party plugins can register sections and badges via window.oriel.registerSection(...).

Theming. The cards expose --oriel-* CSS custom properties — the full token list is in MIGRATION.md.

Hand-authoring custom cards (YAML-direct). When you add a custom_cards (or custom_views / custom_badges / custom_sections) entry by hand, give it the card config under a card: (or equivalent config:) key:

custom_cards:
  - target_section: custom_cards
    card:
      type: markdown
      content: Hello

Oriel normalizes card:/config: to its internal parsed_config at render. A yaml: string is an editor-only input (it is parsed by the GUI, not at render). The GUI editor canonicalizes everything to parsed_config on save, so card:/config: are purely a convenience for authoring raw YAML.

For the full editor walkthrough, open the editor — every field has an inline description.


Troubleshooting

"Custom element doesn't exist: custom:oriel-something-card"

You probably have an old reference in your YAML.

If you came from simon42 and edited your dashboard YAML by hand, search the raw configuration for simon42- and replace each match with oriel-. See MIGRATION.md for the full swap table.

If you installed Oriel manually before HACS support (before 2025), the old files in www/ and the old resource URL can both still be loaded. Remove them, hard-refresh the browser, and reload Home Assistant.

The dashboard doesn't change after I edit the config

Hard-refresh the browser (Cmd+Shift+R on macOS, Ctrl+Shift+R on Windows / Linux). Home Assistant caches the dashboard config aggressively.

Open the browser console (F12). On a fresh load, Oriel prints Oriel Dashboard vX.Y.Z loaded — check the version matches the latest release.

Something else

Open an issue — the bug report template walks you through the relevant version and console-output fields. German issues are welcome.


Origin

Forked from @TheRealSimon42's dashboard strategy — credit there for the auto-generation pattern. Oriel takes that core in a different direction: maximum configurability and integration surface, all reachable through the editor. Simon42 stays the focused, opinionated option; Oriel is for users who want the configurable one. See MIGRATION.md to switch.

Built by @TheDave94.


Further reading


Related projects

Oriel works on its own, and is also deliberately built to work alongside two multi-source Home Assistant integrations:

  • PollenWatch — a pollen integration that Oriel auto-detects and renders as a first-party pollen card + badges, with no manual card configuration.
  • AirWatch — a multi-source air-quality integration sharing PollenWatch's architecture. Oriel auto-detects it and renders a first-party air-quality card — worst sub-index, per-pollutant consensus, an N-of-M source badge, and explicit divergence — with no manual card configuration.

License

MIT © Oriel Dashboard contributors.