qBittorrent
The qbittorrent platform allows you to monitor your downloads with qBittorrent from within Home Assistant and setup automations based on the information.
Setup
This sensor requires the qBittorrent Web UI enabled. The official reference describes how to set up the Web UI.
Configuration
To add the qBittorrent integration to your Home Assistant instance, use this My button:
If the above My button doesn’t work, you can also perform the following steps manually:
-
Browse to your Home Assistant instance.
-
In the bottom right corner, select the Add Integration button.
-
From the list, select qBittorrent.
-
Follow the instructions on screen to complete the setup.
Sensors
The qBittorrent integration will add the following sensors:
-
sensor.qbittorrent_status: The status of qBittorrent -up_down,seeding,downloadingoridle. -
sensor.qbittorrent_upload_speed: The current total upload speed in kB/s. -
sensor.qbittorrent_download_speed: The current total download speed in kB/s. -
sensor.qbittorrent_all_torrents: The current total torrents in qBittorrent. -
sensor.qbittorrent_active_torrents: The current active torrents in qBittorrent. -
sensor.qbittorrent_inactive_torrents: The current inactive torrents in qBittorrent. -
sensor.qbittorrent_paused_torrents: The current paused torrents in qBittorrent.
Services
Service qbittorrent.get_torrents
This service populates Response Data with a dictionary of torrents based on the provided filter.
| Service data attribute | Optional | Description | Example |
|---|---|---|---|
device |
no | The device you’d like to check the torrents of | all, active, inactive, paused, downloading, seeding |
torrent_filter |
no | The type of torrents you want in the response | all, active, inactive, paused, downloading, seeding |
service: qbittorrent.get_torrents
data:
filter: "all"
response_variable: torrents
The response data contains the field torrents which contains a dictionary of torrents. The names of the torrents are the keys.
Service qbittorrent.get_all_torrents
This service populates Response Data with a dictionary of torrents based on the provided filter.
| Service data attribute | Optional | Description | Example |
|---|---|---|---|
torrent_filter |
no | The type of torrents you want in the response | all, active, inactive, paused, downloading, seeding |
service: qbittorrent.get_all_torrents
data:
filter: "all"
response_variable: all_torrents
The response data contains the field all_torrents, which contains a dictionary of integrations, which each contains a dictionary of torrents. The names of the torrents are the keys.