Centrifugal Pump

• Animate the pump impeller rotation when the pump is in the running state.
• Indicate warning and critical states with configurable colors.
• Animate a blinking effect when the pump is in critical state.
• Configure which pipe connection points are visible on each side of the pump symbol.
• Trigger a dashboard action when the widget symbol is clicked.
• Receive state data from device attributes, time series, alarm status, or dashboard state.

The widget connects to a single data source: either a Device or an Entity alias that resolves to a device. This device provides the telemetry or attribute values used to drive the widget’s visual state.

The SCADA symbol defines the visual shape of the widget. The Centrifugal pump widget has a pre-selected symbol from the Traditional SCADA fluid system bundle. To use a different symbol, click Browse SCADA symbol from gallery and choose one from the library, or upload your own.

Behavior parameters define what the widget displays, driven by real-time data from the connected device. Each parameter supports the same set of actions — see Behavior configuration for the full list.

Parameter	Default	Values	Description
Running	Use attribute 'running'	True, False	Whether the pump is currently running. When True, the impeller rotation animation plays.
Warning state	Use alarm status	True, False	Whether the pump is in warning state.
Critical state	Use alarm status	True, False	Whether the pump is in critical state.
Critical state animation	False	True, False	Whether to enable blinking animation when the pump is in critical state.
Rotation animation speed	1	number	Speed of the impeller rotation animation. 1 is normal speed, 0 disables animation, < 1 - slower animation, > 1 - faster animation.
On click	Do nothing	—	Action triggered when the user clicks the widget symbol.

Defines what happens when the user clicks the SCADA symbol on the dashboard. Select one action type from the list below.

• Do nothing

  The symbol is clickable but performs no action. Use while testing styles or as a placeholder.

• Navigate to new dashboard state

  Switches to a different view within the same dashboard, like opening a device details screen.

  Parameter	Description
  Target dashboard state	The state to open (required).
  Open right dashboard layout (mobile view)	Opens a side panel instead of replacing the view (mobile only).
  Set entity from widget	Passes the current entity to the target state.
  State entity parameter name	The key the entity is passed under.
  Dashboard state display option	Normal (same view), In separate dialog (popup), or In popover (inline overlay).

• Update current dashboard state

  Updates the context of the current view, like switching the selected device, without navigating away.

  Parameter	Description
  Target dashboard state	The state to switch to (optional).
  Open right dashboard layout (mobile view)	Opens a side panel on mobile.
  Set entity from widget	Passes the current entity to the updated state.
  State entity parameter name	The key the entity is passed under.

• Navigate to other dashboard

  Opens a completely different dashboard, like jumping from this system view to a global alarms view.

  Parameter	Description
  Target dashboard	The dashboard to open (required).
  Target dashboard state	The specific view to open within that dashboard.
  Open in a new browser tab	Opens the dashboard without leaving the current page.
  Set entity from widget	Passes the current entity to the other dashboard.
  State entity parameter name	The key the entity is passed under.

• Custom action

  Runs custom JavaScript on click to implement any behavior not covered by the built-in options. Use it to make HTTP requests, open custom dialogs, call other widget APIs, or interact with external services. The function receives: $event, widgetContext, entityId, entityName, additionalParams, entityLabel.

• Custom action (with HTML template)

  Same as Custom action, but also renders a custom HTML panel or dialog when the symbol is clicked. The function receives an additional htmlTemplate parameter: $event, widgetContext, entityId, entityName, htmlTemplate, additionalParams, entityLabel.

  Parameter	Description
  Resources	External scripts and styles loaded before the action runs.
  CSS	Styling for the HTML template.
  HTML	Layout of the rendered dialog or panel.
  JS	Action logic.

• Mobile action

  Triggers a native device feature inside a ThingsBoard mobile app, like the camera or QR scanner.

  Parameter	Description
  Mobile action type	Take picture from gallery, Take photo, Open map directions, Open map location, Scan QR Code, Make phone call, Get phone location, Take screenshot, or Device provision.

• Open URL

  Opens a website or external link when clicked.

  Parameter	Description
  URL	The address to open (required).
  Open in a new browser tab	Keeps the current dashboard open while opening the link.

To configure a parameter, click its edit icon. When Action is set to Do nothing, the Value options depend on which parameter you are configuring:

Parameter	Value
Running	True or False
Warning state	True or False
Critical state	True or False
Critical state animation	True or False
Rotation animation speed	Any number — 1 for normal speed, 0 to stop, < 1 - slower animation, > 1 - faster animation.

For all other actions, the configuration dialog works the same way regardless of which parameter you are editing:

• Execute RPC

  Read the parameter value from an RPC response.

  Parameter	Description
  Method	RPC method to call, like getState or getPumpStatus.
  Action result converter	None — parameter is activated when the result matches the value you specify; Function — parameter is activated when your f(data) returns true.
  ’[parameter]’ when result is	The value or condition that activates this parameter (not shown for Rotation animation speed, which uses the raw numeric result).
  RPC request timeout (ms)	How long to wait for a device response before timing out (Advanced settings).
  RPC request persistent	Stores and retries the command until the device comes online (Advanced settings).

• Get attribute

  Read the parameter value from a device attribute.

  Parameter	Description
  Attribute scope	Where the attribute is stored: Any, Client, Server, or Shared.
  Attribute key	Attribute name to read, like running or pumpState.
  Action result converter	None — parameter is activated when the attribute equals the value you specify; Function — parameter is activated when your f(data) returns true.
  ’[parameter]’ when result is	The value or condition that activates this parameter (not shown for Rotation animation speed, which uses the raw numeric result).

• Get time series

  Read the parameter value from the latest telemetry reading.

  Parameter	Description
  Time series key	Telemetry key to monitor, like pumpRunning or speed.
  Action result converter	None — parameter is activated when the telemetry value equals what you specify; Function — parameter is activated when your f(data) returns true.
  ’[parameter]’ when result is	The value or condition that activates this parameter (not shown for Rotation animation speed, which uses the raw numeric result).

• Get alarm status

  Activate the parameter when a specific alarm is active on the device.

  Parameter	Description
  Alarm severity	Which severity levels trigger the active state: Critical, Major, Minor, Warning, or Indeterminate.
  Alarm types	Any alarm, or a specific alarm type.

• Get dashboard state id

  Activate the parameter based on which dashboard state is currently open.

  Parameter	Description
  Action result converter	None — parameter is activated when the state name matches the text you enter; Function — parameter is activated when your f(data) returns true.
  ’[parameter]’ when result is	The state name or condition that activates this parameter.

• Get dashboard state object

  Activate the parameter using the full dashboard state context; use this when you need to evaluate multiple state parameters at once.

  Parameter	Description
  Parse value function	Write a f(data) function that returns the parameter value.

The Appearance section controls the widget title, visible pipe connectors, and pump state colors.

Setting	Default	Description
Title	Centrifugal pump	Widget title displayed in the header. Supports entityName and entityLabel variables.
Card icon	—	Icon shown in the widget header. Configure its size and color.
Right top connector	Enabled	Show or hide the pipe connection point on the top-right side of the pump.
Right bottom connector	Disabled	Show or hide the pipe connection point on the bottom-right side of the pump.
Left top connector	Disabled	Show or hide the pipe connection point on the top-left side of the pump.
Left bottom connector	Enabled	Show or hide the pipe connection point on the bottom-left side of the pump.
Top left connector	Disabled	Show or hide the pipe connection point on the top-left corner of the pump.
Top right connector	Disabled	Show or hide the pipe connection point on the top-right corner of the pump.
Running color	Green	Pump color when in the running state.
Stopped color	Gray	Pump color when stopped (not running).
Warning color	Orange	Pump color when in warning state.
Critical color	Red	Pump color when in critical state.

The Card appearance section controls the widget container style.

Setting	Default	Description
Background	Transparent	Card background color.
Show card buttons	Fullscreen	Buttons shown on the card when hovered.
Card border radius	0px	Rounding of card corners.
Card padding	12px	Inner spacing between the card edge and widget content.

Pump shows no rotation animation when running

Cause	Solution
Running action is set to Do nothing and value is False	Open the Running edit dialog, set the correct Action, and specify the attribute key.
Rotation animation speed is 0	Set Rotation animation speed to a non-zero value (e.g. 1 for normal speed).
Target device is not connected	Confirm that the selected device is online and actively sending data.

Warning or critical color does not appear

Cause	Solution
Warning state or Critical state action is Do nothing and value is False	Configure the state parameter to read from an alarm status or a device attribute.
Alarm is not active on the device	Confirm that the device has an active alarm of the expected severity.

These widgets are used in the following ready-made solution templates built on the Traditional SCADA fluid system bundle:

• SCADA Swimming pool — a complete swimming pool monitoring dashboard built with pipe, pump, valve, and gauge widgets from the Traditional SCADA fluid system bundle.