mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-18 23:06:58 +00:00
Update Transmission docs with event ID info (#15905)
This commit is contained in:
parent
d7a7f01aaf
commit
23b8bb4a08
@ -18,7 +18,7 @@ The Transmission integration allows you to monitor your [Transmission](https://w
|
||||
|
||||
## Setup
|
||||
|
||||
Your Transmission client must first be configured to allow remote access. In your Transmission client navigate to **Preferences** -> **Remote** tab and then click the **Allow remote access** checkbox.
|
||||
Your Transmission client must first be configured to allow remote access. In your Transmission client navigate to **Preferences** -> **Remote** tab and then click the **Allow remote access** checkbox.
|
||||
|
||||
## Configuration
|
||||
|
||||
@ -79,7 +79,7 @@ The Transmission integration will add the following sensors and switches.
|
||||
|
||||
## Event Automation
|
||||
|
||||
The Transmission integration is continuously monitoring the status of torrents in the target client. Once a torrent is started or completed, an event is triggered on the Home Assistant Bus, which allows to implement any kind of automation.
|
||||
The Transmission integration is continuously monitoring the status of torrents in the target client. Once a torrent is started or completed, an event is triggered on the Home Assistant Bus containing the torrent name and ID, which can be used with automations.
|
||||
|
||||
Possible events are:
|
||||
|
||||
@ -89,20 +89,24 @@ Possible events are:
|
||||
|
||||
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.
|
||||
|
||||
Example of configuration of an automation with completed torrents:
|
||||
Example of an automation that notifies on successful download and removes the torrent from the client:
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
- alias: Completed Torrent
|
||||
- alias: Notify and remove completed torrent
|
||||
trigger:
|
||||
platform: event
|
||||
event_type: transmission_downloaded_torrent
|
||||
action:
|
||||
service: notify.telegram_notifier
|
||||
data:
|
||||
title: "Torrent completed!"
|
||||
message: "{{trigger.event.data.name}}"
|
||||
- service: notify.telegram_notifier
|
||||
data:
|
||||
title: "Torrent completed!"
|
||||
message: "{{trigger.event.data.name}}"
|
||||
- service: transmission.remove_torrent
|
||||
data:
|
||||
name: "Transmission"
|
||||
id: "{{trigger.event.data.id}}"
|
||||
```
|
||||
|
||||
{% endraw %}
|
||||
|
Loading…
x
Reference in New Issue
Block a user