Umbra DMXC3: Unterschied zwischen den Versionen

Aus Deutsches DMXC-Wiki
Keine Bearbeitungszusammenfassung
Keine Bearbeitungszusammenfassung
 
Zeile 4: Zeile 4:




Der {{Manual Windowcaption|Umbra}} von DMXControl 3 der Teil der Software, welcher für die Kommunikation zwischen den verschiedenen Programmteilen im DMXControl-Netzwerk übernimmt.  
Der {{Manual Windowcaption|Umbra}} von DMXControl 3 ist die Komponente der Software, welcher für die Kommunikation zwischen den verschiedenen Programmteilen im DMXControl-Netzwerk übernimmt.  


{{Bild_mit_Unterschrift|Platzhalter.png|1|Umbra von DMXControl 3 nach dem Start.|800px}}
{{Bild_mit_Unterschrift|Platzhalter.png|1|Umbra von DMXControl 3 nach dem Start.|800px}}


= Überblick =
= Überblick =
Der Umbra ist wie der {{Manual Windowcaption|[[Kernel DMXC3|Kernel]]}} für den Anwender meist nicht sichtbar und arbeitet im Hintergrund. Man kann sich den Umbra aber auf Wunsch den Launcher anzeigen lassen, wenn man dort den Umschalter für {{Manual MenuText|Umbra verstecken (Hode Umbra)}} betätigt. Beendet man die Bedienoberfläche, wird der Umbra ebenfalls heruntergefahren.
Der Umbra ist wie der {{Manual Windowcaption|[[Kernel DMXC3|Kernel]]}} für den Anwender meist nicht sichtbar und arbeitet im Hintergrund. Man kann sich den Umbra aber auf Wunsch mit Hilfe des Launcher anzeigen lassen, wenn man dort den Umschalter für {{Manual MenuText|Umbra verstecken (Hide Umbra)}} betätigt. Beendet man die Bedienoberfläche, wird der Umbra ebenfalls heruntergefahren.
{{Manual Box | de | Hint | Der Umbra darf zu keinen Zeitpunkt beendet werden, wenn eine Show läuft. Beendet man den Umbra vorzeitig, kann die GUI oder andere Teilnehmer nicht mehr mit dem Kernel kommunizieren.}}
{{Manual Box | de | Hint | Der Umbra darf zu keinen Zeitpunkt beendet werden, wenn eine Show läuft. Beendet man den Umbra vorzeitig, kann die GUI oder andere Teilnehmer nicht mehr mit dem Kernel kommunizieren.}}


Zeile 23: Zeile 23:
|- class="hintergrundfarbe10"
|- class="hintergrundfarbe10"
! style="width: 250px;" | Befehl !! style="width: 500px" | Beschreibung !! Beispiel
! style="width: 250px;" | Befehl !! style="width: 500px" | Beschreibung !! Beispiel
|- class="hintergrundfarbe11"
| colspan="3" | '''Gruppe 1: Hauptmenü'''
|-
|-
| <code>shutdown</code>, <code>quit</code> <code>close</code>oder {{Manual Keyboard|Strg|C}} || Beendet den Kernel.
| <code>shutdown</code>, <code>quit</code> <code>close</code>oder {{Manual Keyboard|Strg|C}} || Beendet den Kernel.
Zeile 30: Zeile 28:
| <code>status</code> || Zeigt Statusinformationen an.
| <code>status</code> || Zeigt Statusinformationen an.
|-
|-
| <code>statistic</code> || Gibt Informationen zur Nachrichtenstatistik im Konsolenfenster aus.
| <code>statistic</code> || Gibt ausführliche Statistiken zu den verschickten Nachrichten der verschiedenen Services im Konsolenfenster aus.
|-
|-
| <code>busy</code> ||
| <code>busy</code> || Erstellt im Konsolenfenster eine Zusammenfassung der verschickten Nachrichten.
|-
|-
| <code>connections</code> ||
| <code>connections</code> || Zeigt die Anzahl der Nachrichten-Streams zum Client bzw. zum Server an.
|-
|-
| <code>kill {client}</code> || Sendet eine Benachrichtigung <code>{message}</code> an alle Clients. || <code>'''notification''' Bitte das Projekt sichern!</code>
| <code>kill</code> || Erstellt eine Liste von Clients, die eine Verbindung zum Umbra aufgebaut haben.
|-
|-
| <code>killf {client}</code> || Sendet eine Benachrichtigung <code>{message}</code> an ausgewählte Clients {sessionNames}. || <code>'''notify''' LICHT-PC1 Bitte das Projekt sichern!</code>
| <code>killf {number}</code> || Trennt die Verbindung des mittels <code>{number}</code> ausgewählten Clients.  
|-
|-
| <code>clear</code> || Leert die Konsole.
| <code>clear</code> || Leert die Konsole.
Zeile 50: Zeile 48:


= Nutzung =
= Nutzung =
== Verbindungsaufbau mittels Netzwerk-ID ==
Der Umbra arbeitet wie GUI und Kernel mit der Netzwerk-ID (Network ID). Standardmäßig wird bei der ersten Installation die Netzwerk-ID auf den Namen des PCs gesetzt. Haben alle Komponenten, also GUI, Umbra und Kernel die gleiche Netzwerk-ID und befinden sich im gleichen physischen Netzwerk, so verbinden sich die Komponenten automatisch.


== Network ID ==
Sollen im gleichen physischen Netzwerk mehrere DMXControl-Instanzen laufen, müssen die Komponenten unterschiedliche Netzwerk-IDs haben. Ansonsten versucht zum Beispiel die GUI auf einem zweiten PC eine Verbindung zum Umbra aufzubauen, der auf einem anderen PC läuft.  
Der Umbra arbeitet mit der NetworkID. Standardmäßig wird bei der ersten Installation die NetworkID auf den PC Namen gesetzt. Haben alle Programme (GUI, Kernel, Umbra) die gleiche und befinden sich im gleichen Netzwerk, so verbinden sich die Programme automatisch.
Sollen im gleichen Netzwerk mehrere DMXControl Instanzen laufen, müssen die Programme unterschiedliche NetworkIDs haben, sonst gibt es einen Konflikt zwischen den Porgrammen.  


== Verteilte Infrastruktur ==
== Verteilte Infrastruktur ==
Damit der getrennte Betrieb von {{Manual Windowcaption|[[GUI DMXC3|Bedienoberfläche]]}} und {{Manual Windowcaption|Kernel}} auf unterschiedlichen PCs funktioniert, sind folgende Voraussetzungen zu erfüllen:
Damit der getrennte Betrieb von {{Manual Windowcaption|[[GUI DMXC3|Bedienoberfläche]]}}, {{Manual Windowcaption|Umbra}} und {{Manual Windowcaption|[[Kernel DMXC3|Kernel]]}} auf unterschiedlichen PCs funktioniert, sind folgende Voraussetzungen zu erfüllen:
* Die Komponenten des DMXC3-Netzwerks müssen den Umbra über den Umbra TCP Port erreicht können. Mithilfe des Ping Test, kann eine Verbindung geprüft werden, gerade wenn ein komplexeres Setup aufgebaut werden soll. Voraussetzung ist, dass in der Firewall icmp freigegeben ist.
* Die Komponenten des DMXC3-Netzwerks müssen den Umbra über den Umbra TCP Port erreicht können. Mithilfe des Ping-Test kann eine Verbindung geprüft werden, gerade wenn ein komplexeres Setup aufgebaut werden soll. Voraussetzung ist, dass in der Firewall icmp freigegeben ist.
* Damit die Kommunikation zwischen den Komponenten im DMX3-Netzwerk aufgebaut werden kann, müssen in der Firewall die unten stehenden Ports<ref>Liste der standardisierten Netzwerk-Ports (englisch): https://en.wikipedia.org/wiki/List_of_TCP_and_UDP_port_numbers</ref> freigegeben in der Firewall werden. Üblicherweise fragt die Firewall dies beim ersten Start ab und trägt diese dann automatisch ein.
* Damit die Kommunikation zwischen den Komponenten im DMX3-Netzwerk aufgebaut werden kann, müssen in der Firewall die unten stehenden Ports<ref>Liste der standardisierten Netzwerk-Ports (englisch): https://en.wikipedia.org/wiki/List_of_TCP_and_UDP_port_numbers</ref> freigegeben in der Firewall werden. Üblicherweise fragt die Firewall dies beim ersten Start ab und trägt diese dann automatisch ein.


Zeile 81: Zeile 79:
Wichtig hierbei ist, dass der gesamte Pfad in Anführungszeichen gesetzt ist. Die zugelassenen Startparameter hängt dann sukzessive hinter dem Pfad zur Anwendung an, wobei dem Schlüsselwort immer zwei Minus-Zeichen vorangestellt ist. Um daher beispielsweise beim Start des Kernels direkt ein bestimmtes Projekt zu laden, sieht der vollständige Eintrag wie folgt aus:
Wichtig hierbei ist, dass der gesamte Pfad in Anführungszeichen gesetzt ist. Die zugelassenen Startparameter hängt dann sukzessive hinter dem Pfad zur Anwendung an, wobei dem Schlüsselwort immer zwei Minus-Zeichen vorangestellt ist. Um daher beispielsweise beim Start des Kernels direkt ein bestimmtes Projekt zu laden, sieht der vollständige Eintrag wie folgt aus:


{{Manual Filepath|C:\Program Files (x86)\DMXControl Projects\DMXControl 3.3.0\Umbra\Umbra.exe" '''--load''' "{Network-ID}"}}
{{Manual Filepath|C:\Program Files (x86)\DMXControl Projects\DMXControl 3.3.0\Umbra\Umbra.exe" '''--NetworkID''' "{Network-ID}"}}
 


Es sind pro Verknüpfung beliebig viele Startparameter zulässig, welche in der nachfolgenden Tabelle aufgeführt sind.
Es sind pro Verknüpfung beliebig viele Startparameter zulässig, welche in der nachfolgenden Tabelle aufgeführt sind.
Zeile 89: Zeile 86:
! style="width: 250px;" | Parameter !! style="width: 500px" | Beschreibung !! style="width: 375px" | Beispiel
! style="width: 250px;" | Parameter !! style="width: 500px" | Beschreibung !! style="width: 375px" | Beispiel
|-
|-
| <code>--hidden</code> || Der Kernel wird versteckt im Hintergrund ausgeführt und ist nicht in der Taskleiste sichtbar. ||
| <code>--NetworkID</code> || Der Umbra soll mit einer bestimmten Netzwerk-ID gestartet werden. ||
|-
| <code>--nonetwork</code> || Die Netzwerkfunktionalität bleibt deaktiviert, wodurch später in der GUI der Eintrag {{Manual MenuText|Connection}} in der Menüleiste des Hauptfensters nicht angezeigt wird. Der nonetwork-Modus kann dann genutzt werden, wenn Kernel und GUI auf dem selben PC arbeiten. ||
|}
|}



Aktuelle Version vom 29. März 2025, 18:55 Uhr

Books.png Artikel beschreibt
DMXControl 3.3.0
Stand: 29.03.2025
Umbra DMXC3
Inhaltsverzeichnis

A

B

C

D

E

F

G

H

K

L

M

N

O

P

R

S

T

U


Der Umbra von DMXControl 3 ist die Komponente der Software, welcher für die Kommunikation zwischen den verschiedenen Programmteilen im DMXControl-Netzwerk übernimmt.


Abbildung 1:Umbra von DMXControl 3 nach dem Start.
Abbildung 1: Umbra von DMXControl 3 nach dem Start.

Überblick

Der Umbra ist wie der Kernel für den Anwender meist nicht sichtbar und arbeitet im Hintergrund. Man kann sich den Umbra aber auf Wunsch mit Hilfe des Launcher anzeigen lassen, wenn man dort den Umschalter für « Umbra verstecken (Hide Umbra) » betätigt. Beendet man die Bedienoberfläche, wird der Umbra ebenfalls heruntergefahren.

Wichtiger Hinweis Der Umbra darf zu keinen Zeitpunkt beendet werden, wenn eine Show läuft. Beendet man den Umbra vorzeitig, kann die GUI oder andere Teilnehmer nicht mehr mit dem Kernel kommunizieren.

Bedienelemente

Der Umbra ist als Konsolenfenster konzipiert und verfügt deswegen über keine grafischen Bedienelemente. Die Steuerung des Umbras funktioniert ausschließlich über Kommandozeilenparameter.

Komandozeilenparameter

Der Umbra kann über folgende Kommandozeilenbefehle um genauere Informationen angesprochen werden, um mehr über den Status des Umbra zu erfahren. Auch sind einfache Tests möglich. Die Anzeigesprache und Kommandos sind in englisch und wurden nicht übersetzt.

Abbildung 2:Kommandozeilenparameter des Umbras.
Abbildung 2: Kommandozeilenparameter des Umbras.
Befehl Beschreibung Beispiel
shutdown, quit closeoder Strg + C Beendet den Kernel.
status Zeigt Statusinformationen an.
statistic Gibt ausführliche Statistiken zu den verschickten Nachrichten der verschiedenen Services im Konsolenfenster aus.
busy Erstellt im Konsolenfenster eine Zusammenfassung der verschickten Nachrichten.
connections Zeigt die Anzahl der Nachrichten-Streams zum Client bzw. zum Server an.
kill Erstellt eine Liste von Clients, die eine Verbindung zum Umbra aufgebaut haben.
killf {number} Trennt die Verbindung des mittels {number} ausgewählten Clients.
clear Leert die Konsole.
width {Zeichenzahl} Legt die Breite der Konsole fest (Anzahl der Zeichen).
help Hilfemenü aufrufen (auch über ? erreichbar).


Wichtiger Hinweis Enthält ein eingegebener Pfad Leer- oder Sonderzeichen, so sind die Anführungszeichen zwingend notwendig.

Nutzung

Verbindungsaufbau mittels Netzwerk-ID

Der Umbra arbeitet wie GUI und Kernel mit der Netzwerk-ID (Network ID). Standardmäßig wird bei der ersten Installation die Netzwerk-ID auf den Namen des PCs gesetzt. Haben alle Komponenten, also GUI, Umbra und Kernel die gleiche Netzwerk-ID und befinden sich im gleichen physischen Netzwerk, so verbinden sich die Komponenten automatisch.

Sollen im gleichen physischen Netzwerk mehrere DMXControl-Instanzen laufen, müssen die Komponenten unterschiedliche Netzwerk-IDs haben. Ansonsten versucht zum Beispiel die GUI auf einem zweiten PC eine Verbindung zum Umbra aufzubauen, der auf einem anderen PC läuft.

Verteilte Infrastruktur

Damit der getrennte Betrieb von Bedienoberfläche, Umbra und Kernel auf unterschiedlichen PCs funktioniert, sind folgende Voraussetzungen zu erfüllen:

  • Die Komponenten des DMXC3-Netzwerks müssen den Umbra über den Umbra TCP Port erreicht können. Mithilfe des Ping-Test kann eine Verbindung geprüft werden, gerade wenn ein komplexeres Setup aufgebaut werden soll. Voraussetzung ist, dass in der Firewall icmp freigegeben ist.
  • Damit die Kommunikation zwischen den Komponenten im DMX3-Netzwerk aufgebaut werden kann, müssen in der Firewall die unten stehenden Ports[1] freigegeben in der Firewall werden. Üblicherweise fragt die Firewall dies beim ersten Start ab und trägt diese dann automatisch ein.

Damit das Automatische verbinden (Auto Discovery) funktioniert, müssen die PCs sich im gleichen Subnet befinden, da Broadcast nicht über eine Firewall hinweg funktioniert.

Port TCP UDP Beschreibung
17474 Inoffiziell DMXControl 3 Network Discovery
17475 Inoffiziell DMXControl 3 Network Broker

DMXC3 Icon V-Collection redo.png Weitere Informationen zum Arbeiten mit DMXControl 3 auf mehreren PCs sind im Artikel Netzwerk-Konzept beschrieben.

Startparameter

Startparameter gibt man in der Regel einer Verknüpfung mit, um eine Anwendung zu starten. Um dem Umbra einen Startparameter zu übergeben, legt wird eine neue Verknüpfung zur Anwendung angelegt und in den Eigenschaften das Feld für das Ziel angepasst. Standardmäßig steht in diesem Feld nur der vollständige Pfad zur Anwendung, wie zum Beispiel:

"C:\Program Files (x86)\DMXControl Projects\DMXControl 3.3.0\Umbra\Umbra.exe"

Wichtig hierbei ist, dass der gesamte Pfad in Anführungszeichen gesetzt ist. Die zugelassenen Startparameter hängt dann sukzessive hinter dem Pfad zur Anwendung an, wobei dem Schlüsselwort immer zwei Minus-Zeichen vorangestellt ist. Um daher beispielsweise beim Start des Kernels direkt ein bestimmtes Projekt zu laden, sieht der vollständige Eintrag wie folgt aus:

"C:\Program Files (x86)\DMXControl Projects\DMXControl 3.3.0\Umbra\Umbra.exe" --NetworkID "{Network-ID}""

Es sind pro Verknüpfung beliebig viele Startparameter zulässig, welche in der nachfolgenden Tabelle aufgeführt sind.

Parameter Beschreibung Beispiel
--NetworkID Der Umbra soll mit einer bestimmten Netzwerk-ID gestartet werden.

Konfigurations-Verzeichnis

Im Windows Explorer existiert nach dem erstmaligen Start des Kernels ein Verzeichnis, in dem verschiedene Einstellungen abgelegt werden. Standardmäßig befindet sich das Verzeichnis unter "C:\Users\{BENUTZERNAME}\AppData\Roaming\DMXControl Projects e.V\DMXControl\Umbra\Config", wobei "{BENUTZERNAME}" durch den Namen des aktuellen Benutzers des PCs zu ersetzen ist. Alternativ kann man das Verzeichnis auch über "%AppData%\Roaming\DMXControl Projects e.V.\Umbra\Config" erreichen.


Datei Beschreibung Beispiel Optional
UmbraSettings.xml Beinhaltet die NetworkID des Umbras Nein Nein

Links und Referenzen

Weiterführende Informationen

  1. Liste der standardisierten Netzwerk-Ports (englisch): https://en.wikipedia.org/wiki/List_of_TCP_and_UDP_port_numbers