Structure Data Type Definitions - OpIntPump

Overview

Structure data types serve as the major input and output data carriers between different function blocks, configuration, and parameterization data.

The following section lists the names of structures (data types) that are used in this function block, followed by a table that describes the elements of structure.

NOTE: For the structure data types that are used from this function block and others, refer to the Common Structure Data Type Definitions chapter.

Structure: stVsdCmd

The stVsdCmd structure data type is used to control and switch the states of the VSDs.

Element of stVsdCmd

Data Type

Description

siNb

SINT

Defines the number of VSDs that are available in the system.

Range: 1...8

xAutoMode

BOOL

automatic mode

When TRUE, the VSD is running in automatic mode without user intervention.

xManMode

BOOL

manual mode

When TRUE, the VSD is running in manual mode, that means it is controlled by operator inputs.

xMainMode

BOOL

maintenance mode

When TRUE, the VSD is running in maintenance mode and is not available for the application.

Structure: stPumpCmd

The stPumpCmd structure data type is used to control and switch the states of the pumps. It is available if the pumping application is running in manual mode (stOpMode.xMan = TRUE).

Element of stPumpCmd

Data Type

Description

siNb

SINT

Indicates the number of the pump on which the commands will be executed.

Range: 1...8

esiCmdType

SINT / Enumeration

1 = esiCmdType.FixSpeed (Fixed Speed)

2 = esiCmdType.VariSpeed (Variable Speed)

xAutoMode

BOOL

When TRUE, the pump is switched to automatic mode.

xManMode

BOOL

When TRUE, the pump is switched to manual mode.

xMainMode

BOOL

When TRUE, the pump is switched to maintenance mode.

xStrt

BOOL

When TRUE, the pump is switched into run state.

xStop

BOOL

When TRUE, the pump is switched into stop state.

xByps

BOOL

Used if fixed link operational mode is selected. When TRUE, the bypass contactor of the corresponding pump is selected (direct online mode).

xVsd

BOOL

Used if fixed link operational mode is selected. When TRUE, the contactor of the corresponding pump to link the VSD is selected.

rManSp

Manual pressure setpoint

The following table provides an example of the settings that must be set at the HMI to switch the variable speed pump 1 to run state:

Element of stPumpCmd

Value

Description

Type of Action

siNb

1

number of the pump

selection

esiCmdType

2

2 = VariSpeed

selection

xAutoMode

automatic mode

command

xManMode

manual mode

command

xMainMode

maintenance mode

command

xStrt

TRUE

start

command

xStop

stop

command

xByps

bypass

command

xVsd

VSD mode

command

rManSp

manual pressure setpoint

command

Structure: stPlantCmd

The OpIntPump function block uses the stPlantCmd structure data type as an input/output variable. The structure is used to control and switch the states of the machine application. This variable is used if there is a local and a remote HMI configured for controlling the pumping application.

The remote HMI control allows you to remotely monitor the application, to perform various maintenance activities, including modifications to data and configuration parameters, and to change the state of the application and associated hardware. Strict care must be taken to be sure that the immediate physical environment of the machine is in a state that will not present safety risks to people or property before exercising control remotely.

NOTE: The documentation of the programming, in particular the parameterization of the HMI, is not part of this document.

Warning_Color.gifWARNING

UNINTENDED EQUIPMENT OPERATION

oConfigure and install the mechanism that enables the remote HMI local to the machine, so that local control over the machine can be maintained regardless of the remote commands sent to the application.

oHave a complete understanding of the application and the machine before attempting to control the application remotely.

oTake the precautions necessary to assure that you are operating remotely on the intended machine by having clear, identifying documentation within the application and its remote connection.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

Element of stPlantCmd

Data Type

Description

xRem

BOOL

Command: switch to remote mode

When TRUE, the OpIntPump function block switches the operating mode stOpMode.xRem to TRUE.

xLoc

BOOL

Command: switch to local mode

When TRUE, the OpIntPump function block switches the operating mode stOpMode.xAuto to TRUE.

xAuto

BOOL

Command: switch to automatic mode

When TRUE, the OpIntPump function block switches the operating mode stOpMode.xLoc to TRUE.

xMan

BOOL

Command: switch to manual mode

When TRUE, the OpIntPump function block switches the operating mode stOpMode.xMan to TRUE.

See the related output variable stPlant.

Structure: stVsdFbck

The OpIntPump function block uses the stVsdFbck structure data type as an output variable. The stVsdFbck structure data type contains status bits designed to represent the status and mode of related VSDs on the HMI (for example, by using different colors to represent different states or modes).

Element of stVsdFbck

Data Type

Description

siSta

SINT

Indicates the status of a specific VSD.

Range:

Bit 0 = stop

Bit 1 = run

Bit 2 = alert detected

Bit 3 = alarm detected

Bit 4 = maintenance

siMode

SINT

Indicates the mode of a specific VSD.

Range:

Bit 0 = manual mode

Bit 1 = automatic mode

Bit 2 = maintenance mode

Structure: stPumpFbck

The stPumpFbck structure data type contains status bits designed to represent the status and mode of related pumps on the HMI (for example, by using different colors to represent different states or modes).

Element of stPumpFbck

Data Type

Description

siSta

SINT

Indicates the status of a specific pump.

Range:

Bit 0 = stop

Bit 1 = run

Bit 2 = alert detected

Bit 3 = alarm detected

Bit 4 = maintenance

siMode

SINT

Indicates the mode of a specific pump.

Range:

Bit 0 = manual mode

Bit 1 = automatic mode

Bit 2 = maintenance mode

siVsdNu

SINT

Indicates which VSD is serving the VS pump.

Range:

Bit 0 = not used

Bit 1 = VSD1 (with flexible operational mode enabled)

Bit 2 = VSD2 (with flexible operational mode enabled)

Bit 3 = VSD3 (with flexible operational mode enabled)

Bit 4 = VSD4 (with flexible operational mode enabled)

Bit 5 = bypass option is enabled

Bit 6 = VSD is set to run state (with fixed link operational mode enabled)

siType

SINT

Indicates the type of a specific pump.

Range:

Bit 0 = VS pump bypassing the VSD or FS pump

Bit 1 = VS pump

Structure: stPlant

The stPlant structure data type is used to indicate the status and the mode of the machine application on the HMI.

Element of stPlant

Data Type

Description

siMode

SINT

Indicates the mode of the machine application.

Range:

Bit 0 = controlled by remote HMI

Bit 1 = controlled by local HMI

siGrpMode

SINT

Indicates the operating mode of the pump group.

Range:

Bit 0 = manual mode

Bit 1 = automatic mode