Macro Runner

Version 1.7

Run any macro in your Integration Designer project on demand, straight from the IDesign workspace - no need to load a UI to a panel and press a button. Pick a macro by name and fire it on the processor.

What it does

- Adds right-click menus to the driver that list every macro in your project.

- Fires the macro you choose on the processor (all macro step types run - IR, relay, driver commands, page changes, delays, etc.).

- Handy for testing macros while you build a project, and for triggering maintenance macros without wiring a button.

Requirements

- RTI processor, firmware with runtime 24 or higher.

- Integration Designer 11.

- The PC running Integration Designer must be able to reach the processor over the network.

Setup

1. Add the driver. Add "Macro Runner" to the project (Global drivers). It will appear named "Macro Runner".

2. Set the Processor IP. In Driver Properties, enter the IP address of the processor this driver is loaded on. Leave Trigger Port at 12560 unless it clashes with another driver.

3. Load the project to the processor once. On load, the driver starts a small listener that fires macros on request.

4. Refresh the macro list. Right-click the driver in the workspace and choose "Refresh Macro List". This reads every macro in the project into the "Macro" dropdown.

5. Pick a macro. Open Driver Properties and choose a macro from the "Macro" dropdown. Named/tagged macros show their name; untagged macros show a short step summary. (If the dropdown still shows the old list, click away from Driver Properties and back.)

6. Run it. Right-click the driver and choose "Run Macro". The selected macro fires on the processor and a confirmation is shown.

Right-click menus

- Refresh Macro List - reload the "Macro" dropdown from the project.

- Run Macro - fire the macro selected in the "Macro" dropdown on the processor.

- Decode Macro - show the steps of the selected macro (does not fire it).

- List Macros - show every macro in the project (id, name/summary, step count).

- Show Remote Link - show the off-site link for this processor (see Off-site access below).

Web object (touch panel or browser)

The driver also serves a web page you can open in any browser or drop into a touch-panel Web Object. Browse to http://[Processor IP]:[Trigger Port]/ (default port 12560). It shows a dropdown of your macros and a Fire button, scales to fill the window, and has a settings cog for background and accent colours. Run "Refresh Macro List" and reload the project so the page has your macro names.

Off-site access (fire from anywhere)

To fire macros while you are away from site, tick "Enable Off-site Access" in Driver Properties (Remote category), then use the "Show Remote Link" right-click menu. It writes a private link into the "Remote Link" field - copy it and open it in any browser (a phone on cellular, another site). The same dropdown-and-Fire page appears and fires macros on the processor. The link is tied to this processor; keep it private, as anyone with it can fire your macros.

Licensing

Unlicensed, the driver fires one macro per processor reboot, then locks until the processor is rebooted or a licence key is entered.

To unlock unlimited firing, purchase a licence and enter the key in Driver Properties (Licence category, "Licence Key"), then load the project to the processor again so the key takes effect.

A licence key is tied to a single processor (its MAC address). To purchase, send your processor's MAC address to Smart Home Programming. You will receive a key for that processor.

Notes

- The driver fires whatever version of a macro is currently loaded on the processor. If you edit a macro, load the project again to update the processor's copy.

- Running "Macro Runner" needs the driver loaded on the processor (that is what starts the listener). Adding it to the project is not enough on its own.

- If "Run Macro" reports it cannot reach the listener, check the processor is loaded, the Processor IP and Trigger Port are correct, and the PC can reach the processor.

Support

Smart Home Programming and Automation

https://smarthomeprogramming.com.au

Include your processor MAC address and Integration Designer version with any support request.