📺 Roku Remote Card

Support

Hey dude! Help me out for a couple of 🍻 or a ☕!

This card is for Lovelace on Home Assistant that display a Roku remote.

Installation

Version 1.1.0 and above require Home Assistant 0.110.0 or above

Use HACS or follow this guide

resources:
  url: /local/roku-card.js
  type: module

Options

Name	Type	Requirement	Description
type	`string`	Required	`custom:roku-card`
entity	`string`	Required	`media_player` entity of Roku device
remote	`string`	Optional	`remote` entity of Roku device. Default assumed 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	`map`	Optional	Button configuration for power See button options
volume_up	`map`	Optional	Button configuration for volume_up See button options
volume_down	`map`	Optional	Button configuration for volume_down See button options
volume_mute	`map`	Optional	Button configuration for volume_mute See button options
up	`map`	Optional	Button configuration for up See button options
down	`map`	Optional	Button configuration for down See button options
left	`map`	Optional	Button configuration for left See button options
right	`map`	Optional	Button configuration for right See button options
home	`map`	Optional	Button configuration for home See button options
info	`map`	Optional	Button configuration for info See button options
back	`map`	Optional	Button configuration for back See button options
select	`map`	Optional	Button configuration for select See button options
reverse	`map`	Optional	Button configuration for reverse See button options
play	`map`	Optional	Button configuration for play See button options
forward	`map`	Optional	Button configuration for forward See button options
apps	`map`	Optional	List of app shortcuts See app options
haptic	`string`	Optional	`none`, `success`, `warning`, `failure`, `light`, `medium`, `heavy`, `selection`. Default is `success`

app Options

Name	Type	Requirement	Description
app	`string`	Optional	Name of the source to launch as `tap_action`
image	`string`	Optional	Path to image to use for app
icon	`string`	Optional	mdi icon to use instead of an image for app
tap_action	`map`	Optional	Tap action map See action options
hold_action	`map`	Optional	Hold action map See action options
double_tap_action	`map`	Optional	Doulbe Tap action map See action options

button Options

Name	Type	Requirement	Description
show	`boolean`	Optional	Show/Hide button `true`
tap_action	`map`	Optional	Tap action map See action options
hold_action	`map`	Optional	Hold action map See action options
double_tap_action	`map`	Optional	Doulbe Tap action map See action options

action Options

Name	Type	Default	Supported options	Description
`action`	`string`	`toggle`	`more-info`, `toggle`, `call-service`, `none`, `navigate`, `url`	Action to perform
`entity`	`string`	none	Any entity id	Only valid for `action: more-info` to override the entity on which you want to call `more-info`
`navigation_path`	`string`	none	Eg: `/lovelace/0/`	Path to navigate to (e.g. `/lovelace/0/`) when action defined as navigate
`url_path`	`string`	none	Eg: `https://www.google.com`	URL to open on click when action is `url`.
`service`	`string`	none	Any service	Service to call (e.g. `media_player.media_play_pause`) when `action` defined as `call-service`
`service_data`	`map`	none	Any service data	Service data to include (e.g. `entity_id: media_player.bedroom`) when `action` defined as `call-service`.
`haptic`	`string`	none	`success`, `warning`, `failure`, `light`, `medium`, `heavy`, `selection`	Haptic feedback for the Beta IOS App
`repeat`	`number`	none	eg: `500`	How often to repeat the `hold_action` in milliseconds.

Usage

type: 'custom:roku-card'
entity: media_player.basement_roku
tv: true
apps:
  - image: /local/netflix.webp
    app: Netflix
  - image: /local/hulu.webp
    app: Hulu
    hold_action:
      action: call-service
      service: media_player.select_source
      service_data:
        source: ESPN
        entity_id: media_player.basement_roku
volume_up:
  tap_action:
    action: call-service
    service: remote.send_command
    service_data:
      entity_id: remote.basement_roku
      command: play
volume_down:
  double_tap_action:
    action: call-service
    service: remote.send_command
    service_data:
      entity_id: remote.basement_roku
      command: play

Troubleshooting

Developers

Fork and clone the repository.
Open the devcontainer and run npm start when it's ready.
The compiled .js file will be accessible on http://127.0.0.1:5000/roku-card.js.
On a running Home Assistant installation add this to your Lovelace resources:

- url: 'http://127.0.0.1:5000/roku-card.js'
  type: module

Change "127.0.0.1" to the IP of your development machine.

Bonus

If you need a fresh test instance you can install a fresh Home Assistant instance inside the devcontainer as well.

Run the command dc start.
Home Assistant will install and will eventually be running on port 9123

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

iantrich / roku-card

Programming Languages

Labels

Projects that are alternatives of or similar to roku-card