From 350004c3cec12493b81ff7221a97cdb8ec2530bd Mon Sep 17 00:00:00 2001 From: Spencer Oberstadt Date: Mon, 14 Jan 2019 16:26:24 -0500 Subject: [PATCH] Adding documentation for Roku hub and remote (#6944) * Adding documentation for Roku hub and remote * revert date change * Fix year * PR feedback fixes --- source/_components/media_player.roku.markdown | 19 +----- source/_components/remote.roku.markdown | 60 +++++++++++++++++++ source/_components/roku.markdown | 37 ++++++++++++ 3 files changed, 99 insertions(+), 17 deletions(-) create mode 100644 source/_components/remote.roku.markdown create mode 100644 source/_components/roku.markdown diff --git a/source/_components/media_player.roku.markdown b/source/_components/media_player.roku.markdown index d301898db11..af72795a3a7 100644 --- a/source/_components/media_player.roku.markdown +++ b/source/_components/media_player.roku.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "Roku" +title: "Roku Media Player" description: "Instructions on how to integrate Roku into Home Assistant." date: 2016-05-16 20:0+0000 sidebar: true @@ -13,19 +13,4 @@ ha_release: "0.20" ha_iot_class: "Local Polling" --- -The [Roku](http://www.roku.com/) media players will be automatically discovered if you enable the [discovery component](/components/discovery/). - -The `roku` media player platform can also be forced to load by adding the following lines to your `configuration.yaml`: - -```yaml -# Example configuration.yaml entry -media_player: - - platform: roku -``` - -{% configuration %} -host: - description: The IP address or the hostname of the device. Use only if you don't want to scan for devices. - required: false - type: string -{% endconfiguration %} +To set up the `roku` media player platform, please follow the instructions on the [Roku Component page](/components/roku/). diff --git a/source/_components/remote.roku.markdown b/source/_components/remote.roku.markdown new file mode 100644 index 00000000000..38a31283611 --- /dev/null +++ b/source/_components/remote.roku.markdown @@ -0,0 +1,60 @@ +--- +layout: page +title: "Roku Remote" +description: "Instructions on how to integrate Roku into Home Assistant." +date: 2018-10-17 20:0+0000 +sidebar: true +comments: false +sharing: true +footer: true +logo: roku.png +ha_category: Remote +ha_release: 0.86 +ha_iot_class: "Local Polling" +--- + +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; please see [Roku Component page](/components/roku/) for configuration details. + +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 service call for pressing several buttons looks like this. + +```yaml +service: remote.send_command +data: + entity_id: remote.roku + command: + - left + - left + - select +``` \ No newline at end of file diff --git a/source/_components/roku.markdown b/source/_components/roku.markdown new file mode 100644 index 00000000000..b3d7aacb057 --- /dev/null +++ b/source/_components/roku.markdown @@ -0,0 +1,37 @@ +--- +layout: page +title: "Roku" +description: "Instructions how to integrate Roku devices into Home Assistant." +date: 2018-10-17 20:47 +sidebar: true +comments: false +sharing: true +footer: true +logo: roku.png +ha_category: Hub +ha_iot_class: "Local Polling" +ha_release: 0.86 +--- + +The [Roku](http://www.roku.com/) component allows integration of Roku [media players](/components/media_player.roku) and [remotes](/components/remote.roku/) which will be automatically discovered if you enable the [discovery component](/components/discovery/). + +The `roku` component can also be forced to load by adding the following lines to your `configuration.yaml`: + +```yaml +# Example configuration.yaml entry +roku: + - host: 192.168.1.100 +``` + +{% configuration %} +host: + description: Set the IP address of the Roku device. Use only if you don't want to autodiscover devices. + required: false + type: string +{% endconfiguration %} + +## {% linkable_title Services %} + +### {% linkable_title Service `roku_scan` %} + +Scans the local network for Rokus. All found devices are presented as a persistent notification.