Update transmission.markdown (#15815)

Add documentation about start_torrent and stop torrent_services
This commit is contained in:
Julien Roy 2021-01-13 17:47:10 +01:00 committed by GitHub
parent f08a5ef3d4
commit d165a4b6ac
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -77,7 +77,6 @@ The Transmission integration will add the following sensors and switches.
- `switch.transmission_switch`: A switch to start/stop all torrents. - `switch.transmission_switch`: A switch to start/stop all torrents.
- `switch.transmission_turtle_mode`: A switch to enable turtle mode (a.k.a. alternative speed limits). - `switch.transmission_turtle_mode`: A switch to enable turtle mode (a.k.a. alternative speed limits).
## Event Automation ## 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, which allows to implement any kind of automation.
@ -129,6 +128,23 @@ Removes a torrent from the client.
| `id` | no | ID of the torrent, can be found in the `torrent_info` attribute of the `*_torrents` sensors | `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) | `delete_data` | yes | Delete torrent data (Default: false)
### Service `start_torrent`
Starts a torrent.
| 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
### Service `stop_torrent`
Stops a torrent.
| 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
## Templating ## Templating