Toggle Switch Widget
General Setting
User can change following things in Toggle Switch widget:
  • Name for widget which will be used data reference
    For Example, if widget name is 'Switch', then data of widget is referenced as Switch.data
  • Show title - User can show/hide widget title
  • Title Color
  • Background Color
Configure Toggle Switch Widget

Widget Setting

In Widget Setting option, user can change following parameters:
  • Key - key parameter of JSON Object which will define state of switch.
User can manage state of switch using MQTT or Actions. To change state of switch, user need to send data in following format.
{"imageKey":true/false}
OR
{"imageKey":1/0}
// 'imageKey' is set as key in widget form.
Configure Toggle Switch Widget

Source

User can select a source mode as MQTT or Action.
Using MQTT
Here, to change state of switch user can publish JSON object on given imageData MQTT topic. The JSON object will be as below. No need to provide <account_id> while providing the MQTT topic.
{"imageKey":true/false}
OR
{"imageKey":1/0}
// 'imageKey' is set as key in widget form.
Configure Toggle Switch Widget
Using Action
Here, to change state of switch, output of the action should contain key-value pair with 'imageKey' key. User can also update the widget either onLoad or periodically by providing refresh interval.
Configure Toggle Switch Widget

Event Handling

Button onChange event is provided. User can choose MQTT or Action mode for onChange event.
Using MQTT
User needs to provide following parameters:
  • event - Select onChange event from dropdown
  • mode - Select mode as MQTT
  • topic - Enter topic name directly. No need to provide accountID.
  • Data parameters - Add new data parameter item. Each data parameter item represent a key-value pair. So select required parameter and give key name to it.
As shown in below images, for onClick event, MQTT mode is selected. It means when state of switch changes, it will publish configured data parameters on given MQTT topic.
Toggle Switch Widget - Event handling using MQTT
Toggle Switch Widget - Event handling using MQTT
So, as per the configuration shown in above images, when button state changes, JSON object with imgKey-UserRole as key-value pair gets published on buttonData topic. Please refer below image for final output.
Toggle Switch Widget - Event handling using MQTT
Using Action
User needs to provide following parameters:
  • event - Select onChange event from dropdown
  • mode - Select mode as action
  • Action ID - Select required Action ID from dropdown
As shown in below images, for onChange event, action mode is selected. It means when switch state changes, it will trigger given Action with configured action parameters.​
oggle Switch Widget - Event handling using Actions
Toggle Switch Widget - Event handling using Actions

Example

If we configure Toggle Switch Widget as below:
  1. 1.
    key - toggleKey
and set source type for widget as MQTT and topic configured is 'data'. And if we publish following JSON Object over 'data' topic then Toggle Switch Widget will look as shown in image.
// Data over configured MQTT Topic
{
"toggleKey":true/1
}
OR
{
"toggleKey":false/0
}
Enabled Toggle Switch
Disabled Toggle S
Copy link
Outline