mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-06-29 21:46:50 +00:00

* Create sensor.pyload.markdown * pyload image * added pyload image * Update sensor.pyload.markdown * Updates according to code
40 lines
1.2 KiB
Markdown
40 lines
1.2 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 variables:
|
|
|
|
- **host** (*Optional*): This is the IP address of your pyLoad download manager, eg. 192.168.0.100. Defaults to `localhost`.
|
|
- **port** (*Optional*): The port your pyLoad interface uses. Defaults to 8000.
|
|
- **name** (*Optional*): The name to use when displaying this pyLoad instance.
|
|
- **username** (*Optional*): Your pyLoad username.
|
|
- **password** (*Optional*): Your pyLoad password.
|
|
|
|
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>
|