Documentation - RD/ShowCockpit

Control & Integration Made Easy

Driver Documentation for v3.7.0

This page contains documentation of the available drivers.

Lighting / Obsidian / Onyx (4.2.1052.0)

Interface with Obsidian Onyx software

< Back to drivers list

    YouTube Videos


    Frequently Asked Questions (FAQs)


What is a "Device Space"?

Each Device Space has its own bank in Onyx. You then associate devices with Device Space the way you want. If you want 2 devices synchronized, you select the same Device Space for both; if you want them working on independent banks, you have to choose different Device Spaces for each. Note: deviceSpace 0 is the MAIN one, and is the one shown at the bottom of Onyx.


I am not getting any feedback. Why?

Feedback for faders and buttons is provided by Onyx for MainPlaybackButtons, MainPlaybackFader, Programmer keys and F-Keys. If you are assigning any other function to your fader or button, don't expect any feedback, because Onyx is not sending any.


I can't control main playbacks 11-20. What am I doing wrong?

Nothing wrong! That's normal. It is a known limitation with no solution.


Can I control multiple banks at the same time?

Sure! All you need is multiple Onyx elements in your project. Each element must connect to a separate bank and through a different Device Space.
Note: deviceSpace 0 is the MAIN one, and is the one shown at the bottom of Onyx.


Does this driver with with older M-PC version?

No. There is a separate driver for the older M-PC program.

    Element Options


Device Space

Device Space

Default Bank

Default Bank

Disable OnyxExternalMidi

The "OnyxExternalMidi" service is used by Onyx to connect to all MIDI devices. Therefore, it might interfer with MIDI connections in ShowCockpit. Turn ON this option to disable the service when connecting.

Connection Timeout (min)

Number of minutes to wait for Onyx to start

    Functions


Main Playback Fader   Fader LUA Script

Controls a main playback fader
  • Playback Number: The number of the playback (1-20)

Main Playback Button   Button LUA Script

Controls a main playback button
  • Playback Number: The number of the playback (1-20)
  • Button: The button (from the top-most button above the fader to the bottom-most below the fader) - one of {Up Up, Up, Down, Down Down}

Submaster Fader   Fader LUA Script

Controls the level of a fader in the submaster wing
  • Page Number: Submaster page number (1-500)
  • Submaster Number: The number of the submaster (1-24)

Submaster Button   Button LUA Script

Sends action for cuelist associated with a submaster button
  • Page Number: Submaster page number (1-500)
  • Submaster Number: The number of the submaster (1-24)
  • Cuelist Action: The action to perform - one of {Go, BackPause, Release, Toggle, Back, Go_Release, Select}

Playback Button   Button LUA Script

Controls a playback button action from the Playback Buttons window
  • Page Number: Playback Buttons page number (1-100)
  • Button Number: The number of the button (1-100)
  • Cuelist Action: The action to perform - one of {Go, BackPause, Release, Toggle, Back, Go_Release, Select}

Grandmaster Fader   Fader LUA Script

Controls the level of the Grandmaster fader

Encoder   Button Encoder LUA Script

Controls an encoder in Onyx
  • Encoder Type: Type of encoder - one of {Base, FX}
  • Encoder Number: The encoder to control (1-4)
  • Scroll Amount: Amount of scrolling

Screen Encoder   Button Encoder LUA Script

Controls one of the screen encoder in Onyx (on the right)
  • Encoder Number: The encoder to control (1-4)
  • Scroll Amount: Amount of scrolling

Encoder Step   Button LUA Script

Sends an encoder step event to Onyx
  • Encoder Type: Type of encoder - one of {Base, FX}
  • Encoder Number: The encoder to control (1-4)
  • Scroll Amount: Amount of scrolling

Change Bank   Button Selector LUA Script

Changes bank on Onyx
  • Change Type: Type change - one of {Next, Previous, Jump To}
  • Jump To Bank: Page to jump to when "Change Type" = "Jump To"

Key   Button LUA Script

Controls a Key event to Onyx
  • Key: The key to trigger - one of {Menu, Preview, Macro, Fade, Delay, Snapshot, Bank, Edit, Undo, Clear, Copy, Move, Delete, Minus, Plus, Dot, Enter, Slash, Back, Full, Thru, At, Record, Update, Load, Group, Cue, Num0, Num1, Num2, Num3, Num4, Num5, Num6, Num7, Num8, Num9, HighLight, Last, Next, MainGo, MainBack, MainSnap, MainRelease, MainSelect, Beat, FXLink, GrandMasterFlash, FlashMasterFlash, EncoderBase1, EncoderBase2, EncoderBase3, EncoderBase4, EncoderFX1, EncoderFX2, EncoderFX3, EncoderFX4, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10}

Parameter Group   Button LUA Script

Selects a parameter group on Onyx
  • Group Type: Type of parameter - one of {Base, FX}
  • Group Number: Number of the parameter group

Direct Parameter   Fader LUA Script

Directly controls a parameter
  • Parameter: The parameter to control - one of {Intensity, Pan, Tilt}
  • 16bit Resolution: Parameter has 16 bit resolution

Parameter Scroll   Fader Encoder Axis LUA Script

Directly controls a parameter
  • Parameter Name: Name of the parameter to control
  • Scroll Amount: Amount of scrolling

Go To Cue   Button LUA Script

Trigger a cue in the selected cuelist
  • Cue Number: Number of the cue to trigger (e.g. "1")

Go To Cue in Cuelist   Button LUA Script

Trigger a cue in a specific cuelist
  • Cue Number: Number of the cue to trigger (e.g. "1")
  • Cuelist Number: Number of the cuelist in the directory (e.g. "1")

Select Group   Button LUA Script

Selects a group of fixtures
  • Group Number: Number of the group you want to select

Get Grandmaster Level   LUA Script

Returns the grandmaster level

Select Fixture   LUA Script

Selects a fixture
  • Fixture Number: Number of the fixture you want to select

Get Selected Fixtures Count   LUA Script

Returns the number of currently selected fixtures

Deselect Fixture   LUA Script

Deselects a fixture
  • Fixture Number: Number of the fixture you want to deselect

Deselect All   LUA Script

Deselects all fixtures

Select Group Mask   LUA Script

Selects a group mask
  • Group Mask Number: Number of the group mask you want to select

Get Group Name   LUA Script

Returns the name of a group of fixtures
  • Group Number: Number of the group you want to get the name from

Select Intensity Preset   LUA Script

Selects an intensity preset
  • Preset Number: Intensity preset number

Select Pan/Tilt Preset   LUA Script

Selects a pan/tilt preset
  • Preset Number: Pan/Tilt preset number

Select Color Preset   LUA Script

Selects a color preset
  • Preset Number: Color preset number

Select Gobo Preset   LUA Script

Selects a gobo preset
  • Preset Number: Gobo preset number

Select Beam Preset   LUA Script

Selects a beam preset
  • Preset Number: Beam preset number

Select Framing Preset   LUA Script

Selects a framing preset
  • Preset Number: Framing preset number

Select Beam FX Preset   LUA Script

Selects a beam FX preset
  • Preset Number: Beam FX preset number

Select FX Macro   LUA Script

Selects an FX Macro
  • FX Macro Number: Number of the FX Macro

Delete Intensity Preset   LUA Script

Deletes an intensity preset
  • Preset Number: Intensity preset number

Delete Pan/Tilt Preset   LUA Script

Deletes a pan/tilt preset
  • Preset Number: Pan/Tilt preset number

Delete Color Preset   LUA Script

Delete a color preset
  • Preset Number: Color preset number

Delete Gobo Preset   LUA Script

Deletes a gobo preset
  • Preset Number: Gobo preset number

Delete Beam Preset   LUA Script

Deletes a beam preset
  • Preset Number: Beam preset number

Delete Framing Preset   LUA Script

Deletes a framing preset
  • Preset Number: Framing preset number

Delete Beam FX Preset   LUA Script

Deletes a beam FX preset
  • Preset Number: Beam FX preset number

Delete FX Macro   LUA Script

Deletes an FX Macro
  • FX Macro Number: FX Macro number

Get Intensity Preset Name   LUA Script

Returns the name of an intensity preset
  • Preset Number: Number of the intensity preset

Get Pan/Tilt Preset Name   LUA Script

Returns the name of a pan/tilt preset
  • Preset Number: Number of the pan/tilt preset

Get Color Preset Name   LUA Script

Returns the name of a color preset
  • Preset Number: Number of the color preset

Get Gobo Preset Name   LUA Script

Returns the name of a gobo preset
  • Preset Number: Number of the gobo preset

Get Beam Preset Name   LUA Script

Returns the name of a beam preset
  • Preset Number: Number of the beam preset

Get Framing Preset Name   LUA Script

Returns the name of a framing preset
  • Preset Number: Number of the framing preset

Get Beam FX Preset Name   LUA Script

Returns the name of a beam FX preset
  • Preset Number: Number of the beam FX preset

Get FX Macro Name   LUA Script

Returns the name of an FX Macro
  • FX Macro Number: Number of the FX Macro

Record Intensity Preset   LUA Script

Records a new intensity preset
  • Preset Number: Number of the preset
  • Preset Name: Name of the preset
  • Merge: True for Merge, false for overwrite

Record Pan/Tilt Preset   LUA Script

Records a new pan/tilt preset
  • Preset Number: Number of the preset
  • Preset Name: Name of the preset
  • Merge: True for Merge, false for overwrite

Record Color Preset   LUA Script

Records a new color preset
  • Preset Number: Number of the preset
  • Preset Name: Name of the preset
  • Merge: True for Merge, false for overwrite

Record Gobo Preset   LUA Script

Records a new gobo preset
  • Preset Number: Number of the preset
  • Preset Name: Name of the preset
  • Merge: True for Merge, false for overwrite

Record Beam Preset   LUA Script

Records a new beam preset
  • Preset Number: Number of the preset
  • Preset Name: Name of the preset
  • Merge: True for Merge, false for overwrite

Record Framing Preset   LUA Script

Records a new framing preset
  • Preset Number: Number of the preset
  • Preset Name: Name of the preset
  • Merge: True for Merge, false for overwrite

Record Beam FX Preset   LUA Script

Records a new beam FX preset
  • Preset Number: Number of the preset
  • Preset Name: Name of the preset
  • Merge: True for Merge, false for overwrite

Record FX Macro   LUA Script

Records a new FX Macro
  • FX Macro Number: Number of the FX Macro
  • FX Macro Name: Name of the FX Macro

Clear Programmer   LUA Script

Clears the programmer

Set Attribute Val   LUA Script

Sets a value for an attribute
  • Attribute Name: Name of the attribute
  • Value: Desired value for the attribute
  • Absolute: Treat value as absolute. Set to false to trat as relative

Select Cuelist   LUA Script

Selects a cuelist
  • Cuelist Number: Desired cuelist number to select

Delete Cuelist   LUA Script

Deletes a cuelist
  • Cuelist Number: Desired cuelist number to delete

Rename Cuelist   LUA Script

Renames the selected cuelist
  • Name: Desired cuelist name (e.g. "New Name")

Get Cuelist Name   LUA Script

Returns the name of a cuelist
  • Cuelist Number: Desired cuelist number you want to get the name from

Set Cuelist Priority   LUA Script

Sets the priority of a cuelist
  • Cuelist Number: Desired cuelist number to change
  • Priority: Desired cuelist priority

Set Cuelist Release Time   LUA Script

Sets the release time of a cuelist
  • Cuelist Number: Desired cuelist number to change
  • Release Time: Desired cuelist release time

Set Cuelist Chase Rate Time   LUA Script

Sets the chase rate time of a cuelist
  • Cuelist Number: Desired cuelist number to change
  • Chase Rate Time: Desired cuelist chase rate time

Set Cuelist Chase XFade Time   LUA Script

Sets the chase x-fade time of a cuelist
  • Cuelist Number: Desired cuelist number to change
  • Chase XFade Time: Desired cuelist chase rate time

Copy Cuelist To Main Playback   LUA Script

Copies a cuelist from directory to main playback section
  • Cuelist Number: Desired cuelist number to change
  • Bank Number: Desired bank number
  • Playback Number: Desired playback number

Copy Cuelist To Playback Button   LUA Script

Copies a cuelist from directory to playback button matrix section
  • Cuelist Number: Desired cuelist number to change
  • Page Number: Desired plyback buttons page
  • Button Number: Desired playback button number

Delete Main Playback   LUA Script

Deletes a cuelist from a main playback bank
  • Bank Number: Desired bank number
  • Playback Number: Desired playback number

Delete Playback Button   LUA Script

Deletes a cuelist from a playback button
  • Page Number: Desired plyback buttons page
  • Button Number: Desired playback button number

Get Cuelist Number From Main Playback   LUA Script

Gets the cuelist number from a main playback
  • Bank Number: Desired bank number
  • Button Number: Desired playback button number

Get Cuelist Number From Playback Button   LUA Script

Gets the cuelist number from a playback button
  • Page Number: Desired page number
  • Button Number: Desired playback button number

Get Next Cuelist Number   LUA Script

Gets the cuelist number for the next recorded cuelist in sequence on directory

Record Cue   LUA Script

Records a cue on the selected cuelist
  • Cue Number: Desired cue number (e.g. "1.1")
  • Merge: True for merge, False for replace

Rename Cue   LUA Script

Renames a cue on the selected cuelist
  • Cue Number: Desired cue number (e.g. "1.1")
  • Name: Desired cue name (e.g. "New Name")

Delete Cue   LUA Script

Deletes a cue on the selected cuelist
  • Cue Number: Cue number to delete (e.g. "1.1")

Delete Cue Range   LUA Script

Deletes a range of cues on the selected cuelist
  • Start Cue Number: Starting cue number to delete (e.g. "1")
  • End Cue Number: End of cue range to delete (e.g. "10")

Set Cue Fade Time   LUA Script

Sets the fade time for a cue
  • Cue Number: Cue number to delete (e.g. "1.1")
  • Fade Time: Desired fade time (e.g. "2.5")

Set Cue Delay Time   LUA Script

Sets the delay time for a cue
  • Cue Number: Cue number to delete (e.g. "1.1")
  • Delay Time: Desired delay time (e.g. "2.5")

Set Cue TC Time   LUA Script

Sets the timecode time for a cue
  • Cue Number: Cue number to delete (e.g. "1.1")
  • TC Time: Desired TC time (e.g. "00030201")

Get Intensity Preset Appearance   LUA Script

Gets the appearance of an intensity preset
  • Preset Number: Number of the preset

Get Pan Tilt Preset Appearance   LUA Script

Gets the appearance of a pan/tilt preset
  • Preset Number: Number of the preset

Get Color Preset Appearance   LUA Script

Gets the appearance of a color preset
  • Preset Number: Number of the preset

Get Gobo Preset Appearance   LUA Script

Gets the appearance of a gobo preset
  • Preset Number: Number of the preset

Get Beam Preset Appearance   LUA Script

Gets the appearance of a beam preset
  • Preset Number: Number of the preset

Get Beam FX Preset Appearance   LUA Script

Gets the appearance of a Beam FX preset
  • Preset Number: Number of the preset

Set Cuelist Appearance   LUA Script

Sets the appearance of a cuelist
  • Cuelist Number: Number of the cuelist
  • Appearance: Desired appearance for the cuelist (e.g. "#FFFFFF")

    Controls


External Macro 1   Button
External Macro 2   Button
External Macro 3   Button
External Macro 4   Button
External Macro 5   Button
External Macro 6   Button
External Macro 7   Button
External Macro 8   Button
External Macro 9   Button
External Macro 10   Button
External Macro 11   Button
External Macro 12   Button
External Macro 13   Button
External Macro 14   Button
External Macro 15   Button
External Macro 16   Button
External Macro 17   Button
External Macro 18   Button
External Macro 19   Button
External Macro 20   Button
External Macro 21   Button
External Macro 22   Button
External Macro 23   Button
External Macro 24   Button
External Macro 25   Button
External Macro 26   Button
External Macro 27   Button
External Macro 28   Button
External Macro 29   Button
External Macro 30   Button
External Macro 31   Button
External Macro 32   Button
External Macro 33   Button
External Macro 34   Button
External Macro 35   Button
External Macro 36   Button
External Macro 37   Button
External Macro 38   Button
External Macro 39   Button
External Macro 40   Button
External Macro 41   Button
External Macro 42   Button
External Macro 43   Button
External Macro 44   Button
External Macro 45   Button
External Macro 46   Button
External Macro 47   Button
External Macro 48   Button
External Macro 49   Button
External Macro 50   Button
External Macro 51   Button
External Macro 52   Button
External Macro 53   Button
External Macro 54   Button
External Macro 55   Button
External Macro 56   Button
External Macro 57   Button
External Macro 58   Button
External Macro 59   Button
External Macro 60   Button
External Macro 61   Button
External Macro 62   Button
External Macro 63   Button
External Macro 64   Button
External Macro 65   Button
External Macro 66   Button
External Macro 67   Button
External Macro 68   Button
External Macro 69   Button
External Macro 70   Button
External Macro 71   Button
External Macro 72   Button
External Macro 73   Button
External Macro 74   Button
External Macro 75   Button
External Macro 76   Button
External Macro 77   Button
External Macro 78   Button
External Macro 79   Button
External Macro 80   Button
External Macro 81   Button
External Macro 82   Button
External Macro 83   Button
External Macro 84   Button
External Macro 85   Button
External Macro 86   Button
External Macro 87   Button
External Macro 88   Button
External Macro 89   Button
External Macro 90   Button
External Macro 91   Button
External Macro 92   Button
External Macro 93   Button
External Macro 94   Button
External Macro 95   Button
External Macro 96   Button
External Macro 97   Button
External Macro 98   Button
External Macro 99   Button
External Macro 100   Button