npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

tivo-remote

v2.1.0

Published

Control your TiVo DVR over the network

Downloads

20

Readme

tivo-remote

Control your TiVo DVR over the network

Generated with nod NPM version GitHub license Build Status Coverage Status

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

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

License

MIT © Zach Bean. See LICENSE for more detail.