nod
nodeku
npm i nodeku
nod

nodeku

discover and control Roku devices with NodeJS

by Ray Farias

1.0.20 (see all)License:Apache-2.0TypeScript:Not Found
npm i nodeku
Readme

nodeku

CircleCI

Discover Roku devices via ssdp and control the device with methods that perform http requests to the device.

requirements:

  • node 7.0.0 or higher
  • connected to the same network as the Roku device.
  • a router/network that supports UPnP (for ssdp)

usage


const Nodeku = require('nodeku')

Nodeku()
  .then(device => {
    console.log(`device found at: ${ device.ip() }`)
    // 'xxx.xxx.xxx.xxx:8060'
    return device.apps()
  })
  .then(apps => {
    apps.forEach(app => console.log(app))
    // [{ id, name, type, version }, ...]
  })
  .catch(err => {
    console.error(err.stack)
  })

getting started

$ npm install nodeku

nodeku

Invoking Nodeku will return a promise and on success it will pass a device module. This module will contain the methods needed to control a roku device. Commands are sent to the Roku device via HTTP protocol as found on the docs.

api methods

method nameparamsreturn typedetails
.ip()NoneStringnetwork ip and port xxx.xxx.xxx.xxx:8060
.apps()NoneList[{}, ...]list of many objects with props: id, name, type, version
.active()NoneList[{}]list with one object with props id, name, type, version
.info()NoneMap{}map with too many(29) props
.keypress('...')StringBooleantrue if success, false if error
.keydown('...')StringBooleantrue if successful, false if error
.keyup('...')StringBooleantrue if successful, false if error
'.icon(1)NumberBufferjpeg image as buffer
'.launch(1)NumberBooleantrue if successful, false if error

keypress values

  • Home
  • Rev
  • Fwd
  • Play
  • Select
  • Left
  • Right
  • Down
  • Up
  • Back
  • InstantReplay
  • Info
  • Backspace
  • Search
  • Enter

tests

$ npm test

references

Roku - External Control Service Commands Roku - Keypress Key Values

additional information

Only tested on OSX and with Roku3 device. halp?

Downloads/wk

60

GitHub Stars

12

LAST COMMIT

4yrs ago

MAINTAINERS

1

CONTRIBUTORS

5

OPEN ISSUES

4

OPEN PRs

0
VersionTagPublished
1.0.20
latest
4yrs ago
No alternatives found
No tutorials found
Add a tutorial