jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-09 18:36:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update transmission.markdown (#14907)

Browse Source
This commit is contained in:
Sean Mooney 2020-10-06 06:38:00 -04:00 committed by GitHub
parent c879b70a20
commit 5678e95ad2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
source/_integrations/transmission.markdown
View File

@ -14,27 +14,17 @@ ha_codeowners:
ha_domain: transmission
---
The `transmission` integration allows you to monitor your downloads with [Transmission](https://www.transmissionbt.com/) from within Home Assistant and setup automation based on the information.
The Transmission integration allows you to monitor your [Transmission](https://www.transmissionbt.com/) BitTorrent downloads from within Home Assistant and set up automations based on that 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.
<p class='img'>
<img src='/images/integrations/transmission/transmission_perf.png' />
</p>
If everything is set up correctly, the details will show up in the frontend.
<p class='img'>
<img src='/images/integrations/transmission/transmission.png' />
</p>
Your Transmission client must first be configured to allow remote access. In your Transmission client navigate to **Preferences** -> **Remote** tab and then click the **Allow remote access** checkbox.
## 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
In Home Assistant, navigate to **Configuration** -> **Integrations** and click the plus button to add a new integration and search for **Transmission**. For legacy support old Transmission configuration is imported and set up as a new integration. Make sure to remove `monitored_conditions` as they are now automatically added to Home Assistant.
To enable this sensor, add the following lines to your `configuration.yaml`:
Alternatively, the integration can be set up via YAML by adding the following lines to your `configuration.yaml`:
```yaml
transmission:
@ -71,21 +61,21 @@ scan_interval:
## Integration Entities
The Transmission Integration will add the following sensors and switches.
The Transmission integration will add the following sensors and switches.
Sensors:
- transmission_current_status: The status of your Transmission daemon.
- transmission_download_speed: The current download speed [MB/s].
- transmission_upload_speed: The current upload speed [MB/s].
- transmission_active_torrents: The current number of active torrents.
- transmission_paused_torrents: The current number of paused torrents.
- transmission_total_torrents: The total number of torrents present in the client.
- transmission_started_torrents: The current number of started torrents (downloading).
- transmission_completed_torrents: The current number of completed torrents (seeding)
**Sensors**:
- `sensor.transmission_current_status`: The status of your Transmission daemon.
- `sensor.transmission_download_speed`: The current download speed [MB/s].
- `sensor.transmission_upload_speed`: The current upload speed [MB/s].
- `sensor.transmission_active_torrents`: The current number of active torrents.
- `sensor.transmission_paused_torrents`: The current number of paused torrents.
- `sensor.transmission_total_torrents`: The total number of torrents present in the client.
- `sensor.transmission_started_torrents`: The current number of started torrents (downloading).
- `sensor.transmission_completed_torrents`: The current number of completed torrents (seeding).
Switches:
- transmission_switch: A switch to start/stop all torrents
- transmission_turtle_mode: A switch to enable turtle mode.
**Switches**:
- `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).
## Event Automation
@ -94,9 +84,9 @@ The Transmission integration is continuously monitoring the status of torrents i
Possible events are:
- transmission_downloaded_torrent
- transmission_started_torrent
- transmission_removed_torrent
- `transmission_downloaded_torrent`
- `transmission_started_torrent`
- `transmission_removed_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.
@ -142,7 +132,7 @@ Removes a torrent from the client.
### Attribute `torrent_info`
All `*_torrents` sensors e.g. `sensor.transmission_total_torrents` or `sensor.transmission_started_torrents` have a state attribute `torrent_info` that contains information about the torrents that are currently in a corresponding state. You can see this information in **Developer Tools** -> **States** -> `sensor.transmission_total_torrents` -> **Attributes**, or by adding a Markdown Card to Lovelace.
All `*_torrents` sensors e.g. `sensor.transmission_total_torrents` or `sensor.transmission_started_torrents` have a state attribute `torrent_info` that contains information about the torrents that are currently in a corresponding state. You can see this information in **Developer Tools** -> **States** -> `sensor.transmission_total_torrents` -> **Attributes**, or by adding a [Markdown card](/lovelace/markdown/) to Lovelace with the following code:
{% raw %}
```yaml