mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-04-30 16:27:37 +00:00
65 lines
1.4 KiB
Markdown
65 lines
1.4 KiB
Markdown
---
|
|
layout: page
|
|
title: "pyLoad Sensor"
|
|
description: "Instructions how to integrate pyLoad download sensor within Home Assistant."
|
|
date: 2017-10-23 09:00
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: pyload.png
|
|
ha_category: Downloading
|
|
ha_release: 0.58
|
|
ha_iot_class: "Local Polling"
|
|
---
|
|
|
|
|
|
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: int
|
|
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='{{site_root}}/images/components/pyload/pyload_speed.png' />
|
|
</p>
|
|
|