Entities Card


Entities will be the most common type of card that will also be the most familiar to people using the standard interface. It groups items together very close to how groups used to do.

Configuration Variables

type

(string)(Required)entities

entities

(list)(Required)A list of entity IDs or entity objects, see below.

title

(string)(Optional)The card title.

show_header_toggle

(boolean)(Optional)Button to turn on/off all entities.

Default value: true

Options For Entities

If you define entities as objects instead of strings, you can add more customization and configuration:

Configuration Variables

entity

(string)(Required)Home Assistant entity ID.

type

(string)(Optional)Sets a custom card type: custom:my-custom-card

name

(string)(Optional)Overwrites friendly name.

icon

(string)(Optional)Overwrites icon or entity picture.

secondary_info

(string)(Optional)Show additional info. Values: entity-id, last-changed.

Special Row Elements

Call Service

Configuration Variables

type

(string)(Required)call-service

name

(string)(Required)Main Label.

icon

(string)(Required)Icon to display (e.g. mdi:home)

action_name

(string)(Required)Button label.

service

(string)(Required)Service like media_player.media_play_pause

service_data

(object)(Required)The service data to use.

Weblink

Configuration Variables

type

(string)(Required)weblink

name

(string)(Required)Link label.

icon

(string)(Required)Icon to display (e.g. mdi:home)

url

(string)(Required)Website URL.

Divider

Configuration Variables

type

(string)(Required)divider

style

(object)(Optional)Style the element using CSS.

Default value: height: 1px, background-color: var(–secondary-text-color)

Example

Entity rows:

- type: entities
  title: Entities card sample
  show_header_toggle: true
  entities:
    - entity: alarm_control_panel.alarm
      name: Alarm Panel
    - device_tracker.demo_paulus
    - switch.decorative_lights
    - group.all_lights
    - group.all_locks

Special rows:

- type: entities
  title: Entities card sample
  show_header_toggle: true
  entities:
    - type: call-service
      icon: mdi:power
      name: Bed light
      action_name: Toggle light
      service: light.toggle
      service_data:
        entity_id: light.bed_light
    - type: divider
    - type: weblink
      name: Home Assistant
      url: https://www.home-assistant.io/
      icon: mdi:home-assistant