rust-streamdeck

KO | EN

gitlite — search

#python #react #llm #golang #android #deep-learning #docker #macos #nodejs #windows #cli #kubernetes #awesome-list #mcp

rust-streamdeck

(★ 79)

libusb based driver for Elgato StreamDeck devices

rust-streamdeck Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 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
  - [x] Stream Deck Module 6Keys
  - [x] Stream Deck Module 15Keys
  - [x] Stream Deck Module 32Keys (untested)

## 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 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 subcommands and options, passing `--help` to subcommands (ie. `streamdeck set-image --help`) displays options for that subcommand

```
streamdeck-cli 0.9.0
Helper object for filtering device connections

USAGE:
    streamdeck-cli [OPTIONS] <SUBCOMMAND>

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

OPTIONS:
        --log-level <level>    Enable verbose logging [default: info]
        --pid <pid>            USB Device Product ID (PID) in hex [env: USB_PID=]  [default: 0063]
        --serial <serial>      USB Device Serial [env: USB_SERIAL=]
        --vid <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)
    probe             Search for connected streamdecks
    reset             Reset the attached device
    set-brightness    Set device display brightness
    set-colour        Simple Colour object for re-writing backgrounds etc
    set-image         Options for image loading and editing
    version           Fetch the device firmware version

```

## Related Works

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

rust-streamdeck

rust-streamdeck Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

rust-streamdeck

rust-streamdeck Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README