Lesson 20 Tut3: Difference between revisions

From English DMXC-Wiki
mNo edit summary
No edit summary
Line 5: Line 5:


{{DMXC3_lesson/en}}
{{DMXC3_lesson/en}}
 
{{NavigationTop-Tut3
| zurückLink = Lektion_19_Tut3
| zurückText = Lektion 19
| hoch = [[Tutorials DMXControl 3|Inhaltsverzeichnis]]
| vorLink = Lektion_21_Tut3
| vorText = Lektion 21
}}




==Overview==
==Overview==
In this lesson we will learn how to create and add new device definitions. You need to do this acivity only, if your device is not yet defined in the default set of DMXControl 3 device definitions.
In this lesson we will learn how to create and add new device definitions. You need to do this acivity only, if your device is not yet defined in the default set of DMXControl 3 device definitions.




Line 18: Line 24:


If you are familar with DDFs of DMXControl 2.0 you will see some important differences:
If you are familar with DDFs of DMXControl 2.0 you will see some important differences:
* There is no GUI description part, because DMXControl 3 doesn't provide the device context menues
* There is no GUI description part, because DMXControl 3 doesn't provide the device context menues
* Sone syntax elements are very similar (esp. in information part), i.e. you can reuse the existing DDFs
* Sone syntax elements are very similar (esp. in information part), i.e. you can reuse the existing DDFs
Line 26: Line 33:
At first lets have a view to a very simple DDF ("Generic RGB Par"):
At first lets have a view to a very simple DDF ("Generic RGB Par"):


<source lang="xml">
 
01 <?xml version="1.0" encoding="utf-8" ?>
----
 
<br>
 
{| cellspacing="1" cellpadding="1" border="0" align="center" width="200"
|-
| <source lang="xml">01 <?xml version="1.0" encoding="utf-8" ?>
  02 <device image="bild" type="DMXDevice">
  02 <device image="bild" type="DMXDevice">
  03  <information>
  03  <information>
Line 33: Line 46:
  05    <vendor>Generic</vendor>
  05    <vendor>Generic</vendor>
  06    <author>Arne Luedtke</author>
  06    <author>Arne Luedtke</author>
      <comment>KLEINER TEXT</comment>
  07  </information>
  07  </information>
  08  <functions>
  08  <functions>
Line 41: Line 55:
  13    </rgb>
  13    </rgb>
  14  </functions>
  14  </functions>
  15 </device>
  15 </device></source>  
</source>
|
<br> [[Image:DeviceManegerInfoBox.jpg|DeviceManegerInfoBox.jpg]]
 
<br>
 
<br>
 
<br>
 
<br>
 
|}
 
<br>
 
=  =


Line 01 is mandatory default line for describing the XML version.
Line 01 is mandatory default line for describing the XML version.
Line 48: Line 77:
* information part (lines 03 to 07), no need for further explanation.
* information part (lines 03 to 07), no need for further explanation.
* function(property) specification part (lines 08 to 14)
* function(property) specification part (lines 08 to 14)
The "image" can be replaced by another .gif or .png file.


The example device posesses one property: RGB colar mode. The mapping to DMX channels is described in lines 10 to 12.
The example device posesses one property: RGB colar mode. The mapping to DMX channels is described in lines 10 to 12.
Line 53: Line 84:
Thats all!
Thats all!


Following table shows the existing properties:
Following table shows the supported properties:


{| class="wikitable"
{| class="wikitable"
! Property
|-
! Description
! scope="col" | Property  
! Comment
! colspan="2" scope="col" | Description  
|-
! colspan="3" scope="col" | Comment
| switch
|-
| fixture has a switch channel
| switch  
| <switch dmxchannel="0" />
| colspan="2" | Fixture hat einen Switch-Kanal<br>
|-
| colspan="3" | <pre>&lt;switch dmxchannel="0" /&gt;</pre>
| dimmer
|-
| fixture has a dimmer channel
| dimmer  
| <dimmer dmxchannel="0" />
| colspan="2" | Fixture hat einen Dimmer-Kanal<br>
|-
| colspan="3" | <pre>&lt;dimmer dmxchannel="0" /&gt; </pre>
| fog
|-
| fod property
| fog  
| <fog dmxchannel="0" />
| colspan="2" | Nebel-Kanal<br>
|-
| colspan="3" | <pre>&lt;fog dmxchannel="0" /&gt;</pre>
| shutter
|-
| fixture has a shutter
| shutter  
| <shutter dmxchannel="4" />
| colspan="2" | Fixture hat einen Shutter<br>
|-
| colspan="3" | <pre>&lt;shutter dmxchannel="0" /&gt;</pre>
| strobe
|-
| fixture has a strobe channel
| strobe  
| <strobe dmxchannel="7" />
| colspan="2" | Fixture hat einen Strobe-Kanal<br>
|-
| colspan="3" | <pre>&lt;strobe dmxchannel="0" /&gt;</pre>
| rgb
|-
| fixture uses RGB color mode
| iris<br>
|<red dmxchannel="0" />
| colspan="2" | Fixture hat einen Iris-Kanal<br>
      <green dmxchannel="1" />
| colspan="3" | <pre>&lt;iris dmxchannel="0"/&gt;</pre>
      <blue dmxchannel="2" />
|-
|-
| focus<br>
| position
| colspan="2" | Fixture hat einen Fokus-Kanal<br>
| fixture has pan/tilt control
| colspan="3" | <pre>&lt;focus dmxchannel="0"/&gt;</pre>
| <position>
|-
      <pan dmxchannel="0" >
| zoom<br>
        <range range="170" />
| colspan="2" | Fixture hat einen Zoom-Kanal<br>
      </pan>
| colspan="3" | <pre>&lt;zoom dmxchannel="0"/&gt;</pre>
      <tilt dmxchannel="1" >
|-
        <range range="110" />
| rgb  
      </tilt>
| colspan="2" | Fixture hat die RGB-Funktion
|-
| colspan="3" | <pre>&lt;rgb&gt;
| color wheel
  &lt;red dmxchannel="0" /&gt;
| fixtures contains color wheel
  &lt;green dmxchannel="1" /&gt;
| <colorwheel dmxchannel="2"/>
  &lt;blue dmxchannel="2" /&gt;
|-
&lt;/rgb&gt;
| gobo wheel
</pre>
| fixtures contains gobo wheel
|-
| <gobowheel dmxchannel="2"/>
| cmy<br>
|-
| colspan="2" | Fixture hat die CMY-Funktion<br>
|}
| colspan="3" | <pre>&lt;cmy&gt;
  &lt;cyan dmxchannel="0"/&gt;
  &lt;magenta dmxchannel="1"/&gt;
  &lt;yellow dmxchannel="2"/&gt;
&lt;/cmy&gt;
</pre>
|-
| position  
| colspan="2" | Fixture hat Pan und/ oder Tilt
| nowrap="nowrap" colspan="3" | <pre>&lt;position&gt;
  &lt;pan dmxchannel="0"&gt;
    &lt;range range="540" /&gt;
  &lt;/pan&gt;
  &lt;tilt dmxchannel="1"&gt;
    &lt;range range="246" /&gt;
  &lt;/tilt&gt;
&lt;/position&gt;
</pre>
|-
| color wheel  
| colspan="2" | Fixture mit Farbrad
| colspan="3" | <pre>&lt;colorwheel dmxchannel="0"&gt;
  &lt;step type="color" val="#ffffff" caption="Weiß" mindmx="0" maxdmx="0" /&gt;
  &lt;step type="color" val="#00bd52" caption="Grün 203" mindmx="32" maxdmx="32" /&gt;
  &lt;step type="color" val="#080094" caption="Blau 108" mindmx="64" maxdmx="64" /&gt;
  &lt;step type="color" val="#8e10bc" caption="UV" mindmx="96" maxdmx="96" /&gt;
  &lt;step type="color" val="#eedefe" caption="1/2 Minus Green" mindmx="128" maxdmx="128" /&gt;
  &lt;step type="color" val="#ffffff" caption="Weiß" mindmx="160" maxdmx="160" /&gt;
&lt;/colorwheel&gt;
</pre>
|-
| rowspan="4" | gobo wheel  
| rowspan="3" | Fixture mit Gobobrad
| valign="top" nowrap="nowrap" |
<br>
 
Goborotation
 
| valign="top" nowrap="nowrap" rowspan="3" | <pre>&lt;gobowheel dmxchannel="0"&gt;
  &lt;goborotation dmxchannel="12" finedmxchannel="13"&gt;
    &lt;step type="stop" mindmx="0" maxdmx="2" /&gt;
    &lt;step type="stop" mindmx="253" maxdmx="255" /&gt;
    &lt;range type="cw" mindmx="3" maxdmx="127" minval="0,1" maxval="8" /&gt;
    &lt;range type="ccw" mindmx="252" maxdmx="128" minval="0,1" maxval="8" /&gt;
  &lt;/goborotation&gt;
  &lt;goboindex dmxchannel="8" finedmxchannel="9"&gt;
    &lt;range mindmx="0" maxdmx="255" range="395" /&gt;
  &lt;/goboindex&gt;
  &lt;step type="open" caption="Open" mindmx="0" maxdmx="11" /&gt;
  &lt;step type="gobo" caption="Gobo 1" mindmx="12" maxdmx="15" val="gobo1.png"&gt;
    &lt;step for="goborotation" mindmx="36" maxdmx="39" /&gt;
    &lt;step handler="shake" mindmx="60" maxdmx="71" minval="0,1" maxval="3" /&gt;
  &lt;/step&gt;
  ...
&lt;/gobowheel&gt;</pre>
|-
| valign="top" |
Gobopositi
 
|-
|
Rotation Gobo 1
 
Shake Gobo 1<br>
 
<br>
 
|}
 
Wenn das Fixture über ein Farb/Goborad verfügt , das sich Kontinuirlich drehen kann, dann schreibt man das so:<br>
<pre>&lt;gobowheel dmxchannel="0"&gt;
  &lt;step type="open" caption="Open" mindmx="0" maxdmx="0" /&gt;
  &lt;step type="gobo" caption="Gobo 1" mindmx="11" maxdmx="11" /&gt;
  ...
  &lt;wheelrotation&gt;
    &lt;range type="cw" mindmx="221" maxdmx="203" minval="0,1" maxval="2" /&gt;
    &lt;range type="ccw" mindmx="222" maxdmx="240" minval="0,1" maxval="2" /&gt;
  &lt;/wheelrotation&gt;
&lt;/gobowheel&gt;
</pre>
<br>
 
Wenn das Fixture über ein Farb/Goborad verfügt , das sich auf zufällige positionen drehen kann, dann schreibt man das so:<br>
<pre>&lt;gobowheel dmxchannel="0"&gt;
  &lt;step type="open" caption="Open" mindmx="0" maxdmx="0" /&gt;
  ...
  &lt;random&gt;
    &lt;step type="fast" mindmx="241" maxdmx="245" /&gt;
    &lt;step type="medium" mindmx="246" maxdmx="250" /&gt;
    &lt;step type="slow" mindmx="251" maxdmx="255" /&gt;
  &lt;/random&gt;
&lt;/gobowheel&gt;
</pre>
<br>
 
Wenn ein Gerät über feine Kanäle für z.B Zoom verfügt, dann schreibt man das so:<br>
<pre>&lt;zoom dmxchannel="0" finedmxchannel="1"/&gt;
</pre>
das funktioniert bei jedem Property.
 
<br>
 


The different intervals in a DMX channel are defined by the "step" tag:
The different intervals in a DMX channel are defined by the "step" tag:
Line 118: Line 250:
  <step type="color" val="#FF0000" caption="Rot" mindmx="32" maxdmx="63" />
  <step type="color" val="#FF0000" caption="Rot" mindmx="32" maxdmx="63" />
</source>
</source>
<br>
{{BoxHinweis|Text=Ein DDF-Creator für DMXControl 3 ist bereits in Arbeit. Bis dahin bitte die eigenen DDFs mit einem XML-Editor Eurer Wahl oder einfach mit einem Texteditor erstellen. Manchmal hilft es, ein bereits existierendes DDF zu kopieren und anzupassen.
Bitte sendet uns Eure neuen DDFs, damit wir sie in die Bibliothek aufnehmen können.}}








'''topics to be added (by beta testers)'''
* Please complete the description
* During the beta test there is no upload capability for new DDFs. This topic must be updated.


==Excercise==
==Excercise==
Line 131: Line 266:
* Create the DDF for your own device.
* Create the DDF for your own device.


==Additional links and references==
*




Line 146: Line 278:
__NOTOC__
__NOTOC__
__NOTITLE__
__NOTITLE__
{{NavigationTop-Tut3
| zurückLink = Lektion_19_Tut3
| zurückText = Lektion 19
| hoch = [[Tutorials DMXControl 3|Inhaltsverzeichnis]]
| vorLink = Lektion_21_Tut3
| vorText = Lektion 21
}}
[[Kategorie:DMXControl 3]]

Revision as of 08:52, 6 January 2013

Template:Hauptüberschrift

{{#tree:id=dmxc3|openlevels=1|root=DMXC 3 lessons|

}}

table of content


Overview

In this lesson we will learn how to create and add new device definitions. You need to do this acivity only, if your device is not yet defined in the default set of DMXControl 3 device definitions.


Lecture 20: Create new device definitions

A device definition file (short: DDF) is used to inform DMXControl about the properties of a device. A DDF is wiritten in XML language and stored in the path 

<DMXControl program path>\kernel\devices

If you are familar with DDFs of DMXControl 2.0 you will see some important differences:

  • There is no GUI description part, because DMXControl 3 doesn't provide the device context menues
  • Sone syntax elements are very similar (esp. in information part), i.e. you can reuse the existing DDFs
  • The function part is much more abstract: You make the definition mainly by properties and not by DMX channels

Currently there is no "DDF creator" available fpr DMXControl 3, we recommend to use a text editor or XML editor tool. (Hint: We need support for adaption of an existing DMXControl 2 php tool towards DMXControl 3)

At first lets have a view to a very simple DDF ("Generic RGB Par"): 



01 <?xml version="1.0" encoding="utf-8" ?>
 02 <device image="bild" type="DMXDevice">
 03  <information>
 04    <modell>Generic RGB PAR</modell>
 05    <vendor>Generic</vendor>
 06    <author>Arne Luedtke</author>
       <comment>KLEINER TEXT</comment>
 07  </information>
 08  <functions>
 09    <rgb>
 10      <red dmxchannel="0" />
 11      <green dmxchannel="1" />
 12      <blue dmxchannel="2" />
 13    </rgb>
 14  </functions>
 15 </device>


DeviceManegerInfoBox.jpg






Line 01 is mandatory default line for describing the XML version. Lines 02 and 15 provide the frame for the device definition that contains of two parts:

  • information part (lines 03 to 07), no need for further explanation.
  • function(property) specification part (lines 08 to 14)

The "image" can be replaced by another .gif or .png file.

The example device posesses one property: RGB colar mode. The mapping to DMX channels is described in lines 10 to 12.

Thats all!

Following table shows the supported properties:

Property Description Comment
switch Fixture hat einen Switch-Kanal
 
<switch dmxchannel="0" />
dimmer Fixture hat einen Dimmer-Kanal
 
<dimmer dmxchannel="0" />
fog Nebel-Kanal
 
<fog dmxchannel="0" />
shutter Fixture hat einen Shutter
 
<shutter dmxchannel="0" />
strobe Fixture hat einen Strobe-Kanal
 
<strobe dmxchannel="0" />
iris
 Fixture hat einen Iris-Kanal
 
<iris dmxchannel="0"/>
focus
 Fixture hat einen Fokus-Kanal
 
<focus dmxchannel="0"/>
zoom
 Fixture hat einen Zoom-Kanal
 
<zoom dmxchannel="0"/>
rgb Fixture hat die RGB-Funktion 
<rgb>
  <red dmxchannel="0" />
  <green dmxchannel="1" />
  <blue dmxchannel="2" />
</rgb>
cmy
 Fixture hat die CMY-Funktion
 
<cmy>
  <cyan dmxchannel="0"/>
  <magenta dmxchannel="1"/>
  <yellow dmxchannel="2"/>
</cmy>
position Fixture hat Pan und/ oder Tilt 
<position>
  <pan dmxchannel="0">
    <range range="540" />
  </pan>
  <tilt dmxchannel="1">
    <range range="246" />
  </tilt>
</position>
color wheel Fixture mit Farbrad 
<colorwheel dmxchannel="0">
   <step type="color" val="#ffffff" caption="Weiß" mindmx="0" maxdmx="0" />
   <step type="color" val="#00bd52" caption="Grün 203" mindmx="32" maxdmx="32" />
   <step type="color" val="#080094" caption="Blau 108" mindmx="64" maxdmx="64" />
   <step type="color" val="#8e10bc" caption="UV" mindmx="96" maxdmx="96" />
   <step type="color" val="#eedefe" caption="1/2 Minus Green" mindmx="128" maxdmx="128" />
   <step type="color" val="#ffffff" caption="Weiß" mindmx="160" maxdmx="160" />
</colorwheel>
gobo wheel Fixture mit Gobobrad


Goborotation 

<gobowheel dmxchannel="0">
  <goborotation dmxchannel="12" finedmxchannel="13">
    <step type="stop" mindmx="0" maxdmx="2" />
    <step type="stop" mindmx="253" maxdmx="255" />
    <range type="cw" mindmx="3" maxdmx="127" minval="0,1" maxval="8" />
    <range type="ccw" mindmx="252" maxdmx="128" minval="0,1" maxval="8" />
  </goborotation>
  <goboindex dmxchannel="8" finedmxchannel="9">
    <range mindmx="0" maxdmx="255" range="395" />
  </goboindex>
  <step type="open" caption="Open" mindmx="0" maxdmx="11" />
  <step type="gobo" caption="Gobo 1" mindmx="12" maxdmx="15" val="gobo1.png">
    <step for="goborotation" mindmx="36" maxdmx="39" />
    <step handler="shake" mindmx="60" maxdmx="71" minval="0,1" maxval="3" />
  </step>
  ...
</gobowheel>

Gobopositi

Rotation Gobo 1

Shake Gobo 1


Wenn das Fixture über ein Farb/Goborad verfügt , das sich Kontinuirlich drehen kann, dann schreibt man das so:

<gobowheel dmxchannel="0">
  <step type="open" caption="Open" mindmx="0" maxdmx="0" />
  <step type="gobo" caption="Gobo 1" mindmx="11" maxdmx="11" />
  ...
  <wheelrotation>
    <range type="cw" mindmx="221" maxdmx="203" minval="0,1" maxval="2" />
    <range type="ccw" mindmx="222" maxdmx="240" minval="0,1" maxval="2" />
  </wheelrotation>
</gobowheel>


Wenn das Fixture über ein Farb/Goborad verfügt , das sich auf zufällige positionen drehen kann, dann schreibt man das so:

<gobowheel dmxchannel="0">
  <step type="open" caption="Open" mindmx="0" maxdmx="0" />
  ...
  <random>
    <step type="fast" mindmx="241" maxdmx="245" />
    <step type="medium" mindmx="246" maxdmx="250" />
    <step type="slow" mindmx="251" maxdmx="255" />
  </random>
</gobowheel>


Wenn ein Gerät über feine Kanäle für z.B Zoom verfügt, dann schreibt man das so:

<zoom dmxchannel="0" finedmxchannel="1"/>

das funktioniert bei jedem Property.



The different intervals in a DMX channel are defined by the "step" tag: 

 <step val="0" mindmx="0" maxdmx="127" />
 <step val="100" mindmx="128" maxdmx="255" />

or: 

 <step type="color" val="#FFFFFF" caption="Weiß" mindmx="0" maxdmx="31" />
 <step type="color" val="#FF0000" caption="Rot" mindmx="32" maxdmx="63" />



 Important Hint Ein DDF-Creator für DMXControl 3 ist bereits in Arbeit. Bis dahin bitte die eigenen DDFs mit einem XML-Editor Eurer Wahl oder einfach mit einem Texteditor erstellen. Manchmal hilft es, ein bereits existierendes DDF zu kopieren und anzupassen.

Bitte sendet uns Eure neuen DDFs, damit wir sie in die Bibliothek aufnehmen können.




Excercise

  • Have a look into several device definitions before creating your own DDF.
  • Open the DDF for TS255. Separate the different properties by blank lines to get a better understanding.
  • Create the DDF for your own device.


Certificate

I have understood the topics of this lecture and want to continue with next course: Lesson 21



table of content

Kategorie:DMXControl 3

Retrieved from "https://wiki-en.dmxcontrol-projects.org/index.php?title=Lesson_20_Tut3&oldid=2006"