mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-08 09:56:52 +00:00
Add services docs for image entity (#31327)
* Add services docs for image * Update example * Fix table
This commit is contained in:
parent
035bef74f8
commit
fd72debdbf
@ -23,3 +23,37 @@ 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:`](/docs/configuration/basic/) 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 %}
|
||||
|
||||
```yaml
|
||||
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 %}
|
||||
|
Loading…
x
Reference in New Issue
Block a user