forty2 / mqtt2tivoremote

Make TiVo DVR remote control available through an mqtt-smarthome style interface.

mqtt2tivoremote

Make TiVo DVR remote control available through an mqtt-smarthome style interface

mqtt2tivoremote is a Node.js application that links TiVo DVRs to an MQTT broker. It is designed to be used to integrate these devices into a home automation system à la mqtt-smarthome.

Getting Started

mqtt2tivoremote is distributed through NPM:

npm install -g mqtt2tivoremote

# or, if you prefer:
yarn global add mqtt2tivoremote

Running it is likewise easy:

mqtt2tivoremote                      # if your MQTT broker is running on localhost
mqtt2tivoremote -b mqtt://<hostname> # if your broker is running elsewhere
mqtt2tivoremote --help               # to see the full usage documentation

Topics and Payloads

This app is intended to conform to the mqtt-smarthome architecture. The topics used by the app are generally of the form:

Topics Published

Topic	Purpose
tivoremote/connected	0 = not connected to anything 1 = connected to MQTT but not DVR 2 = connected to both.
tivoremote/status/channel	JSON encoded current channel information schema: { channel: num, subchannel: num, reason: string }
tivoremote/status/livetv_ready	When a teleport to Live TV is attempted, this will be set to false. When LiveTV is being displayed, this will change to true.
`tivoremote/status/error	A string containing information about the most recent error to occur.

Topics Subscribed

For performance reasons, no argument checking is done: if you pass in an invalid IR code, for instance, it will still get sent to the DVR.

Topic	Purpose
tivoremote/set/ircode	Set to one of the valid IR codes to send that command to the DVR. No acknowledgement or confirmation will be returned.
tivoremote/set/keyboard	As above, but for keboard commands rather than IR codes.
tivoremote/set/teleport	Set to one of TIVO, LIVETV, GUIDE, or NOWPLAYING to jump directly to that screen. Minimal status is available on tivoremote/status/teleport.
tivoremote/set/channel	Set the DVR to the given channel unless a recording is in progress. Only works if the DVR is in Live TV mode. Status will be reported on tivoremote/status/channel. Message format: { "channel": num, "subchannel": num }
tivoremote/set/forcedChannel	As above, but will cancel an in-progress recording if necessary

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 mqtt2tivoremote
yarn

And the development workflow is likewise straightforward:

# make a change to the src/ file, then...
yarn build
node dist/index.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.

mqtt2tivoremote's Issues

Version 10 of node.js has been released

Version 10 of Node.js (code name Dubnium) has been released! 🎊

To see what happens to your code in Node.js 10, Greenkeeper has created a branch with the following changes:

• Added the new Node.js version to your .travis.yml
• The new Node.js version is in-range for the engines in 1 of your package.json files, so that was left alone

If you’re interested in upgrading this repo to Node.js 10, you can open a PR with these changes. Please note that this issue is just intended as a friendly reminder and the PR as a possible starting point for getting your code running on Node.js 10.

More information on this issue

Greenkeeper has checked the engines key in any package.json file, the .nvmrc file, and the .travis.yml file, if present.

• engines was only updated if it defined a single version, not a range.
• .nvmrc was updated to Node.js 10
• .travis.yml was only changed if there was a root-level node_js that didn’t already include Node.js 10, such as node or lts/*. In this case, the new version was appended to the list. We didn’t touch job or matrix configurations because these tend to be quite specific and complex, and it’s difficult to infer what the intentions were.

For many simpler .travis.yml configurations, this PR should suffice as-is, but depending on what you’re doing it may require additional work or may not be applicable at all. We’re also aware that you may have good reasons to not update to Node.js 10, which is why this was sent as an issue and not a pull request. Feel free to delete it without comment, I’m a humble robot and won’t feel rejected 🤖

---

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴