home-assistant.io/source/_integrations/image.markdown

title	description	ha_category	ha_release	ha_quality_scale	ha_domain	ha_codeowners	ha_integration_type
Image	Instructions on how to integrate images within Home Assistant.	Image	2023.7	internal	image	@home-assistant/core	entity

The Image {% term integration %} allows other integrations to display a static image.

{% include integrations/building_block_integration.md %}

The state of an image entity

The state of an image entity is a timestamp, showing the date and time when the image was last changed.

In addition, the entity can have the following states:

• Unavailable: The entity is currently unavailable.
• Unknown: The state is not yet known.

Actions

Once loaded, the image platform will expose services that can be called to perform various actions.

Available services: snapshot.

Action snapshot

Take a snapshot from an image.

Data attribute	Optional	Description
entity_id	no	Name(s) of entities to create a snapshot from, e.g., image.my_image.
filename	no	Snapshot file name

The path part of filename must be an entry in the allowlist_external_dirs in your homeassistant: section of your configuration.yaml file.

For example, the following action in an automation would take a snapshot from "yourimage" and save it to /tmp with a timestamped filename.

{% raw %}

actions:
  - variables:
      entity_id: image.yourimage  # Store the camera entity_id in a variable for reuse
  - action: image.snapshot
    target:
      entity_id: '{{ entity_id }}'
    data:
      filename: '/tmp/{{ entity_id }}_{{ now().strftime("%Y%m%d-%H%M%S") }}.jpg'

{% endraw %}