A node module for interacting with an Apple TV (4th-generation or later) over the Media Remote Protocol.
node-appletv is a
node.js implementation of the Media Remote Protocol which shipped with the 4th-generation Apple TV. This is the protocol that the Apple TV remote app uses, so this should enable the creation of an Apple TV remote app for various platforms. It can also be used in a
homebridge plugin to connect Apple TV events to HomeKit and vice versa.
node-appletv can be used as a standalone command line application, or as a module in your own node app. Keep reading for installation and usage instructions.
Developer documentation for
node-appletv can be found here.
As a standalone cli
# Install$ npm install -g node-appletv# Display built-in help$ appletv --help
appletv cli supports several commands, such as:
pair: Scans for Apple TVs on the local network and initiates the pairing process
command <command>: Execute a command on an Apple TV (play, pause, menu, volume, wake, suspend, etc.)
state: Logs state changes from an Apple TV (now playing info)
queue: Requests the current playback queue from an Apple TV
artwork: Requests the current now playing artwork from an Apple TV
messages: Logs all raw messages from an Apple TV
help <command>: Get help for a specific command
As a node module
$ npm install --save node-appletv
node-appletv makes heavy use of Promises. All functions, except for the observe functions, return Promises.
Scan for Apple TVs and pair
;;// devices is an array of AppleTV objects;await device.openConnection;;// the pin is provided onscreen from the Apple TVawait callbackpin;// you're paired!;console.logcredentials;
Connect to a paired Apple TV
;// see example above for how to get the credentials string;;await device.openConnectioncredentials;// you're connected!// press menuawait device.sendKeyCommandAppleTV.Key.Menu;console.log"Sent a menu command!";// monitor now playing infodevice.on'nowPlaying',;
uniqueIdentifier is advertised by each Apple TV via Bonjour. Use an app like Bonjour Browser to find it. The identifier is also the first value in the string value of the
See homebridge-theater-mode for a more practical use of this module.
node-appletv is written in Typescript. Edit files in the
src directory and then run
npm link to clean, build, and create the symlinks to use the library and cli.
node-appletv would not have been possible without the work of these people:
- Jean Regisser who reversed the protobuf spec of the MediaRemoteTV protocol
- Pierre Ståhl who implemented the protocol in Python
- Khaos Tian for reversing the HomeKit protocol which also uses SRP encryption
- Zach Bean for implementing the HAP client spec
You can find me on Twitter @evandcoleman
Distributed under the MIT license. See
LICENSE for more information.