HP Pump station

Who it’s for

The HP Pump station symbol is for operators and engineers who run water, wastewater, booster or lift stations on ThingsBoard and want the whole station on one SCADA picture. They need to see at a glance which pumps are running, which are on standby, which have tripped, how full the tank is and how far the outlet valve is open. The question they would type is “which of my station pumps is down right now?”

What it does

A station with six pumps reports pump1Status = running, pump2Status = standby, pump3Status = fault and so on, a tank level of 62 and a valve opening of 71. The symbol draws the clear water tank at 62%, six pumps between the suction and discharge headers, with pumps 1 and 4 green and spinning, pump 3 red and the rest gray, and the outlet valve labeled V-1 · 71% with 4.2 bar · 236 m³/h → above the header.

• Shows every pump in the color of its state: running, standby or fault. Running pumps spin.
• Draws only the pumps that have data. Up to six are supported, and a station with four status keys gets four pumps spread evenly along the headers, with no empty slots.
• Shows the tank level as a fill with the value in percent, and the valve opening next to the valve.
• Fits stations without a tank or without a valve: switch either off and the pipes close up around the gap.
• Takes the widget background through the tank and the valve, so the same symbol works on a light or a dark dashboard.
• Opens a dashboard state, a popup or any other widget action from a click on the valve.
• Is a status picture, not a control: it does not start or stop pumps and does not change the valve opening.

Requirements

A SCADA widget reads one entity, so all the values have to arrive on the same device or asset, usually the station asset, picked as the widget’s Target device (through an entity alias when it is an asset). When each pump is its own device, a calculated field on the station asset copies each pump’s status, the tank level and the valve position up to it over the Contains relation.

How to set up

Behavior

The HP Pump station symbol has no data keys and no datasource. Like every SCADA symbol, it reads its values through the Behavior section of the widget settings: pick the Target device once, then each behavior row says where its value comes from. That source can be a time series key, an attribute or an RPC call, and every row is prefilled with the key name below.

• Pump 1 status … Pump 6 status — Timeseries, pump1Status … pump6Status. Text: running, standby or fault; true and false are read as running and standby, and any other value as standby. A pump without a value is not drawn, so a station with four pumps simply leaves the rows of pumps 5 and 6 without a key.
• Tank level — Timeseries, tankLevel, in percent from 0 to 100. Without a value the tank is empty and shows –.
• Valve position — Timeseries, valvePosition, the valve opening in percent. Without a value the label reads V-1 · –.
• Outlet pressure and Outlet flow — Timeseries, outletPressure and stationFlow. They make up the readout above the discharge header; a missing one shows – in its place.
• On valve click — a widget action, does nothing by default. Set it to open a dashboard state or a popup with the valve details.

Properties

Two switches in the Properties section of the widget settings decide what the station consists of.

• Tank — on by default. Turn it off for a station that takes water straight from the network: the tank and its pipe disappear, and the Tank level behavior can stay unbound.
• Valve — on by default. Turn it off when the station has no outlet valve: the discharge pipe runs straight to the outlet arrow, and Valve position can stay unbound.

How to customize

• To rename the tank or the valve — edit the Label under Tank, Clear water tank by default, and under Valve, V-1 by default.
• To number the pumps — turn on Pump labels, off by default. Each pump gets its prefix plus its number, P01 to P06 with the default prefix P0. Its font and color are next to it.
• To stop the running pumps from spinning — turn off Spin running pumps, on by default.
• To hide the legend under the station — turn off Legend, on by default.
• To hide the pressure and flow above the header — turn off Outlet readout, on by default. Its units are bar and m³/h by default.
• To match your state colors — set Running, Standby and Fault under State colors: green, gray and red by default.
• To use a dark background — set the widget background to dark, then set Labels color to a light one. The tank, the valve and the pumps take the background without changes.
• To change the tank and valve color — set Accent color, teal by default. Pipe color sets the pipes and the tank outline.
• To change the text size — set the fonts under Labels and Tank value.

Tips

• Turn the status into text before it reaches the symbol. A rule chain or a calculated field that writes running, standby or fault keeps the logic in one place instead of in six behavior rows.
• Point On valve click at the dashboard state that shows the valve’s setpoint control, so the operator goes from the picture to the control in one click.
• For a station with more than six pumps, place two symbols side by side and turn off Tank on the second one.