2024.11.2
Home ▸ Dashboards ▸

Entity card

The entity card gives you a quick overview of your entity’s state.

Screenshot of the entity card Screenshot of the Entity card.

To add the entity card to your user interface:

  1. In the top right of the screen, select the edit button.
    • If this is your first time editing a dashboard, the Edit dashboard dialog appears.
      • By editing the dashboard, you are taking over control of this dashboard.
      • This means that it is no longer automatically updated when new dashboard elements become available.
      • Once you’ve taken control, you can’t get this specific dashboard back to update automatically. However, you can create a new default dashboard.
      • To continue, in the dialog, select the three dots menu, then select Take control.
  2. Add a card to your dashboard.

All options for this card can be configured via the user interface.

YAML configuration

The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.

Configuration Variables

Looking for your configuration file?
type string Required

entity

entity string Required

Entity ID.

name string (Optional, default: Entity name.)

Name of entity.

icon string (Optional)

Overwrites icon.

state_color boolean (Optional, default: false)

Set to true to have icon colored when entity is active.

attribute string (Optional)

An attribute associated with the entity.

unit string (Optional)

Unit of measurement given to data.

Default:

Unit of measurement given by entity.

theme string (Optional)

Override the used theme for this card with any loaded theme. For more information about themes, see the frontend documentation.

footer map (Optional)

Footer widget to render. See footer documentation.

Example 

- 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: "%"

Related topics