grandMA3 User Manual Publication

Syntax Rules

grandMA3 User Manual » Command Syntax and Keywords » Syntax Rules
Version 2.4

The command line syntax is used to create valid commands.

Function keywords, also called command keywords, behave like verbs in commands – they tell the objects what to do.

Object keywords are used to allocate objects in the show file.

Help keywords are used to create a relation between functions and objects.

Layer keywords address the layers of different parameters.

Cue timing keywords address different times of a cue transition.

Value readout keywords define the unit of displayed values. 

Speed readout keywords define the unit of displayed speeds.

At value keywords are a sort of shortcuts which are used to set parameters to certain predefined values. 

Playback keywords provide control over playback functionalities.

Fader keywords are related to anything that has to do with faders.

Operator keywords are symbols that perfrom mathematical opertions in a command.

Option keywords are temporary filters in commands. For more information on option keywords see Option Keywords.

To view all executed commands, see Command Line History.


General Rules

The general rules are:

  • All objects have a default function which is used if no function is given.
  • Most functions have a default object or an object type which is used if no object is given. 
  • Objects are arranged in a hierarchical tree structure. If an object does not support the function applied, the function is passed on to a child or parent object. 

For more information see Hierarchical Structure of Objects.

Terminology

  • [Square brackets]:
    Description of non-literal content.
  • (Parentheses):
    Description of optional content. 
  • "Quotation marks"/'Quotation marks':
    Quotation marks are used to enter a definite name or content. If the line ends after the word in quotation marks, the quotation marks at the end may be omitted. If the name or content is not a keyword and does not contain special characters, the quotation marks can be left out altogether.
Important:
If an option or any other part of the keyword command requires two types of quotation marks -  single (') and double quotation marks (") - make sure to always use an equal pair. For more information see the RemoteCommand keyword. 
  • Capitalization:
    In general, capitalization is important as values are case-sensitive. 

Example

Here the value "Positive" is capitalized. This is correct and the command will be executed.

Set Group 1 Property "Mode" "Positive"

Here the value "positive" is in lower case. This is wrong and the command will not be executed. 

Set Group 1 Property "Mode" "positive"

  • Only when using keyword commands, the console does not distinguish between upper case and lower case. In such topics, capitalization is used to improve readability only.

Use the Command Line

It is possible to abbreviate all the commands using the shortcuts of the corresponding keywords. 

Each keyword has its own shortcut. Every keyword topic also names the respective shortcut. 

For more information see General Keywords.

Important:
Shortcuts are subject to change as new keywords are added to the software. We advise you read the corresponding keyword topics and the release notes to check for recent changes. 

Example

  • To store cue 20 in sequence 8 using the overwrite option keyword, type:

Full version of the syntax:

User name[Fixture]>Store Sequence 8 Cue 20 /Overwrite

 

Abbreviated version of the syntax:

User name[Fixture]>S Seq 8 Cue 20 /O

 

Very short version of the syntax:

  • To copy cue 2 to cue 6 of the selected sequence, type:
User name[Fixture]>Co 2 At 6
Hint:
The examples use the full version in the manual.