Skip to content

Commit 2cf35a7

Browse files
committed
Howto screenshots pt1
1 parent 3242cad commit 2cf35a7

23 files changed

+29
-32
lines changed

articles/iot-central/core/howto-create-iot-central-application.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ services: iot-central
55
ms.service: iot-central
66
author: dominicbetts
77
ms.author: dobett
8-
ms.date: 06/20/2022
8+
ms.date: 10/28/2022
99
ms.topic: how-to
1010
---
1111

@@ -77,22 +77,20 @@ The **My apps** page lists all the IoT Central applications you have access to.
7777

7878
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.
7979

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).
8181

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":::
8383

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 application copy operation succeeds, you can navigate to the new application using the link.
8585

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.
8987

9088
> [!WARNING]
9189
> 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.
9290
9391
## Create and use a custom application template
9492

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.
9694

9795
When you create an application template, it includes the following items from your existing application:
9896

@@ -119,8 +117,7 @@ To create an application template from an existing IoT Central application:
119117
1. On the **Template Export** page, enter a name and description for your template.
120118
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:
121119

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":::
124121

125122
### Use an application template
126123

articles/iot-central/core/howto-set-up-template.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Define a new IoT device type in Azure IoT Central | Microsoft Docs
33
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.
44
author: dominicbetts
55
ms.author: dobett
6-
ms.date: 06/22/2022
6+
ms.date: 10/31/2022
77
ms.topic: how-to
88
ms.service: iot-central
99
services: iot-central
@@ -20,12 +20,12 @@ This article describes how to create a device template in IoT Central. For examp
2020

2121
The following screenshot shows an example of a device template:
2222

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":::
2424

2525
The device template has the following sections:
2626

2727
- 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.
2929
- Views - Use views to visualize the data from the device and forms to manage and control a device.
3030

3131
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
5454
1. On the **Review** page, select **Create**.
5555
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.
5656

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":::
5858

5959
## Autogenerate a device template
6060

@@ -67,15 +67,15 @@ The following steps show how to use this feature:
6767

6868
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:
6969

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":::
7171

7272
1. On the **Data preview** page, make any required changes to the raw data, and select **Create template**:
7373

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":::
7575

7676
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:
7777

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":::
7979

8080
## Manage a device template
8181

@@ -109,11 +109,11 @@ To view and manage the interfaces in your device model:
109109

110110
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:
111111

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":::
113113

114114
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.
115115

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":::
117117

118118
1. To export a model or interface select **Export**.
119119

@@ -123,13 +123,13 @@ To view and manage the interfaces in your device model:
123123

124124
Select **+ Add capability** to add capability to an interface or component. For example, you can add **Target Temperature** capability to a **SensorTemp** component.
125125

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":::
127127

128128
#### Telemetry
129129

130130
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:
131131

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":::
133133

134134
The following table shows the configuration settings for a telemetry capability:
135135

@@ -149,10 +149,9 @@ The following table shows the configuration settings for a telemetry capability:
149149

150150
#### Properties
151151

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:
154153

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":::
156155

157156
The following table shows the configuration settings for a property capability:
158157

@@ -179,7 +178,7 @@ The following table shows the configuration settings for a property capability:
179178

180179
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:
181180

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":::
183182

184183
The following table shows the configuration settings for a command capability:
185184

@@ -201,8 +200,6 @@ To learn more about how devices implement commands, see [Telemetry, property, an
201200

202201
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.
203202

204-
:::image type="content" source="media/howto-set-up-template/offline-commands.png" alt-text="How to add offline commands":::
205-
206203
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).
207204

208205
Cloud-to-device messages:
@@ -218,7 +215,10 @@ Cloud-to-device messages:
218215

219216
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.
220217

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.
222222
223223
The following table shows the configuration settings for a cloud property:
224224

@@ -254,9 +254,9 @@ To add a view to a device template:
254254
1. Enter a name for your view in **View name**.
255255
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.
256256

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":::
258258

259-
:::image type="content" source="media/howto-set-up-template/tile.png" alt-text="configure tile":::
259+
:::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" :::
260260

261261
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:
262262

@@ -272,11 +272,11 @@ Add forms to a device template to enable operators to manage a device by viewing
272272

273273
1. Change the form name to **Manage device**.
274274

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**.
276276

277277
1. Select **Save** to save your new form.
278278

279-
:::image type="content" source="media/howto-set-up-template/form.png" alt-text="configure form":::
279+
:::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":::
280280

281281
## Publish a device template
282282

67.5 KB
Loading
-29.1 KB
Loading
1.14 KB
Loading
50 KB
Loading
-114 KB
Loading

0 commit comments

Comments
 (0)