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/concepts-device-templates.md
+26-11Lines changed: 26 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,8 +23,7 @@ A device template includes the following sections:
23
23
-_Root component_. Every device model has a root component. The root component's interface describes capabilities that are specific to the device model.
24
24
-_Components_. A device model may include components in addition to the root component to describe device capabilities. Each component has an interface that describes the component's capabilities. Component interfaces may be reused in other device models. For example, several phone device models could use the same camera interface.
25
25
-_Inherited interfaces_. A device model contains one or more interfaces that extend the capabilities of the root component.
26
-
-_Cloud properties_. This part of the device template lets the solution developer specify any device metadata to store. Cloud properties are never synchronized with devices and only exist in the application. Cloud properties don't affect the code that a device developer writes to implement the device model.
27
-
-_Views_. This part of the device template lets the solution developer define visualizations to view data from the device, and forms to manage and control a device. The views use the device model, cloud properties, and customizations. Views don't affect the code that a device developer writes to implement the device model.
26
+
-_Views_. This part of the device template lets the solution developer define visualizations to view data from the device, and forms to manage and control a device. Views don't affect the code that a device developer writes to implement the device model.
28
27
29
28
## Assign a device to a device template
30
29
@@ -326,6 +325,30 @@ Don't use properties to send telemetry from your device. For example, a readonly
326
325
327
326
For writable properties, the device application returns a desired state status code, version, and description to indicate whether it received and applied the property value.
328
327
328
+
### Cloud properties
329
+
330
+
You can also add cloud properties to the root component of the model. Cloud properties let you specify any device metadata to store in the IoT Central application. Cloud property values are stored in the IoT Central application and are never synchronized with a device. Cloud properties don't affect the code that a device developer writes to implement the device model.
331
+
332
+
A solution developer can add cloud properties to device views and forms alongside device properties to enable an operator to manage the devices connected to the application. A solution developer can also use cloud properties as part of a rule definition to make a threshold value editable by an operator.
333
+
334
+
The following DTDL snippet shows an example cloud property definition:
335
+
336
+
```json
337
+
{
338
+
"@id": "dtmi:azureiot:Thermostat:CustomerName",
339
+
"@type": [
340
+
"Property",
341
+
"Cloud",
342
+
"StringValue"
343
+
],
344
+
"displayName": {
345
+
"en": "Customer Name"
346
+
},
347
+
"name": "CustomerName",
348
+
"schema": "string"
349
+
}
350
+
```
351
+
329
352
## Telemetry
330
353
331
354
IoT Central lets you view telemetry in device views and charts, and use rules to trigger actions when thresholds are reached. IoT Central uses the information in the device model, such as data types, units and display names, to determine how to display telemetry values. You can also display telemetry values on application and personal dashboards.
@@ -347,25 +370,17 @@ Offline commands are one-way notifications to the device from your solution. Off
347
370
> [!NOTE]
348
371
> Offline commands are marked as `durable` if you export the model as DTDL.
349
372
350
-
## Cloud properties
351
-
352
-
Cloud properties are part of the device template, but aren't part of the device model. Cloud properties let the solution developer specify any device metadata to store in the IoT Central application. Cloud properties don't affect the code that a device developer writes to implement the device model.
353
-
354
-
A solution developer can add cloud properties to device views and forms alongside device properties to enable an operator to manage the devices connected to the application. A solution developer can also use cloud properties as part of a rule definition to make a threshold value editable by an operator.
355
-
356
373
## Views
357
374
358
375
A solution developer creates views that let operators monitor and manage connected devices. Views are part of the device template, so a view is associated with a specific device type. A view can include:
359
376
360
377
- Charts to plot telemetry.
361
378
- Tiles to display read-only device properties.
362
379
- Tiles to let the operator edit writable device properties.
363
-
- Tiles to let the operator edit cloud properties.
380
+
- Tiles to let the operator edit cloud properties.
364
381
- Tiles to let the operator call commands, including commands that expect a payload.
365
382
- Tiles to display labels, images, or markdown text.
366
383
367
-
The telemetry, properties, and commands that you can add to a view are determined by the device model, cloud properties, and customizations in the device template.
368
-
369
384
## Next steps
370
385
371
386
Now that you've learned about device templates, a suggested next steps is to read [Telemetry, property, and command payloads](./concepts-telemetry-properties-commands.md) to learn more about the data a device exchanges with IoT Central.
Copy file name to clipboardExpand all lines: articles/iot-central/core/howto-manage-device-templates-with-rest-api.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,7 @@ To learn how to manage device templates by using the IoT Central UI, see [How to
24
24
25
25
## Device templates
26
26
27
-
A device template contains a device model, cloud property definitions, and view definitions. The REST API lets you manage the device model and cloud property definitions. Use the UI to create and manage views.
27
+
A device template contains a device modeland view definitions. The REST API lets you manage the device model including cloud property definitions. Use the UI to create and manage views.
28
28
29
29
The device model section of a device template specifies the capabilities of a device you want to connect to your application. Capabilities include telemetry, properties, and commands. The model is defined using [DTDL V2](https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/DTDL.v2.md).
Copy file name to clipboardExpand all lines: articles/iot-central/government/tutorial-connected-waste-management.md
+3-2Lines changed: 3 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -137,8 +137,9 @@ Try to customize the following features:
137
137
138
138
Here's how:
139
139
140
-
1. From the device template menu, select **Cloud property**.
141
-
1. Select **+ Add Cloud Property**. In Azure IoT Central, you can add a property that is relevant to the device but isn't expected to be sent by a device. For example, a cloud property might be an alerting threshold specific to installation area, asset information, or maintenance information.
140
+
1. Navigate to the **Connected Waste Bin** device template, and select **+ Add capability**.
141
+
1. Add a new cloud property by selecting **Cloud Property** as **Capability type**.
142
+
In Azure IoT Central, you can add a property that is relevant to the device but isn't expected to be sent by a device. For example, a cloud property might be an alerting threshold specific to installation area, asset information, or maintenance information.
Copy file name to clipboardExpand all lines: articles/iot-central/retail/tutorial-in-store-analytics-create-app.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -144,17 +144,17 @@ In this section, you add a device template for RuuviTag sensors to your applicat
144
144
145
145
You can customize the device templates in your application in three ways:
146
146
147
-
* Customize the native built-in interfaces in your devices by changing the device capabilities.
147
+
* Customize the native built-in interfaces in your devices by changing the device capabilities.
148
148
149
-
For example, with a temperature sensor, you can change details such as the display name of the temperature interface, the data type, the units of measurement, and the minimum and maximum operating ranges.
149
+
For example, with a temperature sensor, you can change details such as the display name of the temperature interface, the data type, the units of measurement, and the minimum and maximum operating ranges.
150
150
151
-
* Customize your device templates by adding cloud properties.
151
+
* Customize your device templates by adding cloud properties.
152
152
153
153
Cloud properties aren't part of the built-in device capabilities. Cloud properties are custom data that your Azure IoT Central application creates, stores, and associates with your devices. Examples of cloud properties could be:
154
154
* A calculated value
155
155
* Metadata, such as a location that you want to associate with a set of devices
156
156
157
-
* Customize device templates by building custom views.
157
+
* Customize device templates by building custom views.
158
158
159
159
Views provide a way for operators to visualize telemetry and metadata for your devices, such as device metrics and health.
0 commit comments