Update roku for config flow (#12292)

* prep for roku onfig flow related changes

* Update roku.markdown

* add quality scale

* review tweaks

* Update roku.markdown
This commit is contained in:
Chris Talkington 2020-03-16 08:18:06 -05:00 committed by GitHub
parent d90a4c31dc
commit 2628a0db87
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -9,16 +9,25 @@ ha_category:
ha_iot_class: Local Polling
ha_release: 0.86
ha_domain: roku
ha_config_flow: true
ha_quality_scale: silver
---
The [Roku](https://www.roku.com/) integration allows integration of Roku, which will be automatically discovered if you enable the [discovery component](/integrations/discovery/).
The Roku integration allows you to control a [Roku](https://www.roku.com/) device.
### Configuration
Go to the integrations page in your configuration and click on new integration -> Roku.
If your Roku device is on, it has likely been discovered already and you just have to confirm the detected device.
There is currently support for the following device types within Home Assistant:
- Media Player
- Remote
The `roku` integration can also be forced to load by adding the following lines to your `configuration.yaml`:
### YAML Configuration
Manual configuration of your Roku device is also possible, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -33,12 +42,6 @@ host:
type: string
{% endconfiguration %}
## Services
### Service `roku_scan`
Scans the local network for Rokus. All found devices are presented as a persistent notification.
## 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.
@ -89,7 +92,7 @@ data:
## Media Player
When the Home Assistant Roku integration is enabled and has found a Roku device, in the Home Assistant GUI 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, but it requires you to acquire an extra piece of information; the ```appID``` for the channel specific to your Roku. 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 though, you can easily get the information yourself. All you need to do is a simple GET API call on the same network as your device.
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, but it requires you to acquire an extra piece of information; the ```appID``` for the channel specific to your Roku. 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 though, you can easily get the information yourself. All you need to do is a simple GET API call on the same network as your device.
The API calls are like this: