Vertical Ball Valve

• Visualize the open or closed state of a valve in real time.
• Animate the valve symbol between open and closed positions using configurable rotation angles.
• Send open or close commands to the device when the user clicks the valve symbol.
• Apply custom colors for the open and closed states independently.
• Receive state data from device attributes, time series, alarm status, or dashboard state.

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 valve 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 valve 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
Opened	Use attribute 'open'	Whether the valve is currently open. True = open state (symbol rotates to the opened angle and shows the opened color); False = closed state. See Data source configuration.
Open	Set 'open' attribute to: true	Command sent to the device when the user clicks the valve to open it. See Click action configuration.
Close	Set 'open' attribute to: false	Command sent to the device when the user clicks the valve to close it. See Click action configuration.

Applies to Open and Close. Click the edit icon to configure the command sent to the device when the user clicks the valve symbol.

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

Applies to Opened. Click the edit icon to open its configuration dialog. When Action is set to Do nothing, set the Value directly:

Parameter	Value
Opened	True or False

For all other actions, the configuration dialog reads the valve state dynamically from the device:

• Execute RPC

  Read the parameter value from an RPC response.

  Parameter	Description
  Method	RPC method to call, like getState or getValveStatus.
  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.
  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 open or valveOpen.
  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.

• Get time series

  Read the parameter value from the latest telemetry reading.

  Parameter	Description
  Time series key	Telemetry key to monitor, like open or state.
  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.

• 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, valve state colors, and the rotation angle of the symbol in each state.

Setting	Default	Description
Title	Widget 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.
Opened color	Green	Color of the valve symbol when in the open state.
Closed color	Gray	Color of the valve symbol when in the closed state.
Opened rotation angle	0	Rotation angle (degrees) of the symbol when the valve is open.
Closed rotation angle	90	Rotation angle (degrees) of the symbol when the valve is closed.

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.

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.