57d5c57bd0
* Docs - Added clarity to location of download folder for Home Assistant OS In the previous documentation, it's not clear where that folder should exist or live. * fix - Corrected spelling of `initial` * Docs - Moved Home Assistant OS example to same line as configuration folder details. Removed "See Location of Folder" Removed "Location of Folder" header and just placed example with configuration of Home Assistant OS with the other config items. * rephrase * change homeassistant folder to config, assuming HA OS * Update source/_integrations/downloader.markdown --------- Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
3.2 KiB
title, description, ha_category, ha_release, ha_quality_scale, ha_domain, ha_codeowners, ha_integration_type, ha_config_flow
| title | description | ha_category | ha_release | ha_quality_scale | ha_domain | ha_codeowners | ha_integration_type | ha_config_flow | ||
|---|---|---|---|---|---|---|---|---|---|---|
| Downloader | Instructions on how to setup the downloader integration with Home Assistant. |
|
pre 0.7 | internal | downloader |
|
integration | true |
The Downloader {% term integration %} provides an action to download files. It will raise an error and not continue to set itself up when the download directory does not exist. The directory needs to be writable for the user who is running Home Assistant.
{% include integrations/config_flow.md %}
If the path is not absolute, it’s assumed to be relative to the Home Assistant configuration directory (for example, /config/downloads). So if you have a folder called /config/my_download_folder, when prompted to Select a location to get to store downloads, enter my_download_folder. Home Assistant checks if the directory exists.
Use the action
Go to the "Developer Tools", then to "Actions", and choose downloader.download_file from the list of available actions. Fill the "data" field as shown in the example below and select "Perform action".
{"url":"http://domain.tld/path/to/file"}
This will download the file from the given URL.
| Data attribute | Optional | Description |
|---|---|---|
url |
no | The URL of the file to download. |
subdir |
yes | Download into subdirectory of download_dir |
filename |
yes | Determine the filename. |
overwrite |
yes | Whether to overwrite the file or not, defaults to false. |
Download status events
When a download finished successfully, Home Assistant will emit a downloader_download_completed event to the event bus which you can use to write automations against.
In case download failed another event downloader_download_failed is emitted to indicate that the download did not complete successfully.
Along with the event the following payload parameters are available:
| Parameter | Description |
|---|---|
url |
The url that was requested. |
filename |
The name of the file that was being downloaded. |
Example automation:
- alias: "Download Failed Notification"
trigger:
platform: event
event_type: downloader_download_failed
action:
action: persistent_notification.create
data:
message: "{{trigger.event.data.filename}} download failed"
title: "Download Failed"