Field | Description | ||
---|---|---|---|
Title | A free-text name for the widget, which displays at the top of the widget. | ||
Type | Specifies the type of Devices to include in the widget. Select either All, Connected Devices or Disconnected Devices. | ||
Groups | Specifies the group(s) to be included in the widget. | ||
Background Color | Select the background color to display for the widget. This is the color that will be displayed when you select the Static coloring scheme. | ||
Coloring | Here you can choose between: • Static By selecting this option, you will apply the fixed coloring scheme selected as Background color. • Dynamic By selecting this option, you can specify a range based coloring scheme.
| ||
Text Color | Select the color of the text to display in the widget (white or black). |
Field | Description | ||
---|---|---|---|
Title | A free-text name for the widget, which displays at the top of the widget. | ||
Device | The Device to be included in the widget. | ||
Reading | Specifies the Device reading to be included in the widget. | ||
Display connection status | Select this check box to display the device's connection status. Clear this check box if you do not want to display the device's connection status on the widget. You might, for example, turn off the status for a virtual device since by default its status is Disconnected. | ||
Header font size | Specify the font size for headers. | ||
Value font size | Specify the font size for values. | ||
Background Color | Select the background color to display for the widget. This is the color that will be displayed when you select the Static coloring scheme. | ||
Coloring | Here you can choose between: • Static By selecting this option, you will apply the fixed coloring scheme selected as Background color. • Dynamic By selecting this option, you can specify a range based coloring scheme.
| ||
Text Color | Select the color of the text to display in the widget (white or black). |
Field | Description | ||
---|---|---|---|
Title | A free-text name for the widget, which displays at the top of the widget. | ||
Device | The Device to be included in the widget. | ||
Reading | Specifies the Device reading to be included in the widget. These are events that were defined in the Product or events that IoT Platform accepts, even if they were not defined in the Product (for example, color changing, labels, icons and so on. The Reading drop-down list shows all the events that were defined in the Product Events tab, plus any other events that were not defined, but that were received from the Device. | ||
Background Color | Select the background color to display for the widget. This is the color that will be displayed when you select the Static coloring scheme. | ||
Coloring | Here you can choose between: • Static By selecting this option, you will apply the fixed coloring scheme selected as Background color. • Dynamic By selecting this option, you can specify a range based coloring scheme.
| ||
Text Color | Select the color of the text to display in the widget (white or black). |
Field | Description |
---|---|
Icon | The icon representing the type of reading sent by the Device. |
Device | The name of the Device. |
Name | The name of the Event (reading) sent by the Device. |
Label | A user-defined name for the Event sent by the Device. |
Value | The value of the reading sent by the Device. |
Date | The date and time that the reading was sent by the Device. |
Field | Description | ||
---|---|---|---|
Title | A free-text name for the widget, which displays at the top of the widget. | ||
Show Devices Hierarchy | Check this check box to display the Device hierarchy in the left pane of the widget. | ||
View Groups | When checked, each row represents a different Group of Devices. The Group to which a Device belongs is defined when the Device is created. | ||
Devices | The Devices to be included in the widget. | ||
Readings | Specifies the Device readings to be included in the widget. These are events that were defined in the Product or events that IoT Platform accepts, even if they were not defined in the Product (for example, color changing, labels, icons and so on. The Readings drop-down list shows all the events that were defined in the Product Events tab, plus any other events that were not defined, but that were received from the Device. | ||
Background Color | Select the background color to display for the widget. This is the color that will be displayed when you select the Static coloring scheme. | ||
Coloring | Here you can choose between: • Static By selecting this option, you will apply the fixed coloring scheme selected as Background color. • Dynamic By selecting this option, you can specify a range based coloring scheme.
| ||
Text Color | Select the color of the text to display in the widget (white or black). |
Field | Description | ||
---|---|---|---|
Title | A free-text name for the widget, which displays at the top of the widget. | ||
Severity | Specifies the severity of the Alarm (major, minor, critical or warning). | ||
Background Color | Select the background color to display for the widget. This is the color that will be displayed when you select the Static coloring scheme. | ||
Coloring | Here you can choose between: • Static By selecting this option, you will apply the fixed coloring scheme selected as Background color. • Dynamic By selecting this option, you can specify a range based coloring scheme.
| ||
Text Color | Select the color of the text to display in the widget (white or black). |
Alarms cannot be deleted in the Alarm list. |
Field | Description | ||
---|---|---|---|
Title | A free-text name for the widget, which displays at the top of the widget. | ||
Groups | Group(s) of Products to display in the widget. | ||
Background Color | Select the background color to display for the widget. This is the color that will be displayed when you select the Static coloring scheme. | ||
Coloring | Here you can choose between: • Static By selecting this option, you will apply the fixed coloring scheme selected as Background color. • Dynamic By selecting this option, you can specify a range based coloring scheme.
| ||
Text Color | Select the color of the text to display in the widget (white or black). |
Field | Description | ||
---|---|---|---|
Title | A free-text name for the widget, which displays at the top of the widget. | ||
Entity | Specifies the entity to display in the widget, such as Devices, Products, Users and so on. | ||
Reports | Specifies the report to include in the widget. The drop-down menu lists all of the defined reports for the type of entity specified in the Entity field. | ||
Background Color | Select the background color to display for the widget. This is the color that will be displayed when you select the Static coloring scheme. | ||
Coloring | Here you can choose between: • Static By selecting this option, you will apply the fixed coloring scheme selected as Background color. • Dynamic By selecting this option, you can specify a range based coloring scheme.
| ||
Text Color | Select the color of the text to display in the widget (white or black). |
Field | Description | ||
---|---|---|---|
Title | A free-text name for the widget, which displays at the top of the widget. | ||
Device | Specifies the Device to display in the widget. | ||
Reading | Specifies the reading for the Device. The drop-down menu lists all of the readings for the Device specified in the Device field. | ||
Display connection status | Select this check box to display the device's connection status. Clear this check box if you do not want to display the device's connection status on the widget. You might, for example, turn off the status for a virtual device since by default its status is Disconnected. | ||
Time Range | Specifies the relative time range for the data to display in the widget. | ||
Custom Time Range | Enables you to define a custom time range for the data to display in the widget. | ||
Analytics Function | Specifies the function to apply to the data. For telemetric data, you can select from: • Sum • Average • Min • Max • Count For status data, such as opening or closing a switch, you can only select Count. | ||
Header font size | Specify the font size for headers. | ||
Value font size | Specify the font size for values. | ||
Background Color | Select the background color to display for the widget. This is the color that will be displayed when you select the Static coloring scheme. | ||
Coloring | Here you can choose between: • Static By selecting this option, you will apply the fixed coloring scheme selected as Background color. • Dynamic By selecting this option, you can specify a range based coloring scheme.
| ||
Text Color | Select the color of the text to display in the widget (white or black). |
Field | Description | ||
---|---|---|---|
Readings Tab This tab defines the reading to the display in the widget. Define the following settings On this tab | |||
Device | Specifies the Device whose reading to display in the widget. | ||
Reading | Select the reading to display in the widget. | ||
Display connection status | Select this check box to display the device's connection status. Clear this check box if you do not want to display the device's connection status on the widget. You might, for example, turn off the status for a virtual device since by default its status is Disconnected. | ||
Title | A free-text name for the widget, which displays at the top of the widget. | ||
Gauge Colors | Sets the color for each value range. You can set a range for Red, Green and Yellow. After you set a color for a range, its box displays a border in that color, and is not color-filled (for example, ). For example, the example below shows that the 0–20 range will display in green on the gauge, the range of 20–40 will display in yellow and the range of 40–60 will display in red. | ||
Background Color | Select the background color to display for the widget. This is the color that will be displayed when you select the Static coloring scheme. | ||
Coloring | Here you can choose between: • Static By selecting this option, you will apply the fixed coloring scheme selected as Background color. • Dynamic By selecting this option, you can specify a range based coloring scheme.
| ||
Text Color | Select the color of the text to display in the widget (white or black). | ||
Analytics Tab This tab specifies the functions to apply to the selected reading. The settings On this tab are the same as those in the Readings tab, with the following addition: | |||
Analytics Function | Specifies the function to apply to the reading data. For telemetric data, you can select from: • Sum • Average • Min • Max • Count For status data, such as opening or closing a switch, you can only select Count. | ||
Duration Tab This tab indicates the amount of time that the Device was in the selected status (in hours, minutes or seconds), as specified by the last reading received. For example, how long a door was open or closed. The settings On this tab are the same as those in the Readings tab, with the following additions: | |||
State | Specifies the name of the value. For example, Disconnected, Connected and so on. The drop-down menu shows all possible values of the reading selected in the Reading | ||
Time Format | Specifies whether to count the amount of time that the value was in the specified status in hours, minutes or seconds. |
Field | Description | ||
---|---|---|---|
Title | A free-text name for the widget, which displays at the top of the widget. | ||
Device | Specifies the Device(s) to display in the widget. The drop-down menu only contains Devices for which one or more commands have been defined in the IoT Platform API. | ||
Display connection status | Select this check box to display the device's connection status. Clear this check box if you do not want to display the device's connection status on the widget. You might, for example, turn off the status for a virtual device since by default its status is Disconnected. | ||
Commands | Specifies the command(s) to include in the widget. The drop-down menu lists all of the commands for the Device specified in the Device field. | ||
Background Color | Select the background color to display for the widget. This is the color that will be displayed when you select the Static coloring scheme. | ||
Coloring | Here you can choose between: • Static By selecting this option, you will apply the fixed coloring scheme selected as Background color. • Dynamic By selecting this option, you can specify a range based coloring scheme.
| ||
Text Color | Select the color of the text to display in the widget (white or black). |
Field | Description | ||
---|---|---|---|
Title | A free-text name for the widget, which displays at the top of the widget. | ||
Show Devices Hierarchy | Select this check box to display the Device hierarchy in the left pane of the widget. | ||
Groups | Specifies the Device groups to display on the map. When the Show Devices Hierarchy check box is selected (see above), the list displays Device groups. You can drill down within a group to select a specific Device(s). You can only select a single group or a single Device. | ||
Background Color | Select the background color to display for the widget. This is the color that will be displayed when you select the Static coloring scheme. | ||
Coloring | Here you can choose between: • Static By selecting this option, you will apply the fixed coloring scheme selected as Background color. • Dynamic By selecting this option, you can specify a range based coloring scheme.
| ||
Text Color | Select the color of the text to display in the widget (white or black). |
Field | Description | ||
---|---|---|---|
Title | A free-text name for the widget, which displays at the top of the widget. | ||
Default View Mode | Specifies the diagram to use for the heatmap. Click Application Diagram to display the diagram for the Application, or click Group Diagram to display the diagram for the Group. | ||
| |||
Groups/Devices | Specifies the Groups or Devices(s) to display in the widget. It is possible to specify multiple devices or multiple groups. When using the “group diagram” option and multiple groups are selected, the diagram will be taken from the first group selected (In the attached screenshot, the diagram from Group C will be used). All further devices will then be set on that diagram. | ||
Reading | Specifies the reading for the Device(s). The drop-down menu lists all of the readings for the Device(s) specified in the Group/Devices field. | ||
Time Range | Specifies the time range for the data in the widget: • Today • Yesterday • Last week • Last 7 days • Last month • Last 30 days | ||
Aggregation Method | Specifies the aggregation method to apply to the data: • None • Average • Count • Min • Max | ||
Aggregation Times | Specifies the interval at which data is aggregated. | ||
Color Schema | Indicates whether cold temperatures are to be represented by blue or green. | ||
Background Color | Select the background color to display for the widget. This is the color that will be displayed when you select the Static coloring scheme. | ||
Coloring | Here you can choose between: • Static By selecting this option, you will apply the fixed coloring scheme selected as Background color. • Dynamic By selecting this option, you can specify a range based coloring scheme.
| ||
Text Color | Select the color of the text to display in the widget (white or black). |
Field | Description | ||
---|---|---|---|
Title | A free-text name for the widget, which displays at the top of the widget. | ||
Device | Specifies the Device(s) to display in the widget. | ||
Chart Type | Specifies the type of chart to display in the widget: • Line chart • Smooth chart • Column chart • Area chart • Pie chart • Scatter chart • Heatmap | ||
Aggregation Method | Specifies the aggregation method to apply to the data: • None • Sum • Average • Count • Min • Max • Duration | ||
Aggregation Times | Specifies the interval at which data is aggregated. | ||
Readings | Specifies the reading(s) for the Device. The drop-down menu lists all of the readings for the Device specified in the Device field. You can also add readings from different devices by using the Compare to option. | ||
Machine Learning | Enables you to forecast or predict the readings in the next time period based on algorithmic calculations. Different algorithms are used for the Forecast Linear and Forecast Quadratic. | ||
Define a Y-axis range by reading | Per available device readings, you can specify a minimum and maximum value for the respective Y-axis. This feature enables you to more easily compare different readings in the same chart. In the following example, both Y-axes show a custom range: • Min = 20 • Max = 60 | ||
Chart Display | Specifies the type of Chart to display: • Unstacked • Stacked • Shared | ||
Time Range | Specifies the time range for the data in the widget: • Today • Yesterday • Last week • Last 7 days • Last month • Last 30 days | ||
Custom Time Range | Enables you to define a custom time range for the data to display in the chart. | ||
Background Color | Select the background color to display for the widget. This is the color that will be displayed when you select the Static coloring scheme. | ||
Coloring | Here you can choose between: • Static By selecting this option, you will apply the fixed coloring scheme selected as Background color. • Dynamic By selecting this option, you can specify a range based coloring scheme.
| ||
Text Color | Select the color of the text to display in the widget (white or black). |
To define a Device as a camera, see How to connect Cameras to
IoT Platform
. |
Field | Description | ||
---|---|---|---|
Title | A free-text name for the widget, which displays at the top of the widget. | ||
Device | Specifies the Device(s) to display in the widget. The drop-down menu only includes those Devices that are cameras. | ||
Background Color | Select the background color to display for the widget. This is the color that will be displayed when you select the Static coloring scheme. | ||
Coloring | Here you can choose between: • Static By selecting this option, you will apply the fixed coloring scheme selected as Background color. • Dynamic By selecting this option, you can specify a range based coloring scheme.
| ||
Text Color | Select the color of the text to display in the widget (white or black). |
Attribute | Value |
---|---|
mediaProtocol | The type of media streaming protocol, as follows: • 0 - None • 1 - RTMP • 2 - RTSP |
mediaType | • 0 - Unknown • 1 - Video |
aspectRatio | Not currently supported. |
Field | Description | ||
---|---|---|---|
Text Color | Select the color of the text to display in the widget (white or black). | ||
Background Color | Select the background color to display for the widget. This is the color that will be displayed when you select the Static coloring scheme. | ||
Coloring | Here you can choose between: • Static By selecting this option, you will apply the fixed coloring scheme selected as Background color. • Dynamic By selecting this option, you can specify a range based coloring scheme.
| ||
Text Color | Select the color of the text to display in the widget (white or black). |
Field | Description | ||
---|---|---|---|
Title | A free-text name for the widget, which displays at the top of the widget. | ||
Type | Specifies the type of clock: • Analog • Digital | ||
24 | When this check box is selected, indicates that the clock is a 24-hour clock instead of a 12-hour clock. This setting only applies when you specify Digital in the Type field. | ||
Timezone | Specifies the time zone for the widget. | ||
Background Color | Select the background color to display for the widget. This is the color that will be displayed when you select the Static coloring scheme. | ||
Coloring | Here you can choose between: • Static By selecting this option, you will apply the fixed coloring scheme selected as Background color. • Dynamic By selecting this option, you can specify a range based coloring scheme.
| ||
Text Color | Select the color of the text to display in the widget (white or black). |
Field | Description | ||
---|---|---|---|
Location | Specifies the location for the widget. To select the proper value, start typing the name of your city and select it from the list once it appears. | ||
Main Background | Select the background color (main pane) to display for the widget. | ||
Coloring | Here you can choose between: • Static By selecting this option, you will apply the fixed coloring scheme selected as Background color. • Dynamic By selecting this option, you can specify a range based coloring scheme.
| ||
Second Tile | When this check box is selected , the widget displays two panes instead of one. You can define the background color for each pane separately. | ||
Clock | Click this button for the widget to display the time. | ||
Detailed Weather | Click this button for the widget to display detailed weather information (including humidity and wind speed). | ||
Timezone | Specifies the time zone for the widget. | ||
Second Tile Background Color | When the Second Tile check box is selected, specify the background color for the widget’s second (right) pane. | ||
Add Custom Colors | When the Second Tile check box is selected, specify the custom color to use for the widget’s second (right) pane here. |
Field | Description | ||
---|---|---|---|
Title | A free-text name for the widget, which displays at the top of the widget. | ||
Devices | Specifies the Device(s) to display in the widget. | ||
Background Color | Select the background color to display for the widget. This is the color that will be displayed when you select the Static coloring scheme. | ||
Coloring | Here you can choose between: • Static By selecting this option, you will apply the fixed coloring scheme selected as Background color. • Dynamic By selecting this option, you can specify a range based coloring scheme.
| ||
Text Color | Select the color of the text to display in the widget (white or black). |
Field | Description | ||
---|---|---|---|
Group | Specify the Group of Products to display in the widget. | ||
Product | Select the Product to include in the widget in the drop-down menu. | ||
Readings | Specify the Event whose readings you want to display in the widget. | ||
| |||
Add Product (optional) | Click the Add Product button to add another Product to the widget. You must also specify the Event whose readings you want to report for this Product in the adjacent Readings. You can add an unlimited number of Products to the widget. | ||
Background Color | Select the background color to display for the widget. This is the color that will be displayed when you select the Static coloring scheme. | ||
Coloring | Here you can choose between: • Static By selecting this option, you will apply the fixed coloring scheme selected as Background color. • Dynamic By selecting this option, you can specify a range based coloring scheme.
| ||
Text Color | Select the color of the text to display in the widget (white or black). |
Field | Description | ||
---|---|---|---|
Title | A free-text name for the widget, which displays at the top of the widget. | ||
Device | Choose a device. | ||
Reading | Choose a numeric reading from that device. | ||
Add device | Add as many devices as you need. | ||
Background Color | Select the background color to display for the widget. This is the color that will be displayed when you select the Static coloring scheme. | ||
Coloring | Here you can choose between: • Static By selecting this option, you will apply the fixed coloring scheme selected as Background color. • Dynamic By selecting this option, you can specify a range based coloring scheme.
| ||
Text Color | Select the color of the text to display in the widget (white or black). |
Field | Description | ||
---|---|---|---|
Title | A free-text name for the widget, which displays at the top of the widget. | ||
Space | Choose a space which has a calendar defined, this can be a device or a digital twin. | ||
Time Range | Choose the time range to aggregate, options are preset but dynamic. | ||
Aggregation Times | Choose the aggregation bucket to roll up to, these options change based on the time range selected. | ||
Timezone | The time zone where the space is | ||
Readings | Indicate which of the 4 statuses should be displayed | ||
Work Days | Indicate which days of the weeks should be included in the aggregation. This is relevant as usually the utilization over weekend is just white noise. | ||
Start Time/End Time | Indicate which hours of the day should be included in the aggregation. This is relevant as usually the utilization at night is not as relevant | ||
Background Color | Select the background color to display for the widget. This is the color that will be displayed when you select the Static coloring scheme. | ||
Coloring | Here you can choose between: • Static By selecting this option, you will apply the fixed coloring scheme selected as Background color. • Dynamic By selecting this option, you can specify a range based coloring scheme.
| ||
Text Color | Select the color of the text to display in the widget (white or black). |