tivo-remote
v2.1.0
Published
Control your TiVo DVR over the network
Downloads
15
Maintainers
Readme
tivo-remote
Control your TiVo DVR over the network
tivo-remote
is a Node.js library that allows you to control your TiVo DVR over your local network. It's especially useful for integrating into a home automation system.
Getting Started
tivo-remote is distributed through NPM:
npm install tivo-remote
# or, if you prefer:
yarn add tivo-remote
Examples
tivo-remote
provides both discovery and control capabilities. To monitor the local network for TiVo devices, try something like this:
import TiVoDiscovery from 'tivo-remote';
TiVoDiscovery
.on('founddevice', (device) => {
console.log(`Found a device: ${device.name} (${device.ip})`);
})
.on('lostdevice', (device) => {
console.log(`Lost a device: ${device.name} (${device.ip})`);
})
.discover();
Once you have a device object, you have a number of control commands at your disposal:
API
TeleportDestination
Type: ("TIVO"
| "LIVETV"
| "GUIDE"
| "NOWPLAYING"
)
TiVoRemote
Extends EventEmitter
Parameters
sendIrcode
Send an IR code to the DVR. The list of supported codes is very long; For details, see Ircode
Parameters
code
Ircode
sendKeyboardCode
Send a key code to the DVR. The list of supported codes is very long; For details, see KeyboardCode
Parameters
code
KeyboardCode
teleport
"Teleport" to a given location in the DVR UI.
Parameters
destination
TeleportDestination
setChannel
Tune the DVR to the given channel. If the forced flag is set, the DVR will be tuned even if a recording is in progress (canceling the recording).
Parameters
deinit
Once you're finished with the device object, call deinit() to close the underlying network connection.
name
The name of this device.
Returns string
id
The unique ID of this device.
Returns string
ip
The IP address of this device.
Returns string
Migration
1.0 -> 2.0
The difference between 1.0 and 2.0 shouldn't be noticeable to most users, even though it is technically an API break. Version 1.0 exposed a module compiled with Babel such that it was necessary to use
const TiVoDiscovery = require('tivo-remote').default
if the including project was not also compiled with Babel. Version 2.0 resolves this so both import
and require
work as their respective users expect.
Compatibility
tivo-remote
is built to support Node.js version 6.0 or higher.
Contributing
Contributions are of course always welcome. If you find problems, please report them in the Issue Tracker. If you've made an improvement, open a pull request.
Getting set up for development is very easy:
git clone <your fork>
cd tivo-remote
yarn
And the development workflow is likewise straightforward:
# make a change to the src/ file, then...
yarn build
node dist/example.js
# or if you want to clean up all the leftover build products:
yarn run clean