@darrellvs/node-stream-deck-sdk
v1.0.6
Published
An unofficial Node.JS SDK for the Elgato Stream Deck / Stream Deck +
Downloads
7
Maintainers
Readme
@darrellvs/node-steam-deck-sdk
An unofficial SDK for Elgato's Stream Deck / Stream Deck + devices
IMPORTANT
This package relies on the WebSocket Proxy plugin for Stream Deck. Which you can find here.
Special thanks to Yann Bizeul for his excellent work on this plugin!
This package is not affiliated with Elgato or Yann Bizeul.
Introduction
This package provides you with utilities to interact with Elgato's Stream Deck devices.
It allows you to listen for changes on the device and send commands to the device.
Installation
Install @darrellvs/node-steam-deck-sdk with npm
npm install @darrellvs/node-steam-deck-sdk
or yarn
yarn add @darrellvs/node-steam-deck-sdk
or (if you dare) pnpm
pnpm add @darrellvs/node-steam-deck-sdk
Features
Bi-directional communication
Listen for changes and send commands to the Stream Deck plugin.Multiple device types supported
This SDK supports both the Stream Deck and Stream Deck + devices.Set displayed data
Set the displayed data on the buttons and dials / lcds.
Allows you to change the image, text, and other properties of the buttons and dials / lcds.TypeScript support
This package is written in TypeScript and provides type definitions.Easy to use
The SDK is designed to be easy to use and understand.Provided examples
Examples are provided to help you get started.
All communication is bi-directional, and thus allows you to listen for changes:
// Log when and how much the dial with id dial_1 is rotated
streamDeck.onDialRotate('dial_1', (ticks) => {
console.log(`Dial 1 rotated ${ticks} ticks`);
});
// Or more advanced, log when the LCD for dial 1 is held, and log the position of the tap
streamDeck.onLcdHold('dial_1', ({ tapPosition }) => {
console.log(
`LCD of dial 1 held at position x:${tapPosition.x} y:${tapPosition.y}`
);
});
More extensive examples available here!
Available events
The following events are available, with their respective parameters:
// The amount of ticks the dial was rotated
ticks: number;
params: {
// The physical coordinates of the dial on the device
coordinates: {
column: number;
row: number;
}
// The IP address + port of the server that sent the event
remoteServer: string;
}
Example usage
streamDeck.onDialRotate('dial_id', (ticks, { coordinates, remoteServer }) => {
console.log(`Dial rotated ${ticks} ticks`);
console.log(
`Dial is located at column ${coordinates.column} and row ${coordinates.row}`
);
console.log(`Event was sent by ${remoteServer}`);
});
params: {
// The physical coordinates of the dial on the device
coordinates: {
column: number;
row: number;
}
// The IP address + port of the server that sent the event
remoteServer: string;
}
Example usage
streamDeck.onDialPress('dial_id', ({ coordinates, remoteServer }) => {
console.log(`Dial was pressed`);
console.log(
`Dial is located at column ${coordinates.column} and row ${coordinates.row}`
);
console.log(`Event was sent by ${remoteServer}`);
});
params: {
// The physical coordinates of the dial on the device
coordinates: {
column: number;
row: number;
}
// The IP address + port of the server that sent the event
remoteServer: string;
}
Example usage
streamDeck.onDialDown('dial_id', ({ coordinates, remoteServer }) => {
console.log(`Dial was pressed down`);
console.log(
`Dial is located at column ${coordinates.column} and row ${coordinates.row}`
);
console.log(`Event was sent by ${remoteServer}`);
});
params: {
// The physical coordinates of the dial on the device
coordinates: {
column: number;
row: number;
}
// The IP address + port of the server that sent the event
remoteServer: string;
}
Example usage
streamDeck.onDialUp('dial_id', ({ coordinates, remoteServer }) => {
console.log(`Dial was released`);
console.log(
`Dial is located at column ${coordinates.column} and row ${coordinates.row}`
);
console.log(`Event was sent by ${remoteServer}`);
});
params: {
// The physical coordinates of the dial on the device
coordinates: {
column: number;
row: number;
}
// The IP address + port of the server that sent the event
remoteServer: string;
// The position of the tap on the LCD
tapPosition: {
x: number;
y: number;
}
}
Example usage
streamDeck.onLcdTap('dial_id', ({ coordinates, remoteServer, tapPosition }) => {
console.log(`LCD was tapped`);
console.log(
`Dial / LCD is located at column ${coordinates.column} and row ${coordinates.row}`
);
console.log(`Event was sent by ${remoteServer}`);
console.log(`Tap was at x:${tapPosition.x} y:${tapPosition.y}`);
});
params: {
// The physical coordinates of the dial on the device
coordinates: {
column: number;
row: number;
}
// The IP address + port of the server that sent the event
remoteServer: string;
// The position of the tap on the LCD
tapPosition: {
x: number;
y: number;
}
}
Example usage
streamDeck.onLcdHold(
'dial_id',
({ coordinates, remoteServer, tapPosition }) => {
console.log(`LCD is held`);
console.log(
`Dial / LCD is located at column ${coordinates.column} and row ${coordinates.row}`
);
console.log(`Event was sent by ${remoteServer}`);
console.log(`Hold was at x:${tapPosition.x} y:${tapPosition.y}`);
}
);
params: {
// The physical coordinates of the dial on the device
coordinates: {
column: number;
row: number;
}
// The IP address + port of the server that sent the event
remoteServer: string;
// Whether the button is in a multi-action
isInMultiAction: boolean;
}
Example usage
streamDeck.onButtonDown(
'button_id',
({ coordinates, remoteServer, isInMultiAction }) => {
console.log(`Button was pressed`);
console.log(
`Button is located at column ${coordinates.column} and row ${coordinates.row}`
);
console.log(`Event was sent by ${remoteServer}`);
console.log(`Button is ${!isInMultiAction && 'not'} in a multi-action`);
}
);
params: {
// The physical coordinates of the dial on the device
coordinates: {
column: number;
row: number;
}
// The IP address + port of the server that sent the event
remoteServer: string;
// Whether the button is in a multi-action
isInMultiAction: boolean;
}
Example usage
streamDeck.onButtonHold(
'button_id',
({ coordinates, remoteServer, isInMultiAction }) => {
console.log(`Button is held`);
console.log(
`Button is located at column ${coordinates.column} and row ${coordinates.row}`
);
console.log(`Event was sent by ${remoteServer}`);
console.log(`Button is ${!isInMultiAction && 'not'} in a multi-action`);
}
);
params: {
// The physical coordinates of the dial on the device
coordinates: {
column: number;
row: number;
}
// The IP address + port of the server that sent the event
remoteServer: string;
// Whether the button is in a multi-action
isInMultiAction: boolean;
}
Example usage
streamDeck.onButtonUp(
'button_id',
({ coordinates, remoteServer, isInMultiAction }) => {
console.log(`Button was released`);
console.log(
`Button is located at column ${coordinates.column} and row ${coordinates.row}`
);
console.log(`Event was sent by ${remoteServer}`);
console.log(`Button is ${!isInMultiAction && 'not'} in a multi-action`);
}
);
Additionally, you may listen to events emitted by the Stream Deck plugin:
This event is emitted when the Stream Deck plugin connects to the WebSocket server.
Example usage
streamDeck.on('pluginConnected', () => {
console.log(`Stream Deck plugin connected`);
});
This event is emitted when a button or dial / lcd is about to appear on the Stream Deck.
Use this if you need to process some data, set an initial state (value, indicator, layout, image, etc.) before the plugin appears.
Example usage
streamDeck.on('willAppear', (id, params) => {
console.log(`Element with id ${id} will appear`);
console.log(`Parameters:`, params);
});
This event is emitted when a button or dial / lcd is about to disappear from the Stream Deck.
Use this if you need to clean up, reset, or save some data before the plugin disappears.
Example usage
streamDeck.on('willDisappear', (id, params) => {
console.log(`Element with id ${id} will disappear`);
console.log(`Parameters:`, params);
});
Notes
I will not be actively updating this library
As long as Elgato doesn't break anything.
Minor issues may be patched, major issues may or may not 👀
Feel free to open a PR adding your own contributions 🚀