instruction manual i!-MacroManager i n t e g ra t i o n ! S o l u t i o n s
Software Limited Agreement LIMITED WARRANTY LIMITED WARRANTY. AMX Corporation warrants that the SOFTWARE will perform substantially in accordance with the accompanying written materials for a period of ninety (90) days from the date of receipt. Any implied warranties on the SOFTWARE and hardware are limited to ninety (90) days and one (1) year, respectively. Some states/countries do not allow limitations on duration of an implied warranty, so the above limitation may not apply to you. CUSTOMER REMEDIES.
Table of Contents Table of Contents Introduction ...............................................................................................................1 Macro and Schedule Persistence...................................................................................... 1 Programming i!-MacroManager ..............................................................................3 i!-MacroEngineMod .......................................................................................................
Table of Contents i!-MacroSchedulerEditorMod Module Definition..................................................................... 17 Parameters............................................................................................................................. 18 Touch Panel Pages................................................................................................................
Introduction Introduction i!-MacroManager allows users to create custom macros from any NetLinx compatible touch panel and execute them in real time without modification to the NetLinx program. i!-MacroManager is composed of a series of modules that allow users to create, edit, delete, execute and schedule macros from any NetLinx compatible touch panel. i!-MacroManager creates macros from the actions available through i!-ConnectLinx. Each macro can contain up to 50 actions.
Introduction 2 i!-MacroManager
Programming 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.
Programming i!-MacroManager i!-MacroSchedulerEditorMod This is the macro scheduler editor module. This module allows the user to create scheduled macros from a touch panel. This module is only needed if you want to support the scheduling of macros from a touch panel. If you want to support scheduled macros but the schedule is fixed or very simple, you can configure the i!-MacroSchedulerEngineMod via SEND_COMMANDs and you do not need to include this module.
Programming i!-MacroManager Strings i!-MacroEngineMod supports the following in-bound strings (device to master). i!-MacroEngineMod - Strings Command Description 'LOAD-[Slot],[MacroName]' Notification that macro MacroName was started in engine slot Slot (1-10). 'KILL-[Slot],[MacroName]' Notification that macro MacroName was kill with a KILL command. 'STEP-[Slot],[Step#],[StepName]' Notification that step Step# named StepName was executed in engine slot Slot (1-10).
Programming i!-MacroManager i!-MacroEditorMod Module Definition DEFINE_MODULE 'i!-MacroEditorMod' mdlMMEdt (vdvMacroEditor, vdvMacroEngine, vdvConnectLinx, vdvKB, dvKB, dvTP, nchMMMacroEdit, nvtMMMacroEdit, nchMMMacroList, nvtMMMacroList, nchMMMacroListCtrl, nchMMStepEdit, nvtMMStepEdit, nchMMParameterEdit, nvtMMParameterEdit, nchMMEnumList, nvtMMEnumList, nchMMEnumListCtrl, nvtMMDelayEdit, nchMMStepList, nvtMMStepList, nchMMStepListCtrl, nchCLActionListNavigate, nchCLActionList, nvtCLActionList, nchCLAct
Programming i!-MacroManager dvTP An array of touch panel devices implementing i!- MacroEditorMod.
Programming i!-MacroManager Shift Up Shift Down Edit Delay Edit Parameter nvtMMStepEdit An INTEGER array with the following variable text channels: Action Name Parameter Name Edit Parameter nchMMParameterEdit An INTEGER array with the following buttons: Level Parameter Increment Level Parameter Decrement Level Parameter Slider Enumeration/Level Parameter Done Enumeration /Level Parameter Abort Previous Parameter Next Parameter nvtMMParameterEdit An INTEGER array with the following variable text channels: S
Programming i!-MacroManager Parameter Enumeration List Items 1-10 nchMMEnumListCtrl An INTEGER array with the following buttons: Page Up Page Down Top of List End of List Slider Channel Code nvtMMDelayEdit An INTEGER array with the following variable text channels: Hour Field Min Field Sec Field 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 Macro Step Li
Programming i!-MacroManager End of List Slider Channel Code nchCLActionListNavigate An INTEGER array with the following buttons: Back/Up Home Select System nchCLActionList An INTEGER array with the following buttons: i!-ConnectLinx Action List Items 1 - 8 nvtCLActionList An INTEGER array with the following variable text channels: i!-ConnectLinx Action List Total Items i!-ConnectLinx Action List Slider Level Code i!-ConnectLinx Action List Systems Name i!-ConnectLinx Action List Folder Name i!-ConnectLinx A
Programming i!-MacroManager mmParameterEnum mmParameterLevel mmConnectlinxActions KBKeyboard KBKeypad KBEKeypad i!-MacroEditorMod requires the following touch panel pop-up pages: Popup Page Popup Group mmParameterString KBClients mmParameterNumber KBClients mmMacroName KBClients mmDelay KBClients mmDeleteConfirm N/A KBShift KBClients Programming i!-MacroExecuteMod i!-MacroExecuteMod does not appear on the NetLinx bus as a NetLinx device. There is no need for communication to this module.
Programming i!-MacroManager dvTP An array of touch panel devices implementing i!-MacroExecuteMod.
Programming i!-MacroManager i!-MacroExecuteMod requires the following touch panel pop-up page: Popup Page Popup Group mmMacroBrowse N/A Programming i!-MacroSchedulerEngineMod i!-MacroSchedulerEngineMod appears on the NetLinx bus as a NetLinx device. This device has 1 port with channels, levels, commands and strings like most other devices.
Programming i!-MacroManager i!-MacroSchedulerEngineMod - Commands (Cont.) 'GET STIME-[Event Number]' Get start time for event number. 'SET ETIME-[Event Number], [Time String]' Set end time for event number. If time string is empty, the event is set for one-shot (non-time spanning) event. 'GET ETIME-[Event Number]' Get end time for event number. 'SET DATE-[Event Number], [Date String]' Get date for event number. If time string is empty, the event is set for "No Date" (i.e.
Programming i!-MacroManager i!-MacroSchedulerEngineMod - Commands (Cont.) [Time String] Any time or time from Astronomical event in 24 hour time where Astronomical event is 'Sunrise" or "Sunset" and offset can be '-' or '+' and time is 'HH:MM'.
Programming i!-MacroManager i!-MacroSchedulerEngineMod Module Definition DEFINE_MODULE 'i!-MacroSchedulerEngineMod' mdlSchEng (vdvSchEngine, vdvMacroEngine, vdvTmEvents) Where mdlSchEng is a unique module name. Parameters vdvSchEngine A virtual device for communicating to the macro scheduling engine. vdvMacroEngine A virtual device for communicating to i!-MacroEngineMod for running macros. vdvTmEvents The virtual device of the i!-TimeManager module for sunrise and sunset information.
Programming i!-MacroManager Commands i!-MacroSchedulerEditorMod - Commands Command Description 'DFORMAT-DAY/MONTH' Set Date format European format: Day/Month/Year 'DFORMAT-MONTH/DAY' Set Date format US format: Month/Day/Year 'TFORMAT-12 HOUR' Set Time format to 12 hour format: [01-12]:[00-59] [AM,PM] 'TFORMAT-24 HOUR Set Time format to 24 hour (military) format: [00-23]:[00-59] 'DEBUGON' Turn on debug. 'DEBUGOF' Turn off debug.
Programming i!-MacroManager Parameters vdvSchEditor A virtual device for communicating to the macro scheduling editor. vdvSchEngine The virtual device of the i!-MacroSchedulerEngineMod module for editing scheduled macros. vdvTmEvents The virtual device of the i!-TimeManager module for sunrise and sunset information. vdvMacroEditor The virtual device of the i!-MacroEditorMod module for creating new macros. vdvKB The virtual device of the Keyboard module for editing text.
Programming i!-MacroManager Scheduled For time Runs Next at Name Unused nchSchEngineList An INTEGER array with the following buttons: Today's Event List Items 1-6 nvtSchEngineList An INTEGER array with the following variable text channels: Today's Event List Total Items Today's Event List Slider Level Code 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 the fol
Programming i!-MacroManager Number of Future Events nchSchEngineEdit An INTEGER array with the following buttons: Run Event Cancel Event nvtSchEngineStats An INTEGER array with the following variable text 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 following variable text channels: New Name Delete Confirm nchSchSaveOpt An INTEGER array with the following b
Programming i!-MacroManager nchSchTimeSelect An INTEGER array with the following buttons: Start time - Fixed Start Time - Sunrise Start time - Sunset Start Time - Before Sunrise Start time - Before Sunset Start Time - After Sunrise Start time - After Sunset Start 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 End time - Hour End time -
Programming i!-MacroManager End Time - AM/PM End time- Label Adjustable Minutes Trap for Sunrise/Sunset functions nchSchDateSelect An INTEGER array with the following buttons: Date - Fixed Date - Daily Date - Weekly 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 Occurrence Monthly/Yearly Day of Month Yearly Month Fixed Date - Month Fixed Date - Day Fixed Date
Programming i!-MacroManager nchSchDateOpt An INTEGER array with the following buttons: Pool of Channel codes for Date editing options (9 channel codes, see touch panel pages) nchSchDetailSelect An INTEGER array with the following buttons: Pool of Channel codes for editing Date and Time parameters (37 channel codes, see touch panel pages) nvtSchDetailSelect An INTEGER array with the following variable text channels: Pool of variable text channels codes for editing Date and Time parameters (37 channel codes,
Programming i!-MacroManager i!-MacroSchedulerEditorMod requires the following touch panel pop-up pages: Popup Page 24 Popup Group SchDaily SchDate SchWeekly SchDate SchMonthly SchDate SchYearly SchDate SchDateUS SchDate SchDateUK SchDate SchHourAMPM SchSelect SchHourMilitary SchSelect SchMinute SchSelect SchDay SchSelect SchMonth SchSelect SchYear SchSelect SchDateOccur SchSelect SchDayOfWeek SchSelect SchDescription SchSelect SchRepeat SchSelect SchEventName KBClients
Programming i!-MacroManager i!-MacroManager 25
033-004-2697 01/05 ©2005 AMX Corporation. All rights reserved. AMX, the AMX logo, the building icon, the home icon, and the light bulb icon are all trademarks of AMX Corporation. AMX reserves the right to alter specifications without notice at any time. *In Canada doing business as Panja Inc. AMX reserves the right to alter specifications without notice at any time.
