This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
beyond:osc_commands [2020/01/10 13:20] Bob Varkevisser [OSC to PangoScript GATEWAY] |
beyond:osc_commands [2021/04/16 11:10] (current) Bob Varkevisser |
||
---|---|---|---|
Line 6: | Line 6: | ||
===== OSC Message ===== | ===== OSC Message ===== | ||
- | |||
OSC Message contains 3 parts: | OSC Message contains 3 parts: | ||
Line 15: | Line 14: | ||
As example, for control of master position. | As example, for control of master position. | ||
- | ===== Supported Argument types ===== | + | |
+ | ===== OSC in Object tree ===== | ||
+ | |||
+ | To find OSC commands/ | ||
+ | Open up the tools menu and click object tree to make it visible. | ||
+ | |||
+ | {{: | ||
+ | |||
+ | Once the Object tree is visible, you are able to browse the tree it self by double clicking on items. | ||
+ | |||
+ | {{: | ||
+ | |||
+ | Once you clicked on an address or command you can take the command from the OSC address bar and use that on various locations. | ||
+ | |||
+ | The OSC address bar with command is highlighted in the example below. | ||
+ | |||
+ | {{: | ||
+ | |||
+ | This OSC address can be used in many locations. | ||
+ | |||
+ | - Internally in the Pangoscript editor | ||
+ | - In BEYOND Universe | ||
+ | - At the midi controller configuration panels | ||
+ | - In third-party OSC applications like Lemur, TouchOSC etc. | ||
+ | |||
+ | Note that not all third-party OSC applications will process OSC as they should. | ||
+ | A known issue is that TouchOSC is not able to process OSC commands to use the | ||
+ | cue grid to its full potential. | ||
+ | |||
+ | |||
+ | ===== OSC to PangoScript GATEWAY ===== | ||
+ | |||
+ | |||
+ | Server transform the OSC message to the command first and then the command goes to execution. The command appear in the system in the same way as it could be from the keyboard, or the mouse. This kind of servers also has fixed address and corresponding set of arguments. Actually, the address of such OSC server is a way to describe BEYOND command. And it was main intention - to give OSC the ability to do the same what the Script can do. Both parts (OSC and Script) produce a Command at the end, and why not to mix both worlds. | ||
+ | |||
+ | Address of message and number of arguments should correspond to the PangoScript command. Available following addressing: | ||
+ | |||
+ | / | ||
+ | / | ||
+ | / | ||
+ | / | ||
+ | / | ||
+ | / | ||
+ | |||
+ | " | ||
+ | |||
+ | The " | ||
+ | |||
+ | |Address|Type|Commentary| | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |||
+ | |||
+ | |||
+ | ==== Supported Argument types ==== | ||
BEYOND support integer number (i), float point number (f), and string (s). Other data types ignored. You need to ensure that OSC client send correct type of argument to BEYOND. | BEYOND support integer number (i), float point number (f), and string (s). Other data types ignored. You need to ensure that OSC client send correct type of argument to BEYOND. | ||
Line 44: | Line 225: | ||
/ | / | ||
- | ===== Direct servers | + | ===== Other OSC Servers ===== |
+ | ==== Direct servers ==== | ||
This kind of server provide a direct access to internal object of BEYOND. No extra layers, or something in between. BEYOND receive the OSC packet, analyze the address and if the address point on direct server, the BEYOND execute it right after the address parsing. Such servers has fixed address part and number of arguments. | This kind of server provide a direct access to internal object of BEYOND. No extra layers, or something in between. BEYOND receive the OSC packet, analyze the address and if the address point on direct server, the BEYOND execute it right after the address parsing. Such servers has fixed address part and number of arguments. | ||
Line 187: | Line 369: | ||
" | " | ||
- | ===== OSC to PangoScript GATEWAY ===== | ||
- | |||
- | Server transform the OSC message to the command first and then the command goes to execution. The command appear in the system in the same way as it could be from the keyboard, or the mouse. This kind of servers also has fixed address and corresponding set of arguments. Actually, the address of such OSC server is a way to describe BEYOND command. And it was main intention - to give OSC the ability to do the same what the Script can do. Both parts (OSC and Script) produce a Command at the end, and why not to mix both worlds. | ||
- | |||
- | Address of message and number of arguments should correspond to the PangoScript command. Available following addressing: | ||
- | |||
- | / | ||
- | / | ||
- | / | ||
- | / | ||
- | / | ||
- | / | ||
- | |||
- | " | ||
- | |||
- | The " | ||
- | |||
- | |Address|Type|Commentary| | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
Line 342: | Line 375: | ||
==== Server: MIDI DEVICES CONTROL ==== | ==== Server: MIDI DEVICES CONTROL ==== | ||
- | / | + | |Function|Type|Commentary| |
- | / | + | |/midi/close|-|close all 4 ports| |
- | / | + | |/midi/open|-|open all 4 ports| |
- | / | + | |/midi/index|f|set current device index, 0..3| |
- | / | + | |/midi/sysex|fff...f|send sysex to current (index) device| |
- | /midi/1/... or / | + | |/ |
- | / | + | |/midi/1/...|-|or / |
- | / | + | |/midi/2/...|-|or / |
- | / | + | |/midi/3/...|-|or / |
- | / | + | |/midi/4/...|-|or / |
- | / | + | |/ |
- | / | + | |/ |
- | / | + | |/ |
+ | |/ | ||
+ | ==== Server: PROJECTION ZONE SETUP ==== | ||
+ | |Function|Type|Commentary| | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
- | Server: | + | ==== Server: |
- | / | + | |
- | / | + | |
- | / | + | |
- | / | + | |
- | / | + | |
- | / | + | |
- | / | + | |
- | / | + | |
- | / | + | |
- | / | + | |
- | / | + | |
- | / | + | |
- | / | + | |
- | / | + | |
- | / | + | |
- | / | + | |
- | / | + | |
- | / | + | |
- | / | + | |
- | / | + | |
- | / | + | |
- | / | + | |
- | / | + | |
- | / | + | |
- | / | + | |
- | / | + | |
- | / | + | |
- | / | + | |
- | / | + | |
- | / | + | |
- | / | + | |
- | / | + | |
- | / | + | |
- | / | + | |
- | / | + | |
- | + | | |
- | + | ||
- | Server: Universe window | + | |
- | + | ||
- | /u/ Layout Name / Object Name / Property Name | + | |
Universe window is the most flexible because the content defined exclusively by BEYOND User. The name of Layout, same as name of Object inside the Layout are completelly used defined. | Universe window is the most flexible because the content defined exclusively by BEYOND User. The name of Layout, same as name of Object inside the Layout are completelly used defined. | ||
- | /value i,f,ii, ff define value of object. Designed for sliders and buttons. An object such as XY Par require two coordinates, | ||
- | /x i,f equal to " | ||
- | /y i,f define Y value for object such as XY Pad | ||
- | /visible i,f control visibility of object. Value above 0.01 will make it visible, below 0.01 - invisible | ||
- | /selected i,f control Selected state of object. Value above 0.01 will make it Selected, below 0.01 - un selected. Used with Zone, Fixture objects in layouts | ||
- | /minvalue i,f define minimum value of slider | ||
- | /maxvalue i,f define maximum value of slider | ||
- | /timeshift i,f define time shift property of component | ||
- | / | ||
- | /radius i,f radius of spatial effect | ||
- | /caption s define caption text of object. | ||
- | /start tart script execution | ||
- | /stop stop script execution | ||
- | /LabelName This allow do a jump to Label defined in the scripts. Labels used with GOTO commands. You also can execute goto by means of this message | ||
+ | |Function|Type|Commentary| | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
- | + | ==== OSC to Script servers | |
- | + | ||
- | + | ||
- | OSC to Script servers. | + | |
This section assume that you already checked the information about BEYOND Commands. The Command of BEYOND contain information about the recipient of the command, code of operation, and the list of arguments. The Command may be addressed to various objects inside BEYOND such as Cue, Projection Zone, Master Live Control, etc. So, BEYOND has a gateway that allow transform OSC messages directly to the Command and send the Command to execution. | This section assume that you already checked the information about BEYOND Commands. The Command of BEYOND contain information about the recipient of the command, code of operation, and the list of arguments. The Command may be addressed to various objects inside BEYOND such as Cue, Projection Zone, Master Live Control, etc. So, BEYOND has a gateway that allow transform OSC messages directly to the Command and send the Command to execution. | ||
Line 427: | Line 457: | ||
The initial addresses of gateway are below: | The initial addresses of gateway are below: | ||
- | /cue | + | |
- | /zone | + | /zone |
- | / | + | / |
- | /master | + | /master |
- | /general | + | /general |
Lets consider for example Cue server. | Lets consider for example Cue server. | ||
- | /cue/ | + | |
The addressing the cue we need to supply the page index and the cue index inside the page. The final address looks like this: | The addressing the cue we need to supply the page index and the cue index inside the page. The final address looks like this: | ||
- | / | + | |
+ | | ||
where: | where: | ||
- | pageindex is number that define index of the page | + | "**pageindex**" |
- | cueindex is a number that define index of cue inside the page | + | |
- | commandname is the name of operator that can be found in document about the PangoScript. | + | |
- | What happens technically is this. The Command is an object with a few properties. The OSC server create Command obejct and start to initialize the properties of the object, one by one. "/ | + | What happens technically is this. The Command is an object with a few properties. The OSC server create Command obejct and start to initialize the properties of the object, one by one. "/ |
+ | |||
+ | Exactly this is a purpose of the gateway - to transform OSC message to the Command. | ||
The code of execution check all arguments and addressing and if something is not correct, then the Command may be blocked completelly. All will depends on exact situation. | The code of execution check all arguments and addressing and if something is not correct, then the Command may be blocked completelly. All will depends on exact situation. | ||
Example of the OSC address for this server: | Example of the OSC address for this server: | ||
- | / | + | |
- | / | + | |
+ | / | ||
What commands can be served by /cue/ server? The most definitely is the Live Control group commands, and FX. The command like cue start, or cue stop, is an area of /general/ server | What commands can be served by /cue/ server? The most definitely is the Live Control group commands, and FX. The command like cue start, or cue stop, is an area of /general/ server | ||
- | |||
- | OSC to Object server. | ||
- | |||
- | Address of server start from prefix /object . After this follow name of object and finally the name of property. As example, we have object Main Graphics (projection zone) and it has property SizeX. The address for access is | ||
- | / | ||
- | The message must comes with one value (argument). It could be string or number. | ||