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-18 23:06:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update qBittorrent documentation - add get_torrents and get_all_torrents services (#32384)

Browse Source 
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
Joe Neuman 2024-04-22 00:30:38 -07:00 committed by GitHub
parent 50da23b28f
commit ecb4316e81
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 41 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
source/_integrations/qbittorrent.markdown
View File

@ -8,8 +8,8 @@ ha_config_flow: true
ha_iot_class: Local Polling
ha_domain: qbittorrent
ha_codeowners:
- '@geoffreylagaisse'
- '@finder39'
- "@geoffreylagaisse"
- "@finder39"
ha_platforms:
- sensor
ha_integration_type: service
@ -34,3 +34,42 @@ The qBittorrent integration will add the following sensors:
- `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 |
| ---------------------- | -------- | ---------------------------------------------- | --------------------------------------------------- |
| `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 |
```yaml
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](/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 |
| ---------------------- | -------- | --------------------------------------------- | --------------------------------------------------- |
| `torrent_filter` | no | The type of torrents you want in the response | all, active, inactive, paused, downloading, seeding |
```yaml
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.