grandMA3

https://help.malighting.com/grandMA3/2.5
Admin
grandMA3 is a lighting control software and console system designed for controlling complex lighting...
Tokens:964,383
Snippets:11,607
Trust Score:9.8
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Load Show or Run Plugin at Startup with SHOW/RUNPLUGIN Parameters

Source: https://help.malighting.com/grandMA3/2.5/HTML/shf_organize.html

Command-line shortcuts to launch grandMA3 onPC with a show file or a plugin during startup. Add the SHOW or RUNPLUGIN parameter to the shortcut that launches the onPC application. x represents the grandMA3 version number; y represents the number of the Lua component inside the plugin to start (e.g., 1). It is not recommended to specify a path for the plugin, although it can be placed in a subfolder. Do not use spaces in a show file name when loading a show during startup.

```text
"C:\Program Files\MALightingTechnology\gma3_x.x.x\bin\app_system.exe" HOSTTYPE=onPC SHOW="startshow.show"
```

```text
"C:\Program Files\MALightingTechnology\gma3_x.x.x\bin\app_system.exe" HOSTTYPE=onPC RUNPLUGIN=\"startplugin.xml\"-y
```

--------------------------------

### Print Mouse Object Information with MouseObj():Dump()

Source: https://help.malighting.com/grandMA3/2.5/HTML/lua_objectfree_mouseobj.html

Prints the information of the mouse object using the Dump() function. The example uses MouseObj() to get the handle and then calls Dump() on it, wrapping the output with start and end markers.

```lua
return function()
    -- Print all informatin about the MouseObj object
    Printf("=============== START OF DUMP ===============")
    MouseObj():Dump()
    Printf("================ END OF DUMP ================")
end
```

--------------------------------

### AutoCreate single groups for FixtureTypes 9 and 10

Source: https://help.malighting.com/grandMA3/2.5/HTML/ok_single.html

Creates single fixture groups that contain all patched fixtures of fixture types 9 and 10, starting with group pool object 101. Requires the same setup as the previous example.

```grandMA3 command line
AutoCreate FixtureType 9 + 10 At Group 101 /Single
```

--------------------------------

### TopUp command example

Source: https://help.malighting.com/grandMA3/2.5/HTML/keyword_topup.html

Example command to jump to the main instance of the fixture when subfixtures are selected. Type this in the command line.

```plaintext
User name[Fixture]>TopUp
```

--------------------------------

### Print selected feature dump using SelectedFeature() and Dump()

Source: https://help.malighting.com/grandMA3/2.5/HTML/lua_objectfree_selectedfeature.html

This Lua function prints a dump of the selected feature object to the Command Line History. It uses SelectedFeature() to get the handle and calls Dump() on it, surrounding the output with start and end markers. The example is intended for use in a grandMA3 Lua environment.

```Lua
return function ()
    -- The following prints the dump for the selected feature object
    Printf("=============== START OF DUMP ===============")
    SelectedFeature():Dump()
    Printf("================ END OF DUMP ================")
end
```

--------------------------------

### Preview Sequence with /AutoStart "Single"

Source: https://help.malighting.com/grandMA3/2.5/HTML/ok_autostart.html

Loads sequences 1 to 3 into preview mode and starts the last sequence. The /AutoStart option is set to "Single".

```grandMA3 command line
User name[Fixture]>Preview Sequence 1 Thru 3 /AutoStart "Single"
```

--------------------------------

### Create a MessageBox with states, inputs, selectors, and commands

Source: https://help.malighting.com/grandMA3/2.5/HTML/key_rn_v2_0.html

Creates a MessageBox with states, inputs, selectors, and commands, then prints the results. The example shows configuration keys such as message_align_h, message_align_v, timeout (commented out), and icon.

```lua
local function main() 
-- create inputs: 
local states = { 
{order=4, name = "Color", state = true, group = 1}, 
{order=3, name = "Gobo", state = false, group = 1}, 
{order=2, name = "Position", state = true, group = 2}, 
{order=1, name = "Dimmer", state = false, group = 2} 
} 
local inputs = { 
{order=3, name = "Numbers Only", value = "1234", whiteFilter = "0123456789"}, 
{order=1, name = "Text Only", value = "TextOnly", blackFilter = "0123456789"}, 
{order=2, name = "Maximum 10 characters", value = "abcdef", maxTextLength = 10} 
} 
local selectors = { 
{ name="Swipe Selector", selectedValue=2, values={Xylophone=3, Piano=2, Drums=3, ["some stuff"]=4}, type=0}, 
{ name="Radio Selector", selectedValue=2, values={grandMA2=1, grandMA=2, grandMA3=3}, type=1} 
} 
local commands={ 
{value=1, name="Ok", order=4}, 
{value=0, name="Cancel", order=3}, 
{value=4, name="What?", order=2}, 
{value=3, name="Wait", order=1} 
} 
  

-- open messagebox: 
local resultTable = 
MessageBox( 
{ 
title = "Messagebox example", 
message = "This is a message", 
message_align_h = Enums.AlignmentH.Left, 
message_align_v = Enums.AlignmentV.Top, 
states = states, 
inputs = inputs, 
selectors = selectors, 
commands = commands, 
backColor = "Global.Default", 
-- timeout = 10000, --milliseconds 
-- timeoutResultCancel = false, 
icon = "logo_small", 
titleTextColor = "Global.AlertText", 
messageTextColor = "Global.Text" 
} 
) 
  

-- print results: 
Printf("Success = "..tostring(resultTable.success)) 
Printf("Result = "..resultTable.result) 
for k,v in pairs(resultTable.inputs) do 
Printf("Input '%s' = '%s'",k,v) 
end 
for k,v in pairs(resultTable.states) do 
Printf("State '%s' = '%s'",k,tostring(v)) 
end 
for k,v in pairs(resultTable.selectors) do 
Printf("Selector '%s' = '%d'",k,v) 
end 
end 
  

return main
```

--------------------------------

### Get(handle, string[, integer])

Source: https://help.malighting.com/grandMA3/2.5/HTML/lua_object_get.html

Documentation for the Get function in the grandMA3 Lua Object API, including description, arguments, return value, and an example.

```APIDOC
## Get(handle, string[, integer])

### Description
Returns a string with information about a specified property of the object, such as the object's name, class, or path.

### Syntax
`Get(handle, string[, integer])`

### Arguments
- **handle** (light_userdata) - Required - The handle of the object. Can be omitted when using colon notation.
- **string** (string) - Required - The name of a valid property for the object.
- **integer** (integer) - Optional - A valid role integer. When supplied, the returned value is a text string.

### Return
- **string** - The value of the property. If the property is a boolean, returns "0" or "1" unless a role is defined; with a role, returns "No" or "Yes".

### Example
```lua
return function ()
    -- SelectedSequence() creates a handle to the selected sequence.
    local selectedSequence = SelectedSequence()
    -- Check if there is a selected sequence. If not, then exit the function.
    if selectedSequence == nil then
        ErrPrintf("The selected sequence could not be found.")
        return
    end
    -- Set a variable with the property name.
    local propertyName = "Tracking"
    -- Get the value of the property.
    local propertyValue = selectedSequence:Get(propertyName)
    local propertyValueString = selectedSequence:Get(propertyName, Enums.Roles.Edit)
    -- Return some feedback.
    if propertyValue ~= nil then
        Printf("The selected sequence's property " .. propertyName.. " has the value '" .. propertyValue .. "' and a string value of '" .. propertyValueString .. "'.")
    else
        ErrPrintf("The property could not be found.")
    end
end
```
```

--------------------------------

### Start macro 2

Source: https://help.malighting.com/grandMA3/2.5/HTML/keyword_goplus.html

Use this command to start macro 2. The syntax is Go+ Macro 2.

```grandMA3 command line
User name[Fixture]>Go+ Macro 2
```

--------------------------------

### Paste Agenda with Date Option

Source: https://help.malighting.com/grandMA3/2.5/HTML/key_rn_v1_7.html

Use the /Date option to set a new start date when pasting an agenda event. The example sets the start date to 3.10.2042 for the second agenda event.

```grandMA3 command
User name[Fixture]> Paste Agenda 2 /Date "3.10.2042"
```

--------------------------------

### DeleteOtherVersion command example

Source: https://help.malighting.com/grandMA3/2.5/HTML/keyword_deleteotherversion.html

Deletes installation files for a specific software version on a Windows computer. The argument combines the release type and version XML file with the path to the installation packages directory, separated by a semicolon.

```grandMA3 command line
DeleteOtherVersion "release_stick_v1.6.3.67.xml;C:/ProgramData/MALightingTechnology/installation_packages"
```

--------------------------------

### Release Examples (Command Line)

Source: https://help.malighting.com/grandMA3/2.5/HTML/keyword_release.html

Command line examples for entering release values in the programmer. The first releases all attributes of the selected fixtures, the second targets the attribute 'Pan', and the third releases fixture 1.

```command
User name[Fixture]>Release
```

```command
User name[Fixture]>Release Attribute "Pan"
```

```command
User name[Fixture]>Release Fixture 1
```

--------------------------------

### Example: Dump current profile information

Source: https://help.malighting.com/grandMA3/2.5/HTML/lua_objectfree_currentprofile.html

This example prints information about the current user's profile using the Dump() function. It is a Lua function that returns a function, which when called, prints a start marker, dumps the profile data, and prints an end marker.

```Lua
return function()
    -- Dumps information about the current executor page
    Printf("=============== START OF DUMP ===============")
    CurrentProfile():Dump()
    Printf("================ END OF DUMP ================")
end
```

--------------------------------

### Example: View version details

Source: https://help.malighting.com/grandMA3/2.5/HTML/keyword_version.html

Type 'Version' in the command line to display version details in the command line history window.

```plaintext
User name[Fixture]>Version
```

--------------------------------

### Example: SaveShow /Enumerate command

Source: https://help.malighting.com/grandMA3/2.5/HTML/ok_enumerate.html

Example command line input to enumerate a show file. The user name is shown as 'Fixture' and the command is 'SaveShow /Enumerate'.

```text
User name[Fixture]>SaveShow /Enumerate
```

--------------------------------

### GetAttributeByUIChannel example: print native address of first attribute

Source: https://help.malighting.com/grandMA3/2.5/HTML/lua_objectfree_getattributebyuichannel.html

This example gets a handle to the first fixture in the current selection, retrieves its UI Channel Index, and prints the native address of the attribute using GetAttributeByUIChannel. It demonstrates the usage of SelectionFirst, GetUIChannelIndex, and AddrNative.

```Lua
return function()
    -- Get a handle to the first fixture in the current selection
    local fixtureIndex = SelectionFirst()
    -- Get the UI Channel Index number for the first attribute for the fixture
    local channelIndex = GetUIChannelIndex(fixtureIndex,0)
    -- Print the native address for the attribute with the handle
    Printf("The native addr for the attribute is: %s",GetAttributeByUIChannel(channelIndex):AddrNative())
end
```

--------------------------------

### Get first child with Ptr() and Dump()

Source: https://help.malighting.com/grandMA3/2.5/HTML/lua_object_ptr.html

Example usage of the Ptr() function to get a handle to the first child of the selected sequence. It checks for nil handles, prints an error if no sequence is selected, and uses Dump() to print object information. The colon notation omits the handle argument.

```Lua
return function()
    -- SelectedSequence() creates a handle to the selected sequence.
    local selectedSequence = SelectedSequence()
    -- Check that a handle was returned - if not then exit function.
    if selectedSequence == nil then
        ErrPrintf("There is no selected sequence.")
        return
    end
    -- Get a handle to the first child object.
    local firstChild = selectedSequence:Ptr(1)
    -- Print some feedback.
    if firstChild ~= nil then
        Printf("=============== START OF DUMP ===============")
        firstChild:Dump()
        Printf("================ END OF DUMP ================")
    else
        ErrPrintf("The object do not have a child object.")
    end
end
```

--------------------------------

### DirList example with GetPath and filter

Source: https://help.malighting.com/grandMA3/2.5/HTML/lua_objectfree_dirlist.html

This example prints the show files in the showfile directory. It uses the GetPath() function to obtain the path and a filter to list only .show files. The returned table elements contain name, size, and time keys.

```lua
return function ()
    -- Get the path to the show files.
    local path = GetPath(Enums.PathType.Showfiles)
    -- Make a filter to only list .show files.
    local filter = "*show"
    -- Use the DirList function to get a table of the files.
    local returnTable = DirList(path, filter)

    -- Print the information of the files in the returned table.
    for _, value in pairs(returnTable) do
        Printf(value['name'] .. " - Size: " .. value['size'] .. " bytes - Time: " .. os.date("%c", value['time']))
    end
end
```

--------------------------------

### Example: Print cue names from first sequence using Children()

Source: https://help.malighting.com/grandMA3/2.5/HTML/lua_object_children.html

This example stores the handle for sequence 1 in the selected data pool, uses the Children() function to get a table of its child cues, and prints each cue's name. It includes error handling if the sequence is not found.

```Lua
return function()
    -- Stores the handle for sequence 1 in a variable.
    local mySequence = DataPool().Sequences[1]
    if mySequence ~= nil then
            -- Use the "Children()" funciton to store a table with all the children in a new variable.
        local cues = mySequence:Children()
        -- For loop that uses the length operator on the cue variable.
        for i = 1, #cues do
            -- Text is printed for each child.
            Printf("Sequence 1 Child " .. i .. " = " .. cues[i].name)
        end
    else
        ErrPrintf("Sequence could not be found.")
    end
end
```

--------------------------------

### Example: Print dump of channel function using GetChannelFunction

Source: https://help.malighting.com/grandMA3/2.5/HTML/lua_objectfree_getchannelfunction.html

This example selects the first fixture in the current selection, retrieves the UI Channel Index and Attribute Index for the Dimmer attribute, and prints the dump of the channel function. It uses GetAttributeIndex, GetUIChannelIndex, and GetChannelFunction. The example ends with an error message if no fixture with a Dimmer is selected.

```lua
return function()
    -- Select the first fixture in the current selection.
    local subfixtureIndex = SelectionFirst()
    -- End the function if there is no selection.
    if subfixtureIndex == nil then
        ErrPrintf("Please select a fixture with a Dimmer")
        return
    end
    -- Get the Attribute index and UIChannel index.
    local attributeIndex = GetAttributeIndex("Dimmer")
    local uiChannelIndex = GetUIChannelIndex(subfixtureIndex,attributeIndex)
    Printf("The UIChannel Index is: %i. The Attribute Index is: %i. ",uiChannelIndex, attributeIndex)
    -- End the function if any of the index return nil.
    if (attributeIndex == nil or uiChannelIndex == nil) then
        ErrPrintf("Something wrong happened, maybe your first selected fixture don't have a Dimmer - Please try again")
        return
    end
    -- The following prints the dump for the dimmer channel function.
    Printf("=============== START OF DUMP ===============")
    GetChannelFunction(uiChannelIndex,attributeIndex):Dump()
    Printf("================ END OF DUMP ================")
end
```

--------------------------------

### List Objects and Macros

Source: https://help.malighting.com/grandMA3/2.5/HTML/keyword_list.html

These commands list objects in the show file. The first lists the first ten fixtures of the Fixture Edit Setup, the second lists all existing attributes, the third lists the first five groups of the group pool, and the fourth lists macros available to import from the default macro library folder on the first connected USB drive.

```grandMA3 command line
User name[Fixture]>List Fixture Thru 10
```

```grandMA3 command line
User name[Fixture]>List Attribute
```

```grandMA3 command line
User name[Fixture]>List Group Thru 5
```

```grandMA3 command line
User name[Fixture]>List Macro Library If Drive 2
```

--------------------------------

### Record Timecode 3 Example

Source: https://help.malighting.com/grandMA3/2.5/HTML/keyword_record.html

Starts recording timecode 3 in the timecode pool. Type this command in the command line after entering the Record keyword.

```grandMA3 Command Line
User name[Fixture]>Record Timecode 3
```

--------------------------------

### Up keyword example

Source: https://help.malighting.com/grandMA3/2.5/HTML/keyword_up.html

Example command to go back to the main fixture in the fixture sheet in an upward manner.

```plaintext
User name[Fixture]>Up
```

--------------------------------

### Store into Cues with Wildcard Label

Source: https://help.malighting.com/grandMA3/2.5/HTML/cue_store.html

Use an asterisk as a wildcard to store into all cues whose labels start with "BO". This example merges the new value into those cues.

```plaintext
User name[Fixture]>Store Cue "BO*" /Merge
```
Tokens:
Raw