Open Function (DDF-Syntax) DMXC3 - Revision history

Skistner at 14:00, 2 March 2025

2025-03-02T14:00:00Z

← Older revision		Revision as of 16:00, 2 March 2025
Line 23:		Line 23:
	* Alignment of the lens or similar at an angle between {{Manual Value \|\| 0°}} at DMX value {{Manual Value \| DMX value \| 0}} and {{Manual Value \|\| 60°}} at DMX value {{Manual Value \| DMX value \| 127}}.		* Alignment of the lens or similar at an angle between {{Manual Value \|\| 0°}} at DMX value {{Manual Value \| DMX value \| 0}} and {{Manual Value \|\| 60°}} at DMX value {{Manual Value \| DMX value \| 127}}.
	\|}		\|}
	{\| ~~class="wikitable toptextcells"~~		{{DMXC3 Manual-Tableheader DDF-Code attributes \| de \| range-range}}
	\|-		! style="vertical-align:top" \| Description
	~~! Attribute !!~~ range ~~!! mindmx !! maxdmx !! minval !! maxval~~		\| Maximum rotation angle for the lens
	\|-		\| DMX value for the start position
	! style="~~width: 200px;~~ vertical-align:top" \| Description		\| DMX value for the end position
	~~\| style="width: 175px"~~ \| Maximum rotation angle for the lens		\| sStart position of the lens
	~~\| style="width: 175px"~~ \| DMX value for the start position		\| End position of the lens
	~~\| style="width: 175px"~~ \| DMX value for the end position
	\| ~~style="width: 175px" \| Start~~ position of the lens
	~~\| style="width: 175px"~~ \| End position of the lens
	\|-		\|-
	! style="vertical-align:top" \| Permissible attribute value		! style="vertical-align:top" \| Permissible attribute value
Line 60:		Line 57:
	* Counterclockwise rotation at {{Manual Value \|\| 0.05 1/s}} at DMX value {{Manual Value \| DMX value \| 193}}, increasing to {{Manual Value \|\| 5 1/s}} at DMX value {{Manual Value \| DMX value \| 255}}.		* Counterclockwise rotation at {{Manual Value \|\| 0.05 1/s}} at DMX value {{Manual Value \| DMX value \| 193}}, increasing to {{Manual Value \|\| 5 1/s}} at DMX value {{Manual Value \| DMX value \| 255}}.
	\|}		\|}
	{\| ~~class="wikitable toptextcells"~~		{{DMXC3 Manual-Tableheader DDF-Code attributes \| en \| range-range}}
	\|-		! style="vertical-align:top" \| Description
	~~! Attribute !! type !! mindmx !! maxdmx !! minval !! maxval~~		\|
	\|-		\| DMX value for minimum rotation speed
	! style="~~width: 175px;~~ vertical-align:top" \| Description		\| DMX value for maximum rotation speed
	~~\| style="width: 175px"~~ \|		\| Minimum rotation speed
	~~\| style="width: 175px"~~ \| DMX value for minimum rotation speed		\| Maximum rotation speed
	~~\| style="width: 175px"~~ \| DMX value for maximum rotation speed
	~~\| style="width: 175px"~~ \| Minimum rotation speed
	~~\| style="width: 175px"~~ \| Maximum rotation speed
	\|-		\|-
	! style="vertical-align:top" \| Permissible attribute value		! style="vertical-align:top" \| Permissible attribute value
Line 120:		Line 114:
	* Activation of sound-to-light control between DMX value {{Manual Value \| DMX value \| 200}} and {{Manual Value \| DMX value \| 255}}.		* Activation of sound-to-light control between DMX value {{Manual Value \| DMX value \| 200}} and {{Manual Value \| DMX value \| 255}}.
	\|}		\|}
	{\| ~~class="wikitable toptextcells"~~		{{DMXC3 Manual-Tableheader DDF-Code attributes \| en \| step-generic}}
	\|-		! style="vertical-align:top" \| Description
	~~! Attribute !! caption !! mindmx !! maxdmx~~		\| Description of the function
	\|-		\| Minimum DMX value to activate the function
	! style="~~width: 200px;~~ vertical-align:top" \| Description		\| Maximum DMX value to activate the function
	~~\| style="width: 175px"~~ \| Description of the function
	~~\| style="width: 175px"~~ \| Minimum DMX value to activate the function
	~~\| style="width: 175px"~~ \| Maximum DMX value to activate the function
	\|-		\|-
	! style="vertical-align:top" \| Permissible attribute value		! style="vertical-align:top" \| Permissible attribute value
Line 180:		Line 171:
	* Counterclockwise rotation of the animation disc at {{Manual Value \|\| -2 1/s}} at DMX value {{Manual Value \| DMX value \| 124}}, decreasing to {{Manual Value \|\| -0.05 1/s}} at DMX value {{Manual Value \| DMX value \| 0}}.		* Counterclockwise rotation of the animation disc at {{Manual Value \|\| -2 1/s}} at DMX value {{Manual Value \| DMX value \| 124}}, decreasing to {{Manual Value \|\| -0.05 1/s}} at DMX value {{Manual Value \| DMX value \| 0}}.
	\|}		\|}
	{\| ~~class="wikitable toptextcells"~~		{{DMXC3 Manual-Tableheader DDF-Code attributes \| en \| range-generic}}
	\|-		! style="vertical-align:top" \| Description
	~~! Attribute !! type !! mindmx !! maxdmx !! minval !! maxval~~		\|
	\|-		\| Minimum DMX value to activate the function
	! style="~~width: 200px;~~ vertical-align:top" \| Description		\| Maximum DMX value to activate the function
	~~\| style="width: 175px"~~ \|		\| Minimum value
	~~\| style="width: 175px"~~ \| Minimum DMX value to activate the function		\| Maximum value
	~~\| style="width: 175px"~~ \| Maximum DMX value to activate the function
	~~\| style="width: 175px"~~ \| Minimum value
	~~\| style="width: 175px"~~ \| Maximum value
	\|-		\|-
	! style="vertical-align:top" \| Permissible attribute value		! style="vertical-align:top" \| Permissible attribute value
	\| <code>linear</code><br />		\| <code>linear</code> <br /><code>stop</code> <br /><code>cw</code> <br /><code>ccw</code>
	<code>stop</code><br />
	<code>cw</code><br />
	<code>ccw</code>
	\| <code>0</code> to <code>255</code>		\| <code>0</code> to <code>255</code>
	\| <code>0</code> to <code>255</code>		\| <code>0</code> to <code>255</code>
Line 229:		Line 214:
	* ...		* ...
	\|}		\|}
	{\| ~~class~~="~~wikitable toptextcells~~"		{{DMXC3 Manual-Tableheader DDF-Code attributes \| de \| range-generic}}
			! style="vertical-align:top" \| Description
			\|
			\| Minimum DMX value for the function
			\| Maximum DMX value for the function
			\| Minimum value
			\| Maximum value
	\|-		\|-
	~~! Attribute !! type !! mindmx !! maxdmx !! minval !! maxval~~		! style="vertical-align:top" \| Permissible attribute value
	\|-
	~~! style="width: 200px; vertical-align:top" \| Description~~
	~~\| style="width: 175px" \|~~
	~~\| style="width: 175px" \| Minimum DMX value for the function~~
	~~\| style="width: 175px" \| Maximum DMX value for the function~~
	~~\| style="width: 175px" \| Minimum value~~
	~~\| style="width: 175px" \| Maximum value~~
	\|-
	!style="vertical-align:top"\| Permissible attribute value
	\| Short description of the function		\| Short description of the function
	\| <code>0</code> to <code>255</code>		\| <code>0</code> to <code>255</code>
Line 265:		Line 247:
	\|}		\|}

			[[de: Open Function (DDF-Syntax) DMXC3]]
	[[Category: DDF DMXControl 3]]		[[Category: DDF DMXControl 3]]

Skistner at 11:38, 2 March 2025

2025-03-02T11:38:16Z

← Older revision		Revision as of 13:38, 2 March 2025
Line 1:		Line 1:
	{{~~Chaptertitle~~\|Version=~~DMXControl~~ 3.3.0}}		{{Manual Header
			\| Type = DMXC3 DDFs
	~~{{DMXC3_Manual-Navigation_DDF~~		\| Version = 3.3.0
	\|~~backLink~~ = ~~Stage_Effect_~~(DDF-Syntax)~~_DMXC3~~		\| LinkBackwards = Stage Effect (DDF-Syntax) DMXC3
	\|~~backText~~ = Stage Effects		\| TextBackwards = Stage Effects
	~~\|forwardLink =~~
	~~\|forwardText =~~
	}}		}}

Unknown user at 23:20, 7 February 2024

2024-02-07T23:20:02Z

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

	{{DMXC3_Manual-Navigation_DDF		{{DMXC3_Manual-Navigation_DDF

Unknown user: Created page with "{{Chaptertitle|version=DMXControl 3.3.0}} {{DMXC3_Manual-Navigation_DDF |backLink = Stage_Effect_(DDF-Syntax)_DMXC3 |backText = Stage Effects |forwardLink = |forwardText = }}..."

2024-02-06T23:32:56Z

Created page with "{{Chaptertitle|version=DMXControl 3.3.0}} {{DMXC3_Manual-Navigation_DDF |backLink = Stage_Effect_(DDF-Syntax)_DMXC3 |backText = Stage Effects |forwardLink = |forwardText = }}..."

New page

{{Chaptertitle|version=DMXControl 3.3.0}}

{{DMXC3_Manual-Navigation_DDF
|backLink = Stage_Effect_(DDF-Syntax)_DMXC3
|backText = Stage Effects
|forwardLink =
|forwardText =
}}

With the help of open functions, all functions of a device in DMXControl 3 are mapped, which (currently) cannot be implemented through a native function such as [[Intensity_(DDF-Syntax)_DMXC3#Dimmer|Dimmer]], [[Intensity_(DDF-Syntax)_DMXC3#Shutter|Strobe]], [[Color_(DDF-Syntax)_DMXC3#Color_Wheel|Color Wheel]], or comparable. If a function of a device cannot be represented natively through one of the specific functions such as <code>goborotation</code> for the gobo rotation of a gobo wheel or <code>strobe</code> for the (simply put) flashing of the device, so-called general functions or completely free functions can be defined in the DDF.

= General Functions =
== Index ==
This function can be used, for example, when the lenses of a beam effect device can be positioned at a certain angle.
{{Manual Box | en | Hint | For indexing of gobos, the function <code>index</code> should not be used. The slider {{Manual Objectcaption|Gobo index}} in the {{Manual Windowcaption |[[Control Panel DMXC3#Gobo|Gobo]]}} window can only be used via the <code>goboindex</code> function.}}

{{DMXC3 Manual-Tableheader DDF-Code examples | en }}
| Standard
| <syntaxhighlight lang="xml">
<index dmxchannel="0">
<range range="60" mindmx="0" maxdmx="127" minval="0" maxval="60" />
</index>
</syntaxhighlight>
Index on DMX channel {{Manual Value | DMX channel| 1}}:
* Alignment of the lens or similar at an angle between {{Manual Value || 0°}} at DMX value {{Manual Value | DMX value | 0}} and {{Manual Value || 60°}} at DMX value {{Manual Value | DMX value | 127}}.
|}
{| class="wikitable toptextcells"
|-
! Attribute !! range !! mindmx !! maxdmx !! minval !! maxval
|-
! style="width: 200px; vertical-align:top" | Description
| style="width: 175px" | Maximum rotation angle for the lens
| style="width: 175px" | DMX value for the start position
| style="width: 175px" | DMX value for the end position
| style="width: 175px" | Start position of the lens
| style="width: 175px" | End position of the lens
|-
! style="vertical-align:top" | Permissible attribute value
| <code>0°</code> to <code>720°</code>
| <code>0</code> to <code>255</code>
| <code>0</code> to <code>255</code>
| <code>0°</code> to <code>720°</code>
| <code>0°</code> to <code>720°</code>
|}

== Rotation ==
This function can be used, for example, when the lenses of a beam effect device can be rotated or to control the rotation of a mirror ball motor.
{{Manual Box | en | Hint | For rotating gobos, the function <code>rotation</code> should not be used. The slider {{Manual Objectcaption|Gobo rotation}} in the {{Manual Windowcaption |[[Control Panel DMXC3#Gobo|Gobo]]}} window can only be used via the <code>goborotation</code> function.}}

{{DMXC3 Manual-Tableheader DDF-Code examples | en }}
| Standard
| <syntaxhighlight lang="xml">
<rotation dmxchannel="0">
<step type="stop" mindmx="191" maxdmx="192" />
<range type="cw" mindmx="190" maxdmx="128" minval="0.05" maxval="5" />
<range type="ccw" mindmx="193" maxdmx="255" minval="0.05" maxval="5" />
</rotation>
</syntaxhighlight>
Rotation on DMX channel {{Manual Value | DMX channel | 1}}:
* No rotation between DMX value {{Manual Value | DMX value | 191}} and DMX value {{Manual Value | DMX value | 192}}.
* Clockwise rotation at {{Manual Value || 5 1/s}} at DMX value {{Manual Value | DMX value | 128}}, decreasing to {{Manual Value || 0.05 1/s}} at DMX value {{Manual Value | DMX value | 190}}.
* Counterclockwise rotation at {{Manual Value || 0.05 1/s}} at DMX value {{Manual Value | DMX value | 193}}, increasing to {{Manual Value || 5 1/s}} at DMX value {{Manual Value | DMX value | 255}}.
|}
{| class="wikitable toptextcells"
|-
! Attribute !! type !! mindmx !! maxdmx !! minval !! maxval
|-
! style="width: 175px; vertical-align:top" | Description
| style="width: 175px" |
| style="width: 175px" | DMX value for minimum rotation speed
| style="width: 175px" | DMX value for maximum rotation speed
| style="width: 175px" | Minimum rotation speed
| style="width: 175px" | Maximum rotation speed
|-
! style="vertical-align:top" | Permissible attribute value
| <code>stop</code> 
<code>cw</code> 
<code>ccw</code>
| <code>0</code> to <code>255</code>
| <code>0</code> to <code>255</code>
| <code>0.01 1/s</code> to <code>10 1/s</code>
| <code>0.01 1/s</code> to <code>10 1/s</code>
|}

== Cool ==

== Heat ==

= Free Functions =
Since not all functions of a DMX device can be accurately represented, there are elements that can be freely defined. However, these are only output in the {{Manual Windowcaption |[[Device Control DMXC3|Device Control]]}}. The advantages of the {{Manual Windowcaption |[[Hardware Abstraction Layer (HAL) DMXC3|Hardware Abstraction Layers (HAL)]]}} can also be applied to these freely defined functions.

The following elements are currently available to freely define functions of a DMX device:
* <code>rawstep</code>: Generates a list with options for functions.
* <code>raw</code>: Generates a simple slider.
* <code>const</code>: Constantly sends

a specific DMX value on a DMX channel.

{{Manual Box | en | Important | All the elements mentioned above are completely device-specific. After replacing the device, the HAL cannot automatically apply values stored in {{Manual Windowcaption |[[Cuelist DMXC3|Cuelists]]}} etc. to the new device. These elements should only be used if mapping the function through a native function is not possible. }}

== rawstep ==
The <code>rawstep</code> element generates a list in the Device Control to select specific functions of the DMX device. Typical use cases include:
* Selection of different operating modes of a DMX device such as direct DMX control, playing automatic programs, activation of music control
* Inserting and removing an animation disc in a moving head
* Switching the mode for pan-tilt movement from the normal, "classic" control mode to endless movement mode

In contrast to the fixed defined functions, with <code>rawstep</code>, in addition to the DMX channel, a name or a short description of the DMX channel must be specified in the <code>name</code> attribute. The description of each <code>step</code> can be freely chosen. The chosen description does not affect the operation of the HAL.

{{DMXC3 Manual-Tableheader DDF-Code examples | en }}
| Standard
| <syntaxhighlight lang="xml">
<rawstep dmxchannel="0" name="Mode">
<step caption="DMX" mindmx="0" maxdmx="9" />
<step caption="Auto" mindmx="10" maxdmx="199" />
<step caption="Music" mindmx="200" maxdmx="255" />
</rawstep>
</syntaxhighlight>
Freely defined function with the name "Mode" on DMX channel {{Manual Value | DMX channel | 1}}:
* Activation of DMX mode between DMX value {{Manual Value | DMX value | 0}} and {{Manual Value | DMX value | 9}}.
* Activation of automatic mode between DMX value {{Manual Value | DMX value | 10}} and {{Manual Value | DMX value | 199}}.
* Activation of sound-to-light control between DMX value {{Manual Value | DMX value | 200}} and {{Manual Value | DMX value | 255}}.
|}
{| class="wikitable toptextcells"
|-
! Attribute !! caption !! mindmx !! maxdmx
|-
! style="width: 200px; vertical-align:top" | Description
| style="width: 175px" | Description of the function
| style="width: 175px" | Minimum DMX value to activate the function
| style="width: 175px" | Maximum DMX value to activate the function
|-
! style="vertical-align:top" | Permissible attribute value
| <code>Text</code>
| <code>0</code> to <code>255</code>
| <code>0</code> to <code>255</code>
|}

{{Manual Box | en | Important | The text for the description must not contain an ampersand (&). Otherwise, the DDF cannot be loaded. }}
== raw ==
The <code>raw</code> element generates a single slider in the Device Control. Typical use cases for this are:
* Control of the playback speed of automatic programs
* Adjustment of microphone sensitivity for sound-to-light control
* Speed and direction for endless movements of moving heads
* Direction and speed for animation discs
* Use for additional motion axes
* Adjustment for effect speeds for color and gobo wheels

{{Manual Box | en | Hint | If multiple internal programs of the present device can be selected and their playback speed changed via a DMX channel, these should be implemented using the <code>rawranges</code> element. }}

In contrast to the fixed defined functions, with <code>raw</code>, in addition to the DMX channel, a name or a short description of the DMX channel must be specified in the <code>name</code> attribute.

{{DMXC3 Manual-Tableheader DDF-Code examples | en }}
| Speed controller for automatic programs in simplified version
| <syntaxhighlight lang="xml">
<raw dmxchannel="0" name="Macro speed" />
</syntaxhighlight>
Freely defined function with the name "Speed" on DMX channel {{Manual Value | DMX channel | 1}}:
* Speed of the automatic programs increasing from value {{Manual Value || 0}} (lowest speed) at DMX value {{Manual Value | DMX value | 0}} to value {{Manual Value || 255}} (maximum speed) at DMX value {{Manual Value | DMX value | 255}}.
|-
| Speed controller for automatic programs with own value range
| <syntaxhighlight lang="xml">
<raw dmxchannel="0" name="Macro speed" >
<range type="linear" mindmx="0" maxdmx="255" minval="0" maxval="100" />
</raw>
</syntaxhighlight>
Freely defined function with the name "Speed" on DMX channel {{Manual Value | DMX channel | 1}}:
* Speed of the automatic programs increasing from {{Manual Value || 0%}} (lowest speed) at DMX value {{Manual Value | DMX value | 0}} to {{Manual Value || 100%}} (maximum speed) at DMX value {{Manual Value | DMX value | 255}}.
|-
| Template for animation disc
| <syntaxhighlight lang="xml">
<raw dmxchannel="0" name="Animation disk rotation" >
<step type="stop" mindmx="125" maxdmx="130" />
<range type="cw" mindmx="131" maxdmx="255" minval="0.05" maxval="2" />
<range type="ccw" mindmx="124" maxdmx="0" minval="-2" maxval="-0.05" />
</raw >
</syntaxhighlight>
Freely defined function with the name "Rotation Animation Disc" on DMX channel {{Manual Value | DMX channel | 1}}:
* Animation disc static between DMX value {{Manual Value | DMX value | 125}} and {{Manual Value | DMX value | 130}}.
* Clockwise rotation of the animation disc at {{Manual Value || 0.05 1/s}} at DMX value {{Manual Value | DMX value | 131}}, accelerating to {{Manual Value || 2 1/s}} at DMX value {{Manual Value | DMX value | 255}}.
* Counterclockwise rotation of the animation disc at {{Manual Value || -2 1/s}} at DMX value {{Manual Value | DMX value | 124}}, decreasing to {{Manual Value || -0.05 1/s}} at DMX value {{Manual Value | DMX value | 0}}.
|}
{| class="wikitable toptextcells"
|-
! Attribute !! type !! mindmx !! maxdmx !! minval !! maxval
|-
! style="width: 200px; vertical-align:top" | Description
| style="width: 175px" |
| style="width: 175px" | Minimum DMX value to activate the function
| style="width: 175px" | Maximum DMX value to activate the function
| style="width: 175px" | Minimum value
| style="width: 175px" | Maximum value
|-
! style="vertical-align:top" | Permissible attribute value
| <code>linear</code> 
<code>stop</code> 
<code>cw</code> 
<code>ccw</code>
| <code>0</code> to <code>255</code>
| <code>0</code> to <code>255</code>
| No restriction
| No restriction
|}

== rawranges ==
The <code>rawranges</code> element generates a slider in the Device Control for multiple different functions with a variable value range. The functions can be selected via the associated, automatically generated dropdown menu. Typical use cases for this are:
* Changing the playback speed of internal programs

For a clear assignment in the Device Control, in addition to the <code>dmxchannel</code> attribute, a name or a short description of the DMX channel must also be specified in the <code>name</code> attribute. The basic definition does not differ from the <code>raw</code> element, but is only supplemented by the <code>type</code> attribute, in which the description of the respective function on the DMX channel is made.

{{DMXC3 Manual-Tableheader DDF-Code examples | en }}
| Selection and playback speed for automatic programs
| <syntaxhighlight lang="xml">
<rawranges dmxchannel="0" name="Auto show" >
<step type="Off" mindmx="0" maxdmx="31" />
<range type="Show 1" mindmx="32" maxdmx="63" minval="0" maxval="100" />
<range type="Show 2" mindmx="64" maxdmx="95" minval="0" maxval="100" />
<range type="Show 3" mindmx="96" maxdmx="127" minval="0" maxval="100" />
<range type="Show 4" mindmx="128" maxdmx="191" minval="0" maxval="100" />
<range type="Show 5" mindmx="192" maxdmx="255" minval="0" maxval="100" />
</rawranges>
</syntaxhighlight>
Freely defined function with the name "Auto show" on DMX channel {{Manual Value | DMX channel | 1}}:
* Internal show programs {{Manual Value | Caption | switched off}} between DMX value {{Manual Value | DMX value | 0}} and {{Manual Value | DMX value | 31}}.
* Activation of {{Manual Value | Caption | Show 1}} and setting the speed from {{Manual Value || 0%}} at DMX value {{Manual Value | DMX value | 32}} to {{Manual Value || 100%}} at DMX value {{Manual Value | DMX value | 63

}}.
* Activation of {{Manual Value | Caption | Show 2}} and setting the speed from {{Manual Value || 0%}} at DMX value {{Manual Value | DMX value | 64}} to {{Manual Value || 100%}} at DMX value {{Manual Value | DMX value | 95}}.
* ...
|}
{| class="wikitable toptextcells"
|-
! Attribute !! type !! mindmx !! maxdmx !! minval !! maxval
|-
! style="width: 200px; vertical-align:top" | Description
| style="width: 175px" |
| style="width: 175px" | Minimum DMX value for the function
| style="width: 175px" | Maximum DMX value for the function
| style="width: 175px" | Minimum value
| style="width: 175px" | Maximum value
|-
!style="vertical-align:top"| Permissible attribute value
| Short description of the function
| <code>0</code> to <code>255</code>
| <code>0</code> to <code>255</code>
| No restriction
| No restriction
|}

== const ==
The <code>const</code> element is used whenever a specific DMX value needs to be set permanently on a DMX channel, but otherwise this DMX channel is not used. Examples could include DMX channels where various internal programs of the DMX device are stored but should not be used.

No graphical user interface is provided for the <code>const</code> element. Adjustment of the set DMX value is not possible.

In contrast to the fixed defined functions, with <code>const</code>, in addition to the DMX channel, a name or a short description of the DMX channel must be specified in the <code>name</code> attribute. The <code>val</code> attribute specifies the DMX value that should be permanently set on this DMX channel.

{{DMXC3 Manual-Tableheader DDF-Code examples | en }}
| Standard
| <syntaxhighlight lang="xml">
<const dmxchannel="0" name="Macro Effects" val="0" />
</syntaxhighlight>
Macro effects on DMX channel {{Manual Value | DMX channel | 1}}:
* Permanently set DMX value {{Manual Value | DMX value | 0}}.
|}

[[Category: DDF DMXControl 3]]