Obsidian - ONYX
The Obsidian ONYX module uses the ONYX OSC API to remotely control playback functions of ONYX lighting consoles and software.
From the smallest shows to the largest touring productions, ONYX console systems are available in various sizes to accommodate the scale and budgets. At any point the full system can be run on PC systems in installations with USB connected control surfaces or touch screen operation.
| Module Rating | |
|---|---|
| Quality of API | 2/3 |
| Implementation | 3/3 |
| Status | Partial |
See the Modules Overview article for more information about how Module Ratings are calculated.
Settings
Module Settings
- ONYX Patch - Select an OSC patch (IP address) from the Module Settings.
Process Block
After creating an ONYX node, a block will be generated for it within Ctrl Suite's Process Editor.
Create a Process node or edit an existing one to use the ONYX's full functionality.
Endpoints
The endpoints this module supports includes:
Options
| Endpoints | Option 1 | Option 2 | Option 3 | Notes |
|---|---|---|---|---|
| Set Grand Master Level | Integer [0..255] | - | - | Set a value between 0..255 to define the Grand Master Level. |
| Set Flash Master Level | Integer [0..255] | - | - | Set a value between 0..255 to define the Flash Master Level. |
| Set Group Master A Level | Integer [0..255] | - | - | Set a value between 0..255 to define the Group Master Level. |
| Set Group Master B Level | Integer [0..255] | - | - | Set a value between 0..255 to define the Group Master Level. |
| Set Playback Level | Integer [1..20] | Integer [0..255] | - | Set a playback number between 1 and 20 to reference, and a value between 0..255 to define the Playback Level. Button Position "Down" simulates the key being pressed within the ONYX software. |
| Set Playback Bank | Integer [1..5] | Integer [0..255] | - | Set a playback number between 1 and 5 to reference, and a value between 0..255 to define the Playback Level. Button Position "Down" simulates the key being pressed within the ONYX software. |
| Play Playlist | Page Index [1..100] | Button Index [0..99] | - | Set a page and button index to reference the Playlist to play. |
| Pause Playlist | Page Index [1..100] | Button Index [0..99] | - | Set a page and button index to reference the Playlist to pause. |
| Release Playlist | Page Index [1..100] | Button Index [0..99] | - | Set a page and button index to reference the Playlist to release. |
| Select Playlist | Page Index [1..100] | Button Index [0..99] | - | Set a page and button index to reference the Playlist to select. |
| Snap Go Playlist | Page Index [1..100] | Button Index [0..99] | - | Set a page and button index to reference the Playlist to Snap Go. |
| Toggle Playlist | Page Index [1..100] | Button Index [0..99] | - | Set a page and button index to reference the Playlist to toggle. |
| Back Playlist | Page Index [1..100] | Button Index [0..99] | - | Set a page and button index to reference the Playlist to go back. |
| PF | Number [1..20] | Type [PFA/PFB/PFC/PFD] | Button Position [Up/Down] | Set a PF number between 1 and 20, then define its type, (either PFA/BFB/PFC/PFD). Button Position "Down" simulates the key being pressed within the ONYX software. |
| Select Button | Button Position [Up/Down] | - | - | Button Position "Down" emulates the key being pressed within the ONYX software, "Up" simulates it being released. |
| Release Button | Button Position [Up/Down] | - | - | Button Position "Down" emulates the key being pressed within the ONYX software, "Up" simulates it being released. |
| Beat Button | Button Position [Up/Down] | - | - | Button Position "Down" emulates the key being pressed within the ONYX software, "Up" simulates it being released. |
| Snap Button | Button Position [Up/Down] | - | - | Button Position "Down" emulates the key being pressed within the ONYX software, "Up" simulates it being released. |
| Back Button | Button Position [Up/Down] | - | - | Button Position "Down" emulates the key being pressed within the ONYX software, "Up" simulates it being released. |
| Go Button | Button Position [Up/Down] | - | - | Button Position "Down" emulates the key being pressed within the ONYX software, "Up" simulates it being released. |
| View Button | Button Position [Up/Down] | - | - | Button Position "Down" emulates the key being pressed within the ONYX software, "Up" simulates it being released. |
| Bank Page Up Button | Button Position [Up/Down] | - | Button Position "Down" emulates the key being pressed within the ONYX software, "Up" simulates it being released. | |
| Bank Page Down Button | Button Position [Up/Down] | - | - | Button Position "Down" emulates the key being pressed within the ONYX software, "Up" simulates it being released. |
| Trigger Function Key | Function Key [F1..F12] | Button Position [Up/Down] | - | Button Position "Down" emulates the key being pressed within the ONYX software, "Up" simulates it being released. |
Troubleshooting
- Ensure the Ctrl Suite OSC Patch created for ONYX references the port number that ONYX has been configured to receive OSC on.
Additional Resources
- Obsidian Website
- When using OSC, ON LX reccomends the use of a wired network as opposed to WiFi wherever possible, for further advice surrounding UDP based protocols see this article.