jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-18 23:06:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add details about the usage

Browse Source
This commit is contained in:
Fabian Affolter 2015-10-29 12:31:30 +01:00
parent b726f0e94b
commit 06809a7098
1 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
source/_components/downloader.markdown
View File

@ -10,21 +10,29 @@ footer: true
ha_category: Other
---
The `downloader` component provides a service to download files. It will raise an error and not continue to set itself up when the download directory does not exist.
To enable it, add the following lines to your `configuration.yaml`:
To enable it, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
downloader:
download_dir: downloads
```
If the path is not absolute, it's assumed to be relative to the HASS configuration directory.
#### Service `downloader/download_file`
Configuration variables:
Download the specified url.
- **download_dir** (*Required*): If the path is not absolute, it's assumed to be relative to the Home Assistant configuration directory (eg. `.homeassistant/downloads`).
### {% linkable_title Use the service %}
Go the the "Developer Tools", then to "Call Service", and choose `downloader/download_file` from the list of available services. Fill the "Service Data" field as shown in the example below and hit "CALL SERVICE".
```json
{"url":"http://domain.tld/path/to/file"}
```
This will download the file from the given URL.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |