Button Node

A user interface element that triggers an action or event when clicked or tapped. Buttons are fundamental in GUIs, allowing users to interact with the software to submit forms, open dialogs, start processes, or navigate through the application.

What is a button?

The button is designed to provide an interactive button that allows users to toggle between two predefined values. This functionality is particularly useful for manual control operations within an IoT system, such as switching devices on or off, changing modes, or adjusting settings. By offering a simple and intuitive interface, the button enhances user interaction with the system, making it easy to implement and execute binary commands. This node is essential for scenarios requiring straightforward, on-demand control and can significantly improve the usability and responsiveness of IoT applications.

Functionality

Provides a button or a switch that can be used to change between two values, such as “On” and “Off”.

Outputs

Outputs the selected value for the data field name entered.

How to Use

Implementation

In the Rayven Workflow Builder:

Select Controls.
Drag the Button node to the canvas.
Input and output connections for the Button node are optional, as it will output values by itself.
Double click on the Button node to open the configuration window.

Configuration

Section: General
This section contains basic configuration elements required for any Button implementation
Field	Requirement	Comments
Widget Name	Mandatory	Enter a name for this node. This provides a handle to which you and others can refer, so it should be simple but meaningful and explain the node’s purpose.
Button Type	Mandatory	Select a button type from the dropdown menu Button Switch Note: Only the switch option can be grouped (by label value / name).
Widget Subtitle	Optional	Enter a subtitle for the node, it should be simple but meaningful and explain the node’s purpose.
Device/Device Label Name	Optional	Select this checkbox to display the device or label name on the widget.
Data Field Name	Mandatory	Select the field name that will contain values selected in the node on the live dashboard.
On Value	Mandatory	Enter a value to be output when the button is in the on position. This value will be sent in the outgoing JSON within the data field name. If the node is grouped, it will send the output value to all devices in its grouping.
Off Value	Mandatory	Enter a value to be output when the button is in the off position. This value will be sent in the outgoing JSON within the data field name. If the node is grouped, it will send the output value to all devices in its grouping.
Button Color	Optional	A field to either enter the hex key for a desired color, or use the color selector to choose the ideal color for the button.

Section: Tooltip Info
Field	Requirement	Comments
Show Tooltip	Optional	When checked, it allows users to display their tooltip text on the widget.
Tooltip Text	Optional	This section only exists when “Show Tooltip” is checked. Users are able to write any tooltip message they desire which will be displayed on the widget.

Section: Group by Device Label
Field	Requirement	Comments
Device label name	Mandatory	There are no labels available in this box until you have saved at least one in the Device Labels section of the Workspace. Click here for more information. Select a Label to use to filter devices.
Grouped	Mandatory	Select a method for grouping the widget on the dashboard from the dropdown: No Grouping (widget per device): one widget will appear for each device Group by device label value (Widget per label value): One widget will appear for each value of a label. For example, if the Label is ‘Color’ and there are the values ‘Green’ and ‘Gold’, then two widgets will be displayed, one with devices with Color Label equal to “Green” and one with devices with Color Label equal to “Gold” Group by device label name (One widget): Only one widget will be displayed and this will contain data from all devices. Note: Only the button can set to no grouping.