diff --git a/source/_components/sensor.transmission.markdown b/source/_components/sensor.transmission.markdown index e76da08026e0..2fbbef26e8cf 100644 --- a/source/_components/sensor.transmission.markdown +++ b/source/_components/sensor.transmission.markdown @@ -16,6 +16,22 @@ ha_iot_class: "Local Polling" The `transmission` platform allows you to monitor your downloads with [Transmission](http://www.transmissionbt.com/) from within Home Assistant and setup automation based on the information. +## {% linkable_title 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 setup correctly, the details will show up in the frontend. + +

+ +

+ +## {% linkable_title Configuration %} + To enable this sensor, add the following lines to your `configuration.yaml`: ```yaml @@ -28,31 +44,48 @@ sensor: - 'download_speed' - 'upload_speed' - 'active_torrents' + - 'paused_torrents' + - 'total_torrents' ``` -Configuration variables: - -- **host** (*Required*): This is the IP address of your Transmission daemon, eg. 192.168.1.32. -- **port** (*Optional*): The port your Transmission daemon uses, defaults to 9091. -- **name** (*Optional*): The name to use when displaying this Transmission instance. -- **username** (*Optional*): Your Transmission username, if you use authentication. -- **password** (*Optional*): Your Transmission password, if you use authentication. -- **monitored_variables** array (*Required*): Conditions to display in the frontend. - - **current_status**: The status of your Transmission daemon. - - **download_speed**: The current download speed. - - **upload_speed**: The current upload speed. - - **active_torrents**: The current number of active torrents. - - -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 setup correctly, the details will show up in the frontend. - -

- -

+{% configuration %} +host: + description: This is the IP address of your Transmission daemon, e.g., 192.168.1.32. + required: true + type: string +port: + description: The port your Transmission daemon uses. + required: false + type: int + default: 9091 +name: + description: The name to use when displaying this Transmission instance in the frontend. + required: false + type: string +username: + description: Your Transmission username, if you use authentication. + required: false + type: string +password: + description: Your Transmission password, if you use authentication. + required: false + type: string +monitored_variables: + description: Conditions to display in the frontend. + required: false + type: map + keys: + current_status: + description: The status of your Transmission daemon. + download_speed: + description: The current download speed. + upload_speed: + description: The current upload speed. + active_torrents: + description: The current number of active torrents. + paused_torrents: + description: The current number of paused torrents. + total_torrents: + description: The total number of torrents present in the client. +{% endconfiguration %}