DMX Mode Collect
This section is describes all DMX modes of the device.
DMX Mode Collect
General
This section is describes all DMX modes of the device. If firmware
revisions change a DMX footprint, then such revisions should be
specified as new DMX mode. The DMX mode collect currently does not have
any attributes (XML node <DMXModes>). As a child the fixture type DMX
mode collect has DMX modes.
DMX Mode
Each DMX mode describes logical control part of the device in a specific
mode (XML node <DMXMode>). The currently defined XML attributes of the
DMX mode are specified in table 56.
Table 56. DMX Mode Attributes
| XML Attribute Name | Value Type | Description |
|---|---|---|
| Name | Name | The unique name of the DMX mode |
| Description | String | Description of the DMX mode |
| Geometry | Name | Name of the first geometry in the device; Only top level geometries are allowed to be linked. |
DMX mode children are specified in table 57.
Table 57. DMX Mode Children
| XML node | Mandatory | Description |
|---|---|---|
| DMXChannels | Yes | Description of all DMX channels used in the mode |
| Relations | No | Description of relations between channels |
| FTMacros | No | Is used to describe macros of the manufacturer. |
DMX Channel Collect
General
This section defines the DMX footprint of the device. The DMX channel
collect currently does not have any attributes (XML node <DMXChannels>).
As children the DMX channel collect has a list of a DMX
channels.
DMX Channel
General
This section defines the DMX channel (XML node <DMXChannel>). The name
of a DMX channel cannot be user-defined and must consist of a geometry
name and the attribute name of the first logical channel with separator
“_”. In one DMX Mode, this combination needs to be unique. Currently
defined XML attributes of the DMX channel are specified in table
58.
Table 58. DMX Channel Attributes
| XML Attribute Name | Value Type | Description |
|---|---|---|
| DMXBreak | Int | Number of the DMXBreak; Default value: 1; Special value: “Overwrite” – means that this number will be overwritten by Geometry Reference; Size: 4 bytes |
| Offset | Array of Int | Relative addresses of the current DMX channel from highest to least significant; Separator of values is “,”; Special value: “None” – does not have any addresses; Default value: “None”; Size per int: 4 bytes |
| InitialFunction | Node | Link to the channel function that will be activated by default for this DMXChannel. Default value is the first channel function of the first logical function of this DMX channel. |
| Highlight | DMXValue | Highlight value for current channel; Special value: “None”. Default value: “None”. |
| Geometry | Name | Name of the geometry the current channel controls. |
The Geometry should be the place in the tree of geometries where the function
of the DMX Channel (as defined by ChannelFunction) is located either physically
or logically. If the DMX channel doesn’t have a location, put it in the top
level geometry of the geometry tree. Attributes follow a trickle down
principle, so they are inherited from top down.
As children the DMX channel has a list of logical channels.
Logical Channel
The Fixture Type Attribute is assigned to a LogicalChannel and defines
the function of the LogicalChannel. All logical channels that are
children of the same DMX channel are mutually exclusive. In a DMX mode,
only one logical channel with the same attribute can reference the same
geometry at a time. The name of a Logical Channel cannot be user-defined
and is equal to the linked attribute name. The XML node of the logical
channel is <LogicalChannel>. The currently defined XML attributes of the
logical channel are specified in table 59.
Table 59. Logical Channel Attributes
| XML Attribute Name | Value Type | Description |
|---|---|---|
| Attribute | Node | Link to the attribute; The starting point is the Attribute Collect (see Annex A). |
| Snap | Enum | If snap is enabled, the logical channel will not fade between values. Instead, it will jump directly to the new value.; Value: “Yes”, “No”, “On”, “Off”. Default value: “No” |
| Master | Enum | Defines if all the subordinate channel functions react to a Group Control defined by the control system. Values: “None”, “Grand”, “Group”; Default value: “None”. |
| MibFade | Float | Minimum fade time for moves in black action. MibFade is defined for the complete DMX range. Default value: 0; Unit: second |
| DMXChangeTimeLimit | Float | Minimum fade time for the subordinate channel functions to change DMX values by the control system. DMXChangeTimeLimit is defined for the complete DMX range. Default value: 0; Unit: second |
As a child the logical channel has a list of a channel function.
Channel Function
The Fixture Type Attribute is assigned to a Channel Function and defines
the function of its DMX Range. (XML node <ChannelFunction>). The
currently defined XML attributes of channel function are specified in
table 60.
Table 60. Channel Function Attributes
| XML Attribute Name | Value Type | Description |
|---|---|---|
| Name | Name | Unique name; Default value: Name of attribute and number of channel function. |
| Attribute | Node | Link to attribute; Starting point is the attributes node. Default value: “NoFeature”. |
| OriginalAttribute | String | The manufacturer’s original name of the attribute; Default: empty |
| DMXFrom | DMXValue | Start DMX value; The end DMX value is calculated as a DMXFrom of the next channel function – 1 or the maximum value of the DMX channel. Default value: “0/1”. |
| Default | DMXValue | Default DMX value of channel function when activated by the control system. |
| PhysicalFrom | Float | Physical start value; Default value: 0 |
| PhysicalTo | Float | Physical end value; Default value: 1 |
| RealFade | Float | Time in seconds to move from min to max of the Channel Function; Default value: 0 |
| RealAcceleration | Float | Time in seconds to accelerate from stop to maximum velocity; Default value: 0 |
| Wheel | Node | Optional. Link to a wheel; Starting point: Wheel Collect |
| Emitter | Node | Optional. Link to an emitter in the physical description; Starting point: Emitter Collect |
| Filter | Node | Optional. Link to a filter in the physical description; Starting point: Filter Collect |
| ColorSpace | Node | Optional. Link to a color space in the physical description; Starting point: Physical Descriptions Collect |
| Gamut | Node | Optional. Link to a gamut in the physical description; Starting point: Gamut Collect |
| ModeMaster | Node | Optional. Link to DMX Channel or Channel Function; Starting point DMX mode. |
| ModeFrom | DMXValue | Only used together with ModeMaster; DMX start value; Default value: 0/1 |
| ModeTo | DMXValue | Only used together with ModeMaster; DMX end value; Default value: 0/1 |
| DMXProfile | Node | Optional link to DMX Profile; Starting point: DMX Profile Collect |
| Min | Float | Minimum Physical Value that will be used for the DMX Profile. Default: Value from PhysicalFrom |
| Max | Float | Maximum Physical Value that will be used for the DMX Profile. Default: Value from PhysicalTo |
| CustomName | String | Custom Name that can he used do adress this channel function with other command based protocols like OSC. Default: Node Name of the Channel function Example: Head_Dimmer.Dimmer.Dimmer |
Note:
For command based control systems, you can control the fixture by sending it a string in the following style:
"/FIXTURE_ID/CUSTOM_NAME_CHANNELFUCTION ,f FLOAT_VALUE_PHYSICAL"
or
"/FIXTURE_ID/CUSTOM_NAME_CHANNELFUCTION/percent ,f FLOAT_VALUE_PERCENT"
Where:
- FIXTURE_ID is the fixture ID is the value defined for the fixture instance.
- CUSTOM_NAME_CHANNELFUCTION is the Custom Name for the ChannelFunction. Note that all “.” Separators can be replaced with “/”.
- FLOAT_VALUE_PHYSICAL is the physical value that the fixture should adopt. The values will be capped by the fixture by PhysicalFrom and PhysicalTo.
- FLOAT_VALUE_PERCENT is the percent value that the fixture should adopt. The values can be between 0 and 100.
As children the channel function has list of a channel sets and a sub channel sets.
Channel Set
This section defines the channel sets of the channel function (XML node
Table 61. Channel Set Attributes
| XML Attribute Name | Value Type | Description |
|---|---|---|
| Name | Name | The name of the channel set. Default: Empty |
| DMXFrom | DMXValue | Start DMX value; The end DMX value is calculated as a DMXFrom of the next channel set – 1 or the maximum value of the current channel function; Default value: 0/1 |
| PhysicalFrom | Float | Physical start value. Default value is the PhysicalFrom from the parent channel function. |
| PhysicalTo | Float | Physical end value. Default value is the PhysicalTo from the parent channel function. |
| WheelSlotIndex | Int | If the channel function has a link to a wheel, a corresponding slot index shall be specified. The wheel slot index results from the order of slots of the wheel which is linked in the channel function. The wheel slot index is normalized to 1. Size: 4 bytes |
The channel set does not have any children.
Sub Channel Set
This section defines the sub channel sets of the channel function (XML node
Table 62. Sub Channel Set Attributes
| XML Attribute Name | Value Type | Description |
|---|---|---|
| Name | Name | The name of the sub channel set. Default: Empty |
| PhysicalFrom | Float | Physical start value |
| PhysicalTo | Float | Physical end value |
| SubPhysicalUnit | Node | Link to the sub physical unit; Starting Point: Attribute |
| DMXProfile | Node | Optional link to the DMX Profile; Starting Point: DMX Profile Collect |
The sub channel set does not have any children.
Relation Collect
General
This section describes the dependencies between DMX channels and channel
functions, such as multiply and override. The relation collect currently
does not have any XML attributes (XML node <Relations>). As children the
relation collect has a list of a relation.
Relation
This section defines the relation between the master DMX channel and the
following logical channel (XML node <Relation>). The currently defined
XML attributes of the relations are specified in table 63.
Table 63. Relation Attributes
| XML Attribute Name | Value Type | Description |
|---|---|---|
| Name | Name | The unique name of the relation |
| Master | Node | Link to the master DMX channel; Starting point: DMX mode |
| Follower | Node | Link to the following channel function; Starting point: DMX mode |
| Type | Enum | Type of the relation; Values: “Multiply”, “Override” |
The relation does not have any children. Listing 1 shows an example of a simple DMX mode described in XML.
Listing 1. DMX mode with relations
<DMXMode Name="Default" Geometry="Body">
<DMXChannels>
<DMXChannel Highlight="255/1" Geometry="Pixel">
<LogicalChannel Attribute="Dimmer" Master="Grand">
<ChannelFunction Attribute="Dimmer" DMXFrom="0/1">
<ChannelSet Name="closed" DMXFrom="0/1" PhysicalTo="0" />
<ChannelSet DMXFrom="1/1" />
<ChannelSet Name="open" DMXFrom="255/1" PhysicalFrom="1" />
</ChannelFunction>
</LogicalChannel>
</DMXChannel>
<DMXChannel DMXBreak="Overwrite" Offset="1" Default="255/1" Highlight="255/1" Geometry="Pixel">
<LogicalChannel Attribute="ColorAdd_R">
<ChannelFunction Attribute="ColorAdd_R" DMXFrom="0/1"/>
</LogicalChannel>
</DMXChannel>
<DMXChannel DMXBreak="Overwrite" Offset="2" Default="255/1" Highlight="255/1" Geometry="Pixel">
<LogicalChannel Attribute="ColorAdd_G">
<ChannelFunction Attribute="ColorAdd_G" DMXFrom="0/1"/>
</LogicalChannel>
</DMXChannel>
<DMXChannel DMXBreak="Overwrite" Offset="3" Default="255/1" Highlight="255/1" Geometry="Pixel">
<LogicalChannel Attribute="ColorAdd_B">
<ChannelFunction Attribute="ColorAdd_B" DMXFrom="0/1"/>
</LogicalChannel>
</DMXChannel>
</DMXChannels>
<Relations>
<Relation Name="VirtualDimmer" Master="Pixel_Dimmer" Follower="Pixel_ColorAdd_R.ColorAdd_R.ColorAdd_R 1" Type="Multiply" />
<Relation Name="VirtualDimmer" Master="Pixel_Dimmer" Follower="Pixel_ColorAdd_G.ColorAdd_G.ColorAdd_G 1" Type="Multiply" />
<Relation Name="VirtualDimmer" Master="Pixel_Dimmer" Follower="Pixel_ColorAdd_B.ColorAdd_B.ColorAdd_B 1" Type="Multiply" />
</Relations>
</DMXMode>
Macro Collect
General
This section describes DMX sequences to be executed by the control
system. The macro collect currently does not have any XML attributes
(XML node <FTMacros>). As children the macro collect has a list of a
macro.
Macro
General
This section defines a DMX sequence. (XML node <FTMacro>). The currently
defined XML attributes of the macro are specified in table
64.
Table 64. Macro Attributes
| XML Attribute Name | Value Type | Description |
|---|---|---|
| Name | Name | The unique name of the macro. |
| ChannelFunction | Node | Optional. Link to channel function; Starting point DMX Mode |
Macro children are specified in table 65
Table 65. Macro Children
| XML node | Mandatory | Description |
|---|---|---|
| MacroDMX | No | This section defines a DMX sequence. |
Macro DMX
This section defines the sequence of DMX values which are sent by a
control system. (XML node <MacroDMX>). As children the macro DMX has a
list of MacroDMXStep.
Macro DMX Step
This section defines a DMX step (XML node <MacroDMXStep>). The currently
defined XML attributes of the macro DMX step are specified in table
66.
Table 66. Macro DMX Step Attributes
| XML Attribute Name | Value Type | Description |
|---|---|---|
| Duration | Float | Duration of a step; Default value: 1; Unit: seconds. |
As children the macro DMX -Step has a list of a DMX Value.
DMX Value
This section defines the value for DMX channel (XML node
Table 67. DMX Value Attributes
| XML Attribute Name | Value Type | Description |
|---|---|---|
| Value | DMXValue | Value of the DMX channel |
| DMXChannel | Node | Link to a DMX channel. Starting node DMX Channel collect. |
The DMX value does not have any children.