SystemVoltageEnhanced - Functional Description

Overview

Type:

Function block

Available as of:

V1.0.0.0

G-SE-0075851.1.png

 

 

Functional Description

The function block SystemVoltageEnhanced returns and resets the enhanced voltage registers of the system 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_xResetVltgDipCntr

BOOL

If this input is set to TRUE, the value of the parameter q_udiResetVltgDipCntr is reset.

i_xResetVltgSwellCntr

BOOL

If this input is set to TRUE, the value of the parameter q_udiResetVltgSwellCntr is 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_stVltgDipRegister1

ST_VoltageRegister

Maximum voltage magnitude for a voltage dip.

q_stVltgDipRegister1 = most recent

(Unit: V)

q_stVltgDipRegister2

Maximum voltage magnitude for a voltage dip.

...

q_stVltgDipRegister5

q_uiVltgDipCntr

UINT

Voltage dip counter

q_stVltgSwellRegister1

ST_VoltageRegister

Maximum voltage magnitude for a voltage swell (Units of Volts).

q_stVltgSwellRegister1 = most recent

q_stVltgSwellRegister2

Maximum voltage magnitude for a voltage swell.

...

q_stVltgSwellRegister5

q_uiVltgSwellCntr

UINT

Voltage swell counter