ReadAlarmCounters - Functional Description

Overview

Type:

Function block

Available as of:

V2.0.3.0

Functional Description

The function block ReadAlarmCounters returns the alarm counters and resets the alarm counters of the selected avatar.

Interface

Input

Data type

Description

iq_TeSysIslandRef

FB_TeSys_island

Reference to the TeSys island device.

i_xExecute

BOOL

Upon a rising edge of this input, the function block starts the execution. The outputs q_xDone, q_xError, q_etResult, and q_etResultMsg are reset with the falling edge of i_xExecute. Refer to Behavior of Function Blocks with the Input i_xExecute.

i_sAvatarName

STRING(GPL.Gc_uiLengthOfAvatarName)

Reference to the avatar defined in the TeSys island configuration.

i_xResetAlarmCntrs

BOOL

If this input is set to TRUE, the alarm counters are reset.

Output

Data type

Description

q_xError

BOOL

If this output is set to TRUE, an error has been detected. For details, refer to q_etResult and q_etResultMsg.

q_etResult

ET_Result

Provides diagnostic and status information as a numeric value.

q_sResultMsg

STRING[30]

Provides additional diagnostic and status information as a text message.

q_xBusy

BOOL

If this output is set to TRUE, the function block execution is in progress.

q_xDone

BOOL

If this output is set to TRUE, the execution has been completed successfully.

q_uiOverloadCntr

UINT

Counter of alarms related to thermal overload protection.

q_uiJamCntr

UINT

Counter of alarms related to jam protection.

q_uiUndercurrentCntr

UINT

Counter of alarms related to undercurrent protection.

q_uiOvercurrentCntr

UINT

Counter of alarms related to overcurrent protection.

q_uiPhaseUnbalancedCntr

UINT

Counter of alarms related to phase unbalance protection.

q_uiGroundCurrentCntr

UINT

Counter of alarms related to ground current protection.

q_uiMotorOverheatCntr

UINT

Counter of motor overheat events.

q_uiAlarmsCntr

UINT

Counter of alarms related to protections.