Water Stop

This widget belongs to the Traditional SCADA fluid system bundle — a collection of pipe segments, fittings, valves, pumps, and gauges designed for building fluid system diagrams on ThingsBoard dashboards. It connects to a device and reflects real-time valve state through configurable state colors and optional closed-state animation.

• Visualize the open or closed state of a remotely controlled shutoff valve in real time.
• Enable a blinking animation when the valve is closed to draw attention to a shut-off line.
• Send open or close commands to the device when the user clicks the valve symbol.
• Apply custom colors for the open state, the closed state, and the pipe segment independently.
• 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 Water stop 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.

The widget has four behavior parameters: two that read state from the device (Opened, Closed state animation), and two that define commands sent to the device when the user operates the valve (Open, Close).

Parameter	Default	Description
Opened	Use attribute 'open'	Whether the valve is currently open. True = open state (shows the opened color); False = closed state (shows the closed color).
Open	Set 'open' attribute to: true	Command sent to the device when the user clicks the valve to open it.
Close	Set 'open' attribute to: false	Command sent to the device when the user clicks the valve to close it.
Closed state animation	False	Whether to enable a blinking animation when the valve is in the closed state.

Both Opened and Closed state animation read a value from the connected device and activate the corresponding visual state. To configure either parameter, click its edit icon.

When Action is Do nothing, set the Value directly:

Value	Effect
True	Activates the parameter unconditionally.
False	Deactivates the parameter (default).

For all other actions, the widget reads the state dynamically from the device:

• Execute RPC — Read the state from an RPC response.

  Parameter	Description
  Method	RPC method to call, like getState or getValveStatus.
  ’[parameter]’ when result is	The value that activates this parameter.

• Get attribute — Read the state 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 open or valveOpen.
  ’[parameter]’ when result is	The attribute value that activates this parameter.

• Get time series — Read the state from the latest telemetry value.

  Parameter	Description
  Time series key	Telemetry key to monitor, like open or state.
  ’[parameter]’ when result is	The telemetry value that activates this parameter.

• Get alarm status — Activate the parameter when a specific alarm is active on the device.

  Parameter	Description
  Alarm severity	Severity levels that trigger the 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
  ’[parameter]’ when result is	The dashboard state name that activates this parameter.

• Get dashboard state object — Activate the parameter using the full dashboard state context.

  Parameter	Description
  Parse value function	A f(data) function that returns true when the parameter should be active.

The Open and Close parameters define the command sent to the device when the user clicks the valve symbol. Click each parameter’s edit icon to configure the action.

• Execute RPC — Send an RPC command to the device.

  Parameter	Description
  Method	RPC method to call, like setState.
  Parameters	Command value: true for Open, false for Close.

• Set attribute — Write a value to a device attribute.

  Parameter	Description
  Attribute scope	Where the attribute is stored: Shared, Client, or Server.
  Attribute key	Attribute name to write, like open.
  Value	Attribute value: true for Open, false for Close.

• Add time series — Write a value to a time series key.

  Parameter	Description
  Time series key	Time series key to write, like state.
  Value	Time series value: true for Open, false for Close.

The Appearance section controls the widget title and the colors of the valve symbol and pipe segment.

Setting	Default	Description
Title	Water stop	Widget title displayed in the header. Supports entityName and entityLabel variables.
Card icon	—	Icon shown in the widget header. Configure its size and color.
Opened color	Green	Color of the valve body when in the open state.
Closed color	Red	Color of the valve body when in the closed state.
Pipe color	Transparent	Color of the pipe segment shown in the symbol.

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.

Widget shows no state change or shows the wrong state

Cause	Solution
Opened action is set to Do nothing	Open the Opened edit dialog, set the correct Action, and specify the attribute or time-series key.
Attribute or telemetry key mismatch	Verify that the key name in the Opened configuration matches exactly what the device reports.
Target device is not connected	Confirm that the selected device is online and actively sending data.

Clicking the valve does not send a command to the device

Cause	Solution
Open or Close action is not configured	Open the Open or Close edit dialog and set the action type (Execute RPC, Set attribute, or Add time series).
Attribute key or RPC method is incorrect	Verify the key name or method name matches what the device expects.
Target device is not connected	Confirm that the selected device is online.

Closed state animation does not play

Cause	Solution
Closed state animation is set to Do nothing with value False	Open the Closed state animation edit dialog, set the correct Action and condition, or set the value directly to True to enable it unconditionally.
Valve is not in the closed state	The animation only plays when Opened evaluates to False. Verify the Opened parameter reads the correct device state.

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.