home-assistant.io/source/_components/sensor.deluge.markdown
Justin Bassett 6ff34bcc2f
Update Deluge Docs
Updating to reflect which fields are actually required to setup this sensor.
2018-05-21 10:16:30 -04:00

45 lines
1.4 KiB
Markdown

---
layout: page
title: "Deluge Sensor"
description: "Instructions on how to integrate Deluge sensors within Home Assistant."
date: 2017-10-24 17:06
sidebar: true
comments: false
sharing: true
footer: true
logo: deluge.png
ha_category: Downloading
ha_release: 0.57
ha_iot_class: "Local Polling"
---
The `deluge` platform allows you to monitor your downloads with [Deluge](http://deluge-torrent.org/) 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: deluge
host: IP_ADDRESS
username: USERNAME
password: PASSWORD
monitored_variables:
- 'current_status'
- 'download_speed'
- 'upload_speed'
```
Configuration variables:
- **host** (*Required*): This is the IP address of your Deluge daemon, eg. 192.168.1.32.
- **port** (*Optional*): The port your Deluge daemon uses. Defaults to 58846. Warning, this is not the port of the WebUI.
- **name** (*Optional*): The name to use when displaying this Deluge instance.
- **username** (*Required*): Your Deluge daemon username.
- **password** (*Required*): Your Deluge daemon password.
- **monitored_variables** array (*Required*): Conditions to display in the frontend.
- **current_status**: The status of your Deluge daemon.
- **download_speed**: The current download speed.
- **upload_speed**: The current upload speed.