Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ryankurte/rust-streamdeck

libusb based driver for Elgato StreamDeck devices
https://github.com/ryankurte/rust-streamdeck

driver elgato rust streamdeck usb

Last synced: 4 days ago
JSON representation

libusb based driver for Elgato StreamDeck devices

Awesome Lists containing this project

README

        

# Rust Elgato StreamDeck Driver and Utility

An [hidapi](https://crates.io/crates/hidapi) based driver for direct interaction with Elgato StreamDeck devices, this is intended to allow applications to use these devices directly and on arbitrary platforms (without the use of the Elgato SDK), heavily based on the [python streamdeck library](https://github.com/abcminiuser/python-elgato-streamdeck).

## Status

[![GitHub tag](https://img.shields.io/github/tag/ryankurte/rust-streamdeck.svg)](https://github.com/ryankurte/rust-streamdeck)
[![Travis Build Status](https://travis-ci.org/ryankurte/rust-streamdeck.svg?branch=master)](https://travis-ci.org/ryankurte/rust-streamdeck)
[![Crates.io](https://img.shields.io/crates/v/streamdeck.svg)](https://crates.io/crates/streamdeck)
[![Docs.rs](https://docs.rs/streamdeck/badge.svg)](https://docs.rs/streamdeck)

WIP. Pull requests more than welcome!

Features:

- [x] Connecting to devices
- [x] Connecting by VID/PID/Serial
- [x] Matching device _types_ (Mini etc.)
- [ ] Reading buttons
- [x] Poll based mode (w/ blocking / non-blocking selection and timeouts)
- [ ] Multi-threaded / async / callback driven mode
- [x] Writing brightness
- [x] Setting buttons
- [x] Writing colours
- [x] Writing images
- [ ] Devices
- [x] Stream Deck Mini
- [x] Stream Deck Original (untested)
- [x] Stream Deck Original V2
- [x] Stream Deck XL

## Getting started

- `cargo add streamdeck` to add this library to your project (with [cargo-edit](https://github.com/killercup/cargo-edit))
- `cargo install streamdeck` to install the utility only
- `git clone [email protected]:ryankurte/rust-streamdeck.git` to clone the repo

Building requires `libusb` and `hidapi` packages.

### Setting up permissions on linux

- `cp 40-streamdeck.rules /etc/udev/rules.d/` to allow user access to streamdeck devices
- note this may need to be edited with other vid/pid combinations for other devices
- `sudo udevadm control --reload-rules` to reload udev rules

### Using the CLI

`streamdeck-cli --help` displays available subcommands and options, passing `--help` to subcommands (ie. `streamdeck set-image --help`) displays options for that subcommand

```
streamdeck-cli 0.4.1
A CLI for the Elgato StreamDeck

USAGE:
streamdeck-cli [OPTIONS]

FLAGS:
-h, --help Prints help information
-V, --version Prints version information

OPTIONS:
--log-level Enable verbose logging [default: info]
--pid USB Device Product ID (PID) in hex [env: USB_PID=] [default: 0063]
--serial USB Device Serial [env: USB_SERIAL=]
--vid USB Device Vendor ID (VID) in hex [env: USB_VID=] [default: 0fd9]

SUBCOMMANDS:
get-buttons Fetch button states
help Prints this message or the help of the given subcommand(s)
reset Reset the attached device
set-brightness Set device display brightness
set-colour Set button colours
set-image Set button images
version Fetch the device firmware version

```

## Related Works

This library stands on the shoulders of giants (who had already done all the reversing work)...

You might also like to look at:

- [streamdeck-rs](https://crates.io/crates/streamdeck-rs) for writing plugins to interact with the official Elgato SDK
- [stream_deck_rs](https://crates.io/crates/stream_deck_rs) another project with similar goals
- [@cliffrowley's streamdeck protocol notes](https://gist.github.com/cliffrowley/d18a9c4569537b195f2b1eb6c68469e0)
- [python streamdeck library](https://github.com/abcminiuser/python-elgato-streamdeck)
- [node-elgato-stream-deck](https://github.com/Lange/node-elgato-stream-deck/blob/master/NOTES.md)

[Icons](icons/) from [material.io](https://material.io) and [brandeps.com](https://www.brandeps.com)