background image

Programming i!-MacroManager

3

i!-MacroManager

Programming i!-MacroManager

i!-MacroManager is implemented as a series of NetLinx modules to simplify adding macro 

functionality to your program. To add any of the i!-MacroManager modules to your program, 

simply add the module definition and all it's parameters to your code and integrate the sample touch 

panel pages for that module into your touch panel design. 

One simple way of doing this is to save the i!-MacroManager test file as an include file that you can 

include into your main program. Then you can make any needed modifications to your include file. 

To integrate the touch panel pages, copy each page and popup page from the i!-MacroManager test 

touch panel file and paste it into your design. After copying the popup pages to the new file, you 

will need to create the necessary popup groups and group the popup properly. As an option you can 

base your design on the i!-MacroManager test touch panel file. If the channel and variable text 

codes for i!-MacroManager conflict with existing channel or variable text codes, you can move 

i!-MacroManager to another device using Power Assign and editing the touch panel devices in the 

include file.

In order to use i!-MacroManager, you will need to program and define a series of actions through 

i!-ConnectLinx. The i!-ConnectLinxEngineMod module is included with i!-MacroManager and 

some simple examples appear in the i!-MacroManager test file. For complete documentation on 

i!-ConnectLinx, download the i!-ConnectLinx install from the AMX web site.

Once the i!-ConnectLinx programming has been established, choose which i!-MacroManager 

features you want to include in your program and add the corresponding module code and pages. 

The following list describes the i!-MacroManager modules:

i!-MacroEngineMod

This is the macro engine module. This module executes macros and must always be included for 

any i!-MacroManager functions. This module requires the i!-ConnectLinxEngineMod module.

i!-MacroEditorMod

This is the macro editor module. This module creates, edits and deletes macros. This module must 

be used to create macros but is not required to run the macros. Since this module creates macros, 

you will likely include this module in your program. This module requires the 

i!- ConnectLinxEngineMod, i!-MacroEngineMod and KeyboardMod modules.

i!-MacroExecuteMod

This is the macro execute module. This module allows the user to dynamically assign a macro to a 

touch panel button and run the macro when the button is pressed. This is the most common method 

of macro execution; therefore you will likely include this module in your program. This module 

requires the i!-MacroEngineMod module.

i!-MacroSchedulerEngineMod

This is the macro scheduler engine module. This module allows the scheduling and scheduled 

execution of macros. This module is only needed if you want to support the scheduling of macros. 

This module requires the i!-MacroEngineMod module.

Summary of Contents for I!-MACROMANAGER

Page 1: ...instruction manual integration Solutions i MacroManager...

Page 2: ...any accompanying hardware This limited warranty gives you specific legal rights You may have others which vary from state country to state country NO LIABILITY FOR CONSEQUENTIAL DAMAGES In no event sh...

Page 3: ...acroEngineMod 4 Commands 4 Strings 5 i MacroEngineMod Module Definition 5 Parameters 5 Touch Panel Pages 5 Programming i MacroEditorMod 5 Commands 5 Parameters 6 Touch Panel Pages 10 Programming i Mac...

Page 4: ...ii i MacroManager Table of Contents i MacroSchedulerEditorMod Module Definition 17 Parameters 18 Touch Panel Pages 23...

Page 5: ...he i ConnectLinx action list i MacroManager makes a request to i ConnectLinx to execute those actions i ConnectLinx handles this request and presents it to the NetLinx program for execution Macro and...

Page 6: ...Introduction 2 i MacroManager...

Page 7: ...oManager and some simple examples appear in the i MacroManager test file For complete documentation on i ConnectLinx download the i ConnectLinx install from the AMX web site Once the i ConnectLinx pro...

Page 8: ...e This module manages the systems clock by synchronizing with Internet timeservers This module also provides sunrise and sunset information If you are including the i MacroSchedulerEngineMod module yo...

Page 9: ...device has 1 port with channels levels commands and strings like most other devices Commands i MacroEditorMod supports the following out bound commands master to device i MacroEngineMod Strings Comman...

Page 10: ...irtual device of the KeyboardMod module for editing text dvKB An array of touch panel base devices implementing i MacroEditorMod DEFINE_MODULE i MacroEditorMod mdlMMEdt vdvMacroEditor vdvMacroEngine v...

Page 11: ...variable text channels Macro Name nchMMMacroList An INTEGER array with the following buttons Macro Browser List Items 1 10 nvtMMMacroList An INTEGER array with the following variable text channels Mac...

Page 12: ...n Level Parameter Done Enumeration Level Parameter Abort Previous Parameter Next Parameter nvtMMParameterEdit An INTEGER array with the following variable text channels String Parameter Value Number P...

Page 13: ...Sub Sec Field nchMMStepList An INTEGER array with the following buttons Macro Step List Item 1 10 nvtMMStepList An INTEGER array with the following variable text channels Macro Step List Total Items...

Page 14: ...ems i ConnectLinx Action List Slider Level Code i ConnectLinx Action List Systems Name i ConnectLinx Action List Folder Name i ConnectLinx Action List Items Name 1 i ConnectLinx Action List Items Icon...

Page 15: ...s also use a channel code to trigger the execution of the macro and to provide feedback if the macro is running The programer can place the macro buttons anywhere on the touch panel allowing the user...

Page 16: ...ing buttons Add New Macro Save Macro Name To Preset Clear Macro Name From Preset nchMMExeMacroList An INTEGER array with the following buttons Macro Browser List Items 1 10 nvtMMExeMacroList An INTEGE...

Page 17: ...8 Unused 9 Total Event Slots 10 Available Slots 11 Next free Event index 12 Unused 13 Next Event to start 14 Next Event to stop 15 Total Events today 16 Events completed today 17 Number of current eve...

Page 18: ...through Start Count ordered by number GET PLIST Start Count Get list of today s past events from Start through Start Count ordered by time GET CLIST Start Count Get list of today s current events from...

Page 19: ...o Any valid macro file Command Description PAST Binary Event List String List of past event indexes CURRENT Binary Event List String List of current active event indexes FUTURE Binary Event List Strin...

Page 20: ...e of the i TimeManager module for sunrise and sunset information Touch Panel Pages i MacroEngineMod does not require any touch panel pages Programming i MacroSchedulerEditorMod i MacroSchedulerEditorM...

Page 21: ...rn off debug Default VERSION Send version information to master debug port master messaging DEFINE_MODULE i MacroSchedulerEditorMod mdlSchEdt vdvSchEditor vdvSchEngine vdvTmEvents vdvMacroEditor vdvKB...

Page 22: ...the Keyboard module for editing text dvKB An array of touch panel base devices implementing i MacroScheduler dvTPSch An array of touch panel devices implementing i MacroScheduler nchSchEventList An IN...

Page 23: ...ode Today s Event List Items 1 6 nchSchEngineListCtrl An INTEGER array with the following buttons Page Up Page Down Top of List End of List Slider Channel Code nvtSchEngineInfo An INTEGER array with t...

Page 24: ...xt channels Date Time Sunrise Time Sunset Time nchSchEventEdit An INTEGER array with the following buttons Edit Event New Event Delete Confirm Delete Event nvtSchEventEdit An INTEGER array with the fo...

Page 25: ...t Time Hour Start time Minute Start Time AM PM End time None End time Fixed End time Sunrise End time Sunset End time Before Sunrise End time Before Sunset End time After Sunrise End time After Sunset...

Page 26: ...ly Date Monthly Date Yearly nvtSchDateSelect An INTEGER array with the following variable text channels Daily Repeat Weekly Repeat Monthly Repeat Monthly Yearly Date of Month Monthly Yearly Day Occurr...

Page 27: ...of variable text channels codes for editing Date and Time parameters 37 channel codes see touch panel pages nchSchMacroList An INTEGER array with the following buttons Macro Browser List Items 1 10 nv...

Page 28: ...nthly SchDate SchYearly SchDate SchDateUS SchDate SchDateUK SchDate SchHourAMPM SchSelect SchHourMilitary SchSelect SchMinute SchSelect SchDay SchSelect SchMonth SchSelect SchYear SchSelect SchDateOcc...

Page 29: ...Programming i MacroManager 25 i MacroManager...

Page 30: ...of AMX Corporation AMX reserves the right to alter specifications without notice at any time In Canada doing business as Panja Inc DALLAS TEXAS LOS ANGELES CALIFORNIA MEXICO CITY MEXICO ONTARIO CANADA...

Reviews: