diff --git a/README.md b/README.md new file mode 100644 index 0000000..20c573e --- /dev/null +++ b/README.md @@ -0,0 +1,138 @@ +# TV Remote Card +📺 [Roku Lovelace Card](https://github.com/custom-cards/roku-card) editited by mar_robHD + +[![GitHub Release][releases-shield]][releases] +[![License][license-shield]](LICENSE.md) + +![Project Maintenance][maintenance-shield] +[![GitHub Activity][commits-shield]][commits] +[![hacs_badge](https://img.shields.io/badge/HACS-Custom-orange.svg?style=for-the-badge)](https://github.com/custom-components/hacs) +[![Discord][discord-shield]][discord] +[![Community Forum][forum-shield]][forum] + +[![Twitter][twitter]][twitter] +[![Github][github]][github] + +## Support + +This card is for [Lovelace](https://www.home-assistant.io/lovelace) on [Home Assistant](https://www.home-assistant.io/) that display a [TV]() remote. + +# NOTE: Firefox releases before 67 are not supported +https://twitter.com/_developit/status/1090364879377260544 + +![ex](https://i.imgur.com/fUKI5Xm.png) + +## Options + +| Name | Type | Requirement | Description +| ---- | ---- | ------- | ----------- +| type | string | **Required** | `custom:tv-card` +| entity | string | **Required** | `media_player` entity of Roku device +| remote | string | **Optional** | `remote` entity of Roku device. Default assume named like `entity` +| name | string | **Optional** | Card name +| theme | string | **Optional** | Card theme +| tv | boolean | **Optional** | If `true` shows volume and power buttons. Default `false` +| power | `service` | **Optional**| service to call when power button pressed +| volume_up | `service` | **Optional**| service to call when volume_up button pressed +| volume_down | `service` | **Optional**| service to call when volume_down button pressed +| back | `service` | **Optional**| service to call when back button pressed +| info | `service` | **Optional**| service to call when info button pressed +| home | `service` | **Optional**| service to call when home button pressed +| up | `service` | **Optional**| service to call when up button pressed +| left | `service` | **Optional**| service to call when left button pressed +| select | `service` | **Optional**| service to call when select button pressed +| right | `service` | **Optional**| service to call when right button pressed +| down | `service` | **Optional**| service to call when down button pressed +| reverse | `service` | **Optional**| service to call when reverse button pressed +| play | `service` | **Optional**| service to call when play button pressed +| forward | `service` | **Optional**| service to call when forward button pressed +| source | `service` | **Optional**| service to call when source button pressed +| channelup | `service` | **Optional**| service to call when channelup button pressed +| channeldown | `service` | **Optional**| service to call when channeldown button pressed +| volume_up | `service` | **Optional**| service to call when volume up button pressed +| volume_down | `service` | **Optional**| service to call when volume down button pressed +| volume_mute | `service` | **Optional**| service to call when volume mute button pressed + +## `service` Options +| Name | Type | Requirement | Description +| ---- | ---- | ------- | ----------- +| service | string | **Required** | Service to call +| service_data | string | **Optional** | Service data to use + + +## Installation + +### HACS: + +1. + +Add this to your `HACS settings tab`: + +``` +https://github.com/marrobHD/tv-card +``` +![example](https://i.imgur.com/2urg4m2.png) + +### Step 1 + +Install `tv-card` by copying `tv-card.js` and `tv-card-editor.js` from this repo to `/www/tv-card.js` on your Home Assistant instance. + +**Example:** + +```bash +wget https://raw.githubusercontent.com/marrobHD/tv-card/master/tv-card.js +wget https://raw.githubusercontent.com/marrobHD/tv-card/master/tv-card-editor.js +mv tv-card* /config/www/ +``` + +### Step 2 + +Link `tv-card` inside your `ui-lovelace.yaml`. + +```yaml +resources: + - url: /local/tv-card.js?v=1 + type: module +``` + +### Step 3 + +Add a custom element in your `ui-lovelace.yaml` + +```yaml + - type: custom:tv-card + entity: media_player.bedroom_tv + name: Bedroom TV + theme: darkpurple + tv: true + power: + service: switch.turn_on + service_data: + entity_id: switch.bedroom_tv_power +``` + +**Custom Updater:** + +Add this to your `configuration.yaml` + +``` +custom_updater: + card_urls: + - https://raw.githubusercontent.com/marrobHD/tv-card/master/tracker.json +``` + + +[Troubleshooting](https://github.com/thomasloven/hass-config/wiki/Lovelace-Plugins) + +[commits-shield]: https://img.shields.io/github/commit-activity/y/marrobHD/tv-card.svg?style=for-the-badge +[commits]: https://github.com/marrobHD/tv-card/commits/master +[discord]: https://discord.gg/ND4emRS +[discord-shield]: https://img.shields.io/discord/579704220970909717.svg?style=for-the-badge +[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg?style=for-the-badge +[forum]: https://community.home-assistant.io/t/lovelace-tv-remote-card/91476 +[license-shield]: https://img.shields.io/github/license/marrobHD/tv-card.svg?style=for-the-badge +[maintenance-shield]: https://img.shields.io/badge/maintainer-marrobHD-blue.svg?style=for-the-badge +[releases-shield]: https://img.shields.io/github/release/marrobHD/tv-card.svg?style=for-the-badge +[releases]: https://github.com/marrobHD/tv-card/releases +[twitter]: https://img.shields.io/twitter/follow/mar_robHD.svg?style=social +[github]: https://img.shields.io/github/followers/marrobHD.svg?style=social diff --git a/example.png b/example.png new file mode 100644 index 0000000..2502d46 Binary files /dev/null and b/example.png differ diff --git a/example2.png b/example2.png new file mode 100644 index 0000000..e2d59f6 Binary files /dev/null and b/example2.png differ