jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-22 08:46:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update QBittorrent documentation (#30349)

Browse Source
This commit is contained in:
Joe Neuman 2023-12-27 04:31:14 -08:00 committed by GitHub
parent 74713caef9
commit e9fb860fe2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 30 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
source/_integrations/qbittorrent.markdown
View File

@ -9,6 +9,7 @@ ha_iot_class: Local Polling
ha_domain: qbittorrent
ha_codeowners:
- '@geoffreylagaisse'
- '@finder39'
ha_platforms:
- sensor
ha_integration_type: service
@ -27,5 +28,32 @@ This sensor requires the qBittorrent Web UI enabled. The [official reference](ht
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.
- `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](/docs/scripts/service-calls#use-templates-to-handle-response-data)
with a dictionary of torrents based on the provided filter.
| Service data attribute | Optional | Description | Example |
| ---------------------- | -------- | ----------- | --------|
| `filter` | no | The type of torrents you want in the response | all, active, inactive, paused, downloading, seeding
</div>
```yaml
service: qbittorrent.get_torrents
data:
filter: 'all'
response_variable: torrents
```
The response data contains the field `torrent_info` which contains a dictionary of torrents. The name of the torrents are the keys.