Complete Help Docs

Laser Show Technology for Lighting Professionals

User Tools

Site Tools


beyond:osc_commands

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
beyond:osc_commands [2020/01/21 11:00]
Bob Varkevisser [OSC Message]
beyond:osc_commands [2021/04/16 11:10] (current)
Bob Varkevisser
Line 17: Line 17:
 ===== OSC in Object tree ===== ===== OSC in Object tree =====
  
-To find OSC commands/addresses, an easy way is to follow the Object tree.+To find OSC commands/addresses the easy way is to make usage of the Object tree.
 Open up the tools menu and click object tree to make it visible. Open up the tools menu and click object tree to make it visible.
  
Line 42: Line 42:
   A known issue is that TouchOSC is not able to process OSC commands to use the    A known issue is that TouchOSC is not able to process OSC commands to use the 
   cue grid to its full potential.   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:
  
-===== Supported Argument types =====+  /beyond/general/... 
 +  /beyond/master/... 
 +  /beyond/cue/... 
 +  /beyond/zone/... 
 +  /beyond/projector/... 
 +  /beyond/protrack/... 
 + 
 +"general" use for variety of script commands. All others are for specific features of object, or for live control (see above) 
 + 
 +The "general" serve contain embedded Scripter-object that always exists. Basically, you supply a command into embedded scripter and then it wait for the next command 
 + 
 +|Address|Type|Commentary| 
 +|/beyond/general/CueDown|ii or iii| 
 +|/beyond/general/CueUp|ii or iii| 
 +|/beyond/general/PauseCue|iii| 
 +|/beyond/general/RestartCue|ii| 
 +|/beyond/general/StopAllNow|-| 
 +|/beyond/general/StopAllSync|f| 
 +|/beyond/general/StopAllAsync|f| 
 +|/beyond/general/StopCueNow|ii| 
 +|/beyond/general/StopCueSync|iif| 
 +|/beyond/general/StopZone|if| 
 +|/beyond/general/StopZonesOfProjector|i| 
 +|/beyond/general/BlackOut|-| 
 +|/beyond/general/EnableLaserOutput|-| 
 +|/beyond/general/DisableLaserOutput|-| 
 +|/beyond/general/MasterPause|i| 
 +|/beyond/general/VirtualLJ|i| 
 +|/beyond/general/VLJFX|ii| 
 +|/beyond/general/BeatTap|-| 
 +|/beyond/general/SetBpm|f| 
 +|/beyond/general/SetBpmDelta|f| 
 +|/beyond/general/BeatResync|-| 
 +|/beyond/general/OneCue|-| 
 +|/beyond/general/OnePer|-| 
 +|/beyond/general/MultiCue|-| 
 +|/beyond/general/Transition|i| 
 +|/beyond/general/ClickSelect|-| 
 +|/beyond/general/ClickToggle|-| 
 +|/beyond/general/ClickRestart|-| 
 +|/beyond/general/ClickFlash|-| 
 +|/beyond/general/ClickSoloFlash|-| 
 +|/beyond/general/ClickLive|-| 
 +|/beyond/general/TimerBeat|-| 
 +|/beyond/general/AudioBeat|-| 
 +|/beyond/general/ManualBeat|-| 
 +|/beyond/general/ClickScrollZoom|f| 
 +|/beyond/general/ClickScrollSize|f| 
 +|/beyond/general/ClickScrollFade|f| 
 +|/beyond/general/ClickScrollVPoints|f| 
 +|/beyond/general/ClickScrollScanRate|f| 
 +|/beyond/general/ClickScrollColor|f| 
 +|/beyond/general/ClickScrollAniSpeed|f| 
 +|/beyond/general/ClickScrollR|f| 
 +|/beyond/general/ClickScrollG|f| 
 +|/beyond/general/ClickScrollB|f| 
 +|/beyond/general/ClickScrollA|f| 
 +|/beyond/general/SetLimiterProfile|i| 
 +|/beyond/general/SetLimiterPerZone|i| 
 +|/beyond/general/SetLimiterPerGrid|i| 
 +|/beyond/general/SetLimiterFlash|i| 
 +|/beyond/general/SetLimiterHold|i| 
 +|/beyond/general/SetLimiterBeam|i| 
 +|/beyond/general/SetLimiterDMX|i| 
 +|/beyond/general/SetLimiterShow|i| 
 +|/beyond/general/MasterTransitionIndex|i| 
 +|/beyond/general/MasterTransitionTime|f| 
 +|/beyond/general/MasterTransition|i| 
 +|/beyond/general/DisplayPopup|ANY TTS| 
 +|/beyond/general/DisplayPreview|si| 
 +|/beyond/general/MasterSpeed|f| 
 +|/beyond/general/UnselectAllSmart|-| 
 +|/beyond/general/SelectSmart|ANY TTS| 
 +|/beyond/general/UnselectSmart|ANY TTS| 
 +|/beyond/general/ToggleSelectSmart|ANY TTS| 
 +|/beyond/general/UnmuteAllSmart|-| 
 +|/beyond/general/MuteSmart|ANY TTS| 
 +|/beyond/general/UnmuteSmart|ANY TTS| 
 +|/beyond/general/ToggleMuteSmart|ANY TTS| 
 +|/beyond/general/UnselectAllFixt|-| 
 +|/beyond/general/SelectFixt|ANY TTS| 
 +|/beyond/general/UnselectFixt|ANY TTS| 
 +|/beyond/general/ToggleSelectFixt|ANY TTS| 
 +|/beyond/general/UnmuteAllZone|-| 
 +|/beyond/general/MuteZone|ANY TTS| 
 +|/beyond/general/UnmuteZone|ANY TTS| 
 +|/beyond/general/ToggleMuteZone|ANY TTS| 
 +|/beyond/general/MuteSelected|i| 
 +|/beyond/general/UnselectAllZones|-| 
 +|/beyond/general/SelectZone|ANY TTS| 
 +|/beyond/general/SelectZoneName|ANY TTS| 
 +|/beyond/general/UnSelectZone|ANY TTS| 
 +|/beyond/general/UnSelectZoneName|ANY TTS| 
 +|/beyond/general/ToggleSelectZone|ANY TTS| 
 +|/beyond/general/ToggleSelectZoneName|ANY TTS| 
 +|/beyond/general/MuteSelectedZones|i| 
 +|/beyond/general/SetGridSize|ii| 
 +|/beyond/general/MasterPauseTime|i| 
 +|/beyond/general/StoreZoneSelection|-| 
 +|/beyond/general/ReStoreZoneSelection|-| 
 +|/beyond/general/SelectGrid|i| 
 +|/beyond/general/SelectTabName|s| 
 +|/beyond/general/SelectTab|i| 
 +|/beyond/general/SelectNextTab|-| 
 +|/beyond/general/SelectPrevTab|-| 
 +|/beyond/general/SelectPageName|-| 
 +|/beyond/general/SelectPage|i| 
 +|/beyond/general/SelectNextPage|-| 
 +|/beyond/general/SelectPrevPage|-| 
 +|/beyond/general/SelectAllCat|-| 
 +|/beyond/general/SelectCatName|s| 
 +|/beyond/general/SelectCat|i| 
 +|/beyond/general/SelectNextCat|-| 
 +|/beyond/general/SelectPrevCat|-| 
 +|/beyond/general/FocusCell|ii| 
 +|/beyond/general/FocusCellIndex|i| 
 +|/beyond/general/StartCell|-| 
 +|/beyond/general/ReStartCell|-| 
 +|/beyond/general/StopCell|-| 
 +|/beyond/general/ShiftFocus|i| 
 +|/beyond/general/MoveFocus|ii| 
 +|/beyond/general/SelectCue|s| 
 +|/beyond/general/StartCue|s| 
 +|/beyond/general/StopCue|s| 
 +|/beyond/general/LoadCue|s| 
 +|/beyond/general/LoadWorkspace|s| 
 +|/beyond/general/SetPage|i| 
 +|/beyond/general/GetPage|-| 
 +|/beyond/general/SelectMidi|i| 
 +|/beyond/general/MidiOut|iii| 
 +|/beyond/general/DmxOut|Any TTS|'ii', base channel, value, value, value... and so on.| 
 +|/beyond/general/ChannelOut|ii| 
 +|/beyond/general/OscOut|Any TTS|sii ClickCode:'OscOut "/beam1/xy", -5, 100 - set beam 1 position to [-5,100]';),
 +|/beyond/general/StopZoneByName|s| 
 +|/beyond/general/StopProjectorByName|s| 
 +|/beyond/general/ControlMaster|-| 
 +|/beyond/general/ControlCue|ii| 
 +|/beyond/general/ControlZone|i| 
 +|/beyond/general/ControlTrack|i| 
 +|/beyond/general/ControlProjector|i| 
 +|/beyond/general/ControlSmart|i| 
 +|/beyond/general/StopCode|s| 
 + 
 + 
 + 
 +==== 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 78: Line 225:
   /beyond/zone/<MyVariable>/select 1   /beyond/zone/<MyVariable>/select 1
  
-===== 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 221: Line 369:
 "**FUNCTION**" is name of function that exists in the Fixture "**FUNCTION**" is name of function that exists in the Fixture
  
-=====   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: 
- 
-  /beyond/general/... 
-  /beyond/master/... 
-  /beyond/cue/... 
-  /beyond/zone/... 
-  /beyond/projector/... 
-  /beyond/protrack/... 
- 
-"general" use for variety of script commands. All others are for specific features of object, or for live control (see above) 
- 
-The "general" serve contain embedded Scripter-object that always exists. Basically, you supply a command into embedded scripter and then it wait for the next command 
- 
-|Address|Type|Commentary| 
-|/beyond/general/CueDown|ii or iii| 
-|/beyond/general/CueUp|ii or iii| 
-|/beyond/general/PauseCue|iii| 
-|/beyond/general/RestartCue|ii| 
-|/beyond/general/StopAllNow|-| 
-|/beyond/general/StopAllSync|f| 
-|/beyond/general/StopAllAsync|f| 
-|/beyond/general/StopCueNow|ii| 
-|/beyond/general/StopCueSync|iif| 
-|/beyond/general/StopZone|if| 
-|/beyond/general/StopZonesOfProjector|i| 
-|/beyond/general/BlackOut|-| 
-|/beyond/general/EnableLaserOutput|-| 
-|/beyond/general/DisableLaserOutput|-| 
-|/beyond/general/MasterPause|i| 
-|/beyond/general/VirtualLJ|i| 
-|/beyond/general/VLJFX|ii| 
-|/beyond/general/BeatTap|-| 
-|/beyond/general/SetBpm|f| 
-|/beyond/general/SetBpmDelta|f| 
-|/beyond/general/BeatResync|-| 
-|/beyond/general/OneCue|-| 
-|/beyond/general/OnePer|-| 
-|/beyond/general/MultiCue|-| 
-|/beyond/general/Transition|i| 
-|/beyond/general/ClickSelect|-| 
-|/beyond/general/ClickToggle|-| 
-|/beyond/general/ClickRestart|-| 
-|/beyond/general/ClickFlash|-| 
-|/beyond/general/ClickSoloFlash|-| 
-|/beyond/general/ClickLive|-| 
-|/beyond/general/TimerBeat|-| 
-|/beyond/general/AudioBeat|-| 
-|/beyond/general/ManualBeat|-| 
-|/beyond/general/ClickScrollZoom|f| 
-|/beyond/general/ClickScrollSize|f| 
-|/beyond/general/ClickScrollFade|f| 
-|/beyond/general/ClickScrollVPoints|f| 
-|/beyond/general/ClickScrollScanRate|f| 
-|/beyond/general/ClickScrollColor|f| 
-|/beyond/general/ClickScrollAniSpeed|f| 
-|/beyond/general/ClickScrollR|f| 
-|/beyond/general/ClickScrollG|f| 
-|/beyond/general/ClickScrollB|f| 
-|/beyond/general/ClickScrollA|f| 
-|/beyond/general/SetLimiterProfile|i| 
-|/beyond/general/SetLimiterPerZone|i| 
-|/beyond/general/SetLimiterPerGrid|i| 
-|/beyond/general/SetLimiterFlash|i| 
-|/beyond/general/SetLimiterHold|i| 
-|/beyond/general/SetLimiterBeam|i| 
-|/beyond/general/SetLimiterDMX|i| 
-|/beyond/general/SetLimiterShow|i| 
-|/beyond/general/MasterTransitionIndex|i| 
-|/beyond/general/MasterTransitionTime|f| 
-|/beyond/general/MasterTransition|i| 
-|/beyond/general/DisplayPopup|ANY TTS| 
-|/beyond/general/DisplayPreview|si| 
-|/beyond/general/MasterSpeed|f| 
-|/beyond/general/UnselectAllSmart|-| 
-|/beyond/general/SelectSmart|ANY TTS| 
-|/beyond/general/UnselectSmart|ANY TTS| 
-|/beyond/general/ToggleSelectSmart|ANY TTS| 
-|/beyond/general/UnmuteAllSmart|-| 
-|/beyond/general/MuteSmart|ANY TTS| 
-|/beyond/general/UnmuteSmart|ANY TTS| 
-|/beyond/general/ToggleMuteSmart|ANY TTS| 
-|/beyond/general/UnselectAllFixt|-| 
-|/beyond/general/SelectFixt|ANY TTS| 
-|/beyond/general/UnselectFixt|ANY TTS| 
-|/beyond/general/ToggleSelectFixt|ANY TTS| 
-|/beyond/general/UnmuteAllZone|-| 
-|/beyond/general/MuteZone|ANY TTS| 
-|/beyond/general/UnmuteZone|ANY TTS| 
-|/beyond/general/ToggleMuteZone|ANY TTS| 
-|/beyond/general/MuteSelected|i| 
-|/beyond/general/UnselectAllZones|-| 
-|/beyond/general/SelectZone|ANY TTS| 
-|/beyond/general/SelectZoneName|ANY TTS| 
-|/beyond/general/UnSelectZone|ANY TTS| 
-|/beyond/general/UnSelectZoneName|ANY TTS| 
-|/beyond/general/ToggleSelectZone|ANY TTS| 
-|/beyond/general/ToggleSelectZoneName|ANY TTS| 
-|/beyond/general/MuteSelectedZones|i| 
-|/beyond/general/SetGridSize|ii| 
-|/beyond/general/MasterPauseTime|i| 
-|/beyond/general/StoreZoneSelection|-| 
-|/beyond/general/ReStoreZoneSelection|-| 
-|/beyond/general/SelectGrid|i| 
-|/beyond/general/SelectTabName|s| 
-|/beyond/general/SelectTab|i| 
-|/beyond/general/SelectNextTab|-| 
-|/beyond/general/SelectPrevTab|-| 
-|/beyond/general/SelectPageName|-| 
-|/beyond/general/SelectPage|i| 
-|/beyond/general/SelectNextPage|-| 
-|/beyond/general/SelectPrevPage|-| 
-|/beyond/general/SelectAllCat|-| 
-|/beyond/general/SelectCatName|s| 
-|/beyond/general/SelectCat|i| 
-|/beyond/general/SelectNextCat|-| 
-|/beyond/general/SelectPrevCat|-| 
-|/beyond/general/FocusCell|ii| 
-|/beyond/general/FocusCellIndex|i| 
-|/beyond/general/StartCell|-| 
-|/beyond/general/ReStartCell|-| 
-|/beyond/general/StopCell|-| 
-|/beyond/general/ShiftFocus|i| 
-|/beyond/general/MoveFocus|ii| 
-|/beyond/general/SelectCue|s| 
-|/beyond/general/StartCue|s| 
-|/beyond/general/StopCue|s| 
-|/beyond/general/LoadCue|s| 
-|/beyond/general/LoadWorkspace|s| 
-|/beyond/general/SetPage|i| 
-|/beyond/general/GetPage|-| 
-|/beyond/general/SelectMidi|i| 
-|/beyond/general/MidiOut|iii| 
-|/beyond/general/DmxOut|Any TTS|'ii', base channel, value, value, value... and so on.| 
-|/beyond/general/ChannelOut|ii| 
-|/beyond/general/OscOut|Any TTS|sii ClickCode:'OscOut "/beam1/xy", -5, 100 - set beam 1 position to [-5,100]';),| 
-|/beyond/general/StopZoneByName|s| 
-|/beyond/general/StopProjectorByName|s| 
-|/beyond/general/ControlMaster|-| 
-|/beyond/general/ControlCue|ii| 
-|/beyond/general/ControlZone|i| 
-|/beyond/general/ControlTrack|i| 
-|/beyond/general/ControlProjector|i| 
-|/beyond/general/ControlSmart|i| 
-|/beyond/general/StopCode|s| 
-|/beyond/general/CallMenu|s| 
  
  
Line 487: Line 486:
  
 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 
-/object/maingraphics/sizex 
-The message must comes with one value (argument). It could be string or number. 
  
  
beyond/osc_commands.1579600812.txt · Last modified: 2020/06/11 19:23 (external edit)