Function elements (DDF-Syntax) DMXC3 - Revision history

Skistner at 11:16, 2 March 2025

2025-03-02T11:16:15Z

← Older revision		Revision as of 13:16, 2 March 2025
Line 1:		Line 1:
	{{~~Chaptertitle~~\|Version=~~DMXControl~~ 3.2.3}}		{{Manual Header
			\| Type = DMXC3 DDFs
	~~{{DMXC3 Manual-Navigation DDF~~		\| Version = 3.2.3
	\|~~backLink~~ = Basic structure (DDF-Syntax) DMXC3		\| LinkBackwards = Basic structure (DDF-Syntax) DMXC3
	\|~~backText~~ = Basic structure of DDFs		\| TextBackwards = Basic structure of DDFs
	\|~~forwardLink~~ = Basic rules (DDF-Syntax) DMXC3		\| LinkForwards = Basic rules (DDF-Syntax) DMXC3
	\|~~forwardText~~ = Basic rules of DDF creation		\| TextForwards = Basic rules of DDF creation
	}}		}}


	In addition to the general structure in the DDFs for DMXControl 3, there are various elements within the function part that are (almost) always used in all functions. These can be found in two places:		In addition to the general structure in the DDFs for DMXControl 3, there are various elements within the function part that are (almost) always used in all functions. These can be found in two places:
	* There are various additional attributes for all functions, hereinafter referred to as function attributes. Some of these function attributes are mandatory in order to fully define the used function.		* There are various additional attributes for all functions, hereinafter referred to as function attributes. Some of these function attributes are mandatory in order to fully define the used function.
	* Many functions require various subordinate function elements. These function elements define the value range of a DMX channel more precisely or establish predefined dependencies.		* Many functions require various subordinate function elements. These function elements define the value range of a DMX channel more precisely or establish predefined dependencies.


	= Function attributes =		= Function attributes =

Unknown user at 12:35, 10 February 2024

2024-02-10T12:35:30Z

← Older revision		Revision as of 14:35, 10 February 2024
Line 187:		Line 187:
	\|}		\|}

	''Further examples of using the <code>supporthandler</code> can be found in the articles on '''[[Color (DDF-Syntax) DMXC3#Color ~~Wheel~~\|Color ~~Wheel~~]]''' and '''[[Gobo (DDF-Syntax) DMXC3#Gobo ~~Wheel~~\|Gobo ~~Wheel~~]]'''.''		''Further examples of using the <code>supporthandler</code> can be found in the articles on '''[[Color (DDF-Syntax) DMXC3#Color wheel\|Color wheel]]''' and '''[[Gobo (DDF-Syntax) DMXC3#Gobo wheel\|Gobo wheel]]'''.''

	[[de:DDF-~~Funktionselemente~~ DMXC3]]		[[de:Funktionselemente (DDF-Syntax) DMXC3]]
	[[Category:DDF DMXControl 3]]		[[Category:DDF DMXControl 3]]

Unknown user at 09:38, 8 February 2024

2024-02-08T09:38:15Z

← Older revision		Revision as of 11:38, 8 February 2024
Line 3:		Line 3:
	{{DMXC3 Manual-Navigation DDF		{{DMXC3 Manual-Navigation DDF
	\|backLink = Basic structure (DDF-Syntax) DMXC3		\|backLink = Basic structure (DDF-Syntax) DMXC3
	\|backText = Basic ~~Structure~~ of DDFs		\|backText = Basic structure of DDFs
	\|forwardLink = Basic rules (DDF-Syntax) DMXC3		\|forwardLink = Basic rules (DDF-Syntax) DMXC3
	\|forwardText = Basic ~~Rules~~ of DDF ~~Creation~~		\|forwardText = Basic rules of DDF creation
	}}		}}

Line 13:		Line 13:
	* Many functions require various subordinate function elements. These function elements define the value range of a DMX channel more precisely or establish predefined dependencies.		* Many functions require various subordinate function elements. These function elements define the value range of a DMX channel more precisely or establish predefined dependencies.

	= Function ~~Attributes~~ =
	== Mandatory ~~Attributes~~ ==		= Function attributes =
	=== <code>dmxchannel</code>: DMX ~~Channel~~ ===		== Mandatory attributes ==
			=== <code>dmxchannel</code>: DMX channel ===
	The attribute <code>dmxchannel</code>, including the variations <code>finedmxchannel</code>, <code>ultradmxchannel</code>, and <code>ultrafinedmxchannel</code>, specifies the DMX channel on which the corresponding function is located. In most cases, a function only has an 8-bit resolution, which is why the attribute <code>dmxchannel</code> is only needed in many places.		The attribute <code>dmxchannel</code>, including the variations <code>finedmxchannel</code>, <code>ultradmxchannel</code>, and <code>ultrafinedmxchannel</code>, specifies the DMX channel on which the corresponding function is located. In most cases, a function only has an 8-bit resolution, which is why the attribute <code>dmxchannel</code> is only needed in many places.

Line 55:		Line 56:
	\|}		\|}

	== Optional ~~Attributes~~ ==		== Optional attributes ==
	=== <code>defaultval</code>: Initial ~~Value~~ or ~~Default Value~~ ===		=== <code>defaultval</code>: Initial value or default value ===
	Upon request, it is possible to specify for a selection of functions which value they should assume, deviating from the standard definition in DMXControl 3. This is done via the <code>defaultval</code> attribute. This attribute can be used for the following functions:		Upon request, it is possible to specify for a selection of functions which value they should assume, deviating from the standard definition in DMXControl 3. This is done via the <code>defaultval</code> attribute. This attribute can be used for the following functions:
	* Intensity		* Intensity
Line 98:		Line 99:
	\|}		\|}

	= Function ~~Elements~~ =		= Function elements =
	The available function elements are generally used whenever multiple functions are accommodated on one DMX channel. These can be various strobe modes such as linear, random. In the case of a color wheel or a gobo wheel, the various colors and gobos must be specified. But even with a shutter, there are already two functions directly, namely closed and open.		The available function elements are generally used whenever multiple functions are accommodated on one DMX channel. These can be various strobe modes such as linear, random. In the case of a color wheel or a gobo wheel, the various colors and gobos must be specified. But even with a shutter, there are already two functions directly, namely closed and open.

Line 110:		Line 111:
	Function elements such as the <code>supporthandler</code>, however, are optional per se and therefore only used in certain application cases. Corresponding typical examples are listed for the respective functions.		Function elements such as the <code>supporthandler</code>, however, are optional per se and therefore only used in certain application cases. Corresponding typical examples are listed for the respective functions.

	== Required ~~Function Elements~~ ==		== Required function elements ==
	=== <code>step</code>: Specification of ~~Individual Steps~~ ===		=== <code>step</code>: Specification of individual steps ===
	The <code>step</code> function element always consists of the actual <code>step</code> tag, the <code>type</code> attribute, and the attributes for the minimum DMX value <code>mindmx</code> and the maximum DMX value <code>maxdmx</code> for the <code>step</code>. The value for the <code>type</code> attribute always depends on the property of the DMX channel to be represented. The permissible values are specified when describing the respective function. It is important to know here that the HAL always takes the average value between <code>mindmx</code> and <code>maxdmx</code>. In relation to the following example, this would be the DMX value 227.		The <code>step</code> function element always consists of the actual <code>step</code> tag, the <code>type</code> attribute, and the attributes for the minimum DMX value <code>mindmx</code> and the maximum DMX value <code>maxdmx</code> for the <code>step</code>. The value for the <code>type</code> attribute always depends on the property of the DMX channel to be represented. The permissible values are specified when describing the respective function. It is important to know here that the HAL always takes the average value between <code>mindmx</code> and <code>maxdmx</code>. In relation to the following example, this would be the DMX value 227.

Line 118:		Line 119:
	</syntaxhighlight>		</syntaxhighlight>

	=== <code>range</code>: Specification of an ~~Adjustable Range~~ ===		=== <code>range</code>: Specification of an adjustable range ===
	The <code>range</code> function element is structured similarly to the <code>step</code> function element. The most significant difference is the addition of the <code>minval</code> and <code>maxval</code> attributes. Here, for example, the following are specified:		The <code>range</code> function element is structured similarly to the <code>step</code> function element. The most significant difference is the addition of the <code>minval</code> and <code>maxval</code> attributes. Here, for example, the following are specified:
	* the minimum and maximum strobe frequency		* the minimum and maximum strobe frequency
Line 130:		Line 131:
	</syntaxhighlight>		</syntaxhighlight>

	== Optional ~~Function Elements~~ ==		== Optional function elements ==
	=== <code>supporthandler</code>: Value-dependent ~~Control~~ of DMX ~~Channels~~ ===		=== <code>supporthandler</code>: Value-dependent control of DMX channels ===
	Some devices have one or more functions that work according to the principle: "One selects the function on one DMX channel and controls the speed via a second DMX channel". An illustrative example here could be a gobo wheel with rotating gobos, which can also be indexed additionally. Here, three different functions are already present:		Some devices have one or more functions that work according to the principle: "One selects the function on one DMX channel and controls the speed via a second DMX channel". An illustrative example here could be a gobo wheel with rotating gobos, which can also be indexed additionally. Here, three different functions are already present:
	* Indexing of gobos		* Indexing of gobos
Line 159:		Line 160:
	In the following line, which is a subordinate element to the <code>range</code> element, it is specified on which		In the following line, which is a subordinate element to the <code>range</code> element, it is specified on which

	DMX value the DMX channel must be set to select the corresponding function, as soon as one uses the gobo indexing function, for example, in this example. In addition to the corresponding value range via the <code>mindmx</code> and <code>maxdmx</code> attributes, this line receives the second part of the <code>supporthandler</code>. This consists of the <code>handler</code> attribute and the keyword previously chosen. Here it is the keyword <code>goboindex</code>, which is deposited with the prefix <code>support-</code> as the value. With this, all definitions within this line are completed.		DMX value the DMX channel must be set to select the corresponding function, as soon as one uses the gobo indexing function, for example, in this example. In addition to the corresponding value range via the <code>mindmx</code> and <code>maxdmx</code> attributes, this line receives the second part of the <code>supporthandler</code>. This consists of the <code>handler</code> attribute and the keyword previously chosen. Here it is the keyword <code>goboindex</code>, which is deposited with the prefix <code>support-</code> as the value. With this, all definitions within this line are completed.

	<syntaxhighlight lang="xml"><step handler="support-goboindex" mindmx="0" maxdmx="15" /></syntaxhighlight>		<syntaxhighlight lang="xml"><step handler="support-goboindex" mindmx="0" maxdmx="15" /></syntaxhighlight>

	{{Manual Box \| en \| Important \| The line specifying the DMX value for selecting the corresponding function must be added to every definition that requires a specific DMX value on the selection channel. In the case, for example, of gobo rotation, this means that this addition may need to be inserted three times: rotation clockwise, stop, rotation counterclockwise.}}		{{Manual Box \| en \| Important \| The line specifying the DMX value for selecting the corresponding function must be added to every definition that requires a specific DMX value on the selection channel. In the case, for example, of gobo rotation, this means that this addition may need to be inserted three times: rotation clockwise, stop, rotation counterclockwise.}}


	Subsequently, the remaining part for the implementation of gobo indexing is completed. In sum, the code snippet looks like this.		Subsequently, the remaining part for the implementation of gobo indexing is completed. In sum, the code snippet looks like this.

Unknown user at 09:29, 8 February 2024

2024-02-08T09:29:45Z

← Older revision		Revision as of 11:29, 8 February 2024
Line 7:		Line 7:
	\|forwardText = Basic Rules of DDF Creation		\|forwardText = Basic Rules of DDF Creation
	}}		}}


	In addition to the general structure in the DDFs for DMXControl 3, there are various elements within the function part that are (almost) always used in all functions. These can be found in two places:		In addition to the general structure in the DDFs for DMXControl 3, there are various elements within the function part that are (almost) always used in all functions. These can be found in two places:
Line 188:		Line 189:
	''Further examples of using the <code>supporthandler</code> can be found in the articles on '''[[Color (DDF-Syntax) DMXC3#Color Wheel\|Color Wheel]]''' and '''[[Gobo (DDF-Syntax) DMXC3#Gobo Wheel\|Gobo Wheel]]'''.''		''Further examples of using the <code>supporthandler</code> can be found in the articles on '''[[Color (DDF-Syntax) DMXC3#Color Wheel\|Color Wheel]]''' and '''[[Gobo (DDF-Syntax) DMXC3#Gobo Wheel\|Gobo Wheel]]'''.''

			[[de:DDF-Funktionselemente DMXC3]]
	[[Category:DDF DMXControl 3]]		[[Category:DDF DMXControl 3]]

Unknown user at 23:16, 7 February 2024

2024-02-07T23:16:18Z

← Older revision		Revision as of 01:16, 8 February 2024
Line 1:		Line 1:
	{{Chaptertitle\| ~~version~~=DMXControl 3.2.3}}		{{Chaptertitle\|Version=DMXControl 3.2.3}}

	{{DMXC3 Manual-Navigation DDF		{{DMXC3 Manual-Navigation DDF

Unknown user at 21:07, 6 February 2024

2024-02-06T21:07:28Z

← Older revision		Revision as of 23:07, 6 February 2024
Line 4:		Line 4:
	\|backLink = Basic structure (DDF-Syntax) DMXC3		\|backLink = Basic structure (DDF-Syntax) DMXC3
	\|backText = Basic Structure of DDFs		\|backText = Basic Structure of DDFs
	\|~~nextLink~~ = Basic rules (DDF-Syntax) DMXC3		\|forwardLink = Basic rules (DDF-Syntax) DMXC3
	\|~~nextText~~ = Basic Rules of DDF Creation		\|forwardText = Basic Rules of DDF Creation
	}}		}}

Unknown user at 21:05, 6 February 2024

2024-02-06T21:05:55Z

Unknown user at 20:19, 6 February 2024

2024-02-06T20:19:03Z

← Older revision		Revision as of 22:19, 6 February 2024
Line 4:		Line 4:
	\|backLink = Basic structure (DDF-Syntax) DMXC3		\|backLink = Basic structure (DDF-Syntax) DMXC3
	\|backText = Basic Structure of DDFs		\|backText = Basic Structure of DDFs
	\|nextLink = ~~DDF-Basic_Rules_~~(DDF-Syntax)~~_DMXC3~~		\|nextLink = Basic rules (DDF-Syntax) DMXC3
	\|nextText = Basic Rules of DDF Creation		\|nextText = Basic Rules of DDF Creation
	}}		}}

Unknown user: Created page with "{{Chaptertitle| version=DMXControl 3.2.3}} {{DMXC3 Manual-Navigation DDF |backLink = Basic structure (DDF-Syntax) DMXC3 |backText = Basic Structure of DDFs |nextLink = DDF-Ba..."

2024-02-06T20:18:00Z

Created page with "{{Chaptertitle| version=DMXControl 3.2.3}} {{DMXC3 Manual-Navigation DDF |backLink = Basic structure (DDF-Syntax) DMXC3 |backText = Basic Structure of DDFs |nextLink = DDF-Ba..."

New page

{{Chaptertitle| version=DMXControl 3.2.3}}

{{DMXC3 Manual-Navigation DDF
|backLink = Basic structure (DDF-Syntax) DMXC3
|backText = Basic Structure of DDFs
|nextLink = DDF-Basic_Rules_(DDF-Syntax)_DMXC3
|nextText = Basic Rules of DDF Creation
}}

In addition to the general structure in the DDFs for DMXControl 3, there are various elements within the function part that are (almost) always used in all functions. These can be found in two places:
* There are various additional attributes for all functions, hereinafter referred to as function attributes. Some of these function attributes are mandatory in order to fully define the used function.
* Many functions require various subordinate function elements. These function elements define the value range of a DMX channel more precisely or establish predefined dependencies.

= Function Attributes =
== Mandatory Attributes ==
=== <code>dmxchannel</code>: DMX Channel ===
The attribute <code>dmxchannel</code>, including the variations <code>finedmxchannel</code>, <code>ultradmxchannel</code>, and <code>ultrafinedmxchannel</code>, specifies the DMX channel on which the corresponding function is located. In most cases, a function only has an 8-bit resolution, which is why the attribute <code>dmxchannel</code> is only needed in many places.

The reason why up to four attributes are needed to specify the DMX channel is that only a total of 256 different values can be transmitted on each DMX channel. The values range from DMX value 0 to DMX value 255. This describes the classical resolution or accuracy of a DMX channel of 8 bits.
To achieve fine resolutions with certain functions such as Pan, Tilt, or Dimmer, additional DMX channels are used to increase the resolution. In this case, a resolution with 16 bits is referred to, or the second DMX channel for the Pan function is called Pan fine.

DMXControl 3 currently supports resolutions for all functions up to 32 bits. For this purpose, four DMX channels are combined to represent the function in this resolution. The following designations are used in the DDFs for this purpose:
* <code>dmxchannel</code> for 8-bit resolution
* <code>finedmxchannel</code> for 16-bit resolution
* <code>ultradmxchannel</code> for 24-bit resolution
* <code>ultrafinedmxchannel</code> for 32-bit resolution
It should be noted that in the case of 32-bit resolution, all four DMX channels must be specified. It is not uncommon for the four DMX channels to be arranged in the assignment not directly one after the other. The following table shows the definition of the currently possible resolutions for a device function exemplarily using the function "Dimmer".

{{DMXC3 Manual-Tableheader DDF-Code examples | de }}

| Device function with 8-bit resolution
| <syntaxhighlight lang="xml">
<dimmer dmxchannel="0" />
</syntaxhighlight>
Dimmer on DMX channel {{Manual Value | DMX channel | 1}}
|-
| Device function with 16-bit resolution
| <syntaxhighlight lang="xml">
<dimmer dmxchannel="0" finedmxchannel="1" />
</syntaxhighlight>
Dimmer with 16-bit resolution on DMX channels {{Manual Value | DMX channel | 1}} and {{Manual Value | DMX channel | 2}}
|-
| Device function with 24-bit resolution
| <syntaxhighlight lang="xml">
<dimmer dmxchannel="0" finedmxchannel="1" ultradmxchannel="2" />
</syntaxhighlight>
Dimmer with 24-bit resolution on DMX channels {{Manual Value | DMX channel | 1}}, {{Manual Value | DMX channel | 2}}, and {{Manual Value | DMX channel | 3}}
|-
| Device function with 32-bit resolution
| <syntaxhighlight lang="xml">
<dimmer dmxchannel="0" finedmxchannel="1" ultradmxchannel="2" ultrafinedmxchannel="3" />
</syntaxhighlight>
Dimmer with 32-bit resolution on DMX channels {{Manual Value | DMX channel | 1}}, {{Manual Value | DMX channel | 2}}, {{Manual Value | DMX channel | 3}}, and {{Manual Value | DMX channel | 4}}
|}

== Optional Attributes ==
=== <code>defaultval</code>: Initial Value or Default Value ===
Upon request, it is possible to specify for a selection of functions which value they should assume, deviating from the standard definition in DMXControl 3. This is done via the <code>defaultval</code> attribute. This attribute can be used for the following functions:
* Intensity
* Switch
* Colortemp
* Focus
* Iris
* Zoom
* Index
* Rotation
* Raw
* Rawrange
* Rawstep
The value for the <code>defaultval</code> attribute must always lie within the <code>range</code> which is usually specified below. If a function defaults to the standard definition for the value range, the value for <code>defaultval</code> must accordingly lie between <code>0</code> and <code>1</code> or between <code>0</code> and <code>100</code>.

{{DMXC3 Manual-Tableheader DDF-Code examples | de }}

| Default value for brightness
| <syntaxhighlight lang="xml">
<dimmer dmxchannel="0" defaultval="25"/>
</syntaxhighlight>
If the Dimmer (Intensity) is not addressed, the Hardware Abstraction Layer (HAL) now sets the value for the Dimmer contrary to the standard definition to {{Manual Value | | 25%}}.
|-
| Custom value for color temperature
| <syntaxhighlight lang="xml">
<colortemp dmxchannel="0" defaultval="5500">
<range mindmx="255" maxdmx="0" minval="2500" maxval="9500"/>
</colortemp>
</syntaxhighlight>
Color temperature can be set from {{Manual Value | | 9,500 K}} at DMX value {{Manual Value | DMX value | 0}} decreasing to {{Manual Value | | 2,500 K}} at DMX value {{Manual Value | DMX value | 255}} on DMX channel {{Manual Value | DMX channel | 1}}. If the function is not used and no specific value is stored in a scene, etc., instead of the standard value of {{Manual Value | | 6,500 K}}, a color temperature of {{Manual Value | | 5,500 K}} is set.
|-
| User-defined controller
| <syntaxhighlight lang="xml">
<raw dmxchannel="0" name="Auto / music speed" defaultval="25">
<range type="linear" mindmx="0" maxdmx="255" minval="0" maxval="100" />
</raw>
</syntaxhighlight>
The standard speed of the automatic programs should be {{Manual Value | | 25%}}. When

specifying the range from {{Manual Value | | 0%}} at DMX value {{Manual Value | DMX value | 0}} to {{Manual Value | | 100%}} at DMX value {{Manual Value | DMX value | 255}}, a DMX value of {{Manual Value | DMX value | 63}} is output by <code>defaultval</code>.
|}

= Function Elements =
The available function elements are generally used whenever multiple functions are accommodated on one DMX channel. These can be various strobe modes such as linear, random. In the case of a color wheel or a gobo wheel, the various colors and gobos must be specified. But even with a shutter, there are already two functions directly, namely closed and open.

To store all this in the DDF, various function elements are available. They define that
* switching between different functions on one DMX channel (<code>step</code>).
* a function can be changed when a controller is moved within a certain range (<code>range</code>).
* to use a specific function, another DMX channel must be set to a predefined DMX value (<code>supporthandler</code>).

Whether the mentioned function elements are needed depends on the respective function. If there is already a standard implementation directly in DMXControl 3, as is the case with the <code>dimmer</code> for example, the function elements can be completely omitted. If a function either has no standard implementation or one must deviate from it, the function elements <code>step</code> or <code>range</code> are used more or less mandatorily.

Function elements such as the <code>supporthandler</code>, however, are optional per se and therefore only used in certain application cases. Corresponding typical examples are listed for the respective functions.

== Required Function Elements ==
=== <code>step</code>: Specification of Individual Steps ===
The <code>step</code> function element always consists of the actual <code>step</code> tag, the <code>type</code> attribute, and the attributes for the minimum DMX value <code>mindmx</code> and the maximum DMX value <code>maxdmx</code> for the <code>step</code>. The value for the <code>type</code> attribute always depends on the property of the DMX channel to be represented. The permissible values are specified when describing the respective function. It is important to know here that the HAL always takes the average value between <code>mindmx</code> and <code>maxdmx</code>. In relation to the following example, this would be the DMX value 227.

<syntaxhighlight lang="xml">
<step type="open" mindmx="200" maxdmx="255" />
</syntaxhighlight>

=== <code>range</code>: Specification of an Adjustable Range ===
The <code>range</code> function element is structured similarly to the <code>step</code> function element. The most significant difference is the addition of the <code>minval</code> and <code>maxval</code> attributes. Here, for example, the following are specified:
* the minimum and maximum strobe frequency
* the minimum and maximum speed for gobo rotation
* the minimum and maximum beam angle of the zoom

The special feature here is that the DMX values are assigned to the speeds. This means that the minimum speed is entered for the DMX value where, for example, the gobo rotates slowest. The same applies to the maximum speed of the gobo. Therefore, it may happen that the minimum speed does not always automatically correspond to the low DMX value and the maximum speed to the highest DMX value. A code example can be found in the article [[DDF-Syntax_Gobo_DMXC3#Basic-Functions|Gobo Wheel]]. A clearer constellation, on the other hand, is shown in the following example for the strobe frequency, where the lowest DMX value {{Manual Value | DMX value | 0}} also outputs the lowest strobe frequency of {{Manual Value | | 0.5 Hz}}.

<syntaxhighlight lang="xml">
<range type="linear" mindmx="0" maxdmx="255" minval="0.5" maxval="15" />
</syntaxhighlight>

== Optional Function Elements ==
=== <code>supporthandler</code>: Value-dependent Control of DMX Channels ===
Some devices have one or more functions that work according to the principle: "One selects the function on one DMX channel and controls the speed via a second DMX channel". An illustrative example here could be a gobo wheel with rotating gobos, which can also be indexed additionally. Here, three different functions are already present:
* Indexing of gobos
* Clockwise rotation
* Counterclockwise rotation
Via a first DMX channel, one selects one of the three functions, while the second DMX channel always works over its entire value range from {{Manual Value | DMX value | 0}} to {{Manual Value | DMX value | 255}} and determines the function such as
* specifying the indexing angle
* Rotation speed, from slow to fast clockwise
* Rotation speed, from slow to fast counterclockwise

To implement this scenario in a DDF for DMXControl 3, there is the so-called <code>supporthandler</code>. This always consists of two parts:
* specifying which DMX channel switches the function
* the addition to the definition where the actual value is set

In the case of the gobo wheel, the implementation for the function "Indexing of gobos" is built up as follows. The first part of the <code>supporthandler</code> is another line within the <code>goboindex</code> element, after it has been noted in the same context that this function is on DMX channel 3, so DMX channel 3 determines the actual value.

<syntaxhighlight lang="xml"><goboindex dmxchannel="2"></syntaxhighlight>

This implementation corresponds to the normal implementation without the addition of the <code>supporthandler</code>. By specifying the line directly following

<syntaxhighlight lang="xml"><support dmxchannel="1" name="goboindex" /></syntaxhighlight>

it is defined that the function switching takes place on DMX channel {{Manual Value | DMX channel | 2}}. The associated keyword is also <code>goboindex</code>, whereby any other value is also permissible here. Furthermore, the range for the function is specified again, as if one were working without the <code>supporthandler</code>. The line only differs in that for <code>mindmx</code> and <code>maxdmx</code>, the specified value range of the DMX channel that determines the value is used. Furthermore, the line is not closed with <code>/></code>, but left open.

<syntaxhighlight lang="xml"><range range="360" mindmx="0" maxdmx="255" minval="0" maxval="360" ></syntaxhighlight>

In the following line, which is a subordinate element to the <code>range</code> element, it is specified on which

DMX value the DMX channel must be set to select the corresponding function, as soon as one uses the gobo indexing function, for example, in this example. In addition to the corresponding value range via the <code>mindmx</code> and <code>maxdmx</code> attributes, this line receives the second part of the <code>supporthandler</code>. This consists of the <code>handler</code> attribute and the keyword previously chosen. Here it is the keyword <code>goboindex</code>, which is deposited with the prefix <code>support-</code> as the value. With this, all definitions within this line are completed.

<syntaxhighlight lang="xml"><step handler="support-goboindex" mindmx="0" maxdmx="15" /></syntaxhighlight>

{{Manual Box | de | Important | The line specifying the DMX value for selecting the corresponding function must be added to every definition that requires a specific DMX value on the selection channel. In the case, for example, of gobo rotation, this means that this addition may need to be inserted three times: rotation clockwise, stop, rotation counterclockwise.}}

Subsequently, the remaining part for the implementation of gobo indexing is completed. In sum, the code snippet looks like this.

{{DMXC3 Manual-Tableheader DDF-Code examples | de }}

| Gobo Indexing
| <syntaxhighlight lang="xml">
<gobowheel dmxchannel="0">
<goboindex dmxchannel="2">
<support dmxchannel="1" name="goboindex" />
<range range="360" mindmx="0" maxdmx="255" minval="0" maxval="360" >
<step handler="support-goboindex" mindmx="0" maxdmx="15" />
</range>
</goboindex>
<step type="open" mindmx="0" maxdmx="15" caption="Open" />
<step type="gobo" mindmx="16" maxdmx="31" val="congostar.png" caption="Gobo 1" />
<step type="gobo" mindmx="32" maxdmx="47" val="sunburst.png" caption="Gobo 2" />
</syntaxhighlight>
Gobo wheel on DMX channel {{Manual Value | DMX channel | 1}}, gobo indexing on DMX channel {{Manual Value | DMX channel | 3}}, selection of the "Gobo Indexing" mode via DMX channel {{Manual Value | DMX channel | 2}}:
* Activation of gobo indexing at a DMX value on DMX channel {{Manual Value | DMX channel | 2}} between {{Manual Value | DMX value | 0}} and {{Manual Value | DMX value | 15}}. Positioning / orientation of the gobo via DMX channel {{Manual Value | DMX channel | 3}} at an angle between {{Manual Value | | 0°}} at DMX value {{Manual Value | DMX value | 0}} and {{Manual Value | | 360°}} at DMX value {{Manual Value | DMX value | 255}}.
|}

''Further examples of using the <code>supporthandler</code> can be found in the articles on '''[[Color (DDF-Syntax) DMXC3#Color Wheel|Color Wheel]]''' and '''[[Gobo (DDF-Syntax) DMXC3#Gobo Wheel|Gobo Wheel]]'''.''

[[Category:DDF DMXControl 3]]

← Older revision		Revision as of 23:05, 6 February 2024
Line 27:		Line 27:
	It should be noted that in the case of 32-bit resolution, all four DMX channels must be specified. It is not uncommon for the four DMX channels to be arranged in the assignment not directly one after the other. The following table shows the definition of the currently possible resolutions for a device function exemplarily using the function "Dimmer".		It should be noted that in the case of 32-bit resolution, all four DMX channels must be specified. It is not uncommon for the four DMX channels to be arranged in the assignment not directly one after the other. The following table shows the definition of the currently possible resolutions for a device function exemplarily using the function "Dimmer".

	{{DMXC3 Manual-Tableheader DDF-Code examples \| de }}		{{DMXC3 Manual-Tableheader DDF-Code examples \| en }}

	\| Device function with 8-bit resolution		\| Device function with 8-bit resolution
Line 70:		Line 70:
	The value for the <code>defaultval</code> attribute must always lie within the <code>range</code> which is usually specified below. If a function defaults to the standard definition for the value range, the value for <code>defaultval</code> must accordingly lie between <code>0</code> and <code>1</code> or between <code>0</code> and <code>100</code>.		The value for the <code>defaultval</code> attribute must always lie within the <code>range</code> which is usually specified below. If a function defaults to the standard definition for the value range, the value for <code>defaultval</code> must accordingly lie between <code>0</code> and <code>1</code> or between <code>0</code> and <code>100</code>.

	{{DMXC3 Manual-Tableheader DDF-Code examples \| de }}		{{DMXC3 Manual-Tableheader DDF-Code examples \| en }}

	\| Default value for brightness		\| Default value for brightness
Line 162:		Line 162:
	<syntaxhighlight lang="xml"><step handler="support-goboindex" mindmx="0" maxdmx="15" /></syntaxhighlight>		<syntaxhighlight lang="xml"><step handler="support-goboindex" mindmx="0" maxdmx="15" /></syntaxhighlight>

	{{Manual Box \| de \| Important \| The line specifying the DMX value for selecting the corresponding function must be added to every definition that requires a specific DMX value on the selection channel. In the case, for example, of gobo rotation, this means that this addition may need to be inserted three times: rotation clockwise, stop, rotation counterclockwise.}}		{{Manual Box \| en \| Important \| The line specifying the DMX value for selecting the corresponding function must be added to every definition that requires a specific DMX value on the selection channel. In the case, for example, of gobo rotation, this means that this addition may need to be inserted three times: rotation clockwise, stop, rotation counterclockwise.}}


	Subsequently, the remaining part for the implementation of gobo indexing is completed. In sum, the code snippet looks like this.		Subsequently, the remaining part for the implementation of gobo indexing is completed. In sum, the code snippet looks like this.

	{{DMXC3 Manual-Tableheader DDF-Code examples \| de }}		{{DMXC3 Manual-Tableheader DDF-Code examples \| en }}

	\| Gobo Indexing		\| Gobo Indexing