Documentation - ShowCockpit

Show Control and Integration Made Easy

Driver Documentation for v4.11.2

This page contains documentation of the available drivers.

Lighting / Obsidian / Onyx - OSC (4.4.1186)

Interface with Obsidian Control Systems Onyx via OSC. Refer to Onyx manual on how to enable OSC input.

< Back to drivers list
Buy This Driver

    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.

The Device Space is configured in the Onyx OSC device options Menu.

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.

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 work with with older M-PC version?

Yes - as of today, the OSC communication protocol is the same as in the previous M-PC program. Please note that this might change if Onyx gets updated.

Where can I find the old Onyx driver?

This OSC driver is replacing the original Onyx driver to keep compatibility with newer Onyx versions. However, if you are still interested in the original Onyx driver, please read this notice.

Does this driver provide the same functionalities as the previous Onyx Driver?

Unfortunately the official Onyx OSC interface provides a sub-set of the functionality that was provided by ShowCockpit Onyx driver. You can compare the functions of this driver with the previous Onyx driver.

    Element Options

Local IP Address

The local IP address

Incoming Port

Incoming Port in ShowCockpit ("Output Port" in Onyx)

Onyx IP Address

The IP address of the Onyx system

Outgoing Port

Outgoing Port in ShowCockpit ("Input Port" in Onyx)

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.

    Functions

Enable Element   Button LUA Script

Enable this element

Disable Element   Button LUA Script

Disable this element

Change Element Page   Button LUA Script

Changes the page on this element
  • Change Type: The change type - one of {Next, Previous, Go To}
  • Change to Page: Change to specific page, when Change Type is "Go To"

Main Playback Fader   Fader LUA Script

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

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}

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, Pause, Release, Go_Release, Select}

GrandMaster Fader   Fader LUA Script

Controls the level of the GrandMaster fader

FlashMaster Fader   Fader LUA Script

Controls the level of the FlashMaster 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)

Parameter Button   Button LUA Script

Controls an encoder in Onyx
  • Type: Parameter Type - one of {Base, FX}
  • Parameter Number: The number of the parameter to activate (1-7)

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}

Screen Encoder   Encoder LUA Script

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