ALM_REGISTER

Type Function block

Description The function block is used to register an alarm in the system. An alarm must always be registered before it can be used in the system. With a rising edge at the EXECUTE input or with EXECUTE = TRUE, the existing alarm is published to the system. The ALM_STATE structure connected to ALARM holds the alarm state.
The function block has to be executed until the DONE output is set to TRUE. The DONE output is set to FALSE if, for example, many alarm states are registered simultaneously.
ALM_REGISTER is intended to be used along with ALM_ALARM. If custom parameters are required, ALM_REGISTER_PARAM and ALM_ALARM_PARAM should be used.

Notes Function blocks have to be instantiated. The instance name of the function block has to be declared in the 'Variables' table of the POU where the FB is going to be used. The instance name must be unique within the POU.

Parameters Inputs
EXECUTE

Data type: BOOL

Description: The alarm is registered in the system with a rising edge at the input or with EXECUTE = TRUE.

ALARM_ID

Data type: STRING

Description: Unique name of the alarm to be registered.

ALARM_TYPE

Data type: STRING

Description: Type of the alarm. The alarm type information can be used by the client to filter the alarms.

SEVERITY

Data type: INT

Description: Severity of the alarm (1 = low severity; 1000 = high severity).

Input/Output
ALARM

Data type: ALM_STATE
(see below for a description of the ALM_STATE structure elements)

Description: Alarm state.

Output
DONE

Data type: BOOL

Description: Indicates whether the function block execution is complete or not (TRUE=complete, FALSE=not complete; call again).

ALM_STATE structure ALM_STATE structure elements

Structure element Data type Description

ACTIVE_CHANGED LDATE_AND_TIME Optional timestamp for the last change of ACTIVE_STATE.

ACKED_CHANGED LDATE_AND_TIME Optional timestamp for the last change of ACKED_STATE.

CONFIRM_CHANGED LDATE_AND_TIME Optional timestamp for the last change of CONFIRMED_STATE.

SUPPRESSED_CHANGED LDATE_AND_TIME Optional timestamp for the last change of SUPPRESSED_STATE.

RETAIN_CHANGED LDATE_AND_TIME Optional timestamp for the last change of RETAIN_STATE.

ALARM_CHANGED LDATE_AND_TIME Optional timestamp for the last change of ALARM_CHANGED.

ALARM_ID STRING Unique ID (name) of the alarm within the controller.

ALARM_TYPE STRING Type of the alarm.

MESSAGE STRING Message to be shown to the user.

LANG STRING Reserved. Should be empty string.

COMMENT STRING Reserved. Should be empty string.

USER STRING Reserved. Should be empty string.

SEVERITY INT Severity of the alarm (1 = information; 1000 = fatal error).

ACTIVE_STATE BOOL Indication if the alarm condition is true.

ACKED_STATE BOOL Acknowledged state of the alarm (the user has seen the alarm).

CONFIRMED_STATE BOOL Confirmed state of the alarm (the user has resolved the problem causing the alarm).

SUPPRESSED_STATE BOOL The OPC UA server wants to hide the alarm.

RETAIN_STATE BOOL TRUE to indicate that the alarm should be displayed to the user.

reserved0 USINT Reserved

reserved1 INT Reserved