Jkuehn: Created page with "{{Manual Header | Type = DMXC3 Main-Software | Version = 3.3.0}} {{Picture_with_subtitle|Streamdeck.jpg||Stream Deck|right|320px}} Who doesn’t know this? You’re running lights at an event and notice that the stage is nicely lit, but the labeling on your MIDI controller or the DMX console you’re using is impossible to read in the dark. A solution for this are so-called macro boards like the Stream Deck from ElgatoOfficial manufacturer website: https://www.elga..."

2025-03-04T19:47:17Z

Created page with "{{Manual Header | Type = DMXC3 Main-Software | Version = 3.3.0}} {{Picture_with_subtitle|Streamdeck.jpg||Stream Deck|right|320px}} Who doesn’t know this? You’re running lights at an event and notice that the stage is nicely lit, but the labeling on your MIDI controller or the DMX console you’re using is impossible to read in the dark. A solution for this are so-called macro boards like the Stream Deck from Elgato<ref>Official manufacturer website: https://www.elga..."

New page

{{Manual Header
| Type = DMXC3 Main-Software
| Version = 3.3.0}}

{{Picture_with_subtitle|Streamdeck.jpg||Stream Deck|right|320px}}
Who doesn’t know this? You’re running lights at an event and notice that the stage is nicely lit, but the labeling on your MIDI controller or the DMX console you’re using is impossible to read in the dark. A solution for this are so-called macro boards like the Stream Deck from Elgato<ref>Official manufacturer website: https://www.elgato.com/de/de</ref>. The following article describes the basic functions and their usage.

= General =
The Elgato Stream Deck is now available in various sizes and versions. While initially the versions only differed in the number of buttons, there are now versions with rotary encoders (knobs) and a touchbar. All devices share the feature that the buttons are equipped with a color display, so you can display custom text or symbols and change them dynamically. Technically, DMXControl 3 supports the following devices:

{| class="wikitable" style="text-align:center;"
|- class="hintergrundfarbe10"
! rowspan="2" style="width: 125px;" | Type !! rowspan="2" style="width: 75px;" | Revision !! rowspan="2" style="width: 125px;" | Buttons !! rowspan="2" style="width: 125px;" | Resolution !! colspan="2" | Support !! rowspan="2" | Notes
|- class="hintergrundfarbe10"
! style="width: 75px;" | Status !! style="width: 75px;" | DMXC- Version
|-
! rowspan="2" | StreamDeck Mini
| || rowspan="2" style="text-align:left;" | 2 x 3 Buttons || rowspan="2" | 72 x 72 Pixels || {{Yes}} || '''3.2.0''' ||
|-
| Rev. 2 || {{Yes}} || '''3.3.0''' || style="text-align:left;" |
|-
! rowspan="3" | StreamDeck (Standard)
| || rowspan="3" style="text-align:left;" | 3 x 5 Buttons || rowspan="3" | 72 x 72 Pixels || {{Yes}} || '''3.2.0'''
|-
| Rev. 2 || {{Yes}} || '''3.2.2''' ||
|-
| MK.2 || {{Yes}} || '''3.3.0''' ||
|-
! rowspan="2" | StreamDeck XL
| || rowspan="2" style="text-align:left;" | 4 x 8 Buttons || rowspan="2" | 96 x 96 Pixels || {{Yes}} || '''3.2.2'''
|-
| Rev. 2 || {{Yes}} || '''3.3.0''' || style="text-align:left;" |
|-
! Stream Deck +
| || style="text-align:left;" | 8 Buttons, 1 Touchbar, 4 Encoders || rowspan="2" | variable || rowspan="2" | {{No}} || rowspan="2" | || rowspan="2" style="text-align:left;" | More extensive changes and additions required for support
|-
! Stream Deck Neo
| || style="text-align:left;" | 8 Buttons, 1 Infobar, 2 Touchpoints
|}
{{Manual Box | en | Hint | New hardware revisions are generally always accompanied by an update to DMXControl 3.}}

The Stream Deck is connected to the PC via USB. It doesn’t matter whether the device is connected to the PC for the {{Manual Windowcaption|[[GUI DMXC3|Graphical User Interface (GUI)]]}} or for the {{Manual Windowcaption|[[Kernel DMXC3|Kernel]]}}. This allows the Stream Deck to be used at a different location than the Front-of-House (FoH). The XL version requires a USB 3.0 connection due to the larger displays on the buttons. The smaller versions can also be connected via a USB 2.0 port.

DMXControl 3 can also work with multiple Stream Decks simultaneously. The unique assignment is done via the Stream Deck’s serial number. Once the device is connected and the project is saved, the Stream Deck remains visible in both the input tree (Input-Baum) and output tree (Output-Baum) in the {{Manual Windowcaption|[[Input Assignment DMXC3|Input Assignments]]}}. Alternatively, instead of a fixed assignment, you can work with so-called {{Manual Windowcaption|[[Macroboard DMXC3|Macroboard Profiles]]}}. This allows for more flexible assignment and enables the preparation of multiple pages that can be switched live.
{{Manual Box | en | Important | To ensure a clean display and visualization on the buttons, the software for the Stream Deck must be closed while working with DMXControl 3.}}

Info: This article shows an example of using a Stream Deck XL. The number of buttons in the following screenshots depends on the device version.

= Functionality =
== Inputs and Outputs ==
Once the Stream Deck is connected to the PC and DMXControl 3 is started, the device will appear in the input and output tree under Input Assignment:

{{Picture_with_subtitle|Stream Deck input outputs.jpg|1|Stream Deck Input Assignment|center|320px}}

On the input side, the 4x8 buttons and a {{Manual Commands|Connected}} input are displayed. The node {{Manual Commands|Button 1.1}} is set to "high" when the button is pressed. Once released, it returns to "low". The {{Manual Commands|Connected}} input always outputs "high" when the Stream Deck with the corresponding serial number is connected to DMXControl 3. Otherwise, it outputs "low".

Through the output {{Manual Commands|Brightness}}, it is possible to adjust the brightness of the Stream Deck. The range is from 0 to 100. Using the outputs {{Manual Commands|Button (Bitmap) X.Y}}, a graphic can be passed to the corresponding display, which will then show it.

== Display ==
To display something on a screen, a button output is added to a connection set along with a {{Manual Objectcaption|[[Draw Bitmap (Input Assignment) DMXC3|Draw Bitmap Node]]}}. The output {{Manual Commands|Bitmap}} of the node is connected to the input {{Manual Commands|O}} of the Stream Deck output. By default, text is displayed on the screen.

{{Picture_with_subtitle |Stream Deck Draw Bitmap.jpg|2|Stream Deck Draw Bitmap|center|600px}}

In the settings of the node, you can adjust the font, font color, and more. {{Manual Reference |arrow| For more information, see the article about the {{Manual Windowcaption|[[Draw Bitmap (Input Assignment) DMXC3|Draw Bitmap Node]]}}}}. These settings don't need to be static. Some properties can also be changed dynamically by other nodes. This is explained in more detail in the following examples.

= Examples =
With DMXControl 3 and {{Manual Windowcaption|[[Input Assignment DMXC3|Input Assignment]]}}, it is possible to use a Stream Deck as another input and output device. Below are some examples of how you can assign the buttons and receive corresponding feedback.

== Start and stop cue list ==
The first example is likely to be needed frequently. Here, a {{Manual Windowcaption|[[Cuelist DMXC3|Cue List (Cuelist)]]}} is started by pressing the button, and stopped by pressing it again. Additionally, the display should show the name of the cue list and whether it is running, paused, or stopped.

{{Manual Box | en | Hint | This example only works as long as the cue list contains only one cue. If a chaser effect or something else is used, the example for "Cuelist Toggle Chaser" should be used.}}

{{Picture_with_subtitle |Stream Deck Cuelist Toggle IA.jpg|3|Cuelist Toggle Input Assignment|center|800px}}

Additionally, in the cue list "Full On," the option "Release at end mode" must be set to {{Manual Fields|With Go (With go)}}.

Explanation of how it works:

{{Manual Commands|Button 1.1}} is connected with {{Manual Commands|Go}} of the cue list "Full On." The {{Manual Commands|Name}} of the cue list is connected with the {{Manual Commands|Text}} input of the {{Manual Objectcaption|[[Draw Bitmap (Input Assignment) DMXC3|Draw Bitmap Node]]}}. If the name of the cue list is changed, the name on the display will also update. The {{Manual Commands|Status}} of the cue list goes to the input of the {{Manual Objectcaption|[[Input Selector (Input Assignment) DMXC3|Input Selector]]}}. Depending on the status of the cue list, a color is output at the exit.

{| class="wikitable centered" style="text-align:center; vertical-align:middle;"
|-
!style="width: 100px;" | Status
!style="width: 50px;" | Status Value
!style="width: 100px;" | Color
!style="width: 100px;" | RGB Value
|-
| Stopped || 0 || black || <code>0;0;0</code>
|-
| Paused || 1 || yellow || <code>130;130;0</code>
|-
| Running || 2 || green || <code>0;130;0</code>
|}

Each time the value changes at the input {{Manual Commands|O}} from the Bitmap output of the Stream Deck, the corresponding display will be updated. If the device is disconnected from the PC in between, it will only display something on the screen after the next cue list switch. In figure 3, you can see that the {{Manual Commands|Connected}} input is linked to the update of {{Manual Commands|Button (Bitmap) 1.1}}. This way, the display is updated each time it reconnects, showing the correct information.

The result on the Stream Deck display will look as follows:

== Start cue list only briefly ==
In the following example, a cue list should be active only as long as the button is pressed.

{{Picture_with_subtitle |Stream Deck Cuelist Flash IA.jpg|4|Cuelist Flash Input Assignment|center|800px}}

In contrast to the first example, a logic block with the function {{Manual Fields|Not}} must be placed behind the "Button 1.1." The output is connected to the {{Manual Commands|Stop}} of the {{Manual Objectcaption|[[Cuelist (Input Assignment) DMXC3|Cue List Node (Cuelist Node)]]}}.

== Devices or Device Groups ==
It is also possible to select devices or device groups with the buttons, for example {{Manual Windowcaption|[[Device DMXC3|Devices]]}} or {{Manual Windowcaption|[[Device Group DMXC3|Device Groups]]}}. The corresponding connection set has the following structure:

{{Picture_with_subtitle |Stream Deck Device IA.jpg|5|Select device Input Assignment|center|800px}}

On the Stream Deck, not only the images of the respective devices appear, but also the background color visually indicates which device or device group is currently selected. It is also possible to display the device’s image. It is important that an image has been selected in the properties of the corresponding device group. The image should be saved as a <code>.png</code> file with a transparent background.

== Speed Master ==
In the following example, a button should trigger the tempo for a {{Manual Objectcaption|[[Speed Master (Master) DMXC3|Speed Master]]}} and display the current speed accordingly:

{{Picture_with_subtitle |Stream Deck Speedmaster IA.jpg|6|Speedmaster Input Assignment|center|800px}}

The button is connected to the {{Manual Commands|Learn}} input of the {{Manual Objectcaption|[[Speed Master (Input Assignment) DMXC3|Speed Master]]}} node. Then, the output {{Manual Commands|BPM}} of the Speed Master node is connected to the input {{Manual Commands|0}} of the {{Manual Objectcaption|[[Format (Input Assignment) DMXC3|Format Node]]}}. In the settings, the format field should contain {{Manual Fields|Speed: {0:0} BPM}}. The output of the Format Node is connected to the {{Manual Commands|Text}} input of the {{Manual Objectcaption|[[Draw Bitmap (Input Assignment) DMXC3|Draw Bitmap Node]]}}. The current speed of Speedmaster 1 will now be displayed on the screen.

To enhance the visual effect, the button should also blink in the current speed. To do this, a converter node {{Manual Objectcaption|[[Beat to Bool (Input Assignment) DMXC3|Beat to Bool]]}} is connected to the {{Manual Commands|Select}} input of the {{Manual Objectcaption|[[Input Selector (Input Assignment) DMXC3|Input Selector]]}}. In this, for input {{Manual Commands|0}}, the RGB value <code>0;0;0</code> is set, and for input {{Manual Commands|1}}, the RGB value <code>130;0;0</code> is set. The output is connected to the {{Manual Commands|Background Color}} of the {{Manual Objectcaption|Draw Bitmap Node}}.

At a speed of 300 BPM, the chaser stays red almost continuously. If such speeds are needed, the value in the {{Manual Objectcaption|Beat to Bool}} node under {{Manual Fields|On Time}} must be reduced.

{{Picture_with_subtitle |Stream Deck Speedmaster Draw Bitmap.jpg|7|Speedmaster Draw Bitmap Settings|center|350px}}



= Links and References =
== Links ==
<references/>

<noinclude>
[[Category: Manual DMXControl 3]]
</noinclude>

[[de: Stream_Deck_DMXC3]]

Stream Deck DMXC3 - Revision history