Transmission


The transmission integration allows you to monitor your downloads with Transmission from within Home Assistant and setup automation based on the information.

Setup

To use the monitoring, your transmission client needs to allow remote access. If you are running the graphical transmission client (transmission-gtk) go to Edit -> Preferences and choose the tab Remote. Check Allow remote access, enter your username and your password, and uncheck the network restriction as needed.

If everything is set up correctly, the details will show up in the frontend.

Configuration

Set up the integration through Configuration -> Integrations -> Transmission. For legacy support old transmission configuration is imported and set up as new integration. Make sure to remove monitored_condiditions as they are now automatically added to Home Assistant

To enable this sensor, add the following lines to your configuration.yaml:

transmission:
  host: 192.168.1.1

Configuration Variables

host

(string)(Required)

This is the IP address of your Transmission daemon, e.g., 192.168.1.1.

port

(integer)(Optional)

The port your Transmission daemon uses.

Default value:

9091

name

(string)(Optional)

The name to use when displaying this Transmission instance in the frontend.

username

(string)(Optional)

Your Transmission username, if you use authentication.

password

(string)(Optional)

Your Transmission password, if you use authentication.

scan_interval

(integer)(Optional)

How frequently to query for new data. Defaults to 120 seconds.

Integration Entities

The Transmission Integration will add the following sensors and switches.

Sensors:

  • current_status: The status of your Transmission daemon.
  • download_speed: The current download speed [MB/s].
  • upload_speed: The current upload speed [MB/s].
  • active_torrents: The current number of active torrents.
  • paused_torrents: The current number of paused torrents.
  • total_torrents: The total number of torrents present in the client.
  • started_torrents: The current number of started torrents (downloading).
  • completed_torrents: The current number of completed torrents (seeding)

Switches:

  • on_off: A switch to start/stop all torrents
  • turtle_mode: A switch to enable turtle mode.

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.

Possible events are:

  • transmission_downloaded_torrent
  • transmission_started_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.

Example of configuration of an automation with completed torrents:

- alias: Completed Torrent
  trigger:
    platform: event
    event_type: transmission_downloaded_torrent
  action:
    service: notify.telegram_notifier
    data_template:
      title: "Torrent completed!"
      message: "{{trigger.event.data.name}}"

Services

Service add_torrent

Adds a new torrent to download. It can either be a URL (http, https or ftp), magnet link or a local file (make sure that the path is white listed).

Service data attribute Optional Description
torrent no Torrent to download