Home Assistant Dashboards

https://www.home-assistant.io/dashboards
Admin
Home Assistant Dashboards documentation covering dashboard creation, cards, features, and entity...
Tokens:73,015
Snippets:892
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Example theme configuration for personal weather icon

Source: https://www.home-assistant.io/dashboards/weather-forecast

Example theme configuration showing how to set a personal icon for the sunny weather state.

```yaml
--weather-icon-sunny: url("/local/sunny.png")
```

--------------------------------

### Example theme configuration for weather icon colors

Source: https://www.home-assistant.io/dashboards/weather-forecast

Example theme configuration showing how to set the weather icon color variables to custom values.

```yaml
--weather-icon-cloud-front-color: white
--weather-icon-cloud-back-color: blue
--weather-icon-sun-color: orange
--weather-icon-rain-color: purple
```

--------------------------------

### Icons, labels, and buttons example

Source: https://www.home-assistant.io/dashboards/picture-elements

Example picture-elements card with state icons, state labels, an action button, and a navigation icon on a floorplan image.

```yaml
type: picture-elements
image: /local/floorplan.png
elements:
  - type: state-icon
    tap_action:
      action: toggle
    entity: light.ceiling_lights
    style:
      top: 47%
      left: 42%
  - type: state-icon
    tap_action:
      action: toggle
    entity: light.kitchen_lights
    style:
      top: 30%
      left: 15%
  - type: state-label
    entity: sensor.outside_temperature
    style:
      top: 82%
      left: 79%
  - type: state-label
    entity: climate.kitchen
    attribute: current_temperature
    suffix: "°C"
    style:
      top: 33%
      left: 15%
  - type: action-button
    title: Turn lights off
    style:
      top: 95%
      left: 60%
    action: homeassistant.turn_off
    target:
      entity_id: light.home_lights
  - type: icon
    icon: mdi:home
    tap_action:
      action: navigate
      navigation_path: /lovelace/0
    style:
      top: 10%
      left: 10%

```

--------------------------------

### Multiple collections example with energy-date-selection and energy-usage-graph

Source: https://www.home-assistant.io/dashboards/energy

Example dashboard view using multiple collections. The `collection_key` parameter must start with `energy_`; otherwise an error is generated. Cards without `collection_key` are linked to the default date selection, while cards with `collection_key: energy_2` are linked to the second date selection.

```yaml
type: masonry
path: example
cards:
  - type: energy-date-selection
  - type: energy-date-selection
    collection_key: energy_2

  # This card is linked to the first (default) date selection
  - type: energy-usage-graph

  # This card is linked to the second date selection
  - type: energy-usage-graph
    collection_key: energy_2
```

--------------------------------

### YAML example for section themes

Source: https://www.home-assistant.io/dashboards/sections

YAML example showing a dashboard with two sections: one with an explicit `alert_section` theme and another that inherits the view theme.

```yaml
views:
  - title: Home Status
    theme: main_view
    type: sections
    sections:
      # System alerts section with orange theme
      - type: grid
        title: System Alerts
        theme: alert_section
        cards:
          - type: tile
            entity: update.home_assistant_core_update
          - type: tile
            entity: sensor.processor_use
          - type: tile
            entity: sensor.memory_use_percent

      # General info section inherits blue theme
      - type: grid
        title: Status & Info
        cards:
          - type: tile
            entity: sun.sun
          - type: tile
            entity: weather.home
```

--------------------------------

### Images example

Source: https://www.home-assistant.io/dashboards/picture-elements

Example picture-elements card using image elements with state_image, state_filter, camera_image, and custom styles.

```yaml
type: picture-elements
image: /local/floorplan.png
elements:
  # state_image & state_filter - toggle on click
  - type: image
    entity: light.living_room
    tap_action:
      action: toggle
    image: /local/living_room.png
    state_image:
      "off": /local/living_room_off.png
    filter: saturate(.8)
    state_filter:
      "on": brightness(120%) saturate(1.2)
    style:
      top: 25%
      left: 75%
      width: 15%
  # Camera, red border, rounded-rectangle - show more-info on click
  - type: image
    entity: camera.driveway_camera
    camera_image: camera.driveway_camera
    style:
      top: 5%
      left: 10%
      width: 10%
      border: 2px solid red
      border-radius: 10%
  # Single image, state_filter - perform action on click
  - type: image
    entity: media_player.living_room
    tap_action:
      action: perform-action
      perform_action: media_player.media_play_pause
      target:
        entity_id: media_player.living_room
    image: /local/television.jpg
    filter: brightness(5%)
    state_filter:
      playing: brightness(100%)
    style:
      top: 40%
      left: 75%
      width: 5%

```

--------------------------------

### Example: Using custom text with other name types

Source: https://www.home-assistant.io/dashboards/naming

Example of a button card combining area name with custom text to display something like 'Kitchen lights'.

```yaml
type: button
entity: switch.kitchen_lights
name:
  - type: area
  - type: text
    text: "lights"
```

--------------------------------

### Example: Simple string name

Source: https://www.home-assistant.io/dashboards/naming

Example of a tile card using a simple string name to override the entity's display name.

```yaml
type: tile
entity: light.living_room_ceiling_light
name: "Ceiling light"
```

--------------------------------

### Example: Combining device and area

Source: https://www.home-assistant.io/dashboards/naming

Example of a tile card combining area and device name types to display something like 'Living room TV'.

```yaml
type: tile
entity: media_player.living_room_tv
name:
  - type: area
  - type: device
```

--------------------------------

### View theme example

Source: https://www.home-assistant.io/dashboards/views

Sets a separate theme for the view and its cards using the 'theme' key.

```yaml
- title: Home
  theme: happy
```

--------------------------------

### Energy distribution card YAML example

Source: https://www.home-assistant.io/dashboards/energy

Example configuration for the energy distribution card. The type must be 'energy-distribution'. The optional 'link_dashboard' boolean adds a link to the energy dashboard.

```yaml
type: energy-distribution
link_dashboard: true
```

--------------------------------

### Sidebar view YAML configuration example

Source: https://www.home-assistant.io/dashboards/sidebar

Example YAML configuration for a sidebar view with an entities card positioned in the sidebar using the 'view_layout.position' option.

```yaml
type: sidebar
cards:
  - type: entities
    entities:
      - media_player.lounge_room
    view_layout:
      position: sidebar

```

--------------------------------

### Conditional example

Source: https://www.home-assistant.io/dashboards/picture-elements

Example picture-elements card with a conditional element that shows a TV toggle shortcut only when the daughter is home and the dad is away.

```yaml
type: picture-elements
image: /local/House.png
elements:
  # conditionally show TV off button shortcut when dad's away and daughter is home
  - type: conditional
    conditions:
      - entity: sensor.presence_daughter
        state: "home"
      - entity: sensor.presence_dad
        state: "not_home"
    elements:
      - type: state-icon
        entity: switch.tv
        tap_action:
          action: toggle
        style:
          top: 47%
          left: 42%

```

--------------------------------

### View icon and title example

Source: https://www.home-assistant.io/dashboards/views

Defines a view with an icon and the 'show_icon_and_title' option set to true, which displays both the icon and the text title.

```yaml
- title: Garden
  icon: mdi:flower
  show_icon_and_title: true
```

--------------------------------

### Screen condition example

Source: https://www.home-assistant.io/dashboards/conditional

Specifies the visibility of the card per screen size using a CSS media query. Any CSS media query can be used in YAML.

```yaml
condition: screen
media_query: "(min-width: 1280px)"
```

--------------------------------

### Entity card YAML configuration example

Source: https://www.home-assistant.io/dashboards/entity

Example YAML configuration for the entity card. It shows three entity cards: one for a cover, one for a light with brightness attribute and unit, and one for a vacuum with a custom name, icon, and battery level attribute.

```yaml
- type: entity
  entity: cover.kitchen_window
- type: entity
  entity: light.bedroom
  attribute: brightness
  unit: "%"
- type: entity
  entity: vacuum.downstairs
  name: Vacuum
  icon: "mdi:battery"
  attribute: battery_level
  unit: "%"
```

--------------------------------

### And condition example

Source: https://www.home-assistant.io/dashboards/conditional

Specifies that all conditions must be met. The 'conditions' list contains the conditions to check.

```yaml
condition: and
conditions:
  - condition: numeric_state
    above: 0
  - condition: user
    users:
      - 581fca7fdc014b8b894519cc531f9a04
```

--------------------------------

### Example: Using entity name to avoid repetition

Source: https://www.home-assistant.io/dashboards/naming

Example of a tile card using the entity name type to avoid repeating the area name in the friendly name.

```yaml
type: tile
entity: sensor.living_room_sensor_temperature
name:
  type: entity
```

--------------------------------

### Energy sources table card YAML example

Source: https://www.home-assistant.io/dashboards/energy

Example configuration for the energy sources table card. The type must be 'energy-sources-table'. The optional 'types' list filters displayed consumption types; valid values include 'grid', 'solar', 'battery', 'gas', and 'water'.

```yaml
type: energy-sources-table
types:
  - gas
  - water
```

--------------------------------

### View icon example

Source: https://www.home-assistant.io/dashboards/views

Defines a view with an icon. Only the icon is shown; the title appears as a tooltip unless the 'Show icon and title' toggle is enabled.

```yaml
- title: Garden
  icon: mdi:flower
```

--------------------------------

### Basic picture entity card example

Source: https://www.home-assistant.io/dashboards/picture-entity

Basic picture entity card configuration. Displays the specified image for the given entity.

```yaml
type: picture-entity
entity: light.bed_light
image: /local/bed_light.png
```

--------------------------------

### Different images for each state example

Source: https://www.home-assistant.io/dashboards/picture-entity

Maps entity states to different images. Supports local, web, or `media-source://` URLs.

```yaml
type: picture-entity
entity: light.bed_light
state_image:
  "on": /local/bed_light_on.png
  "off": https://demo.home-assistant.io/stub_config/bedroom.png
  "unavailable": media-source://image_upload/123456789
```

--------------------------------

### Basic weather-forecast card YAML configuration

Source: https://www.home-assistant.io/dashboards/weather-forecast

Example YAML configuration for the weather-forecast card. Required fields: type, entity, and forecast_type. Optional fields show_current and show_forecast default to true.

```yaml
show_current: true
show_forecast: true
type: weather-forecast
entity: weather.openweathermap
forecast_type: daily
```

--------------------------------

### Statistic card dynamic date selection example

Source: https://www.home-assistant.io/dashboards/statistic

YAML configuration for a statistic card linked to an Energy date selection card, showing data from the selected period.

```yaml
type: statistic
entity: sensor.energy_consumption
period: energy_date_selection
stat_type: change
```

--------------------------------

### Basic grid card YAML example

Source: https://www.home-assistant.io/dashboards/grid

Basic YAML configuration for a grid card with a picture-entity and an entities card. The type is set to 'grid' and the cards list contains the two cards.

```yaml
type: grid
cards:
  - type: picture-entity
    entity: camera.demo_camera
    show_info: false
  - type: entities
    entities:
      - binary_sensor.movement_backyard

```

--------------------------------

### Live camera feed with snapshot action example

Source: https://www.home-assistant.io/dashboards/picture-entity

Displays a live feed from an FFmpeg camera and configures a tap action to take a snapshot. The filename must be writable by Home Assistant; you may need to configure `allowlist_external_dirs`.

```yaml
type: picture-entity
entity: camera.backdoor
camera_view: live
tap_action:
  action: perform-action
  perform_action: camera.snapshot
  data:
    entity_id: camera.backdoor
    filename: '/shared/backdoor-{{ now().strftime("%Y-%m-%d-%H%M%S") }}.jpg'
```

--------------------------------

### Overwriting names example - My Office

Source: https://www.home-assistant.io/dashboards/light

Another example of overwriting the friendly name, this time for an office light entity.

```yaml
type: light
entity: light.office
name: My Office
```

--------------------------------

### Launch the voice assistant

Source: https://www.home-assistant.io/dashboards/shortcut

Configures a shortcut card to launch the voice assistant.

```yaml
type: shortcut
tap_action:
  action: assist

```

--------------------------------

### Overwriting names example - Kids Bedroom

Source: https://www.home-assistant.io/dashboards/light

Example showing how to overwrite the friendly name of the light entity with a custom name using the 'name' option.

```yaml
type: light
entity: light.bedroom
name: Kids Bedroom
```

--------------------------------

### Perform an action with custom color and description

Source: https://www.home-assistant.io/dashboards/shortcut

Configures a shortcut card to perform an action, with a custom color and description.

```yaml
type: shortcut
label: "Good night"
description: "Turn off all lights"
color: indigo
tap_action:
  action: perform-action
  perform_action: script.good_night

```

--------------------------------

### Solar production graph YAML example

Source: https://www.home-assistant.io/dashboards/energy

Minimal YAML configuration for the solar production graph card. The type must be 'energy-solar-graph'. Optional collection_key links the card to a specific energy dashboard collection; title shows a header with total solar produced chip.

```yaml
type: energy-solar-graph
```

--------------------------------

### Changing view type to panel example

Source: https://www.home-assistant.io/dashboards/views

Changes the view layout to 'panel' by setting 'type: panel'. The default view type is 'section'. This example includes a map card with entities.

```yaml
- title: Map
  type: panel
  cards:
    - type: map
      entities:
        - device_tracker.demo_paulus
        - zone.home
```

--------------------------------

### Statistic card fixed period without start or end

Source: https://www.home-assistant.io/dashboards/statistic

YAML configuration for a statistic card using a fixed period without start or end, showing the all-time change in energy consumption.

```yaml
type: statistic
entity: sensor.energy_consumption
period:
  fixed_period:
stat_type: change
```

--------------------------------

### Statistics graph card YAML example

Source: https://www.home-assistant.io/dashboards/statistics-graph

Example YAML configuration for the statistics graph card. It sets a title and lists two entities: one as a plain entity ID and one as an entity object with a custom name.

```yaml
type: statistics-graph
title: 'My Graph'
entities:
  - sensor.outside_temperature
  - entity: sensor.inside_temperature
    name: Inside

```

--------------------------------

### Configure section background in YAML

Source: https://www.home-assistant.io/dashboards/sections

Two YAML examples for configuring the section background. The first uses the default background with `background: true`. The second sets a custom color and opacity using a map with `color` and `opacity` keys.

```yaml
# Section with default background
background: true
```

```yaml
# Section with custom background color and opacity
background:
  color: "red"
  opacity: 80
```

--------------------------------

### State condition: state and state_not examples

Source: https://www.home-assistant.io/dashboards/conditional

Tests if an entity has a specified state. The first example uses 'state' to match a specific state, while the second uses 'state_not' to match any state except the specified one. One of 'state' or 'state_not' is required.

```yaml
condition: state
entity: climate.thermostat
state: heat
```

```yaml
condition: state
entity: climate.thermostat
state_not: "off"
```

--------------------------------

### YAML configuration example for webpage card

Source: https://www.home-assistant.io/dashboards/iframe

Minimal YAML configuration for the webpage card. Sets the URL to the Home Assistant website and forces the height to 75% of the width. Use in YAML mode or the code editor in the UI.

```yaml
type: iframe
url: https://www.home-assistant.io
aspect_ratio: 75%
```

--------------------------------

### View visibility per user example

Source: https://www.home-assistant.io/dashboards/views

Shows how to set view visibility per user using the 'visible' key. Each view can specify a list of user IDs that can see the tab, or a single user ID. The URL path remains accessible even if the tab is hidden.

```yaml
views:
  - title: Ian
    visible:
      - user: 581fca7fdc014b8b894519cc531f9a04
    cards:
      ...
  - title: Chelsea
    visible:
      - user: 6e690cc4e40242d2ab14cf38f1882ee6
    cards:
      ...
  - title: Admin
    visible: db34e025e5c84b70968f6530823b117f
    cards:
      ...
```

--------------------------------

### Configure YAML dashboards with resources in configuration.yaml

Source: https://www.home-assistant.io/dashboards/dashboards

Adds a `dashboards:` section under `lovelace:` in `configuration.yaml` to define multiple YAML dashboards. Includes `resource_mode: yaml` and a `resources` list for external resources. Each dashboard requires a `mode: yaml` and a `filename`; optional keys include `title`, `icon`, `show_in_sidebar`, and `require_admin`.

```yaml
lovelace:
  # Use resource_mode to load resources from YAML
  resource_mode: yaml
  # Include external resources (requires resource_mode: yaml)
  resources:
    - url: /local/my-custom-card.js
      type: module
    - url: /local/my-webfont.css
      type: css
  # Add YAML dashboards
  dashboards:
    my-home: # Needs to contain a hyphen (-)
      mode: yaml
      filename: my-home.yaml
      title: My home
      icon: mdi:home-outline
      show_in_sidebar: true
    dashboard-hidden:
      mode: yaml
      filename: hidden.yaml
      title: Hidden
      show_in_sidebar: false
    dashboard-admin:
      mode: yaml
      title: Admin
      icon: mdi:tools
      show_in_sidebar: true
      require_admin: true
      filename: admin.yaml
```

--------------------------------

### Not condition example

Source: https://www.home-assistant.io/dashboards/conditional

Specifies that at least one of the conditions must not be met. The 'conditions' list contains the conditions to check.

```yaml
condition: not
conditions:
  - condition: numeric_state
    above: 0
  - condition: user
    users:
      - 581fca7fdc014b8b894519cc531f9a04
```

--------------------------------

### Or condition example

Source: https://www.home-assistant.io/dashboards/conditional

Specifies that at least one of the conditions must be met. The 'conditions' list contains the conditions to check.

```yaml
condition: or
conditions:
  - condition: numeric_state
    above: 0
  - condition: user
    users:
      - 581fca7fdc014b8b894519cc531f9a04
```

--------------------------------

### Basic Detail Devices Energy Graph YAML Configuration

Source: https://www.home-assistant.io/dashboards/energy

Minimal YAML configuration for the Detail devices energy graph card. Requires the type key set to 'energy-devices-detail-graph'.

```yaml
type: energy-devices-detail-graph

```

--------------------------------

### Markdown card basic YAML example

Source: https://www.home-assistant.io/dashboards/markdown

Shows a basic Markdown card configuration in YAML mode, rendering the card title and a paragraph. Use this as a template for simple static Markdown content.

```yaml
type: markdown
content: >
  ## Dashboards

  Starting with Home Assistant 0.72, we're experimenting with a new way of defining your interface.

```

--------------------------------

### Basic tile card configuration

Source: https://www.home-assistant.io/dashboards/tile

Configures a tile card for a cover entity using YAML.

```yaml
type: tile
entity: cover.kitchen_window
```

--------------------------------

### Use entity_picture attribute example

Source: https://www.home-assistant.io/dashboards/picture-entity

Uses the entity's `entity_picture` attribute to show an entity-provided image, such as an update entity logo.

```yaml
type: picture-entity
entity: update.home_assistant_core_update
show_entity_picture: true
show_state: true
show_name: true
```

--------------------------------

### Basic Devices Energy Graph YAML Configuration

Source: https://www.home-assistant.io/dashboards/energy

Minimal YAML configuration for the Devices energy graph card. Requires the type key set to 'energy-devices-graph'.

```yaml
type: energy-devices-graph

```
Tokens:
Raw