Skip to content

Improve docs for the transmission integration #13053

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
frenck merged 2 commits into from
Apr 20, 2020
Merged

Improve docs for the transmission integration #13053

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fab9643
Fix wording, add transmission.remove_torrent service description
zhulik Apr 18, 2020
9f284b9
Add transmission_removed_torrent event
zhulik Apr 18, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 16 additions & 5 deletions source/_integrations/transmission.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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] %}

Expand Down