Roku

The Roku integration allows you to control a Roku device.

Configuration

To add the Roku device to your Home Assistant instance, use this My button:

Roku can be auto-discovered by Home Assistant. If an instance was found, it will be shown as Discovered. You can then set it up right away.

When adding the integration, you will be asked to provide a hostA device that participates in your network. If asked for the host, enter either the device’s IP address or host name. If you don’t know those, check the list of hosts in your router. [Learn more]. Unless you changed the hostname, this refers to the IP address of your Roku device. You can find the IP address or hostname in the network settings of your Roku device, by checking your router, or by using a network scanning tool.

If you are having issues connecting, you may have to adjust the settings on your Roku device to allow local control. The common setting is: Settings / System / Advanced / Control by mobile apps / Network access

There is currently support for the following device types within Home Assistant:

• Media player
• Remote

Remote

The roku remote platform allows you to send remote control buttons to a Roku device. It is automatically set up when a Roku is configured.

At the moment, the following buttons are supported:

• back
• backspace
• channel_down
• channel_up
• down
• enter
• find_remote
• forward
• home
• info
• input_av1
• input_hdmi1
• input_hdmi2
• input_hdmi3
• input_hdmi4
• input_tuner
• left
• literal
• play
• power
• replay
• reverse
• right
• search
• select
• up
• volume_down
• volume_mute
• volume_up

A typical action for pressing several buttons looks like this.

action: remote.send_command
target:
  entity_id: remote.roku
data:
  command:
    - left
    - left
    - select

Media player

When the Home Assistant Roku integration is enabled and a Roku device has been configured, in the Home Assistant UI the Roku media player will show a listing of the installed channels, or apps, under “source”. Select one and it will attempt to launch the channel on your Roku device.

Options

Options for Roku can be set via the user interface, by taking the following steps:

• Browse to your Home Assistant instance.
• Go to Settings > Devices & Services.
• If multiple instances of Roku are configured, choose the instance you want to configure.
• Select the integration, then select Configure.

Source Automation

The media_player.select_source action may be used to launch specific applications/streaming channels on your Roku device.

Examples

actions:
- action: media_player.select_source
  target:
    entity_id: media_player.roku
  data:
    source: "Prime Video"

Alternatively, the application id can be used for source. See Obtaining Application IDs.

actions:
  - action: media_player.select_source
    target:
      entity_id: media_player.roku
    data:
      source: 20197

Obtaining Application IDs

The currently active application ID can be found in the Active App ID diagnostic sensor.

Alternatively, you can make a manual HTTP request (GET) to http://ROKU_IP:8060/query/apps, in either your browser or terminal, to retrieve a complete list of installed applications in XML format.

TV Channel Tuning

The media_player.play_media action may be used to tune to specific channels on your Roku TV device with OTA antenna.

Example

actions:
  - action: media_player.play_media
    target:
      entity_id: media_player.roku
    data:
      media_content_id: 5.1
      media_content_type: channel

Play on Roku

The media_player.play_media action may be used to send media URLs (primarily videos) for direct playback on your device.

This feature makes use of the PlayOnRoku API. If you are using an older Roku OS (pre-11.5), the defaults of this integration should just work. Alternatively, you can configure a third-party application that supports the PlayOnRoku API via the Play Media Roku Application ID option.

The following third-party applications have been tested with this integration:

• Media Assistant (ID: 782875)

Example

actions:
  - action: media_player.play_media
    target:
      entity_id: media_player.roku
    data:
      media_content_id: "http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4"
      media_content_type: url
      extra:
        format: "mp4"
        name: "Big Buck Bunny"

Camera Stream Integration

The camera.play_stream action may be used to send camera streams (HLS) directly to your device. This feature requires the stream integration and makes use of the PlayOnRoku API.

Example

actions:
  - action: camera.play_stream
    target:
      entity_id: camera.camera
    data:
      media_player: media_player.roku

Content Deeplinking

The media_player.play_media action may be used to deep-link to content within an application.

Example

actions:
  - action: media_player.play_media
    target:
      entity_id: media_player.roku
    data:
      media_content_id: 291097
      media_content_type: app
      extra:
        content_id: 8e06a8b7-d667-4e31-939d-f40a6dd78a88
        media_type: movie

Obtaining Content IDs

Content IDs are unique to each streaming service and vary in format but are often part of the video webpage URL. Here are some examples:

Actions

Action roku.search

This action allows you to emulate opening the search screen and entering the search keyword.