2024.11.2
Home ▸ Dashboards ▸

Picture entity card

The picture entity card displays an entity in the form of an image. Instead of images from URL, it can also show the picture of camera entities.

Picture entity card Background changes according to the entity state.

Adding a picture entity card to your dashboard

  1. To add a card, follow steps 1-4 on adding a card from a view.

    • In step 2, on the By card tab, select picture entity card.

  2. Add a picture:

    • Upload picture lets you pick an image from the system used to show your Home Assistant UI.
    • Local path lets you pick an image stored on Home Assistant. For example: /homeassistant/images/lights_view_background_image.jpg.
    • web URL let you use an image from the web. For example https://www.home-assistant.io/images/frontpage/assist_wake_word.png.

  3. Define the parameters that are specific to the picture entity card.

    • For a description of the specific settings, refer to the description under YAML configuration.
    • They also apply to the UI.

  4. Save your changes.

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

picture-entity

entity string Required

A camera, image, or person entity_id used for the picture.

camera_image string (Optional)

Camera entity_id to use. (not required if entity is already a camera-entity).

camera_view string (Optional, default: auto)

“live” will show the live view if stream is enabled.

image string (Optional)

URL of an image. To use a locally hosted image, see Hosting.

state_image map (Optional)

Map entity states to images (state: image URL, check the example below).

state_filter map (Optional)

State-based CSS filters

aspect_ratio string (Optional)

Forces the height of the image to be a ratio of the width. Valid formats: Height percentage value (23%) or ratio expressed with colon or “x” separator (16:9 or 16x9). For a ratio, the second element can be omitted and will default to “1” (1.78 equals 1.78:1).

fit_mode string (Optional, default: cover)

Defines the manner in which the image is stretched/clipped to fit the card area. cover: The image keeps its aspect ratio and fills the given dimension. The image will be clipped to fit. contain: The image keeps its aspect ratio, but is resized to fit within the given dimension. fill: The image is resized to fill the given dimension. If necessary, the image will be stretched or squished to fit.

name string (Optional)

Overwrite entity name.

show_name boolean (Optional, default: true)

Shows name in footer.

show_state boolean (Optional, default: true)

Shows state in footer.

theme string (Optional)

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

tap_action map (Optional)

Action taken on card tap. See action documentation.

hold_action map (Optional)

Action taken on card tap and hold. See action documentation.

double_tap_action map (Optional)

Action taken on card double tap. See action documentation.

How to use state_filter

Specify different CSS filters

state_filter:
  "on": brightness(110%) saturate(1.2)
  "off": brightness(50%) hue-rotate(45deg)

Examples

Basic example:

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

Different images for each state:

type: picture-entity
entity: light.bed_light
state_image:
  "on": /local/bed_light_on.png
  "off": /local/bed_light_off.png

Displaying a live feed from an FFmpeg camera:

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'

The filename needs to be a path that is writable by Home Assistant in your system. You may need to configure allowlist_external_dirs (documentation).

Related topics