You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/_components/sensor.transmission.markdown
+25-58Lines changed: 25 additions & 58 deletions
Original file line number
Diff line number
Diff line change
@@ -16,22 +16,6 @@ ha_iot_class: "Local Polling"
16
16
17
17
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.
18
18
19
-
## {% linkable_title Setup %}
20
-
21
-
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 enable this sensor, add the following lines to your `configuration.yaml`:
36
20
37
21
```yaml
@@ -44,48 +28,31 @@ sensor:
44
28
- 'download_speed'
45
29
- 'upload_speed'
46
30
- 'active_torrents'
47
-
- 'paused_torrents'
48
-
- 'total_torrents'
49
31
```
50
32
51
-
{% configuration %}
52
-
host:
53
-
description: This is the IP address of your Transmission daemon, e.g., 192.168.1.32.
54
-
required: true
55
-
type: string
56
-
port:
57
-
description: The port your Transmission daemon uses.
58
-
required: false
59
-
type: int
60
-
default: 9091
61
-
name:
62
-
description: The name to use when displaying this Transmission instance in the frontend.
63
-
required: false
64
-
type: string
65
-
username:
66
-
description: Your Transmission username, if you use authentication.
67
-
required: false
68
-
type: string
69
-
password:
70
-
description: Your Transmission password, if you use authentication.
71
-
required: false
72
-
type: string
73
-
monitored_variables:
74
-
description: Conditions to display in the frontend.
75
-
required: false
76
-
type: map
77
-
keys:
78
-
current_status:
79
-
description: The status of your Transmission daemon.
80
-
download_speed:
81
-
description: The current download speed.
82
-
upload_speed:
83
-
description: The current upload speed.
84
-
active_torrents:
85
-
description: The current number of active torrents.
86
-
paused_torrents:
87
-
description: The current number of paused torrents.
88
-
total_torrents:
89
-
description: The total number of torrents present in the client.
90
-
{% endconfiguration %}
33
+
Configuration variables:
34
+
35
+
- **host** (*Required*): This is the IP address of your Transmission daemon, eg. 192.168.1.32.
36
+
- **port** (*Optional*): The port your Transmission daemon uses, defaults to 9091.
37
+
- **name** (*Optional*): The name to use when displaying this Transmission instance.
38
+
- **username** (*Optional*): Your Transmission username, if you use authentication.
39
+
- **password** (*Optional*): Your Transmission password, if you use authentication.
40
+
- **monitored_variables** array (*Required*): Conditions to display in the frontend.
41
+
- **current_status**: The status of your Transmission daemon.
42
+
- **download_speed**: The current download speed.
43
+
- **upload_speed**: The current upload speed.
44
+
- **active_torrents**: The current number of active torrents.
45
+
46
+
47
+
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.
0 commit comments