Skip to content

Commit 52942d3

Browse files
Merge pull request #232178 from dominicbetts/central-cloud-properties
IoT Central: update description of cloud properties
2 parents cfe77e0 + 53190d1 commit 52942d3

File tree

4 files changed

+34
-18
lines changed

4 files changed

+34
-18
lines changed

articles/iot-central/core/concepts-device-templates.md

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,7 @@ A device template includes the following sections:
2323
- _Root component_. Every device model has a root component. The root component's interface describes capabilities that are specific to the device model.
2424
- _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.
2525
- _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.
2827

2928
## Assign a device to a device template
3029

@@ -326,6 +325,30 @@ Don't use properties to send telemetry from your device. For example, a readonly
326325

327326
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.
328327

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+
329352
## Telemetry
330353

331354
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
347370
> [!NOTE]
348371
> Offline commands are marked as `durable` if you export the model as DTDL.
349372
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-
356373
## Views
357374

358375
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:
359376

360377
- Charts to plot telemetry.
361378
- Tiles to display read-only device properties.
362379
- 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.
364381
- Tiles to let the operator call commands, including commands that expect a payload.
365382
- Tiles to display labels, images, or markdown text.
366383

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-
369384
## Next steps
370385

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

articles/iot-central/core/howto-manage-device-templates-with-rest-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ To learn how to manage device templates by using the IoT Central UI, see [How to
2424

2525
## Device templates
2626

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 model and view definitions. The REST API lets you manage the device model including cloud property definitions. Use the UI to create and manage views.
2828

2929
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).
3030

articles/iot-central/government/tutorial-connected-waste-management.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -137,8 +137,9 @@ Try to customize the following features:
137137

138138
Here's how:
139139

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.
142143
1. Select **Save**.
143144

144145
### Views

articles/iot-central/retail/tutorial-in-store-analytics-create-app.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -144,17 +144,17 @@ In this section, you add a device template for RuuviTag sensors to your applicat
144144

145145
You can customize the device templates in your application in three ways:
146146

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

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

151-
* Customize your device templates by adding cloud properties.
151+
* Customize your device templates by adding cloud properties.
152152

153153
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:
154154
* A calculated value
155155
* Metadata, such as a location that you want to associate with a set of devices
156156

157-
* Customize device templates by building custom views.
157+
* Customize device templates by building custom views.
158158

159159
Views provide a way for operators to visualize telemetry and metadata for your devices, such as device metrics and health.
160160

0 commit comments

Comments
 (0)