Add config flow to qbittorrent (#25028)

This commit is contained in:
Chris Xiao 2023-04-03 03:36:43 -04:00 committed by GitHub
parent acf7767dc2
commit 83d07f9b9e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -4,6 +4,7 @@ description: Instructions on how to integrate qBittorrent sensors within Home As
ha_category: ha_category:
- Downloading - Downloading
ha_release: 0.84 ha_release: 0.84
ha_config_flow: true
ha_iot_class: Local Polling ha_iot_class: Local Polling
ha_domain: qbittorrent ha_domain: qbittorrent
ha_codeowners: ha_codeowners:
@ -19,37 +20,7 @@ The `qbittorrent` platform allows you to monitor your downloads with [qBittorren
This sensor requires the qBittorrent Web UI enabled. The [official reference](https://github.com/qbittorrent/qBittorrent/wiki#webui-related) describes how to set up the Web UI. This sensor requires the qBittorrent Web UI enabled. The [official reference](https://github.com/qbittorrent/qBittorrent/wiki#webui-related) describes how to set up the Web UI.
## Configuration {% include integrations/config_flow.md %}
To enable this sensor, add the following lines to your `configuration.yaml`:
```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 ## Sensors