You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/iot-central/core/howto-create-iot-central-application.md
+7-10Lines changed: 7 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ services: iot-central
5
5
ms.service: iot-central
6
6
author: dominicbetts
7
7
ms.author: dobett
8
-
ms.date: 06/20/2022
8
+
ms.date: 10/28/2022
9
9
ms.topic: how-to
10
10
---
11
11
@@ -77,22 +77,20 @@ The **My apps** page lists all the IoT Central applications you have access to.
77
77
78
78
You can create a copy of any application, minus any device instances, device data history, and user data. The copy uses a standard pricing plan that you'll be billed for.
79
79
80
-
Select**Copy**. In the dialog box, enter the details for the new application. Then select **Copy** to confirm that you want to continue. To learn more about the fields in the form, see [Create an application](howto-create-iot-central-application.md).
80
+
Navigate to **Application > Management** and select**Copy**. In the dialog box, enter the details for the new application. Then select **Copy** to confirm that you want to continue. To learn more about the fields in the form, see [Create an application](howto-create-iot-central-application.md).
81
81
82
-
:::image type="content" source="media/howto-create-iot-central-application/app-copy-1.png" alt-text="Screenshot of that shows application management page.":::
82
+
:::image type="content" source="media/howto-create-iot-central-application/app-copy.png" alt-text="Screenshot that shows the copy application settings page." lightbox="media/howto-create-iot-central-application/app-copy.png":::
83
83
84
-
:::image type="content" source="media/howto-create-iot-central-application/app-copy-2.png" alt-text="Screenshot that shows the Copy Application settings page.":::
84
+
After the applicationcopy operation succeeds, you can navigate to the new application using the link.
85
85
86
-
After the app copy operation succeeds, you can navigate to the new application using the link.
87
-
88
-
Copying an application also copies the definition of rules and email action. Some actions, such as Flow and Logic Apps, are tied to specific rules via the Rule ID. When a rule is copied to a different application, it gets its own Rule ID. In this case, users will have to create a new action and then associate the new rule with it. In general, it's a good idea to check the rules and actions to make sure they're up-to-date in the new app.
86
+
Copying an application also copies the definition of rules and email action. Some actions, such as Flow and Logic Apps, are tied to specific rules by the rule ID. When a rule is copied to a different application, it gets its own rule ID. In this case, users must create a new action and then associate the new rule with it. In general, it's a good idea to check the rules and actions to make sure they're up-to-date in the new application.
89
87
90
88
> [!WARNING]
91
89
> If a dashboard includes tiles that display information about specific devices, then those tiles show **The requested resource was not found** in the new application. You must reconfigure these tiles to display information about devices in your new application.
92
90
93
91
## Create and use a custom application template
94
92
95
-
When you create an Azure IoT Central application, you have a choice of built-in sample templates. You can also create your own application templates from existing IoT Central applications. You can then use your own application templates when you create new applications.
93
+
When you create an Azure IoT Central application, you choose from the built-in sample templates. You can also create your own application templates from existing IoT Central applications. You can then use your own application templates when you create new applications.
96
94
97
95
When you create an application template, it includes the following items from your existing application:
98
96
@@ -119,8 +117,7 @@ To create an application template from an existing IoT Central application:
119
117
1. On the **Template Export** page, enter a name and description for your template.
120
118
1. Select the **Export** button to create the application template. You can now copy the **Shareable Link** that enables someone to create a new application from the template:
121
119
122
-
123
-
:::image type="content" source="media/howto-create-iot-central-application/create-template-2.png" alt-text="Screenshot that shows export an application template.":::
120
+
:::image type="content" source="media/howto-create-iot-central-application/create-template.png" alt-text="Screenshot that shows export an application template." lightbox="media/howto-create-iot-central-application/create-template.png":::
Copy file name to clipboardExpand all lines: articles/iot-central/core/howto-set-up-template.md
+22-22Lines changed: 22 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ title: Define a new IoT device type in Azure IoT Central | Microsoft Docs
3
3
description: This article shows you how to create a new Azure IoT device template in your Azure IoT Central application. You define the telemetry, state, properties and commands for your type.
4
4
author: dominicbetts
5
5
ms.author: dobett
6
-
ms.date: 06/22/2022
6
+
ms.date: 10/31/2022
7
7
ms.topic: how-to
8
8
ms.service: iot-central
9
9
services: iot-central
@@ -20,12 +20,12 @@ This article describes how to create a device template in IoT Central. For examp
20
20
21
21
The following screenshot shows an example of a device template:
22
22
23
-
:::image type="content" source="media/howto-set-up-template/device-template.png" alt-text="Screenshot that shows a device template.":::
23
+
:::image type="content" source="media/howto-set-up-template/device-template.png" alt-text="Screenshot that shows a device template." lightbox="media/howto-set-up-template/device-template.png":::
24
24
25
25
The device template has the following sections:
26
26
27
27
- Model - Use the model to define how your device interacts with your IoT Central application. Each model has a unique model ID and defines the capabilities of the device. Capabilities are grouped into interfaces. Interfaces let you reuse components across models or use inheritance to extend the set of capabilities.
28
-
-Cloud properties - Use cloud properties to define information that your IoT Central application stores about your devices. For example, a cloud property might record the date a device was last serviced.
28
+
-Raw data - View the raw data sent by your designated preview device. This view is useful when you're debugging or troubleshooting a device template.
29
29
- Views - Use views to visualize the data from the device and forms to manage and control a device.
30
30
31
31
To learn more, see [What are device templates?](concepts-device-templates.md).
@@ -54,7 +54,7 @@ This section shows you how to import a device template from the catalog and how
54
54
1. On the **Review** page, select **Create**.
55
55
The name of the template you created is **Sensor Controller**. The model includes components such as **Sensor Controller**, **SensorTemp**, and **Device Information interface**. Components define the capabilities of an ESP32 device. Capabilities include the telemetry, properties and commands.
56
56
57
-
:::image type="content" source="media/howto-set-up-template/device-template.png" alt-text="Screenshot that shows a Sensor controller device template.":::
57
+
:::image type="content" source="media/howto-set-up-template/device-template.png" alt-text="Screenshot that shows a Sensor controller device template." lightbox="media/howto-set-up-template/device-template.png":::
58
58
59
59
## Autogenerate a device template
60
60
@@ -67,15 +67,15 @@ The following steps show how to use this feature:
67
67
68
68
1. Connect your device to IoT Central, and start sending the data. When you see the data in the **Raw data** view, select **Auto-create template** in the **Manage template** drop-down:
69
69
70
-
:::image type="content" source="media/howto-set-up-template/infer-model-1.png" alt-text="Screenshot that shows raw data from unassigned device.":::
70
+
:::image type="content" source="media/howto-set-up-template/infer-model-1.png" alt-text="Screenshot that shows raw data from unassigned device." lightbox="media/howto-set-up-template/infer-model-1.png":::
71
71
72
72
1. On the **Data preview** page, make any required changes to the raw data, and select **Create template**:
73
73
74
-
:::image type="content" source="media/howto-set-up-template/infer-model-2.png" alt-text="Screenshot that shows data preview change that lets you edit data that IoT Central uses to generate the device template.":::
74
+
:::image type="content" source="media/howto-set-up-template/infer-model-2.png" alt-text="Screenshot that shows data preview change that lets you edit data that IoT Central uses to generate the device template." lightbox="media/howto-set-up-template/infer-model-2.png":::
75
75
76
76
1. IoT Central generates a template based on the data format shown on the **Data preview** page and assigns the device to it. You can make further changes to the device template, such as renaming it or adding capabilities, on the **Device templates** page:
77
77
78
-
:::image type="content" source="media/howto-set-up-template/infer-model-3.png" alt-text="Screenshot that shows how to rename the autogenerated device template.":::
78
+
:::image type="content" source="media/howto-set-up-template/infer-model-3.png" alt-text="Screenshot that shows how to rename the autogenerated device template." lightbox="media/howto-set-up-template/infer-model-3.png":::
79
79
80
80
## Manage a device template
81
81
@@ -109,11 +109,11 @@ To view and manage the interfaces in your device model:
109
109
110
110
1. Go to **Device Templates** page and select the device template you created. The interfaces are listed in the **Models** section of the device template. The following screenshot shows an example of the **Sensor Controller** root interface in a device template:
111
111
112
-
:::image type="content" source="media/howto-set-up-template/device-template.png" alt-text="Screenshot that shows root interface for a model":::
112
+
:::image type="content" source="media/howto-set-up-template/device-template.png" alt-text="Screenshot that shows root interface for a model":::
113
113
114
114
1. Select the ellipsis to add an inherited interface or component to the root interface. To learn more about interfaces and component see [multiple components](../../iot-pnp/concepts-modeling-guide.md#multiple-components) in the modeling guide.
115
115
116
-
:::image type="content" source="media/howto-set-up-template/add-interface.png" alt-text="How to add interface or component":::
116
+
:::image type="content" source="media/howto-set-up-template/add-interface.png" alt-text="Screenshot that shows how to add interface or component." lightbox="media/howto-set-up-template/add-interface.png":::
117
117
118
118
1. To export a model or interface select **Export**.
119
119
@@ -123,13 +123,13 @@ To view and manage the interfaces in your device model:
123
123
124
124
Select **+ Add capability** to add capability to an interface or component. For example, you can add **Target Temperature** capability to a **SensorTemp** component.
125
125
126
-
:::image type="content" source="media/howto-set-up-template/add-capability.png" alt-text="How to add capability":::
126
+
:::image type="content" source="media/howto-set-up-template/add-capability.png" alt-text="Screenshot that shows how to add capability." lightbox="media/howto-set-up-template/add-capability.png":::
127
127
128
128
#### Telemetry
129
129
130
130
Telemetry is a stream of values sent from the device, typically from a sensor. For example, a sensor might report the ambient temperature as shown in the following screenshot:
131
131
132
-
:::image type="content" source="media/howto-set-up-template/telemetry.png" alt-text="How to add telemetry":::
132
+
:::image type="content" source="media/howto-set-up-template/telemetry.png" alt-text="Screenshot that shows how to add a telemetry type." lightbox="media/howto-set-up-template/telemetry.png":::
133
133
134
134
The following table shows the configuration settings for a telemetry capability:
135
135
@@ -149,10 +149,9 @@ The following table shows the configuration settings for a telemetry capability:
149
149
150
150
#### Properties
151
151
152
-
Properties represent point-in-time values. You can set writable properties from IoT Central.
153
-
For example, a device can use a writable property to let an operator set the target temperature as shown in the following screenshot:
152
+
Properties represent point-in-time values. You can set writable properties from IoT Central. For example, a device can use a writable property to let an operator set the target temperature as shown in the following screenshot:
154
153
155
-
:::image type="content" source="media/howto-set-up-template/property.png" alt-text="How to add property":::
154
+
:::image type="content" source="media/howto-set-up-template/property.png" alt-text="Screenshot that shows how to add property." lightbox="media/howto-set-up-template/property.png":::
156
155
157
156
The following table shows the configuration settings for a property capability:
158
157
@@ -179,7 +178,7 @@ The following table shows the configuration settings for a property capability:
179
178
180
179
You can call device commands from IoT Central. Commands optionally pass parameters to the device and receive a response from the device. For example, you can call a command to reboot a device in 10 seconds as shown in the following screenshot:
181
180
182
-
:::image type="content" source="media/howto-set-up-template/command.png" alt-text="How to add commands":::
181
+
:::image type="content" source="media/howto-set-up-template/command.png" alt-text="Screenshot that shows how to add commands" lightbox="media/howto-set-up-template/command.png":::
183
182
184
183
The following table shows the configuration settings for a command capability:
185
184
@@ -201,8 +200,6 @@ To learn more about how devices implement commands, see [Telemetry, property, an
201
200
202
201
You can choose queue commands if a device is currently offline by enabling the **Queue if offline** option for a command in the device template.
203
202
204
-
:::image type="content" source="media/howto-set-up-template/offline-commands.png" alt-text="How to add offline commands":::
205
-
206
203
This option uses IoT Hub cloud-to-device messages to send notifications to devices. To learn more, see the IoT Hub article [Send cloud-to-device messages](../../iot-hub/iot-hub-devguide-messages-c2d.md).
207
204
208
205
Cloud-to-device messages:
@@ -218,7 +215,10 @@ Cloud-to-device messages:
218
215
219
216
Use cloud properties to store information about devices in IoT Central. Cloud properties are never sent to a device. For example, you can use cloud properties to store the name of the customer who has installed the device, or the device's last service date.
220
217
221
-
:::image type="content" source="media/howto-set-up-template/cloud-properties.png" alt-text="How to add cloud properties":::
218
+
:::image type="content" source="media/howto-set-up-template/cloud-properties.png" alt-text="Screenshot that shows how to add cloud properties":::
219
+
220
+
> [!TIP]
221
+
> You can only add cloud properties to the **Root** component in the model.
222
222
223
223
The following table shows the configuration settings for a cloud property:
224
224
@@ -254,9 +254,9 @@ To add a view to a device template:
254
254
1. Enter a name for your view in **View name**.
255
255
1. Select **Start with a visual** under add tiles and choose the type of visual for your tile. Then either select **Add tile** or drag and drop the visual onto the canvas. To configure the tile, select the gear icon.
256
256
257
-
:::image type="content" source="media/howto-set-up-template/start-visual.png" alt-text="How to start with a visual":::
257
+
:::image type="content" source="media/howto-set-up-template/start-visual.png" alt-text="Screenshot that shows how to start with a visual." lightbox="media/howto-set-up-template/start-visual.png":::
:::image type="content" source="media/howto-set-up-template/tile.png" alt-text="Screenshot that shows how to configure a tile." lightbox="media/howto-set-up-template/tile.png" :::
260
260
261
261
To test your view, select **Configure preview device**. This feature lets you see the view as an operator sees it after it's published. Use this feature to validate that your views show the correct data. Choose from the following options:
262
262
@@ -272,11 +272,11 @@ Add forms to a device template to enable operators to manage a device by viewing
272
272
273
273
1. Change the form name to **Manage device**.
274
274
275
-
1. Select the **Customer Name**and **Last Service Date**cloud properties, and the **Target Temperature** property. Then select **Add section**.
275
+
1. Select the properties and cloud properties to add to the form. Then select **Add section**.
:::image type="content" source="media/howto-set-up-template/form.png" alt-text="Screenshot that shows how to configure a form." lightbox="media/howto-set-up-template/form.png":::
0 commit comments