Leak Sensor

• Indicate the presence or absence of a leak with configurable default and leak colors.
• Trigger a dashboard action when the widget symbol is clicked.
• Receive leak 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 Leak sensor 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.

Parameter	Default	Values	Description
Leak	Use time series 'leak'	True, False	Whether a leak is currently detected by the sensor.
On click	Do nothing	—	Action triggered when the user clicks the widget symbol.

To configure the Leak parameter, click its edit icon. When Action is set to Do nothing, set Value to True (leak detected) or False (no leak).

For all other actions:

• Execute RPC

  Read the leak state from an RPC response.

  Parameter	Description
  Method	RPC method to call, like getLeakState.
  Action result converter	None — leak state is activated when the result matches the value you specify; Function — leak state is activated when your f(data) returns true.
  ‘Leak’ when result is	The value or condition that activates the leak state.
  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 leak 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 leak or leakDetected.
  Action result converter	None — leak state is activated when the attribute equals the value you specify; Function — leak state is activated when your f(data) returns true.
  ‘Leak’ when result is	The value or condition that activates the leak state.

• Get time series

  Read the leak state from the latest telemetry reading.

  Parameter	Description
  Time series key	Telemetry key to monitor, like leak or leakSensor.
  Action result converter	None — leak state is activated when the telemetry value equals what you specify; Function — leak state is activated when your f(data) returns true.
  ‘Leak’ when result is	The value or condition that activates the leak state.

• Get alarm status

  Activate the leak state 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 leak state based on which dashboard state is currently open.

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

• Get dashboard state object

  Activate the leak state 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 true to activate the leak state.

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.

The Appearance section controls the widget title and sensor colors.

Setting	Default	Description
Title	Leak sensor	Widget title displayed in the header. Supports entityName and entityLabel variables.
Card icon	—	Icon shown in the widget header. Configure its size and color.
Background color	Transparent	Background color of the widget area.
Default color	Green	Symbol color when no leak is detected.
Leak color	Red	Symbol color when a leak is detected.

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.

Sensor color does not change when a leak is detected

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

Click action has no effect

Cause	Solution
Action is set to Do nothing	Open the On click edit dialog and select the desired action type.
Target device is not set	Confirm that a device or entity alias is selected as the data source.

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.