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-15 21:36:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve docs for the transmission integration (#13053)

Browse Source 
* Fix wording, add transmission.remove_torrent service description

* Add transmission_removed_torrent event
This commit is contained in:
Gleb Sinyavskiy 2020-04-20 15:08:17 +02:00 committed by GitHub
parent 1646913c1c
commit 24eaf54d63
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
source/_integrations/transmission.markdown
View File

@ -43,7 +43,7 @@ transmission:
{% configuration %}
host:
description: "This is the IP address of your Transmission daemon, e.g., `192.168.1.1`."
description: "This is the IP address of your Transmission daemon, e.g., `192.168.1.1` or `https://example.com/transmission/rpc`."
required: true
type: string
port:
@ -96,6 +96,7 @@ Possible events are:
- transmission_downloaded_torrent
- transmission_started_torrent
- transmission_removed_torrent
Inside of the event, there is the name of the torrent that is started or completed, as it is seen in the Transmission User Interface.
@ -123,20 +124,30 @@ Adds a new torrent to download. It can either be a URL (HTTP, HTTPS or FTP), mag
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `name` | no | Name of the configured instance
| `name` | yes | Name of the configured instance (Default: "Transmission")
| `torrent` | no | Torrent to download
### Service `remove_torrent`
Removes a torrent from the client.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `name` | no | Name of the configured instance (Default: "Transmission")
| `id` | no | ID of the torrent, can be found in the `torrent_info` attribute of the `*_torrents` sensors
| `delete_data` | yes | Delete torrent data (Default: false)
## Templating
### Sensor `started_torrents`
### Attribute `torrent_info`
The state attribute `torrent_info` contains information about the torrents that are currently downloading. You can see this information in **Developer Tools** -> **States** -> `sensor.transmission_started_torrents` -> **Attributes**, or by adding a Markdown Card to Lovelace.
All `*_torrents` sensors e.g. `sensor.transmission_total_torrents` or `sensor.transmission_started_torrents` have a state attribute `torrent_info` that contains information about the torrents that are currently in a corresponding state. You can see this information in **Developer Tools** -> **States** -> `sensor.transmission_total_torrents` -> **Attributes**, or by adding a Markdown Card to Lovelace.
{% raw %}
```yaml
content: >
{% set payload = state_attr('sensor.transmission_started_torrents', 'torrent_info') %}
{% set payload = state_attr('sensor.transmission_total_torrents', 'torrent_info') %}
{% for torrent in payload.items() %} {% set name = torrent[0] %} {% set data = torrent[1] %}