The API - Application Program Interface

You can control many of the features of Cognito from external devices like show controllers or PCs. The connection may be either through Telnet (Ethernet) or Serial RS232 but each use the same syntax and commands. When you establish a connection, you can type "help" and the following list of commands will be echoed to your terminal for convenience:

• noecho

• noprompt

• help

• API.AttributeFade(fixture[,attribute_name],value [,time])

• API.AttributeFadeCapture(fixture[,attribute_name],value [,time])

• API.Bump('page_name' | page_index , memory_number, bump_on )

• API.ButtonPress('page','name' or order)

• API.MemoryFade('page',memorynumber,value[,seconds])

• API.MemoryFadeRate('page',memorynumber,value[,seconds full scale])

• API.MemoryFadeStop('page',memorynumber)

• API.MemoryGetValue('page',memorynumber)

• API.MidiNoteOff(channel_1_to_16,key_1_to_128[,velocity_0_to127])

• API.MidiNoteOn(channel_1_to_16,key_1_to_128[,velocity_0_to127])

• API.MidiWrite(midi_byte[,midi_byte ...])

• API.OutputsEnable( true | false )

• API.PlaylistAssert('play list')

• API.PlaylistGo('play list')

• API.PlaylistGotoAndExecuteFollows('play list', cue)

• API.PlaylistGotoAndHalt('play list', cue)

• API.PlaylistHalt('play list')

• API.PlaylistHaltBack('play list')

• API.PlaylistRelease('play list'[,release_time])

• API.ReleaseAll()

• API.SerialClose(1 to 16)

• API.SerialOpen(1 to 16,'9600,N,8,1'[,'script'])

• API.SerialRead(1 to 16)

• API.SerialWrite(1 to 16,'output string' or binary_byte or table [,...])

• API.SetLevel('fixture_string', 'level_string' [,fade_time_seconds])

All commands, including item names in the command string, are case sensitive.  A carriage return <CR> must be sent to execute the command.

Examples

Execute cue 4, on ‘Playlist 1’, using any programmed fade, wait, and follow times.

API.PlayListGotoAndExecuteFollows('Playlist 1', 4) <CR>

Release ‘Playlist 1’.

API.PlayListRelease('Playlist 1’) <CR>

In addition to the above command set, Cognito supports much more advanced scripting using its built-in Lua interpreter.  For more information on the Lua programming language, see www.lua.org.