The Roku integration allows you to control a Roku device.
Adding Roku to your Home Assistant instance can be done via the user interface, by using this My button:
Roku can be auto-discovered by Home Assistant. If an instance was found, it will be shown as “Discovered”, which you can select to set it up right away.
If there wasn’t any discovered automatically, don’t worry! You can set up a manual integration entry:
There is currently support for the following device types within Home Assistant:
- Media Player
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:
A typical service call for pressing several buttons looks like this.
service: remote.send_command target: entity_id: remote.roku data: command: - left - left - select
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. This action can also be automated. Channels can be launched by
name using a configuration similar to the one below:
action: - target: entity_id: media_player. data: source: "Prime Video" service: media_player.select_source
appID for the channel can be used for
source: Although this information is gathered by the Roku integration, at the moment it is not exposed to the end-user. This item might be added in a future release. For now, you can easily get the information yourself. All you need to do is a GET API call on the same network as your device.
The API calls are like this:
GET http://ROKU_IP:8060/query/apps POST http://ROKU_IP:8060/launch/APP_ID YouTube example: POST http://YOUR_ROKU_IP:8060/launch/837?contentID=YOUR_YOUTUBE_VIDEOS_CONTENT_ID&MediaType=live
One method of performing the GET request is to open
http://ROKU_IP:8060/query/apps in your web browser of choice. The Roku will return an XML-formatted list of available channels, including their full name and appID.
More details can be found on the Roku dev pages
To use this information in Home Assistant, the format is as follows. Note that
source: is the appID you discovered in the API call:
action: - service: media_player.select_source target: entity_id: media_player.roku data: source: 20197
It is also possible to tune directly to specific channels if you have a Roku TV and use an OTA antenna. This service only supports
media_channel_type of ‘channel’.
media_content_id corresponds to the TV channel, which you should see when navigating to these on your TV UI.
action: - service: media_player.play_media target: entity_id: media_player.roku data: media_content_id: 5.1 media_content_type: channel
remote platform allows you to send keypress commands to your device. Remote entities are automatically registered during the integration setup.
This service allows you to emulate opening the search screen and entering the search keyword.
|Service data attribute||Optional||Description||Example|
||yes||The entities to search on.||media_player.roku|
||no||The keyword to search for.||Space Jam|