elgato-stream-deck

elgato-stream-deck

elgato-stream-deck is a Node.js library for interfacing with the Elgato Stream Deck.

Install

$ npm install --save elgato-stream-deck

Table of Contents

• Example
• Features
• PLanned Features
• Contributing
• Events
  • down
  • up
  • error

Example

const streamDeck = require('elgato-stream-deck')
streamDeck.on('down', keyIndex => {
    console.log('key %d down', keyIndex);
});

streamDeck.on('up', keyIndex => {
    console.log('key %d up', keyIndex);
});

streamDeck.on('error', error => {
    console.error(error);
});

Features

• Key down and key up events

Planned Features

• Key combinations
• Send new images to keys
• Support "pages" feature from the official Elgato Stream Deck software

Contributing

The elgato-stream-deck team enthusiastically welcomes contributions and project participation! There's a bunch of things you can do if you want to contribute! The Contributor Guide has all the information you need for everything from reporting bugs to contributing entire new features. Please don't hesitate to jump in if you'd like to, or even ask us questions if something isn't clear.

All participants and maintainers in this project are expected to follow Code of Conduct, and just generally be kind to each other.

Please refer to the Changelog for project history details, too.

Events

> down

Fired whenever a key is pressed. keyIndex is the 0-15 numerical index of that key.

Example

streamDeck.on('down', keyIndex => {
    console.log('key %d down', keyIndex);
});

> up

Fired whenever a key is released. keyIndex is the 0-15 numerical index of that key.

Example

streamDeck.on('up', keyIndex => {
    console.log('key %d up', keyIndex);
});

> error

Fired whenever an error is detected by the node-hid library. Always add a listener for this event! If you don't, errors will be silently dropped.

Example

streamDeck.on('error', keyIndex => {
    console.log('key %d error', keyIndex);
});

Changelog

1.0.0 (2017-05-17)

Initial release.