Understanding Macros in the ATRIUM software

Understanding macros, macro counters, and macro timers in the ATRIUM software

Introduction

Macros are used to cause an action on a device when triggering on an event. The macro instructs a device to  perform a specific action like Activate Relay, Lock Door (Latched), etc.

The ATRIUM application allows the creation of a macro by selecting the trigger event and the resulting  command. Up to 100 macros can be created.

All macros of the ATRIUM access control system are saved on the 2-Door Controller module.

From the Advanced Configuration tab, click on the Macros icon.  Select the Macros tab and click on the Add button.



Adding a Macro



General Information

  1. Display Name: Identifies the macro throughout the ATRIUM software. We recommend using a name that is representative of the macro.
  2. Enabled: When selected, activates the usage of this macro.
  3. Schedule: Select the schedule which will define when the macro can be used.

Trigger Event 

  1. Type: Select the type of device/action with which the macro will be triggered.
  2. Event: Select by which event the selected type will trigger the macro. Empty means any event.
  3. Event Detail: Select by which event detail the selected event will trigger the macro. Empty means any event detail.
  4. Entity: Select by which entity of the selected type the macro will be triggered. Empty means any entity.
  5. User: Specify by which User the macro will be triggered. The User list is only available when the type Area and one of his event is selected (Access to Area Granted, Access to Area Denied, User Entered Area and User Exited Area).

Outcome 

  1. Type: Select the type of device with which the macro will do a resulting command.
  2. Command: Select which command the selected type will do.
  3. Entity: Select the entity of the the selected type with which the macro will do a resulting command.

Trigger Event

Select the device type, the event and the entity that will be used as the trigger event. The entities are listed  with the format Module Serial #: Display Name.


TYPE
EVENT
Areas
Access Granted, Access Denied, Area accessed, Area Alarm Restored, Area Armed, Area  Arming Request Sent, Area Disarmed, Area Disarming Request Sent, Area Exited, Area
Intrusion
Batteries
Added, Battery Absent, Battery Absent Restored, Deleted, Edited, Low Battery, Low Battery  Restored
Card Enrollment
Deleted, Edited, Enrollment Mode Started Via Input Alarm, Enrollment Mode Started via  Programming Card, Enrollment Mode Started Via Controller Button, Enrollment Mode Stopped, Enrollment Mode Stopped Via Programming Card, Enrollment Mode Timeout
Doors
Added, Deleted, Door Alarm/Ajar, Door Alarm/Ajar Restored, Door Bypassed by Emergency  Input, Door Closed, Door Disabled, Door Enabled, Door Forced, Door Forced Restored, Door Lock, Door Locked, Door Open, Door Power Restored, Door Power Trouble, Door Pre-Alarm, Door Pre-Alarm Restored, Door Relocked (First Access/First Man in Cancelled), Door Restored by Emergency Input, Door Trouble (Contact), Door Trouble (Lock), Door Trouble Restored (Contact), Door Trouble Restored Lock, Door Unlocked, Door Unlocked by “First Access/First Man In”, Door Unlocked by Operator, Edited, Lockdown Access Granted, Lockdown Started, Lockdown Stopped, PIN Missing, User Entered Using Door, User Exited Using Door
Firmware
Added, Deleted, Edited, Firmware Update Completed, Firmware Update Started, Firmware
Validation Completed, Web Page Update Started
Holidays
Added, Deleted, Edited, Holiday Ended, Holiday Started
Inputs
Added, Deleted, Edited, Input Closed, Input Opened
Lockdown
Added, Deleted, Edited, Lockdown Started, Lockdown Stopped
Locks
Added, Deleted, Door Lock Activated, Door Lock Bypassed by Emergency Input, Door Locked  Deactivated, Door Lock Power Restored, Door Lock Power Trouble, Door Lock Restored by Emergency Input, Edited
Login
Added, ATRIUM PC Service Logged In, ATRIUM SDK Logged In, Deleted, Edited, User Locked
Out-Permitted Login Attempts Exceeded, User Login-ATRIUM software, User Login-ATRIUM Web  Page
Macro Counters
Added, Deleted, Edited
Macro Timers
Added, Deleted, Edited, Macro Timer Has Been Reloaded
Modules
Added, Deleted, Edited, Expander Replaced, Module Replaced
Outputs
Added, Deleted, Edited, Output Activated, Output Deactivated
Primary Power
Added, Deleted, Edited, Primary Power Failure, Primary Power Failure Restored, Primary Power  Trouble, Primary Power Trouble Restored
Readers
Added, Card Read, Deleted, Edited
Relays
Added, Deleted, Edited, Relay Activated, Relay Deactivated, Relay P ulse Mode Activated
Schedules
Added, Deleted, Edited, Schedule Ended, Schedule Started
Smart Supply Outputs
Added, Deleted, Edited, Smart Supply Trouble, Smart Supply Trouble Restored
Sub-Controllers
Module Missing, Module Reconnected
Tamper Switch
Added, Deleted, Edited, Tamper Restored, Tamper Trouble
User
Added, Deleted, Edited, User Counter Has Been Decremented, User Counter Has Been Set, User C ounter Has Reached Zero


Outcome

Select the device type and the command then select the entity on which the command will be applied. The  entities are listed with the format Module Serial #: Display Name.

TYPE
COMMAND
Areas
Arm, Disarm
Doors
Disable Access (Reader), Enable Access (Reader), Grant Access, Lock Door (Permanent), Reset  Door, Timed Unlock, Unlock Door (Latched)
Inputs
Bypass, Unbypass
Lockdown
Start, Stop
Outputs
Activate Output, Deactivate Output, Timed Activation
Relays
Activate Relay, Deactivate Relay, Timed Activation

Notes Tab

Use the Notes text field to record any additional notes that may be required. We recommend that you  keep a log of what settings were changed and when they were changed.

Save Button

Use the Save button to save changes.

Cancel Button

Use the Cancel button to ignore changes.

Modifying a Macro

Select a macro from the list and click on the Properties button. See the  Adding a Macro section in this article for more  information.

Deleting a Macro

Select the macro from the list and click on the Delete button. A dialogue box will appear requesting  confirmation.

Advanced Macros

ATRIUM now offers Advanced Macros, with these, you can program functions to be performed on any event in  real time.

These functions will be managed entirely by the ATRIUM panel and can be triggered by either a local event or on  an event coming from other panel. Resulting commands can also be executed locally or on another controller.

Macro Counters

Generic, power and flexible counters allow you to tally and manage occupancy in real time.

Examples for a macro counter application include parking lot management and user group management  (limiting the number of people in a fitness centre or on a production floor).

From the Advanced Configuration tab, click on the Macros icon. Select the Counters tab and click on the  Add button.


Adding a Macro Counter


General Information

  1. Display Name: Identifies the macro counter throughout the ATRIUM software. We recommend using a name that is representative of the macro counter.
  2. Enabled: When selected, activates the usage of this macro counter.
  3. Module: Select which module the macro counter will be saved on.

Options

  1. Auto Reload on Boot Up: When selected, the counter will reset to the maximum value after the board is rebooted (due to power failure or service).
  2. Auto Reload on Zero Value: When selected, the counter will reload to the maximum value once the count reaches zero.
  3. Auto Reset on Count Maximum Value: When selected, the counter will reset to zero when the count reaches maximum value.
  4. Auto Overflow on Count Maximum Value: When selected, this allows to count to exceed the maximum value.
  5. Counter Maximum Value: Set the counter’s maximum value.

Notes Tab

Use the Notes text field to record any additional notes that may be required. We recommend that you  keep a log of what settings were changed and when they were changed.

Save Button

Use the Save button to save changes.

Cancel Button

Use the Cancel button to ignore changes.

Modifying a Macro Counter

Select a macro counter from the list and click on the Properties button. See the Adding a Macro Counter section in this article  for more information.

Deleting a Macro Counter

Select the macro counter from the list and click on the Delete button. A dialogue box will appear requesting  confirmation.

Macro Timers

Macro timers add the flexibility of timed actions to a macro.

From the Advanced Configuration tab, click on the Macros icon. Select the Timers tab and click on the Add  button.


Adding a Macro Timer


General Information

  1. Display Name: Identifies the macro timer throughout the ATRIUM software. We recommend using a name that is representative of the macro timer.
  2. Enabled: When selected, activates the usage of this macro timer.

Options

  1. Auto Reload on Boot Up: When selected, the timer will restart after a system reboot.
  2. Periodic: When selected, the timer will repeat.
  3. Time (seconds): Set the amount of time (in seconds) the action will be performed.

Notes Tab

Use the Notes text field to record any additional notes that may be required. We recommend that you  keep a log of what settings were changed and when they were changed.

Save Button

Use the Save button to save changes.

Cancel Button

Use the Cancel button to ignore changes.

Modifying a Macro Timer

Select a macro timer from the list and click on the Properties button. See the Adding a Macro Timer section in this article for more information.

Deleting a Macro Timer

Select the macro timer from the list and click on the Delete button. A dialogue box will appear requesting  confirmation.


Macro Command Groups

Macro Command Groups allow the management of hardware groups, such as Doors, Areas, Inputs, Relays and  Outputs.

From the Advanced Configuration tab, click on the Macros icon. Select the Command Groups tab and click  on the Add button.


Adding a Command Group


General Information

  1. Display Name: Identifies the command group throughout the ATRIUM software. We recommend using a name that is representative of the macro command group.
  2. Enabled: When selected, activates the usage of this macro command group.
  3. Module: Select which module the macro command group will be saved on.

Command Group

  1. Type: Select the type of device/action with which the command group will be triggered.
  2. Entity: Select by which entity of the selected type the command group will be triggered.

Notes Tab

Use the Notes text field to record any additional notes that may be required. We recommend that you  keep a log of what settings were changed and when they were changed.

Save Button

Use the Save button to save changes.

Cancel Button

Use the Cancel button to ignore changes.

Modifying a Command Group 

Select a command group from the list and click on the Properties button. See the Adding a Command Group section in this article  for more information.

Deleting a Command Group

Select the Command Group from the list and click on the Delete button. A dialogue box will appear requesting  confirmation.


Next, learn how to configure and manage email notifications in the ATRIUM software.


    • Related Articles

    • Understanding the ATRIUM software

      This article covers the structure of the main window of the ATRIUM software, including the different windows, menus, and buttons.  User Interface Overview The main window of the ATRIUM software is shown below. Menu and Ribbon Buttons  The menu gives ...

    • How to configure readers in the ATRIUM software

      Introduction Readers such as keypads and proximity readers are used to request access to an area via a door. Each controller supports two readers and up to four 2-Door Expansion Modules which provide two readers each. Therefore, each controller can ...

    • Managing relays in the ATRIUM software

      Introduction Typically, relays are used to activate alarm sounders or other devices such as lighting control units and air conditioners. Relays are controlled using macros. For example, a relay can be activated by a macro when the trigger event ...

    • Understanding doors in the ATRIUM software

      Overview The term door refers to any access point controlled by a reader and/or keypad such as a door, turnstile, gate, and wireless or wired door handles. To control entry and exit through an access point (door), a reader and/or keypad can be used ...

    • ATRIUM Software Manual v4.31

      This article provides you with links to other articles covering all the information included in the instruction manual for the ATRIUM software (version 4.31).  Product Presentation  The ATRIUM software is an advanced and powerful access control ...