f3a38686fb
* Create sensor.rtorrent.markdown * Add unofficial rtorrent logo rtorrent doesn't have an official logo, but this one is the most widely used. * Add logo and remove additional empty lines * Set ha_release to 0.80 * Updated description and configuration tags * Put descriptions first in configuration section * Update sensor.rtorrent.markdown
1.8 KiB
layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, ha_release, ha_iot_class
| layout | title | description | date | sidebar | comments | sharing | footer | logo | ha_category | ha_release | ha_iot_class |
|---|---|---|---|---|---|---|---|---|---|---|---|
| page | rtorrent Sensor | Instructions on how to integrate rtorrent sensors within Home Assistant. | 2018-10-14 05:40 | true | false | true | true | rtorrent.png | Downloading | 0.81 | Local Polling |
The rtorrent platform allows you to monitor your downloads with rtorrent from within Home Assistant and setup automations based on the information.
To enable this sensor, add the following lines to your configuration.yaml:
# Example configuration.yaml entry
sensor:
- platform: rtorrent
url: 'http://<user>:<password>@<host>:<port>/RPC2'
monitored_variables:
- 'current_status'
- 'download_speed'
- 'upload_speed'
This sensor requires the rtorrent XMLRPC API exposed on an HTTP interface.
Note that for security reasons, simply using the SCGI interface (default localhost:5000) of rtorrent won't work.
The official reference describes how to set up that HTTP interface.
Alternatively, the arch-rtorrentvpn container can be used with url set to http://admin:rutorrent@127.0.0.1:9080/RPC2.
{% configuration %} url: description: The URL to the HTTP endpoint of the rtorrent XMLRPC API. required: true type: string name: description: The name to use when displaying this rtorrent instance. required: false type: string monitored_variables: description: Conditions to be monitored. required: true type: list keys: current_status: description: The status of your rtorrent daemon. download_speed: description: The current download speed. upload_speed: description: The current upload speed. {% endconfiguration %}