Pump

Pump (FB)

FUNCTION_BLOCK Pump

Short description

Control of a circulation pump with anti-blocking function

Representation

Interfaces

Inputs

Name	Data type	Value range	Initial value	Function
xEn	BOOL			Circulation pump request
xForce	BOOL		FALSE	Forced override after manual override
xFb	BOOL			Circulation pump operating feedback
xAlarmIn	BOOL			Circulation pump fault message
eAOO	HVACTYPES.eManBin	HVACTYPES.eManBin.Auto, HVACTYPES.eManBin.ManOff, HVACTYPES.eManBin.ManOn	HVACTYPES.eManBin.Auto	Operating mode of manual override - hardware
xQuit	BOOL		FALSE	Reset of the operating monitoring fault message

Outputs

Name	Data type	Value range	Initial value	Function
xHB	BOOL			* FALSE: Manual output: circulation pump not enabled * TRUE: Manual output: circulation pump enabled
xAB	BOOL			* FALSE: Automatic output: circulation pump not enabled * TRUE: Automatic output: circulation pump enabled
xEnergyRequest	BOOL			* FALSE: Energy generation request not enabled * TRUE: Energy generation request enabled
xAlarmFb	BOOL			* FALSE: Operating monitoring fault not enabled * TRUE: Operating monitoring fault enabled
tOffDelay	TIME			Remaining time of the pump off-delay
dtLastFb	DATE_AND_TIME			Date / time of the last operation of the circulation pump
dtAbsLastOn	DATE_AND_TIME			Date / time of the last anti-blocking operation
udiOperatingHours	UDINT			Operating hours of the circulation pump
udiCountFb	UDINT			Number of switch-ons of the circulation pump
xAlarm	BOOL			* FALSE: Collective fault not enabled * TRUE: Collective fault enabled
xAuto	BOOL			* FALSE: Collective automatic mode message not enabled * TRUE: Collective automatic mode message enabled

Setpoints / parameters

Name	Data type	Value range	Initial value	Function
xAlarmControl	BOOL		FALSE	* FALSE: xHb from xAlarm independent * TRUE: xHb is when xAlarm = TRUE locked
udiFbControlTime	UDINT	0 … 300s	60s	Duration of the operating monitoring
xFbControl	BOOL		TRUE	* FALSE: Operating monitoring not enabled * TRUE: Operating monitoring enabled
xForceOption	BOOL		TRUE	* FALSE: Output xHB when forced override OFF * TRUE: Output xHB when forced override ON
tAbsTime	UDINT	0 … 600s	120s	Duration of the anti-blocking operation
tAbsTime	TOD	00:00:00 - 23:59:59 hrs	08:00:00 hrs	Time of the anti-blocking operation
eAbsDay	eDoW	eDoW.Monday … eDoW.Sunday	eDoW.Monday	Weekday of the anti-blocking operation
eOffDelayTimeBase	eTime	eTime.Second, eTime.Minute, eTime.Hour	eTime.Second	Scaling of the off-delay ( seconds / minutes / hours )
udiOffDelay	UDINT	0 … 60min	120s	Off-delay duration of the circulation pump
eManModeB	eMANBIN	eMANBIN.Auto, eMANBIN.ManOff, eMANBIN.ManOn	eMANBIN.Auto	Operating mode of the manual override for the digital output xHB

Function description

Automatic output xAB

The digital automatic output xAB is influenced by the input xEn, the output xAlarm, the off-delay module and the anti-blocking module.

xEn	xAlarm	xAlarmControl	Off-delay module	Anti-blocking module	xAB	Notes
X	TRUE	TRUE	X	X	FALSE	Shutdown allowed via collective fault
FALSE	X	FALSE	FALSE	FALSE	FALSE	Automatic mode Off
TRUE	x	FALSE	FALSE	FALSE	TRUE	Automatic mode On
X	X	FALSE	TRUE	X	TRUE	Off-delay operation
X	x	FALSE	X	TRUE	TRUE	Anti-blocking operation

Legend: X = don't care With the parameter xAlarmControl the behavior of the output xAB in case of error can be influenced. When xAlarmControl = TRUE, in case of error (xAlarm = TRUE) the automatic output xAB is switched off; if the manual override module is in automatic, then the output xHB is also switched off. When xAlarmControl = FALSE no reaction occurs.

Manual output xHB

The digital manual output xHB corresponds to the digital automatic output xAB, additionally extended by a manual override module and by a forced override.

xAB	eMANBIN	xForce	xForceOption	xHB	Notes
FALSE	eMANBIN.Auto	FALSE	X	FALSE	Manual override module in automatic
TRUE	eMANBIN.Auto	FALSE	X	TRUE	Manual override module in automatic
X	eMANBIN.ManOn	FALSE	X	TRUE	Manual override module in manual operation On
X	eMANBIN.ManOff	FALSE	X	FALSE	Manual override module in manual operation Off
X	X	TRUE	FALSE	FALSE	Forced override Off
X	X	TRUE	TRUE	TRUE	Forced override On

Legend: X = don't care

Request - energy generation xEnergyRequest

The digital output xEnergyRequest is influenced by the input xFb, the off-delay module and the anti-blocking module.

xFB	Off-delay module	Anti-blocking module	xEnergyRequest	Notes
FALSE	X	X	FALSE	Circulation pump is not running
TRUE	FALSE	FALSE	TRUE	Circulation pump is running
TRUE	TRUE	X	FALSE	Off-delay module is running
TRUE	X	TRUE	FALSE	Anti-blocking module is running

Legend: X = don't care

Off-delay module

The off-delay module is realized by a switch-off delay with adjustable duration. The input of the off-delay module is active if the enable 'xEn' is active and at the same time the collective fault xAlarm is not active.

Anti-blocking module

The anti-blocking module is realized by the binary anti-blocking module with adjustable duration. The duration tAbsTime, the time tAbsTime and the weekday eAbsDay are adjustable. The timestamp (date / time) of the last anti-blocking operation dtAbsLastOn is available.

Output xAlarm

xAlarmIn	xAlarmFb	xAlarm	Notes
FALSE	FALSE	FALSE	Collective fault is inactive
TRUE	FALSE	TRUE	External hardware fault is active
FALSE	TRUE	TRUE	Operating monitoring fault is active
TRUE	TRUE	TRUE	Both faults are active

Legend: X = don't care

Collective automatic mode message xAuto

The collective automatic mode message xAuto is activated ( = TRUE ) if the input eAOO has the value HVACTYPES.eManBin.Auto and the setpoint / parameter eManModeB contains the value eMANBIN.Auto. In all other cases the collective automatic mode message xAuto is not activated ( = FALSE ).

Forced override xForce

The forced override acts directly on the output xHB. With the parameter xForceOption it is defined which state the output xHB assumes at TRUE on the input xForce .

Operating hours counter

The operating hours counter is active if the circulation pump is running (xFb = TRUE) and at the same time the collective fault xAlarm is not active (xAlarm = FALSE). The number of operating hours udiOperatingHours, and the number of switch-ons udiCountFb are output at the corresponding outputs. The timestamp (date / time) of the pump's operation dtLastFb is available.

Write access to the counters

Via the path 'InstanceName._OperatingHours.udiOperatingHours' or 'InstanceName._OperatingHours.udiCountFb' write access to both counters is possible.

Operating monitoring

The operating monitoring monitors the correct function of the circulation pump. The monitoring can generally be enabled (xFbControl = TRUE) or disabled (xFbControl = FALSE). The automatic mode of the circulation pump must also be active ( eAOO = HVACTYPES.eManBin.Auto ). The input xFb and the output xHB are permanently compared with each other. If the states are unequal for a configurable duration udiFbControlTime continuously (i.e. pump enabled but no operating feedback), the operating monitoring fault xAlarmFb is activated. The operating monitoring fault xAlarmFb is reset if the enable of the monitoring xFbControl is locked, or the reset input xQuit is active, or the automatic mode of the circulation pump ( eAOO = HVACTYPES.eManBin.Auto ) is activated.

Visualization

Representation

Interfaces visual element

Name	Data type	Type	Initial value	Function
FB_Pump	Pump	VAR_IN_OUT		Enter FB Pump here e.g. PRG.Pump
rRotation	INT	VAR_INPUT		Here the rotation of the pump graphic can be entered as an angle in degrees. E.g. 90 corresponds to a rotation of 90 degrees to the right. -90 degrees corresponds to a rotation of 90 degrees to the left.

Note: VAR_IN_OUT interfaces must be assigned, VAR_INPUT are optional.

COSESYS

InOut:

Scope	Name	Type	Initial
Input	xEn	BOOL
Input	xForce	BOOL	FALSE
Input	xFb	BOOL
Input	xAlarmIn	BOOL
Input	eAOO	eManBin	eManBin.Auto
Input	xQuit	BOOL	FALSE
Output	xHB	BOOL
Output	xAB	BOOL
Output	xEnergyRequest	BOOL
Output	xAlarmFb	BOOL
Output	tOffDelay	TIME
Output	dtLastFb	DT
Output	dtAbsLastOn	DT
Output	udiOperatingHours	UDINT
Output	udiCountFb	UDINT
Output	xAlarm	BOOL
Output	xAuto	BOOL
Input Const	xAlarmControl	BOOL	FALSE
Input Const	udiFbControlTime	UDINT	60
Input Const	xFbControl	BOOL	TRUE
Input Const	xForceOption	BOOL	TRUE
Input Const	udiAbsTime	UDINT	120
Input Const	todAbsStartTime	TOD	TIME_OF_DAY#8:0
Input Const	eAbsDay	eDoW	eDow.Monday
Input Const	eOffDelayTimeBase	eTime	eTime.Second
Input Const	udiOffDelay	UDINT	60
Input Const	eManModeB	eMANBIN	eMANBIN.Auto

Methods:

mQuit

mResetOperatingHours

Structure:

• mQuit (Method)

• mResetOperatingHours (Method)