ControlMacros book

Clear-Com
Eclipse Logic Maestro Instruction Manual
A - 1 5
Figure A-13: Port Object List
An example of port object use is:
PortObject D4222 = ControlMacro.GetPort(“D4222”);
where D4222 is the port object defined is Matrix Hardware.
Scriptlibrary
The scriptlibrary section is divided into Conditions which allow 
components and component parameters to be tested, Control Actions 
which specify actions to be carried out on system components, Control 
Attachments which specify actions to be carried out on objects and 
Control Macros which act on system components.

---

Clear-Com
Eclipse Logic Maestro Instruction Manual
A - 1 6
Figure A-14: Script Library Categories
Condition
The condition objects allow the value or state of component 
parameters to be tested, compared or converted from one format to 
another.  Conditions are AND and OR.
Figure A-15: Conditions List
An example of the use of a condition is:
FRLY2.Triggerslf(crosspointControl,Condition.AND,AND1);
where control FRLY2 is triggered if the elements crosspointControl and 
AND1 are both true.
Control Actions
Control actions allow the states of system components such as LEDs, 
actions (for example when a key is pressed) and routes to be changed 
for new actions and routes to be created.

---

Clear-Com
Eclipse Logic Maestro Instruction Manual
A - 1 7
Figure A-16: Control Actions List
Control Attachments
Control attachment objects allow the states of pre-existing system 
components to be changed.

---

Clear-Com
Eclipse Logic Maestro Instruction Manual
A - 1 8
Figure A-17: Control Attachment List
Control Latch
Control latch modules provide the functionality associated with latching 
actions.

---

Clear-Com
Eclipse Logic Maestro Instruction Manual
A - 1 9
Figure A-18: Control Latch Actions List
Control Macro
Control macros act on system components to get or set the states or 
attributes of those components.

---

Clear-Com
Eclipse Logic Maestro Instruction Manual
A - 2 0
Figure A-19: Control Macro List
Crosspoint Control
Crosspoint controls act on system crosspoints to get or set the states 
of the crosspoints.

---

Clear-Com
Eclipse Logic Maestro Instruction Manual
A - 2 1
Figure A-20: Crosspoint Controls
Current
Current provides facilities to obtain current system information.
Figure A-21: System Current 

---

Clear-Com
Eclipse Logic Maestro Instruction Manual
A - 2 2
SHARED
The shared entry provides a library of objects for debugging control, 
error reporting, messages and logging from user control macros.
Figure A-22: Shared Object List

---

Clear-Com
Eclipse Logic Maestro Instruction Manual
A - 2 3
CREATING A NEW PROJECT
To start a new project click on ‘File’ and then ‘New’ to display the 
options to create a new control macro or project.  Click on project to 
create a new project and the new project folder with the default name 
“Unknown” will be displayed in the object browser window.
Figure A-23: New Project Screen
A project is a collection of different control macros, usually for a 
specific application such as a studio.
Double click on the ‘Project [Unknown]’ entry in the object browser to 
highlight it and right-click to display the command menu and select 
‘Rename’ then type in the new project name.  The new project can be 
saved by selecting ‘File’ and then ‘Save’ to save the project.
To start a new control macro click on ‘File’ to display the file menu, 
click on ‘New’ and then ‘Control Macro’ to initialize a new control 
macro.

---

Clear-Com
Eclipse Logic Maestro Instruction Manual
A - 2 4
Figure A-24: Start New Control Macro
After clicking on ‘Script’ the editor will automatically create the basic 
structure of the control macro with the required libraries set up at the 
start of the control macro.  One the initial control macro has been 
created the user can start creating the application control macro under 
the comment ‘// User script entered here’.

---

Clear-Com
Eclipse Logic Maestro Instruction Manual
A - 2 5
Figure A-25: Inital New Control Macro
Once the control macro structure has been generated the user control 
macro is created by dragging and dropping items from the object 
browser into the control macro edit window to build up lines of the 
control macro.  
For example, to create an instance of a port select the ‘Configuration 
Entities’ tab and open the ‘PORT’ item to display a list of ports.  Right 
click on the required port to select it and then double click to 
automatically create the line of code that will create and instance of 
that object.
Note: Enter some blank lines (keyboard Enter) after automatically 
generated ‘// user Script entered here’ line
Note: Make sure the cursor is placed on a line under the start of 
the user script marker before selecting a new control control 
macro line.
Certain types of macro actions may have variable or unpredictable 
effects on different types of hardware so where a macro may act on 
different types of hardware it should be checked on all the variants of 
the hardware.
Once such case is macros which cause LEDs on panels to flash.  
There are a variety of different panel types which may be present on a 
system and they may respond differently to commands to flash LEDs.  
For example a macro to cause LEDs to flash system wide will not work 
on ICS-2003 panels but will work on other panels.  Macros which flash 

---