Skip to content

Commit 0440b2d

Browse files
VzhelevVectorVzhelevVector
authored
Merge branch 'next' into update-speaker-spec
2 parents b766df1 + 05d9c9d commit 0440b2d

7 files changed

Lines changed: 2059 additions & 256 deletions

File tree

‎gdtf-spec.md‎

Lines changed: 178 additions & 256 deletions
Large diffs are not rendered by default.

‎mvr-spec.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ the latest edition of the referenced document (including any amendments) applies
3333
- [RFC6455, The WebSocket Protocol](https://www.ietf.org/rfc/rfc6455.txt)
3434
- [RFC6762, Multicast DNS](https://www.ietf.org/rfc/rfc6762.txt)
3535
- [RFC6763, DNS-Based Service Discovery](https://www.ietf.org/rfc/rfc6763.txt)
36+
- [ANSI E1.37-5 – 2024 General Purpose Messages for E1.20 RDM](https://tsp.esta.org/tsp/documents/docs/ANSI%20E1.37-5%20-%202024.pdf)
3637

3738

3839
# Terms and definitions
@@ -408,6 +409,7 @@ The child list (Table 20) contains a list of one of the following nodes:
408409
| CustomId | 0 or 1 | [Integer](#user-content-attrtype-integer) | The Custom ID is a value that can be used as a short name of the Fixture Instance. This does not have to be unique. The default value is 0. |
409410
| CustomIdType | 0 or 1 | [Integer](#user-content-attrtype-integer) | Defines the CustomID Type this object belongs to. |
410411
| [ChildList](#node-definition-childlist) | 0 or 1 | A list of graphic objects that are part of the layer. |
412+
| Comment | 0 or 1 | [String](#user-content-attrtype-string) | Comments for this Objects. |
411413

412414

413415

@@ -433,6 +435,7 @@ The child list (Table 22) contains a list of one of the following nodes:
433435
| [Matrix](#node-definition-matrix) | 0 or 1 | | The location and orientation of the object inside the parent coordinate system. |
434436
| [Classing](#node-definition-class) | 0 or 1 | [UUID](#user-content-attrtype-uuid) | The Class the object belongs to. |
435437
| [ChildList](#node-definition-childlist) | 0 or 1 | | A list of graphic objects that are part of the group. |
438+
| Comment | 0 or 1 | [String](#user-content-attrtype-string) | Comments for this Objects. |
436439

437440

438441
### Node Definition: FocusPoint
@@ -457,6 +460,7 @@ The child list (Table 24) contains a list of one of the following nodes:
457460
| [Matrix](#node-definition-matrix) | 0 or 1 | | The location and orientation of the object inside the parent coordinate system. |
458461
| [Classing](#node-definition-class) | 0 or 1 | [UUID](#user-content-attrtype-uuid) | The Class the object belongs to. |
459462
| [Geometries](#node-definition-geometries) | 1 | | A list of geometrical representation objects that are part of the object. |
463+
| Comment | 0 or 1 | [String](#user-content-attrtype-string) | Comments for this Objects. |
460464

461465

462466
### Node Definition: Fixture
@@ -505,6 +509,7 @@ The child list (Table 26) contains a list of one of the following nodes:
505509
| [Mappings](#node-definition-mappings) | 0 or 1 | | The container for Mappings for this fixture. |
506510
| [Gobo](#node-definition-gobo) | 0 or 1 | | The Gobo used for the fixture. The image resource must conform to the GDTF standard. |
507511
| [ChildList](#node-definition-childlist) | 0 or 1 | | A list of graphic objects that are part of the layer. |
512+
| Comment | 0 or 1 | [String](#user-content-attrtype-string) | Comments for this Objects. |
508513

509514
Note: _The fixture has no `Geometries` node as geometry is defined in a GDTF file._
510515

@@ -588,6 +593,7 @@ EXAMPLE An example of a node definition is shown below:
588593
<Matrix>{0.158127,-0.987419,0.000000}{0.987419,0.158127,0.000000}{0.000000,0.000000,1.000000}{6020.939200,2838.588955,4978.134459}</Matrix>
589594
</Fixture>
590595
</ChildList>
596+
<Comment>Example Comment</Comment>
591597
</Fixture>
592598
```
593599

@@ -632,6 +638,7 @@ The child list (Table 28) contains a list of one of the following nodes:
632638
| UnitNumber | 0 or 1 | [Integer](#user-content-attrtype-integer) | The identification of a fixture on its position. </b> Use this as an alternative numbering scheme if the planning and programming numbering is different. |
633639
| CustomIdType | 0 or 1 | [Integer](#user-content-attrtype-integer) | Defines the CustomID Type this fixture belongs to. A Custom ID Type defines to which group of objects this objects belongs as an additional object identifier. The types for the custom ID Types are defined below. |
634640
| CustomId | 0 or 1 | [Integer](#user-content-attrtype-integer) | The CustomId ID is an identifier for the instance of this fixture within the Custom ID Type that can be used to activate / select them for programming. |
641+
| Comment | 0 or 1 | [String](#user-content-attrtype-string) | Comments for this Objects. |
635642

636643

637644

@@ -675,6 +682,7 @@ The child list (Table 30) contains a list of one of the following nodes:
675682
| CustomIdType | 0 or 1 | [Integer](#user-content-attrtype-integer) | Defines the CustomID Type this fixture belongs to. A Custom ID Type defines to which group of objects this objects belongs as an additional object identifier. The types for the custom ID Types are defined below. |
676683
| CustomId | 0 or 1 | [Integer](#user-content-attrtype-integer) | The CustomId ID is an identifier for the instance of this fixture within the Custom ID Type that can be used to activate / select them for programming. |
677684
| [ChildList](#node-definition-childlist) | 0 or 1 | A list of graphic objects that are part of the layer. |
685+
| Comment | 0 or 1 | [String](#user-content-attrtype-string) | Comments for this Objects. |
678686

679687

680688
## Node Definition: VideoScreen
@@ -716,6 +724,7 @@ The child list (Table 32) contains a list of one of the following nodes:
716724
| UnitNumber | 0 or 1 | [Integer](#user-content-attrtype-integer) | The identification of a fixture on its position. </b> Use this as an alternative numbering scheme if the planning and programming numbering is different. |
717725
| CustomIdType | 0 or 1 | [Integer](#user-content-attrtype-integer) | Defines the CustomID Type this fixture belongs to. A Custom ID Type defines to which group of objects this objects belongs as an additional object identifier. The types for the custom ID Types are defined below. |
718726
| CustomId | 0 or 1 | [Integer](#user-content-attrtype-integer) | The CustomId ID is an identifier for the instance of this fixture within the Custom ID Type that can be used to activate / select them for programming. |
727+
| Comment | 0 or 1 | [String](#user-content-attrtype-string) | Comments for this Objects. |
719728

720729

721730
EXAMPLE An example of a node definition is shown below:
@@ -734,6 +743,7 @@ EXAMPLE An example of a node definition is shown below:
734743
<Sources>
735744
movie.mov
736745
</Sources>
746+
<Comment> Example Comment </Comment>
737747
</Fixture>
738748
```
739749

@@ -776,6 +786,7 @@ The child list (Table 34) contains a list of one of the following nodes:
776786
| UnitNumber | 0 or 1 | [Integer](#user-content-attrtype-integer) | The identification of a fixture on its position. </b> Use this as an alternative numbering scheme if the planning and programming numbering is different. |
777787
| CustomIdType | 0 or 1 | [Integer](#user-content-attrtype-integer) | Defines the CustomID Type this fixture belongs to. A Custom ID Type defines to which group of objects this objects belongs as an additional object identifier. The types for the custom ID Types are defined below. |
778788
| CustomId | 0 or 1 | [Integer](#user-content-attrtype-integer) | The CustomId ID is an identifier for the instance of this fixture within the Custom ID Type that can be used to activate / select them for programming. |
789+
| Comment | 0 or 1 | [String](#user-content-attrtype-string) | Comments for this Objects. |
779790

780791

781792
EXAMPLE An example of a node definition is shown below:
@@ -798,6 +809,7 @@ EXAMPLE An example of a node definition is shown below:
798809
<ScaleHandeling>UpScale</ScaleHandeling>
799810
</Projection>
800811
</Projections>
812+
<Comment> Example Comment </Comment>
801813
</Projector>
802814
```
803815

@@ -1654,6 +1666,7 @@ The defined MVR_REQUEST message Attributes are specified in Table 74.
16541666
| -------------- | ----------------------------------- | --------------------------- | ----------------------------------------------------------------------------- |
16551667
| Type | [String](#user-content-attrtype-string) | Not Optional | Defines the type of the message. Should be MVR_REQUEST- |
16561668
| FileUUID | [UUID](#user-content-attrtype-uuid) | Last MVR File from station | The UUID of the requested MVR file. If not set, the last available file is sent. |
1669+
| StationUUID | [UUID](#user-content-attrtype-uuid) | Not Optional | UUID for the station inside the network. This UUID should be persistent across multiple start-ups of the same software on the same computer |
16571670
| FromStationUUID | Array of [UUID](#user-content-attrtype-uuid) | | The UUID of the station that you want to retrieve the MVR from. |
16581671

16591672
The defined MVR_REQUEST error response Attributes are specified in Table 75.
@@ -1737,6 +1750,7 @@ The defined MVR_NEW_SESSION_HOST message Attributes are specified in Table 76.
17371750
| -------------- | ----------------------------------- | --------------------------- | ----------------------------------------------------------------------------- |
17381751
| Type | [String](#user-content-attrtype-string) | Not Optional |Defines the type of the message. Should be MVR_NEW_SESSION_HOST |
17391752
| ServiceName | [String](#user-content-attrtype-string) | Empty | New mDNS Service Name to connect to. If Empty, ignore. Cannot be set together with ServiceURL |
1753+
| StationUUID | [UUID](#user-content-attrtype-uuid) | Not Optional | UUID for the station inside the network. This UUID should be persistent across multiple start-ups of the same software on the same computer |
17401754
| ServiceURL | [String](#user-content-attrtype-string) | Empty. | New WebSocket Service URL to connect to. If Empty, ignore. Cannot be set together with ServiceURL
17411755

17421756
The defined MVR_NEW_SESSION_HOST error response Attributes Attributes are specified in Table 77.
@@ -1783,6 +1797,7 @@ Normally FixtureIDs are numeric to allow range selection. For Descriptive displa
17831797
A similar concept is the multipatch. Sometimes you want to group multiple objects behind the same FixtureIDNumeric or CustomId. This can be objects of the same GDTF Type, but not forced to be. When you select the FixtureIDNumeric or CustomId from the multipatch parent, all objects that reference this object in multipatch
17841798
parent should also be selected.
17851799

1800+
If the device supports the RDM protocol, the FixtureIDNumeric corresponds to the RDM PID 0x0656 DEVICE_UNIT_NUMBER.
17861801

17871802
# Annex B. UUID purposes (informative)
17881803

0 commit comments

Comments
 (0)