Spherical Tank

• Display the current liquid volume as a visual fill level inside the tank symbol.
• Show the exact volume value in a configurable value box with unit suffix.
• Indicate warning and critical states with configurable fill and tick colors.
• Animate a blinking effect when the tank is in critical state.
• Add a measurement scale with configurable major and minor ticks in Percentage or Absolute format.
• Trigger a dashboard action when the widget is clicked.
• Read tank data from device attributes, time series, or alarm status.

1. Open the dashboard and switch to edit mode.
2. Click Add widget at the top, or the Add new widget icon in the center of the screen.
3. Open the Traditional SCADA fluid system widget bundle.
4. Select the tank widget for your use case.
5. Configure the widget settings, then click Add.

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. Each tank 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 and how it responds to user interaction, driven by real-time data from the connected device.

Parameter	Default	Description
Tank capacity	Use attribute 'tankCapacity'	Total capacity of the tank. Used together with Current volume to compute the fill level. See Data source configuration.
Current volume	Use time series 'liquidVolume'	Current volume of liquid in the tank. See Data source configuration.
Warning state	Use alarm status	Whether the tank is in warning state. When True, the scale and ticks switch to warning colors. See Data source configuration.
Critical state	Use alarm status	Whether the tank is in critical state. When True, the scale and ticks switch to critical colors. See Data source configuration.
Critical state animation	False	Whether to enable blinking animation when the tank is in critical state. See Data source configuration.
On click	Do nothing	Action triggered when the user clicks the widget. See Click action configuration.

Applies to On click. Select one action type from the list below.

• Do nothing

  The widget 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 tank 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 a fluid system overview to a tank monitoring dashboard.

  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 widget 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.

Applies to all parameters. Click the edit icon next to a parameter to open its configuration dialog. When Action is set to Do nothing, the Value options depend on which parameter you are configuring:

Parameter	Value
Tank capacity	Any number — the static tank capacity value.
Current volume	Any number — the static current volume value.
Warning state	True or False
Critical state	True or False
Critical state animation	True or False

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 getVolume or getTankState.
  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 Tank capacity and Current volume, which use 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 tankCapacity.
  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 Tank capacity and Current volume, which use 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 liquidVolume.
  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 Tank capacity and Current volume, which use 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	A f(data) function that receives the current dashboard state object. Use data.id to read the active state name, or data.params to inspect state parameters.
  ‘[parameter]’ when result is	The expected type and value that activates the parameter. Choose String, Integer, Double, Boolean (then select True or False), or JSON.

The Appearance section controls the widget title, tank and fluid colors, volume display, and scale configuration.

Setting	Default	Description
Title	[Tank name]	Widget title displayed in the header. Supports entityName and entityLabel variables.
Card icon	—	Icon shown in the widget header. Configure its size and color.
Tank color	—	Color of the tank body.
Fluid color	Transparent	Color of the liquid fill inside the tank.
Value box	Enabled	Show or hide the current volume value display on the widget.
Value text	—	Font and color for the value label. The Units field (default: gal) sets the unit suffix shown next to the value.
Scale	Enabled	Shows a measurement scale on the tank. Display format: Percentage (0–100%) or Absolute (actual volume units).
Enable units on scale	Disabled	Show the unit label alongside scale tick values.
Transparent mode	Disabled	Make the tank body background transparent, showing only the fluid fill and scale.
Major ticks	Intervals: 10	Major tick marks on the scale. Configure the interval count and colors for Normal, Warning, and Critical states.
Minor ticks	Intervals: 5	Minor tick marks between major ticks. Configure the interval count and colors for Normal, Warning, and Critical states.

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.

Tank fill level does not change

Cause	Solution
Current volume action is Do nothing with a static value	Configure Current volume to read from a time series key (e.g. liquidVolume) or an attribute.
Tank capacity is not set or resolves to zero	Ensure Tank capacity is reading a valid numeric value greater than zero.
Target device is not connected	Confirm 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.

Critical state animation does not play

Cause	Solution
Critical state animation is set to False	Enable it under Behavior or configure it to read from a device attribute or alarm.
Critical state is not active	The animation only plays when Critical state is True.

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.