Pump Rotors

A rotating pump rotor will rotate either clockwise or counter-clockwise to indicate that flow is occurring. The rotor is controlled via its SVG "id".

Animated pumps use SVG animation to provide smooth rotor rotation (regular pump rotors move in discrete steps). Also animated pump rotors only rotate clockwise and do not indicate direction. Other than for these limitions, the visual appearance of animated pump rotors is identical to the regular (non-animated) pump rotors. Animated pump rotors have a fixed rotation period of 5 seconds.

	Type	Name	Description	HMIBuilder Name
	Rotating pump rotor.	pump_rotor_<colour>	Rotor for a rotating pump.	Pump Rotor
	Rotating pump rotor.	pump_rotor_<colour>	Animated rotor for a rotating pump.	Animated Pump Rotor

HMIBuilder Parameters for Pump Rotors

Parameter	Type	Values	Description
Tag	Option menu	Address tags	The HMI server tag to read the current state from
Rotation Inc	Data entry box	Integer	The number of degrees to rotate in each cycle

HMIBuilder Parameters for Animated Pump Rotors

Parameter	Type	Values	Description
Tag	Option menu	Address tags	The HMI server tag to read the current state from

Note¹: Older versions of HMIBuilder required the "id" to be applied to pump rotors in a different way than with other widgets. This no longer applies, and the "id" should be applied to the outer element as is the case with other widgets.

Note²: SVG animations are a comparitively new feature in web browsers and may not work correctly in all browser versions even if that browser supports (non-animated) SVG. Test all your target browsers to see if they will work for you. SVG animations may place significant CPU load on the PC used to display them. Avoid using a large number of simultaneous animations and check the resulting CPU load on the target PC.

---

Backgrounds

These are normally combined with pump rotors. They are purely decorative backgrounds and have no input or output functions on their own.

	Type	Name	Description
	Rotating pump background.	pump_bg_<colour>	Passive background for a rotating pump.

---

Pipes

A pipe is similar to a pilot light in that it changes colour under the control of its "id". A pipe is simply a rectangle, and can be re-sized and stretched as necessary. Pipes are provided in both horizontal and vertical forms for convenience, but can be rotated to any angle required.

	Type	Name	Description	HMIBuilder Name
	Pipe.	pipe_h	Horizontal pipe.	Pipe
	Pipe.	pipe_v	Vertical pipe.	Pipe

HMIBuilder Parameters

Parameter	Type	Values	Description
Output Tag	Option menu	Address tags	The HMI server tag to read the current state from
Init Colour	Option menu	Colour	The colour to before starting
Off Colour	Option menu	Colour	The colour to use when the output tag is 0
On Colour	Option menu	Colour	The colour to use when the output tag is not 0

The available colours are: red, orange, yellow, green, blue, indigo, violet, white, and black.

Note: When the HMI web page starts up, it will use the "init" colour until the first scan is able to set the correct colour. This means you will not see either the "on" or "off" colours until valid data is available.

---