Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sgnl/nodeku
discover and control Roku devices with NodeJS
https://github.com/sgnl/nodeku
iot javascript nodejs npm-package roku roku-device roku-tv ssdp
Last synced: 3 months ago
JSON representation
discover and control Roku devices with NodeJS
- Host: GitHub
- URL: https://github.com/sgnl/nodeku
- Owner: sgnl
- License: other
- Created: 2016-10-11T20:25:33.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-04-25T18:09:15.000Z (over 6 years ago)
- Last Synced: 2024-07-22T10:40:39.368Z (4 months ago)
- Topics: iot, javascript, nodejs, npm-package, roku, roku-device, roku-tv, ssdp
- Language: JavaScript
- Homepage: https://medium.com/@sgnl/nodeku-control-your-roku-with-node-js-d8b8c87cdba6
- Size: 497 KB
- Stars: 13
- Watchers: 2
- Forks: 9
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nodeku
[](https://circleci.com/gh/sgnl/nodeku/tree/master)
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
```javascript
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][1].
## api methods
| **method name** | **params** | **return type** | **details** |
|---|---|---|---|
| `.ip()` | None | `String` | network ip and port `xxx.xxx.xxx.xxx:8060` |
| `.apps()` | None | `List[{}, ...]` | list of many objects with props: `id, name, type, version` |
| `.active()` | None | `List[{}]` | list with one object with props `id, name, type, version` |
| `.info()` | None | `Map{}` | map with *too many(29) props* |
| `.keypress('...')` | String | `Boolean` | true if success, false if error |
| `.keydown('...')`| String | `Boolean` | true if successful, false if error |
| `.keyup('...')` | String | `Boolean` | true if successful, false if error |
| `'.icon(1)` | Number | `Buffer` | jpeg image as buffer |
| `'.launch(1)` | Number | `Boolean` | true 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][1]
[Roku - Keypress Key Values][3]
### additional information
Only tested on OSX and with Roku3 device. halp?
[1]: https://sdkdocs.roku.com/display/sdkdoc/External+Control+API
[2]: http://facebook.github.io/immutable-js/
[3]: https://sdkdocs.roku.com/display/sdkdoc/External+Control+API#ExternalControlAPI-KeypressKeyValues