Image Switch Widget
General Setting
User can change following things in Image Switch widget:
  • Name for widget which will be used data referenceFor 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 Image 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.
  • Switch Style - Select one from available Switch styles
Configure Image Switch Widget
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.

Source

User can select a source mode as MQTT or Action.
Using MQTT
Here, to change state of Image Switch user can publish JSON object on given imageData MQTT topic. No need to provide <account_id> while providing the MQTT topic. The JSON object will be as below.
{"imageKey":true/false}
OR
{"imageKey":1/0}
// 'imageKey' is set as key in widget form.
Configure Image Switch Widget
Using Action
Here, to change state of Image 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 Image Switch Widget

Event Handling

Button onClick event is provided. User can choose MQTT or Action mode for onClick event.
Using MQTT
User needs to provide following parameters:
  • event - Select OnClick 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 the user clicks the button, it will publish configured data parameters on given MQTT topic.​
Image Switch Widget - Event Handling using MQTT
Image Switch Widget - Event Handling using MQTT
So, as per the configuration shown in above images, when the user clicks the button, JSON object with imgSwitch-UserRole as key-value pair gets published on buttonData topic. Please refer below image for final output.
Image Switch Widget - Event Handling using MQTT
Using Action
User needs to provide following parameters:
  • event - Select onClick event from dropdown
  • mode - Select mode as action
  • Action ID - Select required Action ID from dropdown
As shown in below images, for onClick event, action mode is selected. It means when user clicks on the button, it will trigger given Action with configured action parameters.
Image Switch Widget - Event Handling using Action
Image Switch Widget - Event Handling using Action

Example

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