Structure Data Type Definitions

Structure Data Type Definitions - PumpPidStag

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: stPidInit

The stPidInit structure data type contains the initialization data for the PID function of the PumpPidStag function block.

Element of stPidInit	Data Type	Description
rKp	REAL	Defines the proportional gain constant (Kp) for the proportional part (P) of the PID function. Default value: 0.001
rTn	REAL	Defines the integral time (Tn) for the integral part (I) of the PID function. Default value: 1000 ms
rTv	REAL	Defines the derivative time (Tv) for the derivative part (D) of the PID function. Default value: 0.0 ms
rTd	REAL	Defines the derivative damping time (Td) for the derivative part (D) of the PID function. Default value: 0.0 ms
rDbnd	REAL	Defines the value of the dead band for the error value (e) to help to reduce the frequency of switching the VSDs, and thus to help limit wear. A switching process is only initiated if the deviation from the error value (e) exceeds the value defined with this parameter. Default value: 0.0001
rLowLim	REAL	Defines the minimum output limit for the PID control value (in percent). Default value: 0.0
rHighLim	REAL	Defines the maximum output limit for the PID control value (in percent). Default value: 100.0
rMaxErrForInt	REAL	Defines the maximum incremental value for the calculation of the I part. If the incremental value is greater than the value defined with this parameter, then the value of this parameter is used as incremental value. This function helps to limit the gradient of the I curve. If the value for this parameter is ≤ 0, a detected alarm is indicated with the parameter stPidAlrm.xMaxErrForIntPara. Default value: 50.0
tSwc	TIME	Defines the delay time in milliseconds for suppression of the D term in case it is switched from automatic setpoint to manual setpoint and vice versa. Default value: 100000.0

NOTE: The elements of the instance of the structure data type are set to the default values listed above if no other value is assigned.

Structure: stStagInit

The stStagInit structure data type contains the initialization data for the stage function of the PumpPidStag function block. The structure data type is embedded in the structure data type stInitApp.

Element of stStagInit	Data Type	Description
siStagPumpMax	SINT	Defines the total number of VS and FS pumps for the stage function.
rPresIncPump1SwcOff	REAL	Defines the increment that is added to the pressure setpoint value to calculate a pressure limit to switch off the last pump that is running. The calculated value consists of the pressure reference value (i_rSp) plus this incremental value to reach a pressure level that corresponds to the average value of the working range of the auxiliary pump. The increase of the pressure increases the quantity of water in the expansion tank. This procedure helps prevent an early restart of the pumps.
rLimStagPlus	REAL	Defines the limit to increment the stage value (0...100%) that is the demand to switch a pump to the ON state.
rLimStagMnus	REAL	Defines the limit to decrease the stage value (0...100%) that is the demand to switch a pump to the OFF state.
tDlyStagPlus	TIME	Defines the delay time in milliseconds that has to elapse after the rLimStagPlus has been reached before a pump is switched on.
tDlyStagMnus	TIME	Defines the delay time in milliseconds that has to elapse after the rLimStagMnus has been reached before a pump is switched off.
rPercDeriv	REAL	Percent deviation value of the discharge pressure from the setpoint to start the first pump.

NOTE: The elements of the instance of the structure data type are set to the default values (0 or FALSE) assigned by the controller on system startup.

Structure: stFillDevInit

The stFillDevInit structure data type contains the initialization data for the PumpPidStag function block when sequence 1 of the pipe fill mode is active (stOpMode.xFill = TRUE and stFillStat.xSequ1 = TRUE).

Element of stFillDevInit	Data Type	Description
rCtrlVal	REAL	Defines the output limit for the PID control value (in percent). Default value: 50.0%
siNoPump	SINT	Defines the number of pumps that have to run if sequence 1 of the pipe fill mode is active. Default value: 2

Element of stFillDevInit

Data Type

Description

rCtrlVal

REAL

Defines the output limit for the PID control value (in percent).

Default value: 50.0%

siNoPump

SINT

Defines the number of pumps that have to run if sequence 1 of the pipe fill mode is active.

Default value: 2

NOTE: The elements of the structure are set to the default values listed above.

Structure: stFlowStagInit

The stFlowStagInit structure data type contains the initialization data for the stage function of the PumpPidStag function block considering the flow value.

Element of stFlowStagInit	Data Type	Description
siStagPumpMax	SINT	Defines the total number of VS and FS pumps for the stage function based on flow.
rMinFlowLimPump1Off	REAL	Defines the minimum flow that has to be available to switch off the last pump (pump 1).
rPresIncPump1SwcOff	REAL	Defines the pressure that has to be available to switch off pump 1. This value consists of the pressure reference value (i_rSp) plus an additional incremental value to reach a pressure level that corresponds to the average value of the working range of the auxiliary pump.
rCtrlValPump1OnLim	REAL	Defines the minimum limit of the PID control value that has to be available to switch on pump 1. At least 1 pump has to run to generate a flow value. Only then you can use the stage function based on flow.
tDelTimeSwcOn	TIME	Defines the delay time in milliseconds that has to expire before the first pump is switched on.
tDelTimeSwcOFF	TIME	Defines a minimum time in milliseconds the first pump has to be running before it can be switched off again. It is the minimum runtime between 2 sleep mode intervals.
rFlowValPump2OnLim	REAL	Defines the flow value to increase the demand of number of pumps to 2.
rFlowValPump2OffLim	REAL	Defines the flow value to decrease the demand of number of pumps from 2 to 1.
rFlowValPump3OnLim	REAL	Defines the flow value to increase the demand of number of pumps to 3.
rFlowValPump3OffLim	REAL	Defines the flow value to decrease the demand of number of pumps from 3 to 2.
rFlowValPump4OnLim	REAL	Defines the flow value to increase the demand of number of pumps to 4.
rFlowValPump4OffLim	REAL	Defines the flow value to decrease the demand of number of pumps from 4 to 3.
rFlowValPump5OnLim	REAL	Defines the flow value to increase the demand of number of pumps to 5.
rFlowValPump5OffLim	REAL	Defines the flow value to decrease the demand of number of pumps from 5 to 4.
rFlowValPump6OnLim	REAL	Defines the flow value to increase the demand of number of pumps to 6.
rFlowValPump6OffLim	REAL	Defines the flow value to decrease the demand of number of pumps from 6 to 5.
rFlowValPump7OnLim	REAL	Defines the flow value to increase the demand of number of pumps to 7.
rFlowValPump7OffLim	REAL	Defines the flow value to decrease the demand of number of pumps from 7 to 6.
rFlowValPump8OnLim	REAL	Defines the flow value to increase the demand of number of pumps to 8.
rFlowValPump8OffLim	REAL	Defines the flow value to decrease the demand of number of pumps from 8 to 7.

NOTE: The elements of the instance of the structure data type are set to the default values (0 or FALSE) assigned by the controller on system startup.

Structure: stPidFbck

The stPidFbck structure data type is used to indicate the values of the different components of the PID function on the HMI:

Element of stPidFbck	Data Type	Description
rP_Part	REAL	Indicates the value of the proportional part (P).
rI_Part	REAL	Indicates the value of the integral part (I).
rD_Part	REAL	Indicates the value of the differential part (D).
xI_Part_Actv	BOOL	When TRUE, indicates that the integral part (I) is active.
xD_Part_Actv	BOOL	When TRUE, indicates that the differential part (D) is active.

Structure: stPidSta

The stPidSta structure data type is used to indicate the status of the PID function on the HMI:

Element of stPidSta	Data Type	Description
xErrLimActv	BOOL	When TRUE, indicates that the maximum increment value of the I part of the PID control value calculation is exceeded (defined with the parameter stPidInit.rMaxErrForInt) and that the limitation of the increment value from the I part of the PID control value is active.
xAntiWndoActv	BOOL	When TRUE, indicates that the anti-windup process of the I part is active. TRUE = I part – P part > 100%
xLowLimActv	BOOL	When TRUE, indicates that the calculation of the I part of the calculation of the PID control value is less than the minimum output limit for the PID control value (defined with the parameter stPidInit.RLowLim). Then the limitation of the calculation of the I part of the calculation of the PID control value is active.
xCtrlValHighLimActv	BOOL	When TRUE, indicates that the high limit for the PID control value (defined with the parameter rHighLim) is exceeded and the limitation of the PID control value is active.
xCtrlValLowLimActv	BOOL	When TRUE, indicates that the low limit for the PID control value (defined with the parameter rLowLim) is undershot and the limitation of the PID control value is active.
xResActv	BOOL	Indicates that the PID function has executed a reset.
xHoldActv	BOOL	Indicates that the PID function is in stopped mode.
xStopActv	BOOL	Indicates that the PID function has been stopped.
xManActv	BOOL	Indicates that the PID function is operated in manual mode, allowing to enter a setpoint via the HMI.
xAutoActv	BOOL	Indicates that the PID function is operated in automatic mode.
xDBndActv	BOOL	Indicates that a deviation has been suppressed. The PID control value is unchanged.
xErrActv	BOOL	Indicates that an error has been detected in the PID function.
xParaChg	BOOL	Indicates that the parameter values will be mapped in an internal memory, if the verification of the parameter was successful (reaction of the input i_xParaChg).

Structure: stPidStagSta

The stPidStagSta structure data type is used to indicate the status of the stage function on the HMI:

Element of stPidStagSta	Data Type	Description
esiStag_Mode	enumeration esiStag	Indicates whether a stage function is active and which method is selected: oesiStag_Mode = esiStag.Off or 0: stage function is deactivated oesiStag_Mode = esiStag.Stage or 1: stage method by using only the pressure to generate the stage value is active oesiStag_Mode = esiStag.Flow or 2: stage method by using additionally the flow value is active
xEmgyStagMode	BOOL	Indicates that the stage method based on flow is not executable and the stage method based on pressure is used instead.
xSlpMode	BOOL	Indicates that the booster pumping application is in sleep mode.

Element of stPidStagSta

Data Type

Description

esiStag_Mode

enumeration esiStag

Indicates whether a stage function is active and which method is selected:

oesiStag_Mode = esiStag.Off or 0: stage function is deactivated

oesiStag_Mode = esiStag.Stage or 1: stage method by using only the pressure to generate the stage value is active

oesiStag_Mode = esiStag.Flow or 2: stage method by using additionally the flow value is active

xEmgyStagMode

BOOL

Indicates that the stage method based on flow is not executable and the stage method based on pressure is used instead.

xSlpMode

BOOL

Indicates that the booster pumping application is in sleep mode.

Structure: stPidErr

The stPidErr structure data type is used to indicate alarms or alerts.

Element of stPidErr	Data Type	Description
stPidAlrm	stPidAlrm	Use of the structure data type for detected alarms.
stPidAlrt	stPidAlrt	Use of the structure data type for detected alerts.

Structure: stPidAlrm

The stPidAlrm structure data type is used to indicate an alarm detected in the PID function:

Element of stPidAlrm	Data Type	Description
xInvdLimPara	BOOL	When TRUE, an invalid limit parameter has been detected.
xInvdDeadBandPara	BOOL	When TRUE, an invalid dead band limit parameter has been detected.
xKpPara	BOOL	When TRUE, an invalid Kp parameter has been detected.
xTnPara	BOOL	When TRUE, an invalid Tn parameter has been detected.
xTvPara	BOOL	When TRUE, an invalid Tv parameter has been detected.
xMaxErrForIntPara	BOOL	When TRUE, an invalid maximum limit for the calculation of the I part has been detected.

Structure: stPidAlrt

The stPidAlrt structure data type is used to indicate a detected alert in the PID function:

Element of stPidAlrt	Data Type	Description
xNoRel	BOOL	When TRUE, the PID function is disabled.
xTdPara	BOOL	When TRUE, an invalid Td parameter has been detected.

Structure: stPidStagErr

The stPidStagErr structure data type is used to indicate alarms or alerts detected in the stage function.

Element of stPidStagErr	Data Type	Description
stPidStagAlrm	stPidStagAlrm	Use of the structure data type for alarms detected in the stage function.
stPidStagAlrt	stPidStagAlrt	Use of the structure data type for alerts detected in the stage function.

Structure: stPidStagAlrm

The stPidStagAlrm structure data type is used to indicate a detected alarm in the stage function:

Element of stPidStagAlrm	Data Type	Description
xFlowDataCheckAlrm	BOOL	When TRUE, the flow value is no longer valid.
xReserve	BOOL	This parameter is not used.

Structure: stPidStagAlrt

The stPidStagAlrt structure data type is used to indicate a detected alert in the stage function:

Element of stPidStagAlrt	Data Type	Description
xAltValActv	BOOL	When TRUE, the alternative pressure value provided by a second pressure value - if available in your system - is used.
xReserveII	BOOL	This parameter is not used.