Rust Elgato StreamDeck Driver and Utility

An 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.

Status

WIP. Pull requests more than welcome!

Features:

[ ] Connecting to devices
- [x] Connecting by VID/PID/Serial
- [ ] 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
[ ] Setting buttons
- [x] Writing colours
- [ ] Writing images (untested)
[ ] Devices
- [x] Stream Deck Mini
- [x] Stream Deck Original (untested)
- [ ] Stream Deck Original V2
- [ ] Stream Deck XL

Getting started

cargo add streamdeck to add this library to your project (with cargo-edit)
cargo install streamdeck to install the utility only
git clone git@github.com: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 commands and options.

``` streamdeck-cli 0.1.0 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 [default: 0063] --serial USB Device Serial --vid USB Device Vendor ID (VID) in hex [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 version Fetch the device firmware version ```

Related Works

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