https://github.com/amaximus/transmission-card
Custom Transmission card for Home Assistant/Lovelace
https://github.com/amaximus/transmission-card
home-assistant homeassistant lovelace lovelace-card lovelace-custom-card transmission
Last synced: 4 months ago
JSON representation
Custom Transmission card for Home Assistant/Lovelace
- Host: GitHub
- URL: https://github.com/amaximus/transmission-card
- Owner: amaximus
- License: mit
- Created: 2020-11-22T13:30:32.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-12-23T12:08:54.000Z (almost 2 years ago)
- Last Synced: 2023-12-23T13:23:00.459Z (almost 2 years ago)
- Topics: home-assistant, homeassistant, lovelace, lovelace-card, lovelace-custom-card, transmission
- Language: JavaScript
- Homepage:
- Size: 669 KB
- Stars: 32
- Watchers: 2
- Forks: 12
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/hacs/integration)
# Custom Transmission card for HomeAssistant/Lovelace
This Lovelace custom card displays torrents information provided by the Transmission Integration.
It also supports turtle mode and start/stop of all torrents.
You can cycle through the different torrent types by clicking on the type label.
### Installation
The easiest way to install it is through [HACS (Home Assistant Community Store)](https://github.com/hacs/frontend),
search for *Transmission* in the Frontend section and select Transmission Card.
If you are not using HACS, you may download transmission-card.js and put it into
homeassistant_config_dir/www/community/transmission-card/ directory.
### Lovelace UI configuration
Please add the card to the resources in configuration.yaml:
```
resources:
- {type: js, url: '/hacsfiles/transmission-card/transmission-card.js'}
```
### Options
#### Card options
| Name | Type | Required | Default | Description |
| -------------------------| ------------ | ------------ | ----------------------- | ------------------------------------ |
| type | string | **required** | | `custom:transmission-card` |
| no_torrent_label | string | optional | `No Torrents` | label displayed with no torrents, to hide set "" |
| hide_turtle | boolean | optional | false | hide turtle button |
| hide_startstop | boolean | optional | false | hide start/stop button |
| hide_type | boolean | optional | true | hide type selector |
| default_type | string | optional | `total` | type of torrents to display at start |
| display_mode | string | optional | `compact` | display mode: compact or full |
| sensor_name | string | optional | `transmission` | DEPRECATED. Name of the sensor. Use sensor_entity_id instead. It will be removed in a later release. |
| sensor_entity_id | string | optional | `transmission` | name of the sensor. Useful when using different entity name either deliberately or by e.g. HA generating localized entity name/id |
| hide_header | boolean | optional | false | hide header text at the top of card |
| header_text | string | optional | `Transmission` | header text at the top of card |
| force_status_newline | boolean | optional | false | display the status on a separate line to avoid flickering due to different text lengths |
| hide_status | boolean | optional | false | hide status label |
| hide_download_speed | boolean | optional | false | hide download speed |
| hide_upload_speed | boolean | optional | false | hide upload speed |
| hide_add_torrent | boolean | optional | false | hide add torrent input |
| hide_delete_torrent | boolean | optional | false | hide delete torrent button |
| hide_delete_torrent_full | boolean | optional | false | hide delete torrent with data button |
| hide_torrent_list | boolean | optional | false | hide torrent list |
| default_sort | string | optional | `name` | sort type to display torrents at start |
| hide_sort | boolean | optional | true | hide sort selector |
| default_order | string | optional | `ascending` | sort order to display torrents at start |
| hide_order | boolean | optional | true | hide sort selector |
| default_limit | string | optional | `all` | limit number of torrents to display at start |
| hide_limit | boolean | optional | true | hide limit selector |
| hide_ratio | boolean | optional | false | hide torrent ratio |
Accepted values for default_type are: `total`, `active`,`completed`,`paused`,`started`.
Accepted values for default_sort are: `name`, `added_date`,`id`,`status`.
Accepted values for default_limit are: `all`, `5`,`10`,`15`.
Accepted values for default_order are: `ascending`, `descending`.
The card doesn't support entity translation, therefore the card accepts sensors to be sensor._started_torrents, sensor._total_torrents, etc. . Sensors whose names were auto-translated to non-English languages need to be renamed to English version.
Please find below an example of ui-lovelace.yaml card entry:
```yaml
cards:
- type: custom:transmission-card
hide_type: false
default_type: 'active'
```
Transmission idle in compact mode:
Transmission downloading in full mode:
## Thanks
Thanks to all the people who have contributed!
[](https://github.com/amaximus/transmission-card/graphs/contributors)