https://julusian.github.io/node-elgato-stream-deck/

A Node.js library for interfacing with the Elgato Stream Deck. https://julusian.github.io/node-elgato-stream-deck/
https://julusian.github.io/node-elgato-stream-deck/

elgato stream-deck webhid

Last synced: about 1 month ago
JSON representation

A Node.js library for interfacing with the Elgato Stream Deck. https://julusian.github.io/node-elgato-stream-deck/

• Host: GitHub
• URL: https://julusian.github.io/node-elgato-stream-deck/
• Owner: Julusian
• License: mit
• Created: 2019-05-28T18:16:05.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-10-31T22:47:03.000Z (about 1 month ago)
• Last Synced: 2024-10-31T23:26:13.601Z (about 1 month ago)
• Topics: elgato, stream-deck, webhid
• Language: TypeScript
• Homepage: https://www.npmjs.com/org/elgato-stream-deck
• Size: 7.64 MB
• Stars: 161
• Watchers: 10
• Forks: 21
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-webhid - Elgato StreamDeck - using the Elgato Stream Deck (via [@elgato-stream-deck/webhid](https://github.com/julusian/node-elgato-stream-deck)). (Demos, experiments & hacks / Candidates)

README

        
# @elgato-stream-deck

![Node CI](https://github.com/Julusian/node-elgato-stream-deck/workflows/Node%20CI/badge.svg)

[![codecov](https://codecov.io/gh/Julusian/node-elgato-stream-deck/branch/master/graph/badge.svg?token=Hl4QXGZJMF)](https://codecov.io/gh/Julusian/node-elgato-stream-deck)

[@elgato-stream-deck](https://www.npmjs.com/org/elgato-stream-deck) is a collection of libraries for interfacing with the various models of the [Elgato Stream Deck](https://www.elgato.com/en/gaming/).  

With WebHID being made publicly available it is now possible to use the Steam Deck directly in the browser.

## Intended use

This library has nothing to do with the streamdeck software produced by Elgato. There is nothing here to install and run. This is a library to help developers make alternatives to that software

## Installing & Usage

Check one of the installable packages for installation and usage instructions:

-   [`@elgato-stream-deck/node`](https://npm.im/@elgato-stream-deck/node)

-   [`@elgato-stream-deck/webhid`](https://npm.im/@elgato-stream-deck/webhid)

-   [`@elgato-stream-deck/tcp`](https://npm.im/@elgato-stream-deck/tcp)

### Have another hid target you wish to use?

The existing implementations are a light wrapper around the platform agnostic [`@elgato-stream-deck/core`](https://npm.im/@elgato-stream-deck/core). You can use your own HID implementation and device scanning/opening logic and reuse all the streamdeck bits.

## Demo

If you are using a Chromium v89+ based browser, you can try out the [webhid demo](https://julusian.github.io/node-elgato-stream-deck/)

## Linux

On linux, the udev subsystem blocks access to the StreamDeck without some special configuration.

Copy one of the following files into `/etc/udev/rules.d/` and reload the rules with `sudo udevadm control --reload-rules`

-   Use the [headless server](./packages/node/udev/50-elgato-stream-deck-headless.rules) version when your software will be running as a system service, and is not related to a logged in user

-   Use the [desktop user](./packages/node/udev/50-elgato-stream-deck-user.rules) version when your software is run by a user session on a distribution using systemd

Unplug and replug the device and it should be usable

## 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! Please don't hesitate to jump in if you'd like to, or even ask us questions if something isn't clear.

Please refer to the [Changelog](CHANGELOG.md) for project history details, too.