Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 121 Next »

Feature Description

Alarms communicate and document when adverse situations occur in a program. Alarms can have set values or threshold conditions that trigger their occurrence. They signal situations like the breakdown, malfunction, and reach of set limits. Documentation of alarm contents like time-stamp, description, and value is critical for applications. This can be done via CSV generation on the user’s Xpanel with Script Functions. The Alarm Summary is a runtime GUI object that displays all active, acknowledged, and resolved alarms. Alarms can be organized in Groups and Levels which can be displayed in an Alarm Summary object. When alarms change state, Actions can be added to control operations in the project. Alarms can be configured to track digital values or have analog thresholds (i.e., High High, High, Low, and Low Low). For more details on alarm configuration, please visit Alarm Information to learn more.

Designer Functionalities

Alarm Editor

Click Tools > Alarm Editor to bring up the Alarm Editor window, as shown to the right:

This pane shows all created alarms and their designated names, triggers, comparisons, comparison values, and labels. From this window, users can create, delete, edit, copy, paste, and cut alarms.

Edit Alarm

In the Alarm Editor window, click the + icon to bring up the Edit Alarm window:

This window contains the Alarm Settings, Labels, and Descriptions tab that users can customize for created alarms.

Alarm Settings

The first image on the right

Each new alarm must have a trigger and value set before being able to be created. This is the condition upon which the alarm will check to become active. An alarm can be triggered by different situations, like a tag reaching a value between or outside set limits, two tags being compared, or the value of a boolean tag changing. By double-clicking the trigger field or left-clicking the chain-link icon next

a tag can be selected and formatted to be compared and used as a trigger.

The comparison and Action options are changeable on this page.

Alarm Events

To add a trigger, open the Alarm Editor window and create a new alarm. This will open the Edit Alarm window.

Alarms can be either active, shelved, or acknowledged inside of an Alarm Summary object. Based on these events, a user can trigger other actions in the program. In the Edit Alarm window, the user can select the event of the alarm to which an action will be added under the Action Options. The ON Action will trigger an action when the alarm comparison becomes true, the OFF Action will trigger an action when the alarm comparison becomes false from being true, and the Acknowledge Action will trigger an action when the user acknowledges the alarm.

Labels

The labels tab allows users to change groups and levels for alarm organization. There are two default scopes to select from: group and level. Additional labels can be created by clicking the Edit Labels button. One alarm may have multiple group and level labels, and various alarms can have the same label. On the first picture shown on the right, Groups or Levels can be assigned to an alarm by simply left-clicking the already created label:

After clicking the Edit Alarm button, new scopes and labels can be added with the + icon. To edit an already created label, simply double-click the desired one. The second image on the right shows the Edit Labels window and the pop-up shown when creating or editing a label:

Alarm Notifications

The user can set up notifications via labels. While creating or editing a label, there will be a checkbox named “Notify”, shown to the right:

When clicked, any alarm with that label attached will send a notification to an Alarm Summary object when activated. This notification will appear at the bottom of the object.

Another way to achieve this is to insert a command on an alarm Action. When the command “Send Screen Notification” is selected, the user may specify the message sent via the notification at the bottom of the screen.

Descriptions

On the Descriptions tab, clicking New Description allows the user to create comments that can be assigned to alarms and will appear on Alarm Summary objects.

Back to Top of Alarms

Runtime Functionalities

CSV Generation

The user can export past alarm data to a CSV for record keeping. The user can export / import data from a USB, SD card, or local memory on Windows Xpanel.

To create a CSV file, there are two options on how to approach this. The first option is to create a command that will save an Alarm CSV. The user can specify what labels should be saved. The second way is to create a script that calls on the alarm.createCsv() or alarm.createAllCsv().


Back to Top of Alarms
  • No labels