mirror of
https://github.com/openhab/openhab-addons.git
synced 2025-01-11 15:42:10 +01:00
149 lines
7.8 KiB
Markdown
149 lines
7.8 KiB
Markdown
# Roku Binding
|
|
|
|
This binding connects Roku streaming media players and Roku TVs to openHAB.
|
|
The Roku device must support the Roku ECP protocol REST API.
|
|
|
|
## Supported Things
|
|
|
|
There are two supported thing types, which represent either a standalone Roku device or a Roku TV.
|
|
A supported Roku streaming media player or streaming stick uses the `roku_player` id and a supported Roku TV uses the `roku_tv` id.
|
|
The Roku TV type adds additional channels and button commands to the button channel dropdown for TV specific functionality.
|
|
Multiple Things can be added if more than one Roku is to be controlled.
|
|
|
|
## Discovery
|
|
|
|
Auto-discovery is supported if the Roku can be located on the local network using SSDP.
|
|
Otherwise the thing must be manually added.
|
|
|
|
## Binding Configuration
|
|
|
|
The binding has no configuration options, all configuration is done at Thing level.
|
|
|
|
## Thing Configuration
|
|
|
|
The thing has a few configuration parameters:
|
|
|
|
| Parameter | Description |
|
|
|-----------|------------------------------------------------------------------------------------------------------------|
|
|
| hostName | The host name or IP address of the Roku device. Mandatory. |
|
|
| port | The port on the Roku that listens for http connections. Default 8060 |
|
|
| refresh | Overrides the refresh interval for player status updates. Optional, the default and minimum is 10 seconds. |
|
|
|
|
## Channels
|
|
|
|
The following channels are available:
|
|
|
|
| Channel ID | Item Type | Description |
|
|
|--------------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| activeApp | String | A dropdown containing a list of all apps installed on the Roku. The app currently running is automatically selected. The list updates every 10 minutes. |
|
|
| button | String | Sends a remote control command the Roku. See list of available commands below. |
|
|
| playMode | String | The current playback mode ie: stop, play, pause (ReadOnly). |
|
|
| timeElapsed | Number:Time | The total number of seconds of playback time elapsed for the current playing title (ReadOnly). |
|
|
| timeTotal | Number:Time | The total length of the current playing title in seconds (ReadOnly). This data is not provided by all streaming apps. |
|
|
| activeChannel | String | A dropdown containing a list of available TV channels on the Roku TV. The channel currently tuned is automatically selected. The list updates every 10 minutes. |
|
|
| signalMode | String | The signal type of the current TV channel, ie: 1080i (ReadOnly). |
|
|
| signalQuality | Number:Dimensionless | The signal quality of the current TV channel, 0-100% (ReadOnly). |
|
|
| channelName | String | The name of the channel currently selected (ReadOnly). |
|
|
| programTitle | String | The name of the current TV program (ReadOnly). |
|
|
| programDescription | String | The description of the current TV program (ReadOnly). |
|
|
| programRating | String | The TV parental guideline rating of the current TV program (ReadOnly). |
|
|
|
|
Some Notes:
|
|
|
|
* The values for `activeApp`, `playMode`, `timeElapsed`, `timeTotal`, `activeChannel`, `signalMode`, `signalQuality`, `channelName`, `programTitle`, `programDescription` & `programRating` refresh automatically per the configured `refresh` interval (10 seconds minimum).
|
|
|
|
**List of available button commands for Roku streaming devices:**
|
|
Home
|
|
Rev
|
|
Fwd
|
|
Play
|
|
Select
|
|
Left
|
|
Right
|
|
Up
|
|
Down
|
|
Back
|
|
InstantReplay
|
|
Info
|
|
Backspace
|
|
Search
|
|
Enter
|
|
FindRemote
|
|
|
|
**List of additional button commands for Roku TVs:**
|
|
ChannelUp
|
|
ChannelDown
|
|
VolumeUp
|
|
VolumeDown
|
|
VolumeMute
|
|
InputTuner
|
|
InputHDMI1
|
|
InputHDMI2
|
|
InputHDMI3
|
|
InputHDMI4
|
|
InputAV1
|
|
PowerOff
|
|
|
|
## Full Example
|
|
|
|
roku.things:
|
|
|
|
```
|
|
// Roku streaming media player
|
|
roku:roku_player:myplayer1 "My Roku" [ hostName="192.168.10.1", refresh=10 ]
|
|
|
|
// Roku TV
|
|
roku:roku_tv:mytv1 "My Roku TV" [ hostName="192.168.10.1", refresh=10 ]
|
|
|
|
```
|
|
|
|
roku.items:
|
|
|
|
```
|
|
// Roku streaming media player items:
|
|
|
|
String Player_ActiveApp "Current App: [%s]" { channel="roku:roku_player:myplayer1:activeApp" }
|
|
String Player_Button "Send Command to Roku" { channel="roku:roku_player:myplayer1:button" }
|
|
String Player_PlayMode "Status: [%s]" { channel="roku:roku_player:myplayer1:playMode" }
|
|
Number:Time Player_TimeElapsed "Elapsed Time: [%d %unit%]" { channel="roku:roku_player:myplayer1:timeElapsed" }
|
|
Number:Time Player_TimeTotal "Total Time: [%d %unit%]" { channel="roku:roku_player:myplayer1:timeTotal" }
|
|
|
|
// Roku TV items:
|
|
|
|
String Player_ActiveApp "Current App: [%s]" { channel="roku:roku_tv:mytv1:activeApp" }
|
|
String Player_Button "Send Command to Roku" { channel="roku:roku_tv:mytv1:button" }
|
|
String Player_PlayMode "Status: [%s]" { channel="roku:roku_tv:mytv1:playMode" }
|
|
Number:Time Player_TimeElapsed "Elapsed Time: [%d %unit%]" { channel="roku:roku_tv:mytv1:timeElapsed" }
|
|
Number:Time Player_TimeTotal "Total Time: [%d %unit%]" { channel="roku:roku_tv:mytv1:timeTotal" }
|
|
String Player_ActiveChannel "Current Channel: [%s]" { channel="roku:roku_tv:mytv1:activeChannel" }
|
|
String Player_SignalMode "Signal Mode: [%s]" { channel="roku:roku_tv:mytv1:signalMode" }
|
|
Number Player_SignalQuality "Signal Quality: [%d %%]" { channel="roku:roku_tv:mytv1:signalQuality" }
|
|
String Player_ChannelName "Channel Name: [%s]" { channel="roku:roku_tv:mytv1:channelName" }
|
|
String Player_ProgramTitle "Program Title: [%s]" { channel="roku:roku_tv:mytv1:programTitle" }
|
|
String Player_ProgramDescription "Program Description: [%s]" { channel="roku:roku_tv:mytv1:programDescription" }
|
|
String Player_ProgramRating "Program Rating: [%s]" { channel="roku:roku_tv:mytv1:programRating" }
|
|
|
|
```
|
|
|
|
roku.sitemap:
|
|
|
|
```
|
|
sitemap roku label="Roku" {
|
|
Frame label="My Roku" {
|
|
Selection item=Player_ActiveApp icon="screen"
|
|
Selection item=Player_Button icon="screen"
|
|
Text item=Player_PlayMode
|
|
Text item=Player_TimeElapsed icon="time"
|
|
Text item=Player_TimeTotal icon="time"
|
|
// The following items apply to Roku TVs only
|
|
Selection item=Player_ActiveChannel icon="screen"
|
|
Text item=Player_SignalMode
|
|
Text item=Player_SignalQuality
|
|
Text item=Player_ChannelName
|
|
Text item=Player_ProgramTitle
|
|
Text item=Player_ProgramDescription
|
|
Text item=Player_ProgramRating
|
|
}
|
|
}
|
|
```
|