ControlMacros book

Clear-Com
Eclipse Logic Maestro Instruction Manual
A - 7
Figure A-4: Initial Macro Control Macro Editor Display

---

Clear-Com
Eclipse Logic Maestro Instruction Manual
A - 8
CONFIGURATION ENTITIES
Click on the ‘Configuration Entities’ tab of the object browser to select 
the system configuration that is to be used by the control macro editor.  
A drop down menu of all the available system configurations is 
displayed below the window title.
Figure A-5: Configuration Selection
After a system configuration has been selected the entities that exist in 
that configuration are displayed in the object browser window under 
the headings:
• Gpsf - General Purpose Specific Functions
• Group - fixed groups and sort groups defined in ECS
• Port - system ports defined as Direct in ECS
• Conf - party lines (conferences) defined in ECS
• Port - system ports defined as panels in ECS
• Relay - relays that can be set open or closed
• Route - routes between panels defined in ECS
Each item can be opened to display a list of all the entities of this type 
in the currently selected system configuration.  If the configuration 
does not include any entities of a type the heading for that entity type is 
not displayed.
If a new ECS element is made while the control macro editor is 
opened, then:

---

Clear-Com
Eclipse Logic Maestro Instruction Manual
A - 9
1. In ECS Save the configuration(s).
2. Re-select the configuration(s) from the configuration task in order to 
force the macro editor to refresh its copy of the configuration(s).
Figure A-6: Configuration Entities List
These entities contained in the system configuration selected may be 
referenced in the control macro as required but the control macro will 
be specific to that system configuration and should not be used with 
any other system configuration as it may fail or produce unexpected 
results.

---

Clear-Com
Eclipse Logic Maestro Instruction Manual
A - 1 0
AVAILABLE MODULES
Click on the ‘Available Modules’ tab in the object browser to display the 
menus for the objects used to create the macros.  These are divided 
into the ‘ClearCom’ modules to construct programs to modify the map 
and ‘Shared’ to provide logging and debug capability.
CLEARCOM
Click on the ‘ClearCom’ item and expand the menus to show the object 
classes available.
Figure A-7: ClearCom Module Libraries
Entities
The entities section is divided into Attachment Objects which are 
associated with components, Control Objects that act on system 
components, Entity Objects that act on the state of system 
components and Port Objects that act on system ports.

---

Clear-Com
Eclipse Logic Maestro Instruction Manual
A - 1 1
Figure A-8: Entity Libraries
Attachment Objects
When the attachment objects item is selected the list will be expanded 
to display the attachment objects available and the logic operations 
that may be used with attachment objects.  Attachment objects are 
attached to components to set or get the properties of those 
components such as parameters.
Examples of attachment objects are relays, routes and speed dials.
  
Figure A-9: Attachment Objects Library

---

Clear-Com
Eclipse Logic Maestro Instruction Manual
A - 1 2
To use an attachment object select the required object by right clicking 
over it and then dragging it over to the edit window and dropping it in 
the required position.
When an attachment object is dropped into the control macro the 
editor will prompt for information such as whether the object is to set or 
get the component parameter and depending on this any other 
information that is required such as parameters and how to return the 
information.
Figure A-10: Example of Attachment Object Properties
Control Objects
Control objects act on the components to change their properties in 
some way.  When a control object is dropped into the editor window 
the editor will prompt for the required settings and parameters for that 
object.
Control objects are controls created in ECS using the Control Manager 
function accessed from the Setup Eclipse menu.

---

Clear-Com
Eclipse Logic Maestro Instruction Manual
A - 1 3
Figure A-11: Control Objects List
An example of the use of a control object is:
HSON.Triggers(ControlActions.CutLoudspeaker(D4222));
where CutLoudspeaker is the control.
Entity Objects
Entity objects act on the components to change their state in some 
way.  When an entity object is dropped into the editor window the 
editor will prompt for the required settings and parameters for that 
object.

---

Clear-Com
Eclipse Logic Maestro Instruction Manual
A - 1 4
Figure A-12: Entity Object List
An example of the use of an entity object is:
HSON.Triggers(ControlActions.CutLoudspeaker(D4222));
where CutLoudspeaker is the control.
Port Objects
Port objects are used to get information on a system port to change the 
properties of a system port.  When a port object is dropped into the the 
edit window the editor will prompt for the required settings and 
parameters for that object and action.
Port objects are normally ports on the system.

---