rTorrent


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'
      - 'all_torrents'
      - 'stopped_torrents'
      - 'complete_torrents'
      - 'uploading_torrents'
      - 'downloading_torrents'
      - 'active_torrents'

This sensor requires the rTorrent XML-RPC 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:[email protected]:9080/RPC2.

Configuration Variables

url string Required

The URL to the HTTP endpoint of the rTorrent XML-RPC API.

name string (Optional)

The name to use when displaying this rTorrent instance.

monitored_variables list Required

Conditions to be monitored.

current_status

The status of your rTorrent daemon.

download_speed

The current download speed.

upload_speed

The current upload speed.

all_torrents

The number of all torrents.

stopped_torrents

The number of torrents that are stopped.

complete_torrents

The number of torrents that are fully downloaded.

uploading_torrents

The number of torrents that are seeding.

downloading_torrents

The number of torrents that are leeching.

active_torrents

The number of torrents that are actively ( measurable speed ) leeching, seeding or both.