Transmission config flow (#10293)

* Transmission config flow

Configure Transmission using config flow.

* ✏️ Tweak

* Update transmission.markdown

Removed monitored conditions and updated list of entities added by the integration
This commit is contained in:
Rami Mosleh 2019-10-01 13:08:12 +03:00 committed by Franck Nijhof
parent 3c40e6beba
commit ef8a5744b0

View File

@ -31,6 +31,8 @@ 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`:
```yaml
@ -60,39 +62,31 @@ password:
description: Your Transmission password, if you use authentication.
required: false
type: string
turtle_mode:
description: If enabled, it creates a switch entity to control the 'Alternative Speed Limits' (aka 'Turtle mode') setting.
required: false
type: boolean
default: false
scan_interval:
description: How frequently to query for new data. Defaults to 120 seconds.
required: false
type: integer
monitored_conditions:
type: integer
description: "List of monitored conditions. Possible values are:"
required: false
type: list
keys:
current_status:
description: The status of your Transmission daemon.
download_speed:
description: The current download speed [MB/s].
upload_speed:
description: The current upload speed [MB/s].
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.
started_torrents:
description: The current number of started torrents (downloading).
completed_torrents:
description: The current number of completed torrents (seeding)
{% endconfiguration %}
## 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.