OpenPass Roku SDK


The OpenPass Roku SDK makes it easier to integrate OpenPass directly on your Roku channels.

Installation

$3

The preferred installation method is via ropm

``bash
ropm install @openpass/openpass-roku-sdk
`

$3

Copy openpass_openpassrokusdk files inside your source folder

Requirements

In order to use this SDK you will need the following requirements

1. Install Node.JS from here
2. Install the Roku Package Manager node module globally

`bash
npm i ropm -g
`

3. Install BrighterScript module globally

`bash
npm install brighterscript -g
`

4. At project root level run

`bash
ropm install
`

5. Enable Developer Mode on you Roku device, you can see more here

6. In order to use npm scripts to run the project locally, you will need to add the following ENV VARS to your system:

- ROKU_HOST: This is the IP Address of your Roku device.
- ROKU_DEV_PASSWORD: This is the password you set for your Roku device when Developer Mode was enabled.

To add the variables to your system for Mac or Linux:

- If using zsh as your shell

`bash
echo 'export ROKU_DEV_PASSWORD=' >> ~/.zshrc
echo 'export ROKU_HOST=' >> ~/.zshrc
`

- If using bash as your shell

`bash
echo 'export ROKU_DEV_PASSWORD=' >> ~/.bash_profile
echo 'export ROKU_HOST=' >> ~/.bash_profile
`

To add the variables to your system if using Windows

`bash
setx ROKU_DEV_PASSWORD ""
setx ROKU_HOST ""
`

Usage

1. Install the package via ropm

`bash
ropm install @openpass/openpass-roku-sdk
`

2. You will need to create 2 tasks nodes that will allow for specify a functions to be spawned in a different thread, you can do that like the following example:

create a task for Authorize Device flow: tasks/AuthorizeDeviceTask.brs

`brightscript
sub Init()
m.top.functionName = "AuthorizeDevice"
end sub

sub AuthorizeDevice()
' Your client Id
clientId = "YOUR_CLIENT_ID"

' Init client
m.op = openpass_openpassrokusdk_OpenPass()

' optionalParams = { polling_timeout: 200}
' optionalParams = { openpass_base_url: "www.differenturl.com", polling_timeout: 4000}
' optionalParams = { openpass_base_url: "www.differenturl.com"}
optionalParams = { enable_logging: true }

m.op.Init(clientId, AuthCallback, optionalParams)

' Start sign in process
m.op.SignIn()

' m.op.SignOut()
end sub

sub AuthCallback(state, data)

print state
_states = {
"SignedIn": 0,
"SignedOut": 1,
"Error": 2,
"Loading": 3,
"Polling": 4,
"Refreshable": 5 ' Signed In but needs to refresh
}

if state = _states.SignedIn
HandleSignedIn(data)
else if state = _states.Polling
HandlePolling(data)
' else if state = _states.Error
' HandleSignOut()
end if

end sub

sub HandleSignedIn(data)
authorizedDevice = CreateObject("roSGNode", "ContentNode")
authorizedDevice.addFields(data["device_token_success"])
m.top.authorizedDevice = authorizedDevice
end sub

sub HandlePolling(data)
authDevice = CreateObject("roSGNode", "ContentNode")
authDevice.addFields(data["authorize_device_success"])
m.top.authDevice =authDevice
end sub

`

and tasks/AuthorizeDeviceTask.xml

`xml