DDF DMXC2

DDF DMXC2

Hinweis:
{{{1}}}

Überblick

Bild 1: Grafische Bühnenansicht mit DDF-Icon

Bild 2: Geöffnetes DDF-Fenster mit Steuerelementen

DDF ist die Abkürzung für "Device Definition File". Die DDF's sind die Gerätebeschreibung (Fixtures) in DMXControl, sie dienen dazu DMXControl die Funktionen des angeschlossenen DMX-Geräts mitzuteilen. Im DDF wird die Anzahl der benuzten Kanäle des DMX-Geräts definiert und ebenso die mögliche Steuerelemente wie:

• Positionseingabe-Steuerelement z.B. bei Movingheads und Scannern.
• RGB- bzw. CMY-Farbauswahl-Steuerelement zur Farbmischung bei z.B LED-Scheinwerfer oder Farbmischeinheiten bei Movingheads.
• Dropdown-Steuerelement
• Button-Steuerelement usw.

Die DDF's werden in der "Grafischen Bühnenansicht" mit einem Icon des Geräts angezeigt (siehe Bild 1), hier kann dann auch durch einen Klick auf das Icon, auf das DDF-Fenster mit den Steuerelementen zugegriffen werden (siehe Bild 2). Die Beschreibung der DMX-Geräten erfolgt in einem XML-Format, das durch DMXControl in die interne Gerätebeschreibung übersetzt wird.Die DDF's finden sich im Unterordner "Devices" des DMXControl-Hauptverzeichnisses. Die zugehörigen Icon-Bilder, welche in der "Grafischen Bühnenansicht" angezeigt werden, liegen in einem weiteren Unterordner namens "Images".

Vorgefertigte DDFs, die nicht bei der Installation mitgeliefert wurden, können Sie evtl. von der DMXControl-Homepage in der Gerätebibliothek beziehen.DDF's können auf einfache Weise mit einem XML-Editor (z.B. PSPad) oder auch mit dem DDFCreator erstellt werden. Sowohl die Erstellung eines DDF's mit einem XML-Editor als auch mit dem DDFCreator haben Vor- und Nachteile. Das Umschreiben eines bestehenden DDF's läst sich mit einem XML-Editor wesentlich schneller bewerkstelligen als mit dem DDFCreator, dagegen ist man mit dem DDFCreator wesentlich schneller bei der Erstellung einer neuen DDF-Oberfläche, mit Slidern, Buttons usw.Egal ob man nun den DDFCreator bevorzugt oder den XML-Editor, bei beiden benötigt man ein entsprechendes Hintergrundwissen um ein funktionierendes DDF zu erstellen. Dieses Wissen sollen Ihnen die nachfolgenden Kapitel vermittelt werden, unter anderem dient die Sprachreferenz als Nachschlagewerk

Beschreibung

XML (eXtensible Markup Language) ist eine im Internet sehr gebräuchliche Sprachsyntax, die z.B. in anderen Dialekten bei Webseiten oder WAP-Seiten verwendet wird. Aber sie müssen kein Experte sein, um eine neue Gerätebeschreibung zu manuell zu erstellen. Folgende einfache Hinweise genügen:

Bitte achten Sie darauf, dass Ihr Editor keine (unsichtbaren) Steuerzeichen abspeichert. Beim Windows-Editor oder PSPad wird es keine Probleme geben. Falls Sie Word o.ä. verwenden wollen, sollten Sie die Datei im Textformat speichern.

• Der DMXControl-Dialekt von XML verlangt zu jedem öffnenden Tag („<tag>“) immer ein schliessendes Tag („</tag>“). Nur die Tags der letzten Ebene werden gleich implizit abgeschlossen (z.B. <item caption= "Weiss" value="0" />).
• Die Endzeichen „/>“ und „</tag>“ sind semantisch äquivalent, also auch „<item caption="Weiss" value="0" > </item>“ ist gültig.
• Jeder Tag kann Attribute besitzen, die Sie unten in der Tabelle erklärt finden. Jeder Attributwert wird mit einem Gleichheitszeichen eingeleitet und der Wert muss immer in Doppelapostrophe eingeschlossen sein.
• Alle Tag- und Attribut-Bezeichner werden bei DMXControl in kleinen Buchstaben notiert.
• Die Tags sind hierarchisch zu definieren. Das sollten sie über entsprechende Einrückungen auch kenntlich machen.
• Die Reihenfolge der Attribute eines Tags ist in der Regel egal. Wo es ausnahmsweise doch auf die Reihenfolge ankommt, wird unten explizit beschrieben.
• Kommentarzeilen werden in der Form notiert „<! —Das ist ein Kommentar —>“
• Sie können sich xml-files (somit auch die DMX devices files) in übersichtlicher Form z.B. mit dem Internet Explorer anschauen.

So, das war es schon - schauen wir uns ein einfaches Beispiel an.

Beispiel: Gedimmter Scheinwerfer

Jedes Gerät sollte ein treffendes Icon erhalten, um in Bühnendarstellung eine angepasste Darstellung zu erhalten. Dieses Icon wird im Unterverzeichnis Images (Root:\Programme\DMXControl\Devices\Images) abgelegt.

Die Icons können in DMXControl hinterher noch geändert werden. (Kontextmenü der grafischen Bühnenansicht).

Die vorangestellten Zeilennummern des folgenden XML-Beispielfiles sind nicht einzufügen; sie dienen nur der Beschreibung des Beispiels:

1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <device image="light.gif" initsequence=“set 0 128“ >
3   <channels>
4     <function channel="0" minvalue="0" maxvalue="255" name="Helligkeit" fade="yes" />
5   </channels>
6   <form width="177" height="85">
7     <deviceimage top="0" left="0" />
8     <devicename top="0" left="40" />
9     <deviceadress top="16" left="40" />
10    <slider channel="0" startvalue="0" endvalue="255" top="40" left="0" height="41" width="176" default="0" />
11  </form>
12 </device>

Zeile   1		teilt dem Parser die verwendete XML-Version mit.
Zeile   2		definiert die globale Beschreibung des neuen Gerätetyps inklusive Verweis auf das zu verwendende Icon und einer Initialisierung des Gerätes (die optionale initsequence wurde hier demonstriert, ist aber bei einem Scheinwerfer nur bedingt sinnvoll. Der Dimmerkanal wird hier bei der Initialisierung auf DMX-Wert 128 gesetzt (50%)).
Zeile   3		zwischen Zeile 3 und 5 werden die DMX-Kanäle des Geräts definiert.
Zeile   4		ist die Kanalbeschreibung des ersten Kanals. Wichtig ist das die Kanalnummern immer bei Null anfangen, d.h. der erste Kanal ist channel="0" . Außerdem werden hier noch andere Parameter, sowie der Kanalname gesetzt.
Zeile   6		die Zeilen 6-9 beschreiben das Form, also die grafischen Koordinaten im Kontextmenü für das Gerätebild, Namen und Startadresse in der Einheit „Pixel“.
Zeile 10		hier folgen nun die Bedienelemente mit ihren Eigenschaften, in diesem Beispiel ein slider mit seinen grafischen Koordinaten und der Zuordnung zum betreffenden Kanal. Für andere Gerätetypen könnten hier auch Bedienelemente wie Radiobuttons, Dropdowns oder Buttons deklariert werden.

Bild 3: DDF-Dimmer

Die drei Buttons rechts oben (siehe Bild 3) Pin-Button, Move-Button, Close-Button werden standardmäßig generiert.

DDF erstellen

Bevor Sie ein neues DDF erstellen, schauen Sie bitte auf unserer Webseite in der Gerätebibliothek nach, ob es schon eine passende oder ähnliche Definitionen für Ihr Gerät gibt. Um ein neues DDF zu erstellen, modifizieren Sie am besten ein existierendes DDF eines ähnlichen Gerätes. Dies geht gerade mit dem textbasierten Ändern wesentlich schneller als mit dem DDF Creator. Wenn Sie Ihre Arbeit abgeschlossen haben, legen Sie einfach das xml-file im DMXControl-Verzeichnis in das Unterverzeichnis „devices“ in Ihrer DMX-Installation ab und speichern das entsprechende gif-Bild (im Format 32x32 Pixel, dabei hat sich der Transparenzmode bewährt) im Unterverzeichnis „images“ im „device“-Verzeichnis ab. Das Gerät sollte so beim nächsten Start von DMXControl sichtbar sein.

Sprachübersicht

Jede Beschreibung enthält vier Hauptteile (siehe Bild 4):

• Beschreibung globaler Eigenschaften "device" (im Beispiel Gedimmter Scheinwerfer Zeile 1-2)
• Beschreibung der einzelnen DMX-Kanäle "channels" (im Beispiel Gedimmter Scheinwerfer Zeile 3-5)
• Beschreibung des grafischen Kontextmenüs "form" (im Beispiel Gedimmter Scheinwerfer Zeile 6-11)
• Prozedurcode (optional, im Beispiel nicht enthalten)

Bild 4: Grundsätzlicher DDF-Aufbau

Alle Forms-Elemente müssen mit grafischen Koordinaten zur Positionierung auf dem DDF-Form versehen werden. Die Elemente „Label“ und „Line“ sind passiv und dienen nur der Gestaltung der Oberfläche. Die restlichen aktiven Elemente der Form (auch Steuerelemente genannt, z.B. onoff) können zur aktiven Steuerung des DMX-Gerätes eingesetzt werden.

Grafische Elemente

Das Bild 5 zeigt eine Übersicht über alle unterstützten grafischen Elemente. In den Erklärungstexten ist eine Zuordnung zu den erforderlichen Syntaxelementen vorgenommen.

Bild 5: Grafische Elemente

Das nachfolgende Bild 6 illustriert die Bedeutung der grafischen Koordinaten der Steuerelemente:

Bild 6: Grafische Koordinaten der Steuerelemente

Funktionale Elemente

Die aktiven Steuerungselemente interagieren in 3 möglichen Konzepten mit DMXControl bzw. dem Gerät, wobei bei der Definition eines konkreten Steuerelementes genau ein Konzept ausgewählt wird:

	Konzept	Beschreibung	Beispiel
1	Channel/Value concept	Über das channel-Attribut wird das Steuerelement einem konkreten Kanal zugeordnet. Im Steuer- element werden konkrete Werte oder Wertebereiche definiert, die bei der Betätigung des Steuer- elementes gesetzt werden.	- option Liste   caption="Sternenhimmel"   value="165" - Wertebereich des   Schiebereglers   startvalue="0"   endvalue="255"
2	Sequences	Eine Anweisungsfolge wird im Steuerelement als String definiert, die beim Betätigen ausgeführt wird.	clicksequence= “set 1 75; set 2 100“
3	Action/Procedures	Eine separat definierte Prozedur enthält komplexere Programm- anweisungen. Die Prozedur wird über das Action-Attribut zuge- ordnet und bei jedem Betätigen des Steuerelementes ausgeführt.	action="SetGobo"

Insbesondere bedeutet das, das Channel-Attribut und das Action-Attribut alternativ in den Steuerelementen verwenden werden können.

Für viele Anwendungen sind die ersten beiden Konzepte ausreichend.

So wie die Komplexität und Mächtigkeit der 3 Konzepte anwächst, steigen auch die Laufzeitanforderungen. Daher sollte immer die einfachste Variante zur Lösung einer Aufgabe gewählt werden. Auch bei der Kanalbeschreibung kann ein Action-Attribut verwendet werden. Das bedeutet, dass die Prozedur bei jeder Änderung des Kanal-Wertes aufgerufen wird. In Bild 7 ist ein Beispiel aufgezeigt, wie verschiedene Steuerelemente mit den Kanälen interagieren können. Die Kanalwerte werden über „channel_n“ adressiert und können über die oben genannten 3 Konzepte gesetzt werden. Der aktuelle Wert, der mit einem Steuerelement verbunden ist, wird über ein dem Steuerelement zugeordneten frei wählbaren Namen (Referenz) adressiert, hier mit „control_n“ bezeichnet.Im nachfolgenden Beispiel sind drei Steuerelementen „actions“ und zusätzlich „Referenznamen“ zugeordnet. Diese actions können einen oder mehrere Channel-Werte setzen und sollten daher in der Regel mit „SetName“ bezeichnet werden. Weiterhin ist eine „action“ den channel_3 zugeordnet.Das ist dafür vorgesehen, die aktuellen Kanal-Werte zu lesen und den Steuerelementen mitzuteilen. Daher wird eine solche Prozedur in der Regel den Namen „GetName“ bekommen, da sie aktuelle Kanalwerte lesen muss.

Bild 7: Interaction der Steuerelemente

Die Beschriftungen der Buttons haben hier keine Bedeutung.

Syntax

Dieses Kapitel beschreibt die Syntax der Device- und Forms-Konfigurationsfiles von DMXControl.

Generische Attribute

Zur Verkürzung der nach folgenden Tabellen werden sich oft wiederholende Attribute mit gleicher Bedeutung hier einmal global beschrieben.

Referenz	Attribut	Hierachie und Eigenschaft	Bemerkung	Beispiel
GP1	value	Zugeordneter DMX-Wert	Byte	0, 128, 255
GP2	caption	Beschreibender Aufzählungs- wert. Erklärender Name für eine Einstellung.	string	Dimmer, Strobe, usw.
GP3	top	Relative y-Koordinate des Elementes von der linken oberen Ecke	integer	top=“150“
GP4	left	Relative x-Koordinate des Elementes von der linken oberen Ecke.	integer	left=“100“
GP5	width	Breite des Elements	integer	width=“80“
GP6	height	Höhe des Elements	integer	height=“30“

Alle Koordinatenangaben (top, left, width, height) werden in Pixel angegeben.

Gerätebeschreibung

Tag	Attribut	Hierachie und Eigenschaft	Bemerkung	Beispiel
<device>		Level 1
	image	Dateiname des Icons.	string, Filename.gif	Moon.gif
	initsequence	Setzt Initialwerte für die einzelnen DMX-Kanäle des Gerätes	Optionale Benutzung z.B. für Scanner/MH Startposition	set 0 15; set 7 128;
<information>		Level 2 Ergänzender Kommentar.
<name>		Level 3 Beliebiger Text		Custom Scanner
<vendor>		Level 3 Beliebiger Text (Hersteller)	optional	Showtec
<deviceidentifier>		Level 3 Beliebiger Text (Herstellerbezeichnung)	optional	TG-3
<author>		Level 3 Beliebiger Text (Ersteller)	optional
<comment>		Level 3 Beliebiger Text (Kommentar).	optional
<help>		Level 2 Hilfetext (ASCII).	optional

Kanalbeschreibung

Tag	Attribut	Hierachie und Eigenschaft	Bemerkung	Beispiel
<channels>		Level 2 Pro DMX-Kanal ist ein “<function>”-Teil zu definieren
<function>		Level Subtag von “<channels>“
	channel	Interne DMX-Kanal-Nummer Kanalnr. müssen immer von 0 aufsteigend ohne Unterbrechung für die einzelnen Kanäle definiert werden	integer
	minvalue	Minimaler DMX Wert	integer
	maxvalue	Maximaler DMX Wert	integer
	name	Beschreibender Name für den Kanal	string	Helligkeit
	fade	Kanal-Überblendung	string	yes,no
	type	Kanal-Typ Wichtig für die Interne Daten- verarbeitung	string	dimmer, r,g,b, pan, panfine, tilt, tiltfine, color, gobo
	action	Aufruf einer Prozedur bei Änderung des Kanalwerts	string optional
<virtual>		Level 3 Subtag von “<channels>“
<channel>		Level 4 Subtag von “<virtual>“
	channel	Interne DMX-Kanal-Nummer Der drei dem virtuellen Dimmer zugeordneten Kanäle	integer

Der Kanaltyp (type) sollte für jeden Kanal auch vergeben werden, sofern dieser Kanal zum Typ passt. Es macht z.B. keinen Sinn jeden Kanal als Dimmer zu bezeichnen.

dimmer	reserviert für Kanäle die die Helligkeit regeln
r,g,b	reserviert für Kanäle von RGB LED-Geräten, "r" für den roten Kanal, "g" für den grünen Kanal, "b" für den blauen Kanal.
pan, panfine	reserviert für die Pan Kanäle von Scannern, Movingheads oder ähnlichen Geräten. Wobei pan dem Kanal für die Grobsteuerung zugeordnet wird und panfine dem Kanal für die Feinsteuerung, bei 16 Bit Geräten
tilt, tiltfine	wie bei pan und panfine aber für die Tiltachse
color, gobo	Können den entsprechenden Farb- und Goborad Kanälen zugeordnet werden
sonstige	alle anderen Kanäle benötigen keine Typbeschreibung

Menübeschreibung

Tag	Attribut	Hierachie und Eigenschaft	Bemerkung	Beispiel
<form>		Level 2 Subtag von “<device>“
	width height	Siehe Generische Attribute GP5; GP6	integer
<deviceimage>		'Level 3 Subtag von “<form>“; Absolute Position des angezeigten Bildes
	top left width height	Siehe Generische Attribute GP3 bis GP6	integer
<devicename>		'Level 3 Subtag von “<form>“; Absolute Position des angezeigten Namens
	top left width height	Siehe Generische Attribute GP3 bis GP6	integer
<deviceaddress>		'Level 3 Subtag von “<form>“; Absolute Position des angezeigten Basisadresse
	top left width height	Siehe Generische Attribute GP3 bis GP6	integer
<position>		Koordinatenkreuz für Scanner und Moving Lights
	top left width height	Siehe Generische Attribute GP3 bis GP6	integer

Der Positions-Pointer kann per Initsequenz positioniert werden

Steuerungselemente

<position> und <slider>

Tag	Attribut	Hierachie und Eigenschaft	Bemerkung	Beispiel
<position>		Level 3 Subtag von “<form>“; Erzeugt ein Positionierungs- feld zur Positionierung von Scannern oder Movingheads.	Durch einen Klick auf den Button unten rechts im DDF kann zwischen kartesischer und polarer Positionierung umgeschaltet werden.
	top left width height	Siehe Generische Attribute GP3 bis GP6	integer
<slider>		Level 3 Subtag von “<form>“; Erzeugt einen Schieberegler
	top left width height	Siehe Generische Attribute GP3 bis GP6	integer
	channel	Zugeordneter Kanal alternativ zu action	integer optional
	startvalue	Wertebereich des Schiebers (unterer Wert)	integer	0
	endvalue	Wertebereich des Schiebers (oberer Wert)	integer	255
	tickfreq	Skalierung, Abstand der Skalenunterteilung	integer	32
	smallchange	Änderungsrate z.B. beim Pfeiltastenscrollen	integer (VB-Eigenschaft)	20
	largechange	Änderungsrate z.B. beim Mausklicken (nicht ziehen)	integer (VB-Eigenschaft)	50
	name	Referenzname für procedure code (Variablenname)	string optional	StrobeSpeed
	action	Aufruf einer Prozedur bei Änderung am Slider alternativ zu channel	string optional	SetSpeed

<dropdown> und <options>

Tag	Attribut	Hierachie und Eigenschaft	Bemerkung	Beispiel
<dropdown>		Level 3 Subtag von “<form>“; Erzeugt ein Dropdown-Menü.
	top left width height	Siehe Generische Attribute GP3 bis GP6	integer
	channel	Zugeordneter Kanal alternativ zu action	integer optional
	name	Referenzname für procedure code (Variablenname)	string optional	Gobo
	action	Aufruf einer Prozedur bei Aufruf eines Dropdown- eintrags, alternativ zu channel	string optional	SetGobo
<item>		Level 4 Subtag von “<dropdown>“
	caption	Erklärender Name	string	Clear
	value	DMX-Wert zu caption	integer	0
<colorlist>		Fügen alle Einträge der dem Gerät zugewiesenen Colorliste ein.	optional Ersatz/ Ergänzung für Item
<gobolist>		Fügen alle Einträge der dem Gerät zugewiesenen Goboliste ein.	optional Ersatz/ Ergänzung für Item
<options>		Level 3 Subtag von “<form>“; Erzeugt einen Schieberegler
	top left	Siehe Generische Attribute GP3 & GP4	integer
	channel	Zugeordneter Kanal alternativ zu action	integer optional
	action	Aufruf einer Prozedur bei Auswahl im Dropdowneintrag, alternativ zu channel	optional	SetGoboSpeed
<option>		Level 4 Subtag von “<option>“
	caption	Siehe Generische Attribute GP2	string	off
	value	DMX-Wert zu caption	integer	0
	top left	Siehe Generische Attribute GP3 & GP4, relative Position zur Position von “<options>“	integer	left="0" top="0"

<onoff> und <command>

Tag	Attribut	Hierachie und Eigenschaft	Bemerkung	Beispiel
<onoff>		Level 3 Subtag von “<form>“; Erzeugt Button’s als Schalter
	top left width height	Siehe Generische Attribute GP3 bis GP6	integer
	channel	Zugeordneter Kanal alternativ zu action	integer optional
	name	Referenzname für procedure code (Variablenname)	string optional	Gobo
	action	Aufruf einer Prozedur beim betätigen des Buttons alternativ zu channel	string optional	SetOnOff
	caption	Erklärender Name	string	An/Aus
	color	Hex RGB-Farbwert des Button	string	color="#00ff00"
	onvalue	DMX-Wert für ON	integer	onvalue="150"
	offvalue	DMX-Wert für OFF	integer	offvalue="0"
	onsequence	Sequence, die bei ON ausgeführt wird	string	"set 0 230; set 1 25"
	offsequence	Sequence, die bei OFF ausgeführt wird	string	"set 0 0; set 1 0"
<command>		Level 3 Subtag von “<form>“; Erzeugt Button’s als Taster
	top left	Siehe Generische Attribute GP3 & GP4	integer
	name	Referenzname für procedure code (Variablenname)	string optional	Gobo
	action	Aufruf einer Prozedur beim betätigen des Buttons	string optional	SetOnOff
	caption	Erklärender Name	string	An/Aus
	color	Hex RGB-Farbwert des Button	string	color="#00ff00"
	clicksequence	Beim Buttonclick zu startende Aktivität ist im Attribut spezifiziert	string	"save 0; set 0 230; hold 5500; restore 0"
	downsequence	Beim Niederdrücken zu startende Aktivität ist im Attribut spezifiziert	string	"save 0; set 0 230; hold 5500; restore 0"
	upsequence	Beim Loslassen zu startende Aktivität ist im Attribut spezifiziert	string	"save 0; set 0 230; hold 5500; restore 0"

<colorpicker>

Tag	Attribut	Hierachie und Eigenschaft	Bemerkung	Beispiel
<colorpicker>		Level 3 Subtag von “<form>“; Erzeugt ein Dropdown-Menü.
	top left width height	Siehe Generische Attribute GP3 bis GP6	integer
	channel1	Zuordnung zum 1. Kanal Rot oder Cyan, alternativ zu action	integer optional
	channel2	Zuordnung zum 2. Kanal Grün oder Magenta, alternativ zu action	integer optional
	channel3	Zuordnung zum 3. Kanal Blau oder Yellow, alternativ zu action	integer optional
	name	Referenzname für procedure code (Variablenname)	string optional	ColRGB
	action	Aufruf einer Prozedur bei Änderung einer Farbe, alternativ zu channel1-3	string optional	SetColRGB
	mode	Auswahl der zwei Modi RGB oder CMY	string	mode=“cmy“
	layout	Auswahl von zwei verschiedenen Layouts des Colorpickers	integer	layout="1"

Beispiel:

<colorpicker mode="rgb" channel1="0" channel2="1" channel3="2" layout="2" top="40"
left="0" height="75" width="177"/>

Bitte halten Sie die Maustaste gedrückt, wenn Sie über das Dropdown-Menü die Einstellung im Farbbalken ändern wollen. Eine Direkteingabe des numerischen Wertes ist ebenfalls möglich. In Proceduren werden die Farbwerte über name:Farbkanal referenziert ({ColRGB:1}; {ColRGB:2}; {ColRGB:3})

Passive Gestaltungselemente

Tag	Attribut	Hierachie und Eigenschaft	Bemerkung	Beispiel
<line>		Level 3 Subtag von “<form>“; Gestaltungselement; Erzeugt ein Linie.
	x1; y1	Startkoordinate Linie	integer
	x2; y2	Endkoordinate Linie	integer
<label>		Level 3 Subtag von “<form>“; Gestaltungselement; zusätzliche Beschreibung eines Bedienelementes.
	top left	Siehe Generische Attribute GP3 bis GP4	integer
	caption	Anzuzeigender Text	string