README
¶
streamdeck
A CLI application and Go library to control your Elgato Stream Deck on Linux.
If you're looking for a complete Linux service to control your StreamDeck, check out Deckmaster, which is based on this library.
Installation
Make sure you have a working Go environment (Go 1.9 or higher is required). See the install instructions.
To install streamdeck, simply run:
go get github.com/muesli/streamdeck/cmd/...
Configuration
On Linux you need to set up some udev rules to be able to access the device as a
regular user. Edit /etc/udev/rules.d/99-streamdeck.rules and add these lines:
SUBSYSTEM=="usb", ATTRS{idVendor}=="0fd9", ATTRS{idProduct}=="0060", MODE:="666", GROUP="plugdev"
SUBSYSTEM=="usb", ATTRS{idVendor}=="0fd9", ATTRS{idProduct}=="0063", MODE:="666", GROUP="plugdev"
SUBSYSTEM=="usb", ATTRS{idVendor}=="0fd9", ATTRS{idProduct}=="006c", MODE:="666", GROUP="plugdev"
Make sure your user is part of the plugdev group and reload the rules with
sudo udevadm control --reload-rules. Unplug and replug the device and you
should be good to go.
Usage
Control the brightness, in percent between 0 and 100:
streamdeck-cli brightness 50
Set an image on the first key (from the top-left):
streamdeck-cli image 0 image.png
Clear all images:
streamdeck-cli clear
Reset the device:
streamdeck-cli reset
Development
Documentation
¶
Index ¶
- Constants
- type Device
- func (d Device) Clear() error
- func (d Device) Close() error
- func (d Device) FirmwareVersion() (string, error)
- func (d *Device) Open() error
- func (d Device) ReadKeys() (chan Key, error)
- func (d Device) Reset() error
- func (d Device) SetBrightness(percent uint8) error
- func (d Device) SetImage(index uint8, img image.Image) error
- type Key
Constants ¶
const ( VID_ELGATO = 0x0fd9 PID_STREAMDECK = 0x0060 PID_STREAMDECK_V2 = 0x006d PID_STREAMDECK_MINI = 0x0063 PID_STREAMDECK_XL = 0x006c )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Device ¶
type Device struct {
ID string
Serial string
Columns uint8
Rows uint8
Pixels uint
// contains filtered or unexported fields
}
Device represents a single Stream Deck device
func (Device) FirmwareVersion ¶
FirmwareVersion returns the firmware version of the device
func (*Device) Open ¶
Open the device for input/output. This must be called before trying to communicate with the device
func (Device) SetBrightness ¶
SetBrightness sets the background lighting brightness from 0 to 100 percent
Source Files
Directories