Quick start

To start, create or open a TwinCAT HMI project.

Installation

Install the NuGet package "Beckhoff.TwinCAT.HMI.Alarm" via the NuGet Package Manager.

Adding an alarm in Visual Studio / TcXaeShell

Quick start 1:
1. Open the TwinCAT HMI Configuration window.
2. Go to the Server Symbols / Mapped Symbols tab.
3. Select the symbol to be added to the Alarm extension.
4. Add these to the Alarm extension configuration by right-clicking on New Alarm Settings.
A pop-up opens for further settings.
Quick start 2:
5. Define under:
    Name the name of the alarm function to be created
    Text (key) the message text (the text is localized)
    Severity what type of message it is
    Notification Type whether it is a message or an alarm.
    Interval at which the symbol is checked for changes.
    Condition when the alarm is triggered.
The alarm you have created is now monitored by the Alarm extension in the background. The EventGrid or EventLine Control can be used for display.
Quick start 3:

Adding a symbol via the server configuration page

1. Open the server configuration page.
2. Go to the TcHmiAlarm
tab.Quick start 4:
3. Go to Alarm Symbols.
All currently configured alarm symbols are displayed here.
4. Click on Add alarm symbol.
A pop-up opens for further settings.
Quick start 5:
5. Define under:
    Symbol-Mapping, the name of the corresponding symbol.
    Enabled whether the value should currently be monitored.
    Interval time at which the symbol is checked for changes.
6. Go to Alarm settings.
All currently configured alarm settings for this symbol are displayed here.
7. Click on Add alarm settings.
A pop-up opens for further settings.
Quick start 6:
8. Define under:
    Name, the name of the corresponding setting.
    Enabled whether the setting is used.
    Message type whether it is a message or an alarm.
    Condition when the alarm is triggered.
    Text (key) the message text (the text is localized)
    Severity what kind of message it is
The alarm you have created is now monitored by the Alarm extension in the background. The EventGrid or EventLine Control can be used for display.

When using the EventGrid or the EventLine, the filter must be set to the "TcHmiAlarm" domain accordingly. All alarms of the extension run under this domain and can only be displayed if the filter allows messages from the domain.