AlarmCounter

AlarmCounter (FB)

FUNCTION_BLOCK AlarmCounter

Short description

Read out the active alarms from a specified alarm group or an alarm class. Typical application: display the number of active alarms.

Representation

Interfaces

Inputs

Name	Data type	Value range	Initial value	Function
sFilterByAlarmGroup	STRING			Filter the number of active alarms only by the specified alarm group. (Empty = all groups)
sFilterByAlarmClass	STRING			Filter the number of active alarms only by the specified alarm class. (Empty = all classes)
xRetryRegistration	BOOL			Attempt to re-register the alarm manager client

Outputs

Name	Data type	Value range	Initial value	Function
uiTotalActiveAlarms	UINT			Number of all active alarms without filter criteria
uiActiveAlarms	UINT			Number of active alarms in the state “alarm condition is true”
uiActiveACK	UINT			Number of active alarms in the state “waiting to be acknowledged”
uiWaitingForConfirmation	UINT			Current status
eAlarmCounterState	eAlmAlarmCounterStates			Number of active alarms in the state “waiting for confirmation”

Setpoints / parameters

Name	Data type	Value range	Initial value	Function
usiMaxFailedRegistrations	USINT		5	Maximum number of failed attempts for the client registration of the alarm counter

Functional description

General

This function block is used to read out the number of active alarms in different states. The alarm counter can be filtered by an alarm group or an alarm class, as well as by a combination of these two options. If no filter of the available filter options is specified, all alarms of the respective option are considered by the counter.

Example configuration 1:

• The two inputs sFilterByAlarmGroup and sFilterByAlarmClass are not specified.

Effect of example configuration 1:

• All alarms are considered regardless of alarm class and alarm group.

Example configuration 2:

• The input *sFilterAlarmClass* is assigned the STRING “Alarm” and the input *sFilterByAlarmGroup* remains unassigned.

Effect of example configuration 2:

• All alarms with the alarm class “Alarm” are shown from all alarm groups.

CODESYS

InOut:

Scope	Name	Type	Initial
Input	sFilterByAlarmGroup	STRING
Input	sFilterByAlarmClass	STRING
Input	xRetryRegistration	BOOL
Input Const	usiMaxFailedRegistrations	USINT	5
Output	uiTotalActiveAlarms	UINT
Output	uiActiveAlarms	UINT
Output	uiActiveACK	UINT
Output	uiWaitingForConfirmation	UINT
Output	eAlarmCounterState	eAlmAlarmCounterStates