• grandMA3 User Manual
    • About the Help
      • Open the help in the console
      • Open the help in the web
      • Open the help as pdf
      • Navigate in the help
    • Device Overview
      • grandMA3 consoles
        • grandMA3 full-size
        • grandMA3 full-size CRV
        • grandMA3 light
        • grandMA3 light CRV
        • grandMA3 compact XT
        • grandMA3 compact
      • grandMA3 extension
      • grandMA3 replay unit
      • grandMA3 processing units
      • grandMA3 nodes
      • grandMA3 nodes DIN-Rail
      • grandMA3 I/O Node
      • grandMA3 I/O Node DIN-Rail
      • grandMA3 onPC command wing XT
      • grandMA3 onPC command wing
      • grandMA3 onPC fader wing
      • grandMA3 onPC rack-unit
      • Screen allocation
      • Keyboard shortcuts
        • Framework shortcuts
      • Keys
        • . [Dot]
        • <<< [GoFastBackward] | Black
        • >>> [GoFastForward] | Flash
        • - [Minus]
        • + [Plus]
        • / [Slash] | * [Asterisk/Multiply]
        • At
        • Assign
        • Align
        • Blind
        • Clear
        • Channel
        • Copy
        • Ctrl
        • Cue
        • Down
        • Delete
        • Esc
        • Edit
        • Freeze
        • Full
        • Fixture
        • Group
        • Goto
        • Go+ [large]
        • Go- [large]
        • Go+ | Temp
        • Go- | Top
        • Help
        • Highlt [Highlight]
        • If
        • Learn | Rate1
        • List
        • MA
        • Menu
        • Move
        • Next
        • Numeric keys | arrows
        • Oops
        • On
        • Off
        • Pause [large]
        • Pause | Fix
        • Page+
        • Page-
        • Please
        • Power
        • Preset
        • Prvw [Preview]
        • Prev [Previous]
        • Select
        • SelFix [SelectFixture]
        • Sequ [Sequence]
        • Set
        • Solo
        • Stomp
        • Store
        • Thru
        • Time
        • Up
        • Update
        • U1
        • U2
        • X1 | Clone
        • X2 | Link
        • X3 | Grid
        • X4 | Layout
        • X5 | Step
        • X6 | TC
        • X7 | View
        • X8 | DMX
        • X9
        • X10
        • X11
        • X12
        • X13 | Phaser
        • X14 | Macro
        • X15 | Page
        • X16 | Exec
        • Xkeys
      • Control elements
        • Command area
        • Master area
        • Custom area
        • Dual encoders
        • Level wheel
        • Grand master
        • Executor elements
      • Connector pin assignment
      • UPS battery
    • System Overview
      • Standalone device
      • Locally networked devices
      • World server
      • Parameters
        • Calculate parameters
        • Expand the amount of parameters
    • First Steps
      • Unpack the device
      • Check scope of delivery
      • Position the device
      • Connect power
      • Connect desk light
      • Connect external screens
      • Connect USB devices
      • Connect DMX
      • Connect Audio In
      • Connect MIDI
      • Connect LTC
      • Connect Ethernet
      • Connect DC Remote In
      • Connect grandMA3 extension
      • Connect grandMA3 fader wing
      • Turn on the device the first time
    • grandMA3 onPC
      • System requirements
      • Windows™® installation
      • Optimize Windows™®
      • macOS® installation
      • Optimize macOS®
      • onPC Terminal App
      • onPC settings
    • Show File Handling
      • Load show file
      • Save show file
      • New show file
      • Backup, demo and template show files
      • Organize show files
    • Workspace
      • User interface
        • Configuration of displays
        • Desk lock
        • User-defined area
        • Command line
        • Control bar
        • View bar
        • Tables in general
        • Trackpad window
      • Gestures
      • Command area
      • Oops overlay
      • Master controls
      • Playback controls
      • Displays in grandMA3 onPC
      • Encoder bar
        • Feature group control bar
        • Encoder toolbar
      • Calculator
      • Playback bar
      • Command wing bar
      • Colors
        • System
        • Markers
        • Color theme
        • Compare tool
    • Command Syntax and Keywords
      • Syntax rules
      • Parent child concept
      • General keywords
        • ; [Semicolon]
        • / [Slash]
        • . [Dot]
        • = [Equal]
        • <<< [GoFastBackward]
        • >>> [GoFastForward]
        • - [Minus]
        • * [Asterisk]
        • % [Percent]
        • + [Plus]
        • Absolute
        • Acceleration
        • Action
        • ActivationGroup
        • Agenda
        • Align
        • AlignTransition
        • Appearance
        • Assign
        • At
        • Attribute
        • AutoCreate
        • Black
        • Blind
        • Block
        • BPM
        • Call
        • CancelSoftwareUpdate
        • Camera
        • Capture
        • ChangeDestination
        • Channel
        • ChannelSet
        • Chat
        • ChatJoin
        • ChatLeave
        • CleanUp
        • Clear
        • ClearActive
        • ClearAll
        • ClearSelection
        • Clone
        • CommandDelay
        • Collect
        • Collection
        • Color
        • ColorDefinition
        • ColorTheme
        • Configuration
        • Console
        • Cook
        • Copy
        • Cue
        • CueAbsolute
        • CueDelay
        • CueFade
        • CueInDelay
        • CueInFade
        • CueOutDelay
        • CueOutFade
        • CueRelative
        • CueUpdate
        • CurrentEnvironment
        • CurrentUser
        • CurrentUserProfile
        • Cut
        • DataPool
        • Deceleration
        • Decimal8
        • Decimal16
        • Decimal24
        • Default
        • Delay
        • Delete
        • DeleteOtherVersions
        • DeleteGlobalVariable
        • DeleteUserVariable
        • Dismiss
        • Display
        • DMXAddress
        • DMXLayer
        • DMXReadout
        • DMXUniverse
        • DoubleSpeed
        • Down
        • DumpLog
        • Drive
        • DropOwnership
        • Echo
        • Edit
        • EditSetting
        • Eject
        • Effect
        • EncoderPage
        • EndIf
        • Environment
        • Exchange
        • Executor
        • Export
        • Extract
        • Extension
        • Fade
        • FaderCrossFade
        • FaderCrossFadeA
        • FaderCrossFadeB
        • FaderMaster
        • FaderRate
        • FaderSpeed
        • FaderTemp
        • FaderTime
        • FeatureGroup
        • Filter
        • Fix
        • FixtureClass
        • FixtureLayer
        • Fixture
        • FixtureType
        • Flip
        • Flash
        • Fog
        • Freeze
        • Full
        • Gel
        • GetGlobalVariable
        • GetUserVariable
        • Go+
        • Go-
        • Goto
        • Grid
        • GridPosition
        • Group
        • HalfSpeed
        • Help
        • HelpLua
        • Hex8
        • Hex16
        • Hex24
        • Highlight
        • Houselights
        • Hz
        • If
        • IfActive
        • IfOutput
        • IfProgrammer
        • Image
        • Import
        • Index
        • Insert
        • Integrate
        • Interface
        • Invert
        • Invite
        • IP
        • JoinSession
        • Key
        • Keyboard
        • KeyboardShortcut
        • Kill
        • KnockIn
        • KnockOut
        • Label
        • Layout
        • LearnSpeed
        • LeaveSession
        • Library
        • List
        • ListOwnership
        • ListReference
        • Load
        • Loaded
        • LoadShow
        • Lock
        • LogIn
        • LogOut
        • Lowlight
        • Lua
        • LuaFile
        • Macro
        • MArker
        • Master
        • MAtricks
        • Measure
        • Media
        • MemoryInfo
        • Menu
        • Mesh
        • Move
        • Multipatch
        • MyRunningMacro
        • MyRunningPreset
        • MyRunningSequence
        • MyRunningTimer
        • Natural
        • NDI
        • NewShow
        • Next
        • NextY
        • NextZ
        • NetworkNode
        • NonDim
        • Normal
        • Note
        • Off
        • Offset
        • On
        • onPC
        • OSC
        • Oops
        • OutputLayer
        • Page
        • Part
        • Park
        • Paste
        • Patch
        • Pause
        • Percent
        • PercentFine
        • Phase
        • Physical
        • Plugin
        • Preset
        • PresetUpdate
        • Press
        • Preview
        • Previous
        • PreviousY
        • PreviousZ
        • Programmer
        • Property
        • ProcessingUnit
        • Pyro
        • Quickey
        • Rate1
        • RDM
        • Readout
        • Reboot
        • Recast
        • Record
        • Relative
        • Release
        • ReloadAllPlugins
        • ReloadUI
        • Remote
        • RemoteHID
        • RemoteCommand
        • Remove
        • RenderQuality
        • Reset
        • Restart
        • Root
        • RealtimeChannel
        • RunningMacro
        • RunningPreset
        • RunningSequence
        • RunningTimecode
        • RunningTimer
        • SaveShow
        • ScreenConfiguration
        • ScreenContent
        • Scribble
        • Seconds
        • Select
        • Selection
        • SelectFixtures
        • Sequence
        • SendMIDI
        • SendOSC
        • Set
        • SetGlobalVariable
        • SetUserVariable
        • Shuffle
        • ShutDown
        • SnapDelay
        • SoftwareImport
        • SoftwareUpdate
        • SoundChannel
        • Solo
        • SpecialExecutor
        • Speed
        • Speed1
        • SpeedMaster
        • Stage
        • Station
        • StationSettings
        • Step
        • Stomp
        • Store
        • SwitchTograndMA2Software
        • SwitchTograndMA3Software
        • Swap
        • Temp
        • Thru
        • Time
        • Timecode
        • TimecodeSlot
        • Timer
        • Toggle
        • TopUp
        • Top
        • Transition
        • Type
        • UIChannel
        • UIGridSelection
        • Unblock
        • Universal
        • Unlock
        • Unpark
        • Unpress
        • Up
        • Update
        • UpdateContent
        • User1
        • User2
        • User
        • UserProfile
        • Video
        • Version
        • View
        • ViewButton
        • Width
        • World
        • Zero
      • Option keywords
        • /Active
        • /ActiveForSelected
        • /AddNewContent
        • /All
        • /AllForSelected
        • /Ask
        • /Auto
        • /CopyCueDestination
        • /CopyCueSource
        • /CreateReferenceObject
        • /CreateSecondCue
        • /CueOnly
        • /Date
        • /Default
        • /DiscardChanges
        • /DMX
        • /DMXProtocols
        • /Embed
        • /Enumerate
        • /File
        • /ForceGlobal
        • /GDTF
        • /Gaps
        • /Global
        • /GridMergeMode
        • /Indirect
        • /InputFilter
        • /KeepActivation
        • /LocalSettings
        • /Look
        • /MAtricks
        • /Merge
        • /MergeHighPriority
        • /MergeLowPriority
        • /MoveValues
        • /NoAutoClose
        • /NoConfirmation
        • /NoDependencies
        • /NoOops
        • /NoRefresh
        • /NoSave
        • /NoShowData
        • /NoSubfolders
        • /OriginalContentOnly
        • /Output
        • /OutputStations
        • /Overwrite
        • /PatchOffset
        • /Path
        • /PhaserData
        • /Programmer
        • /Release
        • /Remove
        • /Save
        • /Screen
        • /Selection
        • /Selective
        • /Single
        • /Tab
        • /Type
        • /Universal
        • /Wrap
      • Extended command line syntax options
    • Windows, Views, and Menus
      • Add window
      • Rearrange
      • Store and recall views
      • Remove windows from a screen
      • Window settings
      • Title bar configuration
      • Menus
      • Change menu locations
      • Pool windows
        • Create pool objects
        • Label pool objects
        • Move pool objects
        • Insert pool objects
        • Copy pool objects
        • Lock and unlock pool objects
        • Delete pool objects
    • Networking
      • Interfaces and IP
      • Session
        • Create a session
        • Join a session
        • Leave a session
        • Invite to a session
        • Dismiss from session
        • Create a custom key
        • Session master selection
      • Web remote
      • Network design
        • Protocol details
        • WLAN (WiFi)
      • Regulations and standards
    • DMX In and Out
      • DMX port configuration
      • Ethernet DMX
        • Art-Net menu
        • sACN menu
        • Transmit DMX using Art-Net
    • Single User and Multi User Systems
      • Create user
      • User settings
      • Object ownership
    • Patch and Fixture Setup
      • What are fixtures
      • Add fixtures to the show
      • Add multipatch fixtures
      • MVR
      • Live patch
      • DMX sheet
      • DMX universes
      • Remove fixtures from the show
      • Position fixtures in the 3D space
      • 3D viewer
      • Render quality
      • Camera pool
      • Stages
      • Classes and layers
      • Attribute definitions
        • Activation group
        • Feature group
        • Deactivation group
      • Parameter list
      • DMX curves
    • Operate Fixtures
      • Select fixtures
      • What is the programmer
      • Fixture sheet
        • Graphics
      • Encoder resolution
      • Using the color picker
      • Gel pool
      • Selection bar
      • Align
      • Selection Grid
      • SMArt view
    • Scribbles
      • Create scribbles
      • Edit scribbles
      • Assign scribbles
      • Delete scribbles
    • Images
      • Screenshots
    • Video
    • Meshes
    • Gobos
    • Symbols
      • Import symbols
      • Delete symbols
    • Appearances
      • Create appearances
      • Use appearances
      • Delete appearances
    • Notes
    • Groups
      • Create groups
      • Edit groups
      • Delete groups
      • Group masters
    • Presets
      • Preset pools
      • Create new presets
      • Recipe presets
      • Use preset
      • Edit or Update presets
    • Worlds and Filters
      • At filter
      • Create a world
      • Create a filter
      • Use a world or filter
      • Delete a world
      • Delete a filter
    • MAtricks and Shuffle
      • Blocks
      • Groups
      • Wings
      • Widths
      • Shuffle
      • Transform
    • Cues and Sequences
      • What is tracking
        • Tracking distance
        • Break
      • Sequence sheet
      • Content sheet
      • Sequence settings
      • Store cues
      • Update cues
      • Copy cues
      • Cue recipes
      • Store settings and preferences
      • Play back cues
      • Move in black
      • Cue timing
      • Renumber cues
      • Delete cues
    • Executors
      • Assign object to an executor
      • Executor configurations
      • Running playbacks
      • Special executors
    • Masters
      • Selected masters
      • Grand masters
        • Time control
      • Speed masters
      • Playback masters
    • Recipes
    • Phasers
      • Phaser editor
      • Create sinus dimmer phaser
      • Create circle phaser
      • Create circle phaser around position
      • Create color rainbow phaser
    • XYZ
      • Activating XYZ for fixture types
      • MArker fixture
    • Macros
      • Create macros
      • Import macros
      • Edit macros
      • Assign macros to keys and buttons
      • Variables
      • Examples
    • Agenda
      • View modes
      • Create an agenda entry
      • Edit an agenda entry
      • Agenda toolbar
    • Timers
      • Stopwatch
      • Countdown
    • Timecode
      • What are timecode slots
      • Timecode settings
      • Track groups
      • Time ranges and events
      • Toggle view mode
      • Record a timecode show
      • Record an external timecode show
      • Edit a timecode show
      • External sources
    • Layouts
      • Create a layout
      • Assign multipatch fixtures
      • Edit layout
      • Layout view settings
      • Edit layout view
      • Edit layout elements
      • Layout encoder bar
    • Plugins
      • What is Lua?
      • Handle
      • Interface functions
        • Progress bar
      • Variable functions
      • Functions - Object-Free API
        • AddonVars
        • BuildDetails
        • ClassExists
        • CloseAllOverlays
        • CloseUndo
        • Cmd
        • CmdIndirect
        • CmdIndirectWait
        • CmdObj
        • ConfigTable
        • Confirm
        • CreateUndo
        • CurrentEnvironment
        • CurrentExecPage
        • CurrentProfile
        • CurrentUser
        • DataPool
        • DefaultDisplayPositions
        • DelVar
        • DeskLocked
        • DeviceConfiguration
        • DrawPointer
        • Echo
        • ErrEcho
        • ErrPrintf
        • Export
        • ExportCSV
        • ExportJson
        • FromAddr
        • GetApiDescriptor
        • GetAttributeByUIChannel
        • GetAttributeCount
        • GetAttributeIndex
        • GetChannelFunction
        • GetChannelFunctionIndex
        • GetClassDerivationLevel
        • GetDisplayByIndex
        • GetDisplayCollect
        • GetDMXUniverse
        • GetDMXValue
        • GetExecutor
        • GetFocus
        • GetFocusDisplay
        • GetObjApiDescriptor
        • GetPath
        • GetPathSeparator
        • GetRTChannel
        • GetRTChannelCount
        • GetRTChannels
        • GetSample
        • GetSelectedAttribute
        • GetShowFileStatus
        • GetSubfixture
        • GetSubfixtureCount
        • GetTokenName
        • GetTokenNameByIndex
        • GetUIChannelCount
        • GetUIChannelIndex
        • GetUIChannels
        • GetVar
        • GlobalVars
        • HandleToInt
        • HandleToStr
        • HookObjectChange
        • HostOS
        • HostSubType
        • HostType
        • Import
        • IncProgress
        • IntToHandle
        • IsObjectValid
        • KeyboardObj
        • MasterPool
        • MessageBox
        • MouseObj
        • ObjectList
        • Patch
        • PopupInput
        • Printf
        • ProgrammerPart
        • Pult
        • ReleaseType
        • Root
        • SelectedSequence
        • Selection
        • SelectionCount
        • SelectionFirst
        • SelectionNext
        • SerialNumber
        • SetBlockInput
        • SetLED
        • SetProgress
        • SetProgressRange
        • SetProgressText
        • SetVar
        • ShowData
        • ShowSettings
        • StartProgress
        • StopProgress
        • StrToHandle
        • TextInput
        • Time
        • Timer
        • TouchObj
        • UserVars
        • Version
      • Functions - Object API
        • Addr
        • AddrNative
        • Children
        • Dump
        • Export
        • HasActivePlayback
        • Import
        • ToAddr
    • Quickeys
      • Quickey editor
      • Use quickey pool objects
      • Example
    • Data Pools
    • System
      • Date and time
      • Clock
      • Desk lights
      • System information
      • System monitor
      • Info window
    • Sound
    • Remote In and Out
      • DC remotes
      • MIDI remotes
      • DMX remotes
      • OSC
        • Examples
        • TouchOSC
        • QLab
        • Open stage control
        • zactrack
        • Protocol viewer
      • PSN
      • MIDI
    • RDM
    • Control other MA Devices
      • grandMA3 nodes
      • MA network switch
      • RemoteHID
    • Update the Software
      • Update grandMA3 consoles
      • Update grandMA3 Nodes
      • Update grandMA3 onPC windows hardware
      • Update grandMA3 viz-key
      • Network update
      • Delete update files
      • Troubleshooting
    • Fixture Types
      • Import fixture types
        • Import GDTF
        • Conflicts in fixture types
      • Build fixture types
        • Insert fixture types
        • Insert DMXModes
        • Insert geometries
        • Insert models
        • Link models to geometries
        • Link DMX modes to geometries
        • Environmental fixture types
      • Export fixture types
    • File Management
      • SFTP connection
      • Import / Export menu
      • Folder structure
    • Shut Down the System
    • Troubleshooting
      • Clean start
      • Update does not work
      • Station does not connect
      • Panic macro
    • Glossary
  • grandMA3 Quick Start Guide
  • grandMA3 Quick Manual consoles
  • grandMA3 Quick Manual processing units
  • grandMA3 Quick Manual Nodes
  • grandMA3 Quick Manual Nodes DIN-Rail
  • grandMA3 Quick Manual onPC command wing XT
  • grandMA3 Quick Manual onPC command wing
  • grandMA3 Quick Manual onPC fader wing
  • grandMA3 Quick Manual onPC rack-unit
  • grandMA3 Quick Manual viz-key
  • grandMA3 Quick Manual I/O Nodes
  • Release Notes
Select different version
 
Hint:
New help version
The help version you selected belongs to an older software version. You may want to view the latest help version.
Version 1.9

Create Macros

Table of contents of this topic

Macros are created using the GUI editor or the command line.

For a better understanding of macros, see Macros topic.

Create a Macro

To create a macro:

  1. To open the Macro pool, open the Add window dialog, tap Data Pools and then tap Macros.
  2. Edit an empty macro pool object. This automatically creates a new macro and opens the editor.
  3. Tap Insert New MacroLine to add a row in the macro.
  4. 2 Finger Edit the Command cell. The text input pop-up opens.
  5. Write a command into the editor. See Examples for more information.
  6. Repeat steps 3 through 5 to add several rows with commands to the macro.

There are several buttons in the editor. This is a short explanation of the specific buttons:

  • Settings: Enable Settings in the title bar to display the Name, Scribble, Appearance, Note, Lock, and CLI buttons.
  • Test Macro Line: Tests only the selected line.
  • Test Macro: Tests the macro.
  • List References: For more information, see Info Window.
Hint:
The macro editor displays the value in the Wait cell of the last macro line in red to indicate that the value is not being used. For more information, see Macros.

To execute the macro, close the editor and tap the macro.

 

The editor could look like this (the macro is the "ChangeDestination Root" macro from the library):

Macro editor

If CLI is disabled, tapping the macro pool will still execute it if nothing is entered into the command line. If there are commands entered in the command line, the macro is executed without affecting the command line.

When you press Edit and tap macro 5 in the macro pool, it will no longer interact with the edit command. To edit the macro, you would have to type: 

User name[Fixture]> Edit Macro 5
Hint:
When command-line interaction is disabled, CLI is displayed in red letters on the pool object. Now that commands no longer interact with the command line, use Swipey Commands.
Macro 3 with CLI deactivated

Create a Macro by Using the Command Line

Macros can be added using the command line. This is relevant when the GUI is unavailable, for instance, when the software is accessed via the command line only, using the terminal window.

To see the result in the command line feedback, use the List command at any time during the creative process.

Requirement:

  • The command line feedback needs to be visible.

This is the creation process:

  1. Navigate to the macro part of the software:

User name[Fixture]>ChangeDestination Macro
  1. List the existing macros to see empty macro objects:

User name@ShowData/DataPools/Default/Macros>List
  1. Locate an available number (one that is not listed).
  2. Store a macro with the number:

User name@ShowData/DataPools/Default/Macros>Store [Available_Number]
  1. Navigate into the new macro:
User name@ShowData/DataPools/Default/Macros>ChangeDestination [Available_Number]
  1. Insert a line into the macro:
User name@ShowData/DataPools/Default/Macros/Macro #>Insert
  1. Add the command to the text field line number using the Set command:
User name@ShowData/DataPools/Default/Macros/Macro #>Set [Line_Number] Property "Command" ["Command Inside Quotations"]
 
  1. The wait time can be set in the same manner as the text:
User name@ShowData/DataPools/Default/Macros/Macro #>Set [Line_Number] Property "Wait" ["Wait Time"]
Hint:
The wait time can be entered as a number in seconds without quotation marks or as text with quotation marks. The two special times called Follow and Go can be entered without quotation marks, but the software will add the marks. They are case-sensitive. Typing "go" gives an error. Typing "Go" works.
  1. Add more macro lines by repeating steps 6 through 8, but remember to use the correct line number with the Set command.
  2. Return to the root of the command line:
User name@ShowData/DataPools/Default/Macros/Macro #>ChangeDestination Root

A new macro is created.

Label a Macro

Macro pool objects are labeled like any pool object. Read more in the Label Pool Objects topic.

A unique macro name makes it possible to run the macro by using their names.


Select different version