mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-06 19:18:59 +00:00
60 lines
1.4 KiB
Markdown
60 lines
1.4 KiB
Markdown
---
|
|
title: pyLoad
|
|
description: Instructions on how to integrate pyLoad download sensor within Home Assistant.
|
|
ha_category:
|
|
- Downloading
|
|
ha_release: 0.58
|
|
ha_iot_class: Local Polling
|
|
ha_domain: pyload
|
|
ha_platforms:
|
|
- sensor
|
|
ha_integration_type: integration
|
|
---
|
|
|
|
The `pyload` platform allows you to monitor your downloads with [pyLoad](https://pyload.net/) from within Home Assistant and setup automation based on the information.
|
|
|
|
To enable this sensor, add the following lines to your `configuration.yaml`:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
sensor:
|
|
- platform: pyload
|
|
```
|
|
|
|
{% configuration %}
|
|
host:
|
|
description: This is the IP address of your pyLoad download manager.
|
|
required: false
|
|
type: string
|
|
default: localhost
|
|
port:
|
|
description: The port your pyLoad interface uses.
|
|
required: false
|
|
type: integer
|
|
default: 8000
|
|
name:
|
|
description: The name to use when displaying this pyLoad instance.
|
|
required: false
|
|
type: string
|
|
default: 20
|
|
username:
|
|
description: Your pyLoad username.
|
|
required: false
|
|
type: string
|
|
password:
|
|
description: Your pyLoad password.
|
|
required: false
|
|
type: string
|
|
ssl:
|
|
description: Enable SSL/TLS for the host.
|
|
required: false
|
|
type: boolean
|
|
default: false
|
|
{% endconfiguration %}
|
|
|
|
If everything is setup correctly, the download speed will show up in the frontend.
|
|
|
|
<p class='img'>
|
|
<img src='/images/integrations/pyload/pyload_speed.png' />
|
|
</p>
|