Elgato Stream Deck

This connection type provides direct USB HID access to supported Elgato Stream Deck devices.

BTConnect reads key presses from the device and can update the key displays with simple status tiles generated by BTConnect itself.

Supported Devices and Prerequisites

The current implementation supports the following Stream Deck models:

• Stream Deck V1
• Stream Deck V2
• Stream Deck Mini
• Stream Deck XL

The connection talks to the hardware directly via USB HID. The Elgato Stream Deck application is not required and should be closed while BTConnect is using the device.

Configuration

This connection type uses the common USB HID device settings.

Click Select Device to choose the Stream Deck from the list of available HID devices. BTConnect fills in the vendor ID, product ID, serial number and path automatically.

The device model is identified from the USB vendor and product ID. Supported product IDs are:

• 0fd9:0060 - Stream Deck V1
• 0fd9:006d - Stream Deck V2
• 0fd9:0063 - Stream Deck Mini
• 0fd9:006c - Stream Deck XL

If the selected HID device does not match one of these IDs, the connection can not be started.

When the connection starts, BTConnect resets the device, sets the brightness to 100, and initializes all keys with generated images.

Parameters

The connection provides the following parameters:

• brightness (integer, write-only) - set the device brightness in percent. Values outside the valid range are limited to 0 through 100.

For each key, BTConnect creates the following parameters:

• key/<number>/down (boolean, read-only) - current physical key state. true while the key is held down.
• key/<number>/press (trigger, read-only) - triggers once when the key is pressed.
• key/<number>/state/off (boolean, write-only) - show the key in the Off state.
• key/<number>/state/on (boolean, write-only) - show the key in the On state.
• key/<number>/state/hot (boolean, write-only) - show the key in the Hot state.

Key numbering starts at 1. The number of keys depends on the selected model:

• Stream Deck V1 / V2: 15
• Stream Deck Mini: 6
• Stream Deck XL: 32

Writing one of the state/* parameters updates the image shown on that key. BTConnect renders the key number centered on a colored background:

• off - black background with gray text
• on - green background with black text
• hot - red background with black text

Writing false to any state/* parameter returns that key to the off state.

Typical Usage

Typical uses for this connection include:

• reading key/<number>/press to trigger actions in Protocol Converter rules
• using key/<number>/state/on or key/<number>/state/hot to mirror external status information back to the key display
• adjusting brightness automatically for daytime or nighttime operation