mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-02 01:07:36 +00:00
1aca7b08cf
* e.g. to e.g., and proper case for Home Assistant * Instructions how to -> Instructions on how to
45 lines
1.7 KiB
Markdown
45 lines
1.7 KiB
Markdown
---
|
|
layout: page
|
|
title: "Downloader"
|
|
description: "Instructions on how to setup the downloader component with Home Assistant."
|
|
date: 2015-01-24 14:39
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: home-assistant.png
|
|
ha_category: Downloading
|
|
ha_release: pre 0.7
|
|
---
|
|
|
|
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. The directory needs to be writable for the user that is running Home Assistant.
|
|
|
|
To enable it, add the following lines to your `configuration.yaml` file:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
downloader:
|
|
download_dir: downloads
|
|
```
|
|
|
|
Configuration variables:
|
|
|
|
- **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 to 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 |
|
|
| ---------------------- | -------- | ---------------------------------------------- |
|
|
| `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`. |
|