Skip to content

Commit a32ff64

Browse files
authored
Merge pull request #116619 from dominicbetts/central-multi-device-tiles
Update dashboard tiles article
2 parents e13bb21 + 49c84c2 commit a32ff64

11 files changed

+45
-62
lines changed

articles/iot-central/core/howto-add-tiles-to-your-dashboard.md

Lines changed: 45 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,97 +1,80 @@
11
---
2-
title: Add tiles to your dashboard | Microsoft Docs
3-
description: As a builder, learn how to configure the default Azure IoT Central application dashboard.
4-
author: mavoge
5-
ms.author: mavoge
6-
ms.date: 10/17/2019
2+
title: Add tiles to your Azure IoT Central dashboard | Microsoft Docs
3+
description: As a builder, learn how to configure the default Azure IoT Central application dashboard with tiles.
4+
author: Haley-Rowland
5+
ms.author: harowl
6+
ms.date: 05/27/2020
77
ms.topic: how-to
88
ms.service: iot-central
99
services: iot-central
10-
manager: philmea
1110
---
1211

1312
# Configure the application dashboard
1413

15-
The **Dashboard** is the page that loads when users who have access to the application navigate to the application's URL. If you created your application from one of the **Application Templates**, your application will have a pre-defined dashboard to start. If you created your application from a **Custom application** application template, your dashboard will show some tips on getting started.
14+
The **Dashboard** is the first page you see when you connect to an IoT Central application. If you create your application from one of the industry-focused [application templates](./concepts-app-templates.md), your application has a pre-defined dashboard to start. If you create your application from a custom [application template](./concepts-app-templates.md), your dashboard shows some tips to get started.
1615

17-
> [!NOTE]
16+
> [!TIP]
1817
> Users can [create multiple dashboards](howto-create-personal-dashboards.md) in addition to the default application dashboard. These dashboards can be personal to the user only, or shared across all users of the application.
1918
2019
## Add tiles
2120

22-
The following screenshot shows the dashboard in an application created from the **Custom Application** template. To customize the default dashboard for your application, select **Edit** at the top-left of the page.
21+
The following screenshot shows the dashboard in an application created from the **Custom application** template. To customize the current dashboard, select **Edit**, to add a custom personal or shared dashboard, select **New**:
2322

24-
> [!div class="mx-imgBorder"]
25-
> ![Dashboard for applications based on the "Sample Contoso" template](media/howto-add-tiles-to-your-dashboard/dashboard-sample-contoso.png)
23+
:::image type="content" source="media/howto-add-tiles-to-your-dashboard/dashboard-sample-contoso.png" alt-text="Dashboard for applications based on the custom application template":::
2624

27-
Selecting **Edit** opens the dashboard library panel. The library contains the tiles and dashboard primitives you can use to customize the dashboard.
25+
After you select **Edit** or **New**, the dashboard is in *edit* mode. You can use the tools in the **Edit dashboard** panel to add tiles to the dashboard, and customize and remove tiles on the dashboard itself. For example, to add a **Telemetry** tile to show current temperature reported by one or more devices:
2826

29-
> [!div class="mx-imgBorder"]
30-
> ![Dashboard library](media/howto-add-tiles-to-your-dashboard/dashboard-library.png)
27+
1. In the **Edit dashboard** panel, select a **Device group**.
28+
1. Select one or more devices in the **Devices** dropdown to show on the tile. You now see the available telemetry, properties, and commands from the devices.
29+
1. Select **Temperature** in the telemetry section, and then select **Add tile**. The tile now shows on the dashboard where you can change the visualization, resize the tile, and configure it:
3130

32-
For example, you can add a **Telemetry** tile for the current temperature of the device. To do so:
31+
:::image type="content" source="media/howto-add-tiles-to-your-dashboard/device-details.png" alt-text="Add a temperature telemetry tile to the dashboard":::
3332

34-
1. Select a **Device template**
35-
1. Select a device from **Devices** for the device you want to see on a dashboard tile. Then you will see a list of the device's properties that can be used on the tile.
36-
1. To create the tile on the dashboard, click on **Temperature** and drag it to the dashboard area. You can also click the checkbox next to **Temperature** and click **Add tile**. The following screenshot shows selecting a Device Template and Device Instance then creating a Temperature Telemetry tile on the dashboard.
37-
1. Select **Save** in the top left to save the tile to the dashboard.
33+
When you've finished adding and customizing tiles on the dashboard, select **Save**.
3834

39-
> [!div class="mx-imgBorder"]
40-
> !["Configure Device Details" form with details for settings and properties](media/howto-add-tiles-to-your-dashboard/device-details.png)
35+
## Customize tiles
4136

42-
Now when an operator views the default application dashboard, they see the new tile with the **Temperature** for the device. Each tile has a pre-selected graph, chart, etc. that will be displayed when the tile is created. However, users can choose to edit and change this visualization.
37+
To customize a tile on the dashboard, the dashboard must be in edit mode. The available customization options depend on the [tile type](#tile-types):
4338

44-
> [!div class="mx-imgBorder"]
45-
> !["Dashboard" tab with displayed settings and properties for the tile](media/howto-add-tiles-to-your-dashboard/settings-and-properties.png)
39+
* The ruler icon on a tile lets you change the visualization. Visualizations include line charts, last known values, and heat maps.
4640

47-
## Edit tiles
41+
* The square icon lets you resize the tile.
4842

49-
To edit a tile on the dashboard, first click **Edit** at the top left of the page, which will open edit mode for the dashboard and all its tiles.
50-
51-
> [!div class="mx-imgBorder"]
52-
> ![Dashboard screen with edit mode activated for a selected tile](media/howto-add-tiles-to-your-dashboard/edit-mode.png)
53-
54-
Then click the **Gear** icon in the top-right corner of the tile you wish to edit. Here you can edit aspects of the tile including its title, its visualization, aggregation, etc.
55-
56-
> [!div class="mx-imgBorder"]
57-
> ![Dropdown for tile aggregation settings](media/howto-add-tiles-to-your-dashboard/aggregation-settings.png)
58-
59-
You can also change the chart visualization by clicking the **Ruler** icon on the tile.
60-
61-
> [!div class="mx-imgBorder"]
62-
> ![Dropdown for tile visualization settings](media/howto-add-tiles-to-your-dashboard/visualization-settings.png)
43+
* The gear icon lets you configure the visualization. For example, for a line chart visualization you can choose to show the legend and axes, and choose the time range to plot.
6344

6445
## Tile types
6546

66-
The following table summarizes the usage of tiles in Azure IoT Central:
67-
68-
| Tile | Dashboard | Description
69-
| ----------- | ------- | ------- |
70-
| Content | Application and device set dashboards |Markdown supported tiles are clickable tiles that display heading and description text. You can also use this tile as a link tile to enable a user to navigate to a URL related to your application.|
71-
| Image | Application and device set dashboards |Image tiles display a custom image and can be clickable. Use an image tile to add graphics to a dashboard and optionally enable a user to navigate to a URL relevant to your application.|
72-
| Label | Application dashboards |Label tiles display custom text on a dashboard. You can choose the size of the text. Use a label tile to add relevant information to the dashboard such descriptions, contact details, or help.|
73-
| Map | Application and device dashboards |Map tiles display the location of a device on a map. You can also display up to 100 points of a device's location history. For example, you can a display sampled route of where a device has been on the past week.|
74-
| Line Chart | Application and device dashboards |Line chart tiles display a chart of aggregate measurement for a device for a time period. For example, you can display a line chart that shows the average temperature and pressure of a device for the last hour.|
75-
| Bar Chart | Application and device dashboards |Bar chart tiles display a chart of aggregate measurements for a device for a time period. For example, you can display a bar chart that shows the average temperature and pressure of a device for the last hour.|
76-
| Pie Chart | Application and device set dashboards |Pie chart tiles display a chart of aggregate measurements for a device for a time period.|
77-
| Heat Map | Application and device set dashboards |Heat Map tiles display information about the device, represented as colors.|
78-
| Event History | Application and device dashboards |Event History tiles display the events for a device over a time period. For example, you can use it to show all the temperature changes for a device during the last hour.|
79-
| State History | Application and device dashboards |State history tiles display the measurement values for a time period. For example, you can use it to show the temperature values for a device during the last hour.|
80-
| KPI | Application and device dashboards | KPI tiles display an aggregate telemetry or event measurement for a time period. For example, you can use it to show the maximum temperature reached for a device during the last hour.|
81-
| Last Known Value | Application and device dashboards |Last known value tiles display the latest value for a telemetry or state measurement. For example, you can use this tile to display the most recent measurements of temperature, pressure and humidity for a device. |
82-
| Property | Application and device dashboards | Property tiles display the current value for properties and cloud properties of a device. For example, you can use this tile to display device properties like manufacturer or firmware version for a device. |
47+
The following table describes the different types of tile you can add to a dashboard:
48+
49+
| Tile | Description |
50+
| ---------------- | ----------- |
51+
| Markdown | Markdown tiles are clickable tiles that display a heading and description text formatted using markdown. The URL can be a relative link to another page in the application, or an absolute link to an external site.|
52+
| Image | Image tiles display a custom image and can be clickable. The URL can be a relative link to another page in the application, or an absolute link to an external site.|
53+
| Label | Label tiles display custom text on a dashboard. You can choose the size of the text. Use a label tile to add relevant information to the dashboard such descriptions, contact details, or help.|
54+
| Count | Count tiles display the number of devices in a device group.|
55+
| Map | Map tiles display the location of one or more devices on a map. You can also display up to 100 points of a device's location history. For example, you can display sampled route of where a device has been on the past week.|
56+
| KPI | KPI tiles display aggregate telemetry values for one or more devices over a time period. For example, you can use it to show the maximum temperature and pressure reached for one or more devices during the last hour.|
57+
| Line chart | Line chart tiles plot one or more aggregate telemetry values for one or more devices for a time period. For example, you can display a line chart to plot the average temperature and pressure of one or more devices for the last hour.|
58+
| Bar chart | Bar chart tiles plot one or more aggregate telemetry values for one or more devices for a time period. For example, you can display a bar chart to show the average temperature and pressure of one or more devices over the last hour.|
59+
| Pie chart | Pie chart tiles display one or more aggregate telemetry values for one or more devices for a time period.|
60+
| Heat map | Heat map tiles display information about one or more devices, represented as colors.|
61+
| Last Known Value | Last known value tiles display the latest telemetry values for one or more devices. For example, you can use this tile to display the most recent temperature, pressure, and humidity values for one or more devices. |
62+
| Event History | Event History tiles display the events for a device over a time period. For example, you can use it to show all the valve open and close events for one or more devices during the last hour.|
63+
| Property | Property tiles display the current value for properties and cloud properties of one or more devices. For example, you can use this tile to display device properties such as the manufacturer or firmware version for a device. |
64+
65+
Currently, you can add up to 10 devices to tiles that support multiple devices.
8366

8467
### Customizing visualizations
8568

86-
For line charts, bar charts, and pie charts, you can customize the colors displayed by different telemetries in your chart. To do this, select the palate icon next to the telemetry you want to customize, and choose a color.
69+
For tiles that display aggregate values, select the gear icon next to the telemetry type in the **Configure chart** panel to choose the aggregation. You can choose from average, sum, maximum, minimum, and count.
70+
71+
For line charts, bar charts, and pie charts, you can customize the color of the different telemetry values. Select the palette icon next to the telemetry you want to customize:
8772

88-
> [!div class="mx-imgBorder"]
89-
> ![Dropdown for telemetry color display settings](media/howto-add-tiles-to-your-dashboard/color-customization.png)
73+
:::image type="content" source="media/howto-add-tiles-to-your-dashboard/color-customization.png" alt-text="Change the color of a telemetry value":::
9074

91-
For telemetries or properties that are of string type, you can choose how you want to visualize the text. For example, if your device sends a URL as string telemetry, you can visualize that URL as a clickable link. If the URL references an image, you can render the image in a last known value or property tile. You can change the way string telemetry is displayed by selecting the gear next to the telemetry name. In this way, you can show the text as text, link, or an image.
75+
For tiles that show string properties or telemetry values, you can choose how to display the text. For example, if the device stores a URL in a string property, you can display it as a clickable link. If the URL references an image, you can render the image in a last known value or property tile. To change how a string displays, in the tile configuration select the gear icon next to the telemetry type or property:
9276

93-
> [!div class="mx-imgBorder"]
94-
> ![Dropdown for string visualization settings](media/howto-add-tiles-to-your-dashboard/string-viz-customization.png)
77+
:::image type="content" source="media/howto-add-tiles-to-your-dashboard/string-customization.png" alt-text="Chane how a string displays on a tile":::
9578

9679
## Next steps
9780

89.7 KB
Loading
42 KB
Loading
-52.9 KB
Loading
Binary file not shown.
79.2 KB
Loading

0 commit comments

Comments
 (0)