71 lines
1.8 KiB
Markdown

---
title: "Entity Card"
sidebar_label: Entity
description: "The Entity card gives you a quick overview of your entity's state"
---
The Entity card gives you a quick overview of your entity's state.
<p class='img'>
<img src='/images/lovelace/lovelace_entity_card.png' alt='Screenshot of the entity card'>
Screenshot of the Entity card.
</p>
To add the Entity card to your user interface, click the Lovelace menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the "Add Card" button in the bottom right corner and select **Entity** from the card picker.
{% configuration %}
type:
required: true
description: "`entity`"
type: string
entity:
required: true
description: Entity ID.
type: string
name:
required: false
description: Name of entity.
type: string
default: Entity name.
icon:
required: false
description: Overwrites icon.
type: string
attribute:
required: false
description: An attribute associated with the `entity`.
type: string
unit:
required: false
description: Unit of measurement given to data.
type: string
default: Unit of measurement given by entity.
theme:
required: false
description: Override the used theme for this card with any loaded theme. For more information about themes, see the [frontend documentation](/integrations/frontend/).
type: string
footer:
required: false
description: Footer widget to render. See [footer documentation](/lovelace/header-footer/).
type: map
{% endconfiguration %}
## Example
Alternatively, the card can be configured using YAML:
```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: "%"
```