mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-21 00:06:51 +00:00
Update documentation
This commit is contained in:
parent
b2c5eb78a6
commit
bd24282855
@ -16,33 +16,7 @@ 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.
|
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.
|
||||||
|
|
||||||
To enable this sensor, add the following lines to your `configuration.yaml`:
|
## {% linkable_title Setup %}
|
||||||
|
|
||||||
```yaml
|
|
||||||
# Example configuration.yaml entry
|
|
||||||
sensor:
|
|
||||||
- platform: transmission
|
|
||||||
host: IP_ADDRESS
|
|
||||||
monitored_variables:
|
|
||||||
- 'current_status'
|
|
||||||
- 'download_speed'
|
|
||||||
- 'upload_speed'
|
|
||||||
- 'active_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.
|
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.
|
||||||
|
|
||||||
@ -56,3 +30,62 @@ If everything is setup correctly, the details will show up in the frontend.
|
|||||||
<img src='{{site_root}}/images/components/transmission/transmission.png' />
|
<img src='{{site_root}}/images/components/transmission/transmission.png' />
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
|
To enable this sensor, add the following lines to your `configuration.yaml`:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# Example configuration.yaml entry
|
||||||
|
sensor:
|
||||||
|
- platform: transmission
|
||||||
|
host: IP_ADDRESS
|
||||||
|
monitored_variables:
|
||||||
|
- 'current_status'
|
||||||
|
- 'download_speed'
|
||||||
|
- 'upload_speed'
|
||||||
|
- 'active_torrents'
|
||||||
|
- 'paused_torrents'
|
||||||
|
- 'total_torrents'
|
||||||
|
```
|
||||||
|
|
||||||
|
{% 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 %}
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user