Skip to content
Stand with Ukraine flag

HP Control Panel

HP Control panel SCADA symbol

This widget belongs to the General high-performance SCADA symbols bundle — a collection of versatile components for building interactive high-fidelity SCADA dashboards on ThingsBoard.

It renders a labeled control panel with two buttons — On and Off — that operators can click directly on the dashboard to turn a device or subsystem on or off. The panel reads the current state from the device and updates the button appearance accordingly, so the display always reflects reality.

Use it to control pumps, fans, heaters, lighting circuits, or any binary-switched equipment in HVAC, water treatment, industrial automation, or building management systems where a clear, labeled toggle control fits the diagram layout.

  • Display the current on/off state of a device as a highlighted On or Off button.
  • Turn a device on or off with a single click directly from the dashboard.
  • Customize the panel label, button text, and button colors.
  • Configure an optional background color for the panel body.
  • 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 General high-performance SCADA symbols widget bundle.
  4. Select HP Control panel.
  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 attribute or telemetry value used to reflect the current state, and receives the write commands when the operator clicks a button.

The SCADA symbol defines the visual shape of the widget. The HP Control panel widget has a pre-selected symbol from the General high-performance SCADA symbols 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.

ParameterDefaultDescription
On/Off stateUse attribute 'value'Whether the device is currently on. When True, the widget highlights the On button; when False, it highlights the Off button. See Data source configuration.
On update stateSet 'value' attribute to: trueAction triggered when the operator clicks the On button. See Update action configuration.
Off update stateSet 'value' attribute to: falseAction triggered when the operator clicks the Off button. See Update action configuration.

Applies to On update state and Off update state. On update state fires when the operator clicks the On button; Off update state fires when the operator clicks the Off button. Select one action type from the list below.

  • Execute RPC

    Sends the on or off command to the device as an RPC call.

    ParameterDescription
    MethodRPC method to call, like setState.
    ParametersValue — sends true (On) or false (Off) as a boolean; Function — sends a value computed by your f(value) function; None — sends no parameter.
    RPC request timeout (ms)How long to wait for a device response before timing out (Advanced settings).
    RPC request persistentStores and retries the command until the device comes online (Advanced settings).
  • Set attribute

    Writes the on or off state to a device attribute.

    ParameterDescription
    Attribute scopeWhere to write: Server, Shared, or Client.
    Attribute keyAttribute name to write to, like value.
    ValueConstant — writes true (On) or false (Off) as a boolean; Function — writes a value computed by your f(value) function.
  • Add time series

    Writes the on or off state as a new time series data point on the device.

    ParameterDescription
    Time series keyThe telemetry key to write, like value.
    ValueValue — writes true (On) or false (Off) as a boolean; Function — writes a value computed by your f(value) function.

Applies to On/Off state. Click the edit icon next to the parameter to open its configuration dialog. When Action is set to Do nothing, the value options are:

ParameterValue
On/Off stateTrue or False

For all other actions, the configuration dialog includes these options:

  • Execute RPC

    Read the parameter value from an RPC response.

    ParameterDescription
    MethodRPC method to call, like getState.
    Action result converterNone — parameter is activated when the result matches the value you specify; Function — parameter is activated when your f(data) returns true.
    ‘On’ when result isThe value or condition that activates the On state.
    RPC request timeout (ms)How long to wait for a device response before timing out (Advanced settings).
    RPC request persistentStores and retries the command until the device comes online (Advanced settings).
  • Get attribute

    Read the parameter value from a device attribute.

    ParameterDescription
    Attribute scopeWhere the attribute is stored: Any, Client, Server, or Shared.
    Attribute keyAttribute name to read, like value.
    Action result converterNone — parameter is activated when the attribute equals the value you specify; Function — parameter is activated when your f(data) returns true.
    ‘On’ when result isThe value or condition that activates the On state.
  • Get time series

    Read the parameter value from the latest telemetry reading.

    ParameterDescription
    Time series keyTelemetry key to monitor, like value.
    Action result converterNone — parameter is activated when the telemetry value equals what you specify; Function — parameter is activated when your f(data) returns true.
    ‘On’ when result isThe value or condition that activates the On state.
  • Get alarm status

    Activate the On state when a specific alarm is active on the device.

    ParameterDescription
    Alarm severityWhich severity levels trigger the active state: Critical, Major, Minor, Warning, or Indeterminate.
    Alarm typesAny alarm, or a specific alarm type.
  • Get dashboard state id

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

    ParameterDescription
    Action result converterNone — parameter is activated when the state name matches the text you enter; Function — parameter is activated when your f(data) returns true.
    ‘On’ when result isThe state name or condition that activates the On state.
  • Get dashboard state object

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

    ParameterDescription
    Parse value functionA 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 isThe 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, the panel label, button text, and button colors.

SettingDefaultDescription
TitleHP Control panelWidget title displayed in the header. Supports entityName and entityLabel variables.
Card iconIcon shown in the widget header. Configure its size and color.
Background colorOffOptional background fill color for the control panel body. When disabled, the default panel style is used.
LabelHeat pumpText label displayed above the On/Off buttons. Configure its font and color.
‘On’ label textOnText shown on the On button.
‘Off’ label textOffText shown on the Off button.
Button colorColors for the buttons in three states: Active (the currently selected state), Default (the inactive state), and Border (button outline).

The Card appearance section controls the widget container style.

SettingDefaultDescription
BackgroundTransparentCard background color.
Show card buttonsFullscreenButtons shown on the card when hovered.
Card border radius0pxRounding of card corners.
Card padding12pxInner spacing between the card edge and widget content.

Button highlight does not reflect the actual device state

CauseSolution
On/Off state action is Do nothing and value is fixedOpen the On/Off state edit dialog and configure it to read from a device attribute or time series key.
Device is not sending dataConfirm the device is online and publishing the expected attribute or telemetry key.

Clicking a button does not update the device

CauseSolution
On update state or Off update state is not configuredOpen the respective edit dialog and select Execute RPC, Set attribute, or Add time series.
Target device is not connectedConfirm that the selected device is online and able to receive commands.

This widget is used in the following ready-made solution template built on the General high-performance SCADA symbols bundle:

  • SCADA Swimming pool — a complete swimming pool monitoring dashboard that uses the HP Control panel to switch equipment on and off directly from the diagram.