Page 1 of 4

HC. The list - and questions about it.

Posted: Tue Dec 30, 2008 5:43 pm
by tom
I thought it would be nice to compile a definitive list of the HC. commands. (feel free to edit this post to add commands.)

There must be more than this. I ripped this from 10.5.10(beta)

HC.ButtonWingButtonPress( bank, button )
HC.ButtonWingPageUp( bank )
HC.ButtonWingPageDown( bank )
HC.CueListGo('cue list')
HC.CueListHaltBack('cue list')
HC.CueListHalt('cue list')
HC.CueListRelease('cue list'[,release_time])
HC.CueListAssert('cue list')
HC.CueListGotoAndHalt('cue list', cue)
HC.CueListGotoAndExecuteFollows('cue list', cue)
HC.GetButtonWingPageName( bank )
HC.GetButtonWingButtons( bank )
HC.GetSoftkeyText( 'bank' )
HC.GetCommandLineText()
HC.PowerPointFirstSlide(machine_id)
HC.PowerPointLastSlide(machine_id)
HC.PowerPointPrevSlide(machine_id)
HC.PowerPointNextSlide(machine_id)
HC.PowerPointGotoSlide(machine_id,slide_number)
HC.FixtureCheckForward()
HC.FixtureCheckBack()
HC.MediaPlayerPlay()
HC.MediaPlayerStop()
HC.MediaPlayerPause()
HC.MediaPlayerPlayFile('file name')
HC.SerialOpen(1 to 16,'9600,N,8,1'[,'script'])
HC.SerialWrite(1 to 16,'output string' or binary_byte or table [,...])
HC.SerialRead(1 to 16)
HC.SerialClose(1 to 16)
HC.HardwareConsoleLights(level 0 to 10)
HC.VariableGet('page','name' or order)
HC.ButtonPress('page','name' or order)
HC.VariableSet('page','name' or order,'value' or value)
HC.VariableSetDelayed('page','name' or order,'value' or value,seconds)
HC.VariablePagePatchSet('page','new patch')
HC.Status('status string')
HC.LookFade('page',looknumber,value[,seconds])
HC.LookFadeRate('page',looknumber,value[,seconds full scale])
HC.LookGetValue('page',looknumber)
HC.LookFadeStop('page',looknumber)
HC.AttributeGetValue([source_identifier,]fixture[,attribute_name])
HC.AttributeFade(fixture[,attribute_name],value [,time])
HC.PatchFixture(fixture[,dmx_channel [, 'Dimmer' | 'DMX1' | 'DMX2' | 'DMX3' ] ] )
HC.SetFixtureType(fixture[, 'manufacturer', 'model [, 'mode']])
HC.RecordLook('look_page',look_number[,'merge'|'replace'][,'IPCGLSTE'][,'label'])
HC.RecordCue('cue_list',cue_number[,'merge'|'replace'][,'IPCGLSTE'][,cue_time][,'label'])
HC.ReleaseAll()
HC.GetScriptSource('type'|'number'|'parent'|'name'[,'type'|'number'|'parent'|'name'[,'seperator']])
HC.ILSSetScene(device_id,scene) HC.ILSLockCommand(device_id,lock(1)/unlock(0)
HC.MidiNoteOff(channel_1_to_16,key_1_to_128[,velocity_0_to127])
HC.MidiNoteOn(channel_1_to_16,key_1_to_128[,velocity_0_to127])
HC.MidiTimeCodeEnable() HC.MidiWrite(midi_byte[,midi_byte ...])
HC.SMPTEStart(['hh:mm:ss.fr'[,'30'|'30dr'|'25'|'24']][,interface])
HC.SMPTEStop(interface) HC.UIMacro('macro-info'[,'macro-info' ...])
HC.MessageBox('message box string'[,'message box title'])
HC.OutputCapture(output , level | 'level_percent')
HC.OutputRelease(output )
HC.OutputPark(output, level | 'level_percent' [, park_group])
HC.OutputUnPark(output [, park_group ] )
HC.FlashFixture([fixture_num])
HC.FlashOutput([output_num])
HC.Select('fixture_string')
HC.Deselect('fixture_string')
HC.SetLevel('fixture_string', 'level_string' [,fade_time_seconds])
HC.Encoder( encoder_number, signed_value)
HC.Wheel( wheel_number, signed_value)
HC.Trackball( 'H' | 'V' | 'X' | 'Y', signed_value)
HC.SoftkeyPress( 'M or S', button_number )
HC.GetCurrentSelectionSet(['delimeter'])
HC.FlipCurrentSelectionSet()
HC.SetOutputPriority(output_number , priority )
HC.AddUserFunctionDescription('description_of_function')

Re: HC. The list - and questions about it.

Posted: Tue Dec 30, 2008 5:46 pm
by tom
Questions.

What is the functionality of the []. Does it ignore the entry and just see it as a place holder.

What can you do with the HC.AddUserFunctionDescription('description_of_function')

Could this list be organised alphabetically in the console?

What are all the HC.Get..... commands?

Re: HC. The list - and questions about it.

Posted: Tue Dec 30, 2008 7:08 pm
by RobertBell
tom wrote:What is the functionality of the []. Does it ignore the entry and just see it as a place holder.
[] is standard syntax for optional commands. Note where the commad is in the []'s
tom wrote:What can you do with the HC.AddUserFunctionDescription('description_of_function')
This adds an entry into the Script part of the macro editor. ShowReports has these at the end of the *.lua file so that users don't have to look at the code to know how to use it.
tom wrote:Could this list be organised alphabetically in the console?
Big on my wish list too.
tom wrote:What are all the HC.Get..... commands?
We have a document. I'm going to try to get permission to post it here.

Re: HC. The list - and questions about it.

Posted: Wed Dec 31, 2008 11:03 am
by TaineGilliam
Alpha sort, easy. Finding list of missing functions, not easy.

HC.AddUserFunctionDescription('description_of_function')
HC.AttributeFade(fixture[,attribute_name],value [,time])
HC.AttributeGetValue([source_identifier,]fixture[,attribute_name])
HC.ButtonPress('page','name' or order)
HC.ButtonWingButtonPress( bank, button )
HC.ButtonWingPageDown( bank )
HC.ButtonWingPageUp( bank )
HC.CueListAssert('cue list')
HC.CueListGo('cue list')
HC.CueListGotoAndExecuteFollows('cue list', cue)
HC.CueListGotoAndHalt('cue list', cue)
HC.CueListHalt('cue list')
HC.CueListHaltBack('cue list')
HC.CueListRelease('cue list'[,release_time])
HC.Deselect('fixture_string')
HC.Encoder( encoder_number, signed_value)
HC.FixtureCheckBack()
HC.FixtureCheckForward()
HC.FlashFixture([fixture_num])
HC.FlashOutput([output_num])
HC.FlipCurrentSelectionSet()
HC.GetButtonWingButtons( bank )
HC.GetButtonWingPageName( bank )
HC.GetCommandLineText()
HC.GetCurrentSelectionSet(['delimeter'])
HC.GetScriptSource('type'|'number'|'parent'|'name'[,'type'|'number'|'parent'|'name'[,'seperator']])
HC.GetSoftkeyText( 'bank' )
HC.HardwareConsoleLights(level 0 to 10)
HC.ILSSetScene(device_id,scene)
HC.ILSLockCommand(device_id,lock(1)/unlock(0)
HC.LookFade('page',looknumber,value[,seconds])
HC.LookFadeRate('page',looknumber,value[,seconds full scale])
HC.LookFadeStop('page',looknumber)
HC.LookGetValue('page',looknumber)
HC.MediaPlayerPause()
HC.MediaPlayerPlay()
HC.MediaPlayerPlayFile('file name')
HC.MediaPlayerStop()
HC.MessageBox('message box string'[,'message box title'])
HC.MidiNoteOff(channel_1_to_16,key_1_to_128[,velocity_0_to127])
HC.MidiNoteOn(channel_1_to_16,key_1_to_128[,velocity_0_to127])
HC.MidiTimeCodeEnable() HC.MidiWrite(midi_byte[,midi_byte ...])
HC.OutputCapture(output , level | 'level_percent')
HC.OutputPark(output, level | 'level_percent' [, park_group])
HC.OutputRelease(output )
HC.OutputUnPark(output [, park_group ] )
HC.PatchFixture(fixture[,dmx_channel [, 'Dimmer' | 'DMX1' | 'DMX2' | 'DMX3' ] ] )
HC.PowerPointFirstSlide(machine_id)
HC.PowerPointGotoSlide(machine_id,slide_number)
HC.PowerPointLastSlide(machine_id)
HC.PowerPointNextSlide(machine_id)
HC.PowerPointPrevSlide(machine_id)
HC.RecordCue('cue_list',cue_number[,'merge'|'replace'][,'IPCGLSTE'][,cue_time][,'label'])
HC.RecordLook('look_page',look_number[,'merge'|'replace'][,'IPCGLSTE'][,'label'])
HC.ReleaseAll()
HC.Select('fixture_string')
HC.SerialClose(1 to 16)
HC.SerialOpen(1 to 16,'9600,N,8,1'[,'script'])
HC.SerialRead(1 to 16)
HC.SerialWrite(1 to 16,'output string' or binary_byte or table [,...])
HC.SetFixtureType(fixture[, 'manufacturer', 'model [, 'mode']])
HC.SetLevel('fixture_string', 'level_string' [,fade_time_seconds])
HC.SetOutputPriority(output_number , priority )
HC.SMPTEStart(['hh:mm:ss.fr'[,'30'|'30dr'|'25'|'24']][,interface])
HC.SMPTEStop(interface)
HC.SoftkeyPress( 'M or S', button_number )
HC.Status('status string')
HC.Trackball( 'H' | 'V' | 'X' | 'Y', signed_value)
HC.UIMacro('macro-info'[,'macro-info' ...])
HC.VariableGet('page','name' or order)
HC.VariablePagePatchSet('page','new patch')
HC.VariableSet('page','name' or order,'value' or value)
HC.VariableSetDelayed('page','name' or order,'value' or value,seconds)
HC.Wheel( wheel_number, signed_value)

Re: HC. The list - and questions about it.

Posted: Wed Dec 31, 2008 2:14 pm
by RobertBell
RobertBell wrote:
tom wrote:What are all the HC.Get..... commands?
We have a document. I'm going to try to get permission to post it here.
See this:
HC_Get.pdf
(26.56 KiB) Downloaded 382 times

Re: HC. The list - and questions about it.

Posted: Wed Dec 31, 2008 3:00 pm
by TaineGilliam
Great info Robert.

Help me clarify: GetProperty( 'cue', 'TheCueList', 5, 'name')

I'm hoping to get back the label for Cue 5. How do I tell GetProperty I'm looking for Cue 5 not the 5th cue - Cue number not index? Is this the point or the hash - #5 vs 5 ?

I guess the same question could apply to Look or Variable, too.

Any progress on adding a Lua interface for Events?

Taine

Re: HC. The list - and questions about it.

Posted: Wed Dec 31, 2008 3:40 pm
by RobertBell

Code: Select all

print(HC.GetProperty('cue','T2C','#2','name'))
gives cue # 2 vs. the 2nd index (zero based index)

No info on time events yet.

Re: HC. The list - and questions about it.

Posted: Wed Dec 31, 2008 4:01 pm
by MattKlasmeier
Attached is a sortable Excel spread sheet of the HC. commands. It was done in Excel 2007 .

Re: HC. The list - and questions about it.

Posted: Mon Feb 02, 2009 5:51 pm
by tom
Do we get any commands for making and manipulating effects?

Re: HC. The list - and questions about it.

Posted: Mon Feb 02, 2009 8:04 pm
by RobertBell
None at present. The problem we have is identifying which running fx you want to tweak (currently there is no unique identifier). Any thoughts are welcome.