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.

Add Widgets

To add a widget:

  • Click the button

  • A new dialog will open with different types of widgets: Actuators, Cards, Charts, Control, Gauges, Layout, Live messages, Maps, Semantic groups and Status

  • 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 the value of the latest reading, and state (ready/busy).

  • Click a switch symbol in a switch actuator widget
  • Confirm/abort the action by clicking (tick) or (x)
  • The actuator will be switched on/off

Slider (Count)

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

  • Change the value on a slider (count) actuator widget
  • Confirm/abort the action by clicking (tick) or (x)
  • The actuation value on a slider (count) will be changed

String

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

  • Managing String Actuator

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

  • Enter the text command by clicking the field on the label
  • Confirm/abort the action by clicking (tick) or (x)
  • The command text will be displayed on the 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 right corner 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)
  • After you type the command and click Save, 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.

Cards

Cards widget displays the latest reading of one feed of one semantic group.

To visualise data with card widget:

  • Choose feed by selecting the radio button (round button) on the right side
  • Click Save

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

Charts

Charts widget displays live reading(s) in form of a chart.

To visualise data with charts widget:

  • Choose it and click the Select button
  • It will open a drop-down menu with a list of semantic groups and feeds (e.g. office: pressure, humidity, temperature)

You can choose feeds from multiple semantic groups (e.g. room 1: temperature 1; room 2: temperature 2…). However, they need to belong to the same reading type (e.g. Temperature reading type). Chart can display readings of up to four feeds.

  • Choose feed(s)
  • Click Save

Control

Control widget is a mix of chart and card widget. It displays real-time data and updates on its label.

Control widget displays the following data:

  • Name of feed and its semantic group
  • Time/date of last update
  • Status (active/inactive)
  • Chart with real-time data

To visualise data with control widget:

  • Choose control widget in Add widget dialog
  • Widget settings dialog will appear with the list of all the semantic groups and their feeds
  • Choose feed
  • Click Save
  • Control widget with the selected feed data will appear on a dashboard

Gauges

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

To visualise data with gauge widget:

  • Click the Gauges button in Choose widget dialog
  • You will get the list of all the semantic groups you have previously made
  • Choose feed with value you would like to be displayed (e.g. Temperature)
  • New Widget settings dialog will appear
  • Within a default range, set your own range of limits by clicking
  • Define limit values by using number input spinners or by directly typing the exact number and assign matching colour
  • Click Save

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 Layout widget button in the Choose widget dialog
  • Within new widget settings dialog you are prompt to enter Layout Name
  • Click the SELECT BACKGROUND (PNG or JPEG format; size up to 15 MB) button
  • Choose your background
  • Click Save

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

To add feed:

  • Click the feed icon /uploads/feed icon-1.jpeg
  • 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 data feed 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
  • Adjust font size
  • Click Save

By clicking the Clear background button, you will delete the current one and will be able to choose a new one.

To resize the layout widget, click one of the following buttons:

Live Messages

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 Live messages button in Choose widget dialog
  • New Widget settings dialog will appear
  • Set the number of notifications your widget will display (up to 4, 8 or 12 at once)
  • Click Save

Maps

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.

To use Maps:

  • Click the Maps button in the Choose widget dialog
  • New dialog will appear with a list of the semantic groups which contain either location (GPS) feed or static location data entered (location attributes)
  • Select one or more semantic group(s) by checking the box
  • Click Save
  • 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: name of the semantic group, coordinates (latitude and longitude), connection state, time of the last update and the Details link.

If you go to the Details link:

  • It will redirect you to the Data Semantics module, to the semantic group that the feed from this widget belongs to in the Data browser tab

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

Modify Maps

  • Go to Widget settings
  • A dialog with a list of semantic groups will appear
  • Change the semantic group by checking its box
  • Change the size of a widget by clicking one of three buttons:, or click the button on a widget to display map in full size
  • Button in the middle displays map widget in default size
  • Click Save

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 Status button in Choose widget dialog
  • New dialog will appear with a list of semantic groups you have created on the Platform
  • Select semantic group
  • New Widget settings dialog will appear

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

Default colours can be changed in a drop-down menu in the Widget settings dialog.

  • Click Save

Status widget will display a 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).

Manage Status Widget

To manage Status widget:

  • Select the widget on a dashboard
  • New dialog will appear

Feeds are in normal state:

  • Name and graphic representation of the icon of the feed displayed

  • 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

/uploads/feed-warning-state-status-18.12.png

  • 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

/uploads/details-feeds-warning-state-18.12.png

  • 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

Feeds are inactive:

  • Click the feed in question
  • New dialog will appear but will not contain feed details (real-time data) since the feed’s sensor is inactive

Please note that the status widget itself, along with status widget details dialog, will indicate if there are feed(s)/subpoint(s) within a semantic group which are inactive.

Semantic Groups

Dashboard Semantic groups widget enables you to see real-time data of multiple feeds and actuators of one custom semantic group on dashboard.

Create Semantic Groups Widget

To visualise data with Semantic groups widget:

  • Click the Semantic groups button in the Choose widget dialog

A new dialog will appear with the list of all the semantic groups and the data (feeds and actuators) in those groups you have created and/or have the access to.

  • Select feeds and actuators in the checkbox on the right
  • Click Save

Note: You can select up to 4 feeds/actuators but from one semantic (sub)group only!

Select one feed/actuator in the widget to see more details about the latest reading, e.g. maximum and minimum values, daily reports and the list of the latest notifications.

Edit/Delete Semantic Groups Widget

All other actions (editing and deleting) which can be performed on a widget, are applicable to Semantic groups widgets as well (See Editing Widgets and Removing Widgets sections below). Additionally to that, access permission restriction is also displayed on the semantic groups widget in the same way as on all other widgets.

Note: If you do not have permission to access a semantic group, or if widget data is missing, widget label with No data sign will be displayed.

Similar information, with the appropriate visual component will be displayed if feeds/actuators/alarms in the semantic group are 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 change type of data displayed:

  • Click the Settings button (It will display if you hover the cursor over the widget)
  • New Widget settings dialog will appear containing all the semantic groups you have created on the Platform
  • Select one
  • A drop-down list of feeds/actuators will expand
  • Choose one by checking the checkbox/radio button next to it
  • Click Save

Note: If a reading of a particular parameter cannot be displayed on that widget you will not be able to choose it!

Resize a widget by clicking the Settings button in it and choose either square or rectangular shape.

Note: This can be applied to reading widget only!

Change the position of a widget by drag and drop at any place on the screen.

Mobile Enablement

Mobile enabled switch is in the Settings dialog. If switched on, that particular widget will be visible on your Android and/or iOS if you have installed our free mobile application.
Note Live messages widget is not mobile enabled.

For Android visit: App Store

For iOS visit: Google Play Store

A green mobile phone symbol displayed on a widget indicates Mobile enabled is turned on.

Note: Mobile enabled settings can be switched on and off after the widget has already been created.

Trend

Each widget displaying numeric type of data also displays a trend of the value of that data which can be: rising , falling and steady if the value is increasing, decreasing or relatively consistent comparing to the previously received data.

Delete Widgets

  • Remove/delete widget by clicking x
  • This will open a new dialog in which you need to confirm the action
  • Click Delete to do so