Name¶

The Name tool displays the name connected to an entity. By default it shows the Home Assistant entity name. You can also give the entity a fixed name or build a name from its entity, device, area, floor, and fixed text.

This page shows how to choose the displayed name in entities:, place it with layout.names, style it, shorten long names, and optionally color it from the entity value.

Show the entity name¶

Add the entity under entities: and refer to it from layout.names with entity_index:

1
2
3
4
5
6
7
8

entities:  # Entities used by this example
  - entity: sensor.living_room_temperature

layout:
  names:
    - entity_index: 0
      xpos: 50
      ypos: 50

With no name: override, Home Assistant supplies the displayed entity name.

Use a fixed name¶

Set name on the entity when this card should use fixed text instead of the Home Assistant name:

1
2
3
4
5
6
7
8
9

entities:  # Entities used by this example
  - entity: sensor.living_room_temperature
    name: Room temperature

layout:
  names:
    - entity_index: 0
      xpos: 50
      ypos: 50

Build a name from several parts¶

Home Assistant lets you assemble the displayed entities name from several parts, in the order you list them:

Put these parts under entities[].name.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

entities:  # Entities used by this example
  - entity: sensor.living_room_temperature
    name:
      - type: area
      - type: text
        text: "-"
      - type: entity

layout:
  names:
    - entity_index: 0
      xpos: 50
      ypos: 50

This can display Living room - Temperature. Home Assistant supplies the current entity, device, area, and floor names. A text part remains exactly as configured.

Position and align the name¶

Position the name with xpos and ypos. Use text-anchor to control horizontal alignment: start starts the text at xpos, middle centers it on xpos, and end ends it at xpos.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

entities:  # Entities used by this example
  - entity: sensor.living_room_temperature

layout:
  names:
    - entity_index: 0
      xpos: 20
      ypos: 50
      styles:
        text-anchor: start

Shorten a long name¶

Use ellipsis to limit the displayed name length:

1
2
3
4
5
6
7
8
9

entities:  # Entities used by this example
  - entity: sensor.living_room_temperature

layout:
  names:
    - entity_index: 0
      xpos: 50
      ypos: 50
      ellipsis: 18

Names longer than the configured length are shortened with an ellipsis. max_characters is an alternative field with the same effect. If both max_characters and ellipsis are set, max_characters is used.

Change color with the entity¶

Add color_stops when the displayed name should change color with the selected entity value or state. See Color stops.

Configuration options¶

Required applies to this layout.names item. Not set means the card adds no explicit value when the option is omitted.

Related¶

• Entities
• State
• Area
• Text