home-assistant.io/source/_integrations/qbittorrent.markdown
2022-03-30 21:50:39 +02:00

1.7 KiB

title description ha_category ha_release ha_iot_class ha_domain ha_codeowners ha_platforms ha_integration_type
qBittorrent Instructions on how to integrate qBittorrent sensors within Home Assistant.
Downloading
0.84 Local Polling qbittorrent
@geoffreylagaisse
sensor
integration

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 enable this sensor, add the following lines to your configuration.yaml:

# Example configuration.yaml entry
sensor:
  - platform: qbittorrent
    url: "http://<hostname>:<port>"
    username: YOUR_USERNAME
    password: YOUR_PASSWORD

{% configuration %} url: description: The URL of the Web UI of qBittorrent. required: true type: string name: description: The name to use when displaying this qBittorrent instance. required: false type: string username: description: The username of the Web UI of qBittorrent. required: true type: string password: description: The password of the Web UI of qBittorrent. required: true type: string {% endconfiguration %}

Sensors

The qBittorrent integration will add the following sensors:

  • sensor.qbittorrent_status: The status of qBittorrent - up_down, seeding, downloading or idle.
  • sensor.qbittorrent_up_speed: The current total upload speed in kB/s.
  • sensor.qbittorrent_down_speed: The current total download speed in kB/s.