Configure executor functions, custom commands and size
gma3_configure_executorConfigure grandMA3 executor keys, faders, encoders, custom commands, size, fix, and lock settings by page and executor, with validation, preview, and readback checks.
Instructions
Set key, MA-key, fader, encoder and MA-encoder functions, custom command triplets, Width/Height and Fix of the Sequence or Macro executor at Page . by writing its properties. Unlike 'Assign At', this never clears an unrelated unpress function. Functions are validated against the assigned class before writes; Macro faders/encoders allow only Empty. Sequence Flash, Temp, Swap, Black and Time are key-only. Custom command text is stored, never executed; command requires explicit enabled because the console auto-enables text. The flag is written after the text, even when initially unchanged. Commands preserve exact case and internal spaces; edge whitespace is refused because object reads trim it. Encoder continuous functions and left/right actions or enabled custom commands are mutually exclusive: conflicting requests fail before reads, and implicit mode clears are reported and verified. Storing disabled encoder text against an active continuous mode is refused unless that mode is explicitly cleared. Size changes check complete page occupancy, expanded footprints and proxies; collisions, unreadable or failed enumeration and expansion beyond page bounds are refused before any write. Shrinks precede growth. Executor settings belong to this executor only; sequence settings (Wrap Around, priority, ...) are configured with gma3_configure_sequence. lock: true/false sets the executor's own Lock. A page lock also blocks executor changes. Never sends Go, On, Off, Toggle, Flash or any other playback keyword and does not touch the selection, the programmer or fader levels; playback state is read before and after (playback.activeBefore/activeAfter) and configuration alone does not start playback. A locked target is refused before anything is sent (the console silently ignores writes to it) unless unlock: true, which unlocks the owning object, applies the changes and locks it again (relocking is attempted even after a failed change). preview: true performs only the reads and returns the planned changes (from -> to); values already set are reported as unchanged and never sent. Each value is written with one 'set' request whose reply must read back the requested value, because the console silently keeps the previous value for anything it does not accept; the first failure stops the remaining changes. A value that could not be read is unknown, never a default: the call is refused when a value the plan depends on (requested property, Lock, page Lock) is missing, and a set reply without a value is an unknown step. verify (default true) reads every changed property and the lock back. Mutations from this server are serialised, but not isolated from other operators or clients.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fix | No | Fix the executor on every page (Fix). | |
| lock | No | Final state of the executor's own Lock; lock: false on a locked executor removes the lock (explicit unlock). | |
| page | Yes | Executor page number (1-9999); the page must exist. | |
| fader | No | Fader: Sequence choices Empty, Master, X, XA, XB, Temp, Rate, Speed, Time; Macro choices Empty. Empty clears it. | |
| width | No | Width in executor cells, 1-5. Full page occupancy is checked first; overlapping assignments, incomplete scans, page boundaries and Xkey expansion are refused. | |
| height | No | Height in executor rows, 1-4. Extends toward higher numbered rows, never beyond row 4. The tool refuses collisions before changing size. | |
| unlock | No | Allow unlocking a locked executor and/or page for this call; the locks are restored afterwards (default false: refuse). | |
| verify | No | Read the changed properties back and compare (default true). | |
| encoder | No | Encoder: Sequence choices Empty, Master, X, XA, XB, Temp, Rate, Speed, Time; Macro choices Empty. Empty clears it. | |
| preview | No | Only read and report the planned changes (default false). | |
| executor | Yes | Executor number on that page: 101-190 (keys), 201-290 (faders), 301-390 and 401-490 (knobs), plus the Xkeys 191-198 and 291-298. | |
| data_pool | No | Data pool number (DataPool n). Default: the current data pool, as without this parameter. | |
| key_press | No | KeyPress: Sequence choices Empty, Go+, Go-, <<<, >>>, On, Off, Toggle, Top, Kill, Pause, Goto, Load, Select, SelectFixtures, Rate1, Speed1, Learn, LearnSpeed, HalfSpeed, DoubleSpeed, ReSync, FastSync, Flash, Temp, Swap, Black, Time; Macro choices Empty, <<<, >>>, Call, Go+, Go-, Off, Pause. Empty clears it. | |
| ma_encoder | No | MAEncoder: Sequence choices Empty, Master, X, XA, XB, Temp, Rate, Speed, Time; Macro choices Empty. Empty clears it. | |
| key_unpress | No | KeyUnpress: Sequence choices Empty, Go+, Go-, <<<, >>>, On, Off, Toggle, Top, Kill, Pause, Goto, Load, Select, SelectFixtures, Rate1, Speed1, Learn, LearnSpeed, HalfSpeed, DoubleSpeed, ReSync, FastSync; Macro choices Empty, <<<, >>>, Call, Go+, Go-, Off, Pause. Empty clears it. | |
| encoder_left | No | EncoderLeft: Sequence choices Empty, Go+, Go-, <<<, >>>, On, Off, Toggle, Top, Kill, Pause, Goto, Load, Select, SelectFixtures, Rate1, Speed1, Learn, LearnSpeed, HalfSpeed, DoubleSpeed, ReSync, FastSync; Macro choices Empty, <<<, >>>, Call, Go+, Go-, Off, Pause. Empty clears it. | |
| ma_key_press | No | MAKeyPress: Sequence choices Empty, Go+, Go-, <<<, >>>, On, Off, Toggle, Top, Kill, Pause, Goto, Load, Select, SelectFixtures, Rate1, Speed1, Learn, LearnSpeed, HalfSpeed, DoubleSpeed, ReSync, FastSync, Flash, Temp, Swap, Black, Time; Macro choices Empty, <<<, >>>, Call, Go+, Go-, Off, Pause. Empty clears it. | |
| encoder_right | No | EncoderRight: Sequence choices Empty, Go+, Go-, <<<, >>>, On, Off, Toggle, Top, Kill, Pause, Goto, Load, Select, SelectFixtures, Rate1, Speed1, Learn, LearnSpeed, HalfSpeed, DoubleSpeed, ReSync, FastSync; Macro choices Empty, <<<, >>>, Call, Go+, Go-, Off, Pause. Empty clears it. | |
| ma_key_unpress | No | MAKeyUnpress: Sequence choices Empty, Go+, Go-, <<<, >>>, On, Off, Toggle, Top, Kill, Pause, Goto, Load, Select, SelectFixtures, Rate1, Speed1, Learn, LearnSpeed, HalfSpeed, DoubleSpeed, ReSync, FastSync; Macro choices Empty, <<<, >>>, Call, Go+, Go-, Off, Pause. Empty clears it. | |
| custom_commands | No | Stored custom commands per discrete trigger. Each has command (one line; empty clears; requires explicit enabled), enabled and add_executor. Text is saved before flags; commands are never executed. Enabled encoder commands choose discrete mode and clear the continuous encoder function. | |
| ma_encoder_left | No | MAEncoderLeft: Sequence choices Empty, Go+, Go-, <<<, >>>, On, Off, Toggle, Top, Kill, Pause, Goto, Load, Select, SelectFixtures, Rate1, Speed1, Learn, LearnSpeed, HalfSpeed, DoubleSpeed, ReSync, FastSync; Macro choices Empty, <<<, >>>, Call, Go+, Go-, Off, Pause. Empty clears it. | |
| ma_encoder_right | No | MAEncoderRight: Sequence choices Empty, Go+, Go-, <<<, >>>, On, Off, Toggle, Top, Kill, Pause, Goto, Load, Select, SelectFixtures, Rate1, Speed1, Learn, LearnSpeed, HalfSpeed, DoubleSpeed, ReSync, FastSync; Macro choices Empty, <<<, >>>, Call, Go+, Go-, Off, Pause. Empty clears it. |