Artist Help:Text Commands

From ShowCAD Wiki

These are text versions of the System Command which are used with serial input and Telnet input

All the following commands are ASCII strings. Fields enclosed by, but excluding, the <> characters are required and have the meaning described in the text. Fields enclosed by, but excluding, the [] characters are options dependant on the message. All of these messages are terminated by a return character (HEX 0D, DEC 13).

Display Client DC<type>,<group>

Example : DC3,2

This command will display cue list 2.

type description 0 current - don't changed 1 fixtures 2 scenes 3 cues


group 0 current - don't change >0 any value greater than zero will select that list or group


Display Window DW<section>,<window>

Example DW3,5

This command will display the Cues in the navigator.

section window 1 Master window description 1 Cue Control 2 Time Control 3 Program Control

2 Client window description 1 Templates 2 Fixtures 3 Scenes 4 Cues 5 Patch

3 Navigator window description 1 Resources 2 Templates 3 Fixtures 4 Scenes 5 Cues

4 Monitor window description 1 Status 2 Notes 3 Capture 4 Output

5 Palette window description 1 Colour 2 Brush 3 Focus 4 Beam

6 Other window description 1 touch screen 2 theatre gui


Activate AC<type>,<group>,<object>[,action]

Example: AC3,0,5

This command will activate cue 5 on the currently active list

type description 0 current - no change 1 fixture 2 scene 3 cue


group 0 current - don't change >0 any value greater than zero will select that list or group

object is the decimal number of the object in the group to activate.

action 1 Toggle status. This command will invert the state of the object specified. 2 Activate object. 3 Deactivate object. 4 Button Up/Note off

If an action is not specified, toggle is assumed.

Events and Flags EF<type>[,argument]

Example: EF1

This command will clear all parameter flags.

type description 1 Clear all parameter flags 2 Clear selected parameter flags 3 Set event flag - requires argument 4 Clear event flag - requires argument 5 Mark time stamped event 6 Set Linear flag - the arguments is the level is the range 0 - 255

Global GL<section>,<function>[,option]

Example: GL1,4

This command toggles the Fade In/Out function in the cue control window.

section function 1 cue control function description 1 Black/Restore 2 Blackout only 3 Restore only 4 Fade in/out 5 Fade out 6 Fade in 7 Panic 8 Go 9 Clear 10 Sequence 11 Chase 12 Stop 13 Start RTS 14 Stop RTS 15 Preset 16 Normalize Global Rate 17 Set blackout fade to snap 18 Maximise List Level 19 Normalise List Hue 20 Autopilot toggle 21 Master level bump up 22 Master level bump down 23 List level bump up 24 List level bump down

2 fixture function description 1 Reset ALL 2 Reset group 3 Lamp ON ALL 4 Lamp ON group 5 Lamp OFF ALL 6 Lamp OFF group

3 activate functions description 1 Deactivate ALL 2 Deactivate all in group

4 group/list functions description 1 Previous group 2 Next group 3 group advance

5 triggers description 1 BPM tap 2 BPM rate 3 BPM Auto 4 Manual trigger 5 Manual gate

6 Programming description 1 Fixture Preset 2 Clear All Flags 3 Zero Active Parameter



Serial Output SO<port>,<message_string>

Example: SO1,xollob_fo_daol

port the serial port number the message is to be output on. In the range 1-8 message_string this is an ASCII string with no white spaces as it will appear on the serial output port.

Network Output NO<port>,<message_string>

Example: NO,xollob_fo_daol

port the network port number the message is to be output on. message_string this is an ASCII string with no white spaces as it will appear on the network output port.

MIDI Output MO<message><device><channel>[data1][data2]

message NF note off NO note on KP key pressure CC control change PC program change CP channel pressure PB Pitch bend SR system real time

device the index of the MIDI output port to send the message out on channel the midi channel number in the range 1 - 16 data1 optional data field in the range 0 - 127 data2 optional data field in the range 0 - 127

Example:

MONO1,1,64,127

Wave Audio output WA<name>[,action][,volume]

name is the name of the file as it is displayed in the resources tree view including the extension.

Example: WAboing.wav,1

Action value,

0 stop audio wave 1 play audio wave 2 toggle audio wave state 3 play audio wave and associated time code events 4 stop all audio files from playing

If the volume argument is specified it sets the playback volume of the audio clip. The value is in the range of 0 to 100 where 100 is the maximum volume.

Shell SH<command>[filename]

Command Description 1 Screen saver ON 2 Screen saver OFF 3 Monitor OFF 4 Monitor ON 5 Set power scheme 0 6 Set power scheme 1 7 Set power scheme 2 8 Set power scheme 3 9 Set power scheme 4 10 Set power scheme 5 11 Shutdown computer 12 Execute command [filename]

Linear Control LC<type>[,param1][,param2],<level>

Example: LC3,0,5,33

This command will set the level of Cue 5 in the active list to 33%.

The level is in the range 0 - 100.

type name description 1 Active parameter the param1 value is in the range 1 - the number of fixture in the active fixture group. 2 Active fixture the param1 value is in the range 1 to the number of parameters in the active fixture 3 Cue level Adjusts the level of the specified cue. If param1 is 0 then the current cue list is used or param1 is the cue list.

Param2 is the cue.

4 Master adjusts the master fader 5 XFader adjusts the xfader 6 BPM time adjusts the global BPM timer 7 Cue thru rate adjusts the thru rate of the specified cue If param1 is 0 then the current cue list is used or param1 is the cue list.

Param2 is the cue.

8 Last cue level adjusts the level of the last activated cue 9 Last cue rate adjusts the thru rate of the last activated cues 10 Dynamic adjusts the level of the dynamic fader allocation. 11 Cue List Level 12 Global Rate 13 List Chase Rate adjust the speed of the running List chase in the range of 1 second to 5 minutes 14 List Chase Rate adjusts the speed of the list chase 15 List Hue adjusts the hue of the colour mixing elements in a cue list.

Video Clip VC<name>[,action]

name is the file name as it is displayed in the resource tree view including file extension.

Example: VCskiing.avi

Action value,

0 stop video clip 1 play video clip 2 toggle video clip state 3 play video clip and associated time code events

CD Audio CD<device>[,track][,action]

device is 1. This will be selectable in future implementations.

track is the 1 based track index of the required CD audio track. If track is zero then all tracks are played from the start. The action is play by default.

Example: CD1,2

This command wil play CD audio track 2.

0 stop CD audio playing 1 play specified track (default)

Shell SH<command>

Example: SH3

This command turns the computer monitor off.

1 Enable screen saver 2 Disable screen saver 3 Turn off monitor 4 Turn on monitor 5 Power scheme 1 6 Power scheme 2 7 Power scheme 3 8 Power scheme 4 9 Power scheme 5 10 Power scheme 6 11 Shutdown Windows

Load File FL<filename>

filename is the filename plus file extension of the file to load. It can have one of the following extensions,

extension Notes

  • .wsp Load workspace file
  • .rtc Load real time file
  • .mtc Load time code file
  • .pat Load patch file

Cue Flash CF<list>,<cue>[,0]

group 0 current - don't change >0 any value greater than zero will select that list or group

cue is the index number of the cue with in the selected list.

If not already activated, this command activates the cue and sets its level to maximum. On release, the cue returns to it's previous state.

The zero is for the button Up command.

Select Fixture Parameter SP<parameter>

Example: SP3

This will select the third parameter of the fixtures in the current fixture group.

Dynamic Fader


Palette Command


Cue List Command This command applies to Cue Lists.

CL<command>,<list>

Example : CL6,3

This command start a cue list chase on cue list 3.

1 Cue List action0 Latch 1 Interlocked 2 Momentary

2 Deactivate all cues in the list 3 Advance active cue in list 4 not supported 5 Start cue list sequence 6 Start cue list chasing 7 Stop chase or sequence in cue list 8 Page cue list up 9 Page cue list down 10 Set Cue List level 11 Normalise Cue List rate to Zero 12 Douse Cue List 13 Start/Stop Cue List Timer

Power point