diff --git a/source/_components/sensor.qbittorrent.markdown b/source/_components/sensor.qbittorrent.markdown new file mode 100644 index 00000000000..1dfdd2d9cf9 --- /dev/null +++ b/source/_components/sensor.qbittorrent.markdown @@ -0,0 +1,52 @@ +--- +layout: page +title: "qBittorrent Sensor" +description: "Instructions on how to integrate qBittorrent sensors within Home Assistant." +date: 2018-11-21 00:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: qbittorrent.png +ha_category: Downloading +ha_release: 0.84 +ha_iot_class: "Local Polling" +--- + +The `qbittorrent` platform allows you to monitor your downloads with [qBittorrent](https://www.qbittorrent.org/) from within Home Assistant and setup automations based on the information. + +## {% linkable_title Setup %} + +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. + +## {% linkable_title Configuration %} + +To enable this sensor, add the following lines to your `configuration.yaml`: + +```yaml +# Example configuration.yaml entry +sensor: + - platform: qbittorrent + url: 'http://:' + 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 %} diff --git a/source/images/supported_brands/qbittorrent.png b/source/images/supported_brands/qbittorrent.png new file mode 100644 index 00000000000..45ddb99053f Binary files /dev/null and b/source/images/supported_brands/qbittorrent.png differ