Image
The Image integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] allows other integrations to display a static image.
Building block integration
This image is a building block integration that cannot be added to your Home Assistant directly but is used and provided by other integrations.
A building block integration differs from the typical integration that connects to a device or service. Instead, other integrations that do integrate a device or service into Home Assistant use this image building block to provide entities, services, and other functionality that you can use in your automations or dashboards.
If one of your integrations features this building block, this page documents the functionality the image building block offers.
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.
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'