Handle Widgets

Widgets are visual real-time representations of the status/real-time readings of the data you receive from your devices through semantic groups. These widgets are available in various sizes and each type will have specific content.

Add Widgets

To add a widget:

  • Click the Add widget button

  • A new dialog will open with different types of widgets: Actuators, Gauge, Layout, Live messages, Map, Reading, Status and Trending.

  • Select one
  • In a new dialog choose semantic group/feed you would like to see on that widget
  • The widget and the data will appear on your dashboard

Actuators

Actuator displays current state and value of a switch, slider (count) or string and enables you to actuate a physical device by switching it on and off, or by setting desired values on the widget itself.

Switch

Switch actuator enables you to control devices by switching them on and off. The widget displays name, time and state (Ready/Busy).

If you click on the Switch widget, a sidebar with widget details will appear

Slider (Count)

Slider enables you to send a numerical actuation value. The widget displays: name, time ,the value of the latest reading, and state (ready/busy).

  • Change the value on a slider (count) actuator widget
  • The actuation value on a slider (count) will be changed

If you click on the slider widget, a sidebar with widget details will appear

String

String actuator enables you to send an actuation value to a device

String actuator widget displays a text field, the name of the string actuator, date and time of the last change.

  • Click the Add widget button and choose Actuator widget
  • In the Search actuators by name field, select String actuator
  • Select Mobile enabled checkbox if you wish widget to be seen on your mobile as well

  • Click Add widget

You can use XML, String, JSON or even plain text to enter the command. Maximum size of the actuation message is 2048 characters.

If the process of actuation has been successfully completed, a message Changes saved will be displayed at the bottom of the screen.

  • String actuator has three statuses: ready, busy and error
  • If the actuator is in the ready status, you can send a command (type the text in the text field)

If you click on the String widget, widget details will appear * Enter the text command by clicking the field on the label * The command text will be displayed on the widget * After you type the command and click Apply, the actuator’s status will be busy during the process of sending and executing the command * After the actuation process is finished, the status will go back to ready

If the actuation process has not been successfully completed, the error status will be displayed on the widget and the device will not be able to receive any other actuation signal from the Platform until the status is set to ready again.

Note: Actuator widget displays current state and the value of the actuator. If one operation is in progress, the reading of another one will not be displayed until the previous operation has been completed.

Gauge

Gauges widget is a visual representation of user-defined quality ranges of numeric feed values.

To visualise data with gauge widget:

  • Click the Add widget button and choose Gauge
  • In the search feeds by name field, filter feeds by name (e.g. Humidity)
  • Within a default range, set your own range of limits and add new range by clicking
  • Define limit values by using number input spinners or by directly typing the exact number and assign a matching colour
  • Click Add widget

You can add multiple value ranges.

Note: The default range is defined in the Device template as minimum and maximum and can be edited for the Gauge widget.

Layout

Layout widget is a monitoring-enabled widget which provides a background for specific feeds so that they can be organised according to your business logic.

To use a Layout widget:

  • Click the Add widget button and choose Layout widget
  • Within new widget settings dialog you are prompt to enter Layout Name
  • Upload the background image (PNG or JPEG format; size up to 10 MB) by drag and drop option
  • Choose your background
  • Click Save

When you create your background you are able to add feeds to it.

To add feed:

  • Click the add feed button
  • Place the feed placeholder on the background
  • Feed properties will be displayed on the right side of the dialog
  • Click the at the top left to select a feed
  • Select an appropriate data feed within search feed by name drop-down menu
  • Adjust your x and y feed properties to change the position of feeds
  • Enter label
  • Check Show label box to make it visible on the widget
  • To resize the layout widget, click one of the following buttons:

  • Click Create

Your layout widget has been created

Live messaging

Live messages widget displays the latest notifications coming from semantic groups sent by the alarm that is on a physical device, or from the Platform rule engine if the parameters exceed their limit values. You, as a user, can define limit values for the parameters and can be notified if they are exceeded.

To use Live messages widget:

  • Click the Add widget button and choose Live messages
  • New Add Messages Widget dialog will appear
  • Define which types of messages you would like to see

  • Click Add widget

Your live messages have been created

Map

Maps widget enables real-time tracking of your data on a map by visualising the last sent physical location/position of the specific GPS feeds of a selected set of semantics.

To use Maps:

  • Click the Add widget button and choose Map
  • New dialog will appear and you will be prompt to enter name (Location GPS feed)
  • Select one semantic group
  • Choose size
  • Select Mobile enabled checkbox if you wish widget to be seen on your mobile as well
  • Click Add widget

  • Map widget will be displayed on your dashboard

Manage Maps

You will get a zoomed-in version of a map with the location marker. Location markers are colour-coded:

red - there is at least one alarm in a semantic group

orange - there is at least one warning in a semantic group

green - there is no alarm

grey - feed(s) in a semantic group are inactive

If you click on a location marker, you will get the following information: Path (name of the semantic group), coordinates (latitude and longitude), time of the last update, source status

  • Zoom in/out map by clicking the / button, or by using ctrl + scroll command
  • Use button to exit zoomed in/out mode

You can search location by name or path:

Reading

Reading widget displays the latest feed value, trend, alarm status (by changing the colour of the card) and feed connection status (grey colour and offline message).

To visualise data with reading widget:

  • Click the Add widget button and choose Reading
  • New dialog will appear where you can enter feed name in the Search feeds by name field
  • Choose size
  • Select Mobile enabled checkbox if you wish widget to be seen on your mobile as well

  • Click Add widget

Note: A click on a widget opens a new dialog with more details about the latest readings of the feed.

Status

Status widget displays current status of a semantic group based on real-time data sent from any selected feed or hardware alarm within a selected semantic group.

To use Status widget:

  • Click the Add widget button and choose Status
  • New dialog will appear and enter in the Search semantic groups field one of the semantic groups you have created on the Platform
  • Choose size
  • Select Mobile enabled checkbox if you wish widget to be seen on your mobile as well

  • Click Add widget

It displays the name of the semantic group you have chosen along with the different statuses a widget can have:

  • NORMAL - no thresholds crossed/alarms activated; green is default colour
  • ALARM - threshold crossed/alarm triggered on any feed in any semantic (sub)group; red is default colour
  • WARNING - alert condition of selected feed or semantic (sub)group; yellow is default colour

Status widget will display the colour of a state its feeds/semantic (sub)groups are in.

If any feed in any semantic (sub)group crosses a defined threshold, the status widget displaying its data will turn red and will display the number of threshold alarms that have been triggered. If feed’s data goes back to normal state, the widget will turn green (or will be in any other colour you have selected to be your normal state colour).

If you click on the widget it opens a new dialog with more details about the last reading of the feed.

If you click on the expanded menu on the far right, name and graphic representation of the icon of the feed will display. You can see details for every status widget has.

  • Click the feed
  • New dialog will appear with feed details: time, date and value of the last reading; measurement peaks for today (minimum and maximum); current settings of the alarm, text of the alarm messages and the time when the Platform received it

  • It will contain a chart with graphic representation of the data, the same as the one in chart widget details window

Feeds are in warning state:

  • The window contains messages the Platform receives when alarm threshold is being triggered

  • Messages are presented in form of a label with the name of the feed, time when its data triggered threshold, text of the message displayed when the alarm is triggered, value of the data when it triggered the threshold
  • Click the feed
  • New dialog will appear with feed details: time, date and value of the last reading; measurement peaks for today (minimum and maximum); current settings of the alarm, text of the alarm messages and the time when the Platform received it

  • It will also contain a chart with graphic representation of the data, the same as the one in chart widget details window

Feeds are in alarm state:

  • The window contains messages the Platform receives when alarm threshold is being triggered
  • Messages are presented in form of a label with the name of the feed, time when its data triggered threshold, text of the message displayed when the alarm is triggered, value of the data when it triggered the threshold
  • Click the feed
  • New dialog will appear with feed details: time, date and value of the last reading; measurement peaks for today (minimum and maximum); current settings of the alarm, text of the alarm messages and the time when the Platform received it
  • It will also contain a chart with graphic representation of the data, the same as the one in chart widget details window

Trending widget displays the latest feed trending history (aggregated value) in the chart form. It is a live widget and new aggregated value will update the displayed chart.

To use Trending widget:

  • Click the Add widget button and choose Trending
  • New dialog will appear and enter in the Search semantic groups field one of the semantic groups you have created on the Platform

  • Click Add widget

Trending widget will be displayed

Feeds are inactive:

  • If feeds are inactive it will appear but will not contain feed details (real-time data) since the feed’s sensor is inactive

Note: Data might be outdated graphic representation appears on a widget of a feed if the status of a device which sends data is connected, but the Platform hasn’t received any data in more than 30 minutes.

Edit Widgets

To edit widget:

  • Click the more button on widget
  • Select Edit

Within widgets you can change:

  • custom name
  • position on dashboard
  • size
  • mobile property
  • specific configuration (e.g. layout widget, gauge widget, etc)

Rearrange widgets

You can change the current widget layout position on the dashboard by using drag&drop.

To change the position of a widget:

  • Click the rearrange widget button on the top right

  • Move selected widget to the desired position on dashboard
  • Update the widget position on the dashboard

Delete Widgets

  • Click the more button on the widget
  • Select Delete

  • Confirm the action