Skip to content

Commit 053a1dd

Browse files
Merge pull request #208689 from dominicbetts/central-model-export
IoT Central: Model export updates
2 parents 1173617 + 11ad763 commit 053a1dd

6 files changed

+8
-8
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ A DTDL model can be a _no-component_ or a _multi-component_ model:
4646
- Multi-component model. A more complex model that includes two or more components. These components include a single root component, and one or more nested components. For an example, see the [Temperature Controller](https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/samples/TemperatureController.json) model.
4747

4848
> [!TIP]
49-
> You can [export a device model](howto-set-up-template.md#interfaces-and-components) from an IoT Central device template as a DTDL v2 file.
49+
> You can [import and export a complete device model or individual interface](howto-set-up-template.md#interfaces-and-components) from an IoT Central device template as a DTDL v2 file.
5050
5151
To learn more about device models, see the [IoT Plug and Play modeling guide](../../iot-develop/concepts-modeling-guide.md)
5252

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,11 +66,11 @@ To lean more about the DPS payload, see the sample code used in the [Tutorial: C
6666

6767
## Device models
6868

69-
A device model defines how a device interacts with your IoT Central application. The device developer must make sure that the device implements the behaviors defined in the device model so that IoT Central can monitor and manage the device. A device model is made up of one or more _interfaces_, and each interface can define a collection of _telemetry_ types, _device properties_, and _commands_. A solution developer can import a JSON file that defines the device model into a device template, or use the web UI in IoT Central to create or edit a device model.
69+
A device model defines how a device interacts with your IoT Central application. The device developer must make sure that the device implements the behaviors defined in the device model so that IoT Central can monitor and manage the device. A device model is made up of one or more _interfaces_, and each interface can define a collection of _telemetry_ types, _device properties_, and _commands_. A solution developer can import a JSON file that defines a complete device model or individual interface into a device template, or use the web UI in IoT Central to create or edit a device model.
7070

7171
To learn more about editing a device model, see [Edit an existing device template](howto-edit-device-template.md)
7272

73-
A solution developer can also export a JSON file that contains the device model. A device developer can use this JSON document to understand how the device should communicate with the IoT Central application.
73+
A solution developer can also export a JSON file from the device template that contains a complete device model or individual interface. A device developer can use this JSON document to understand how the device should communicate with the IoT Central application.
7474

7575
The JSON file that defines the device model uses the [Digital Twin Definition Language (DTDL) V2](https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/dtdlv2.md). IoT Central expects the JSON file to contain the device model with the interfaces defined inline, rather than in separate files. To learn more, see [IoT Plug and Play modeling guide](../../iot-develop/concepts-modeling-guide.md).
7676

@@ -345,7 +345,7 @@ You can choose queue commands if a device is currently offline by enabling the *
345345
Offline commands are one-way notifications to the device from your solution. Offline commands can have request parameters but don't return a response.
346346

347347
> [!NOTE]
348-
> This option is only available in the IoT Central web UI. This setting isn't included if you export a model or interface from the device template.
348+
> Offline commands are marked as `durable` if you export the model as DTDL.
349349
350350
## Cloud properties
351351

articles/iot-central/core/concepts-telemetry-properties-commands.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1062,7 +1062,7 @@ When the device has finished processing the request, it should send a property t
10621062

10631063
In the IoT Central web UI, you can select the **Queue if offline** option for a command. Offline commands are one-way notifications to the device from your solution that are delivered as soon as a device connects. Offline commands can have a request parameter but don't return a response.
10641064

1065-
The **Queue if offline** setting isn't included if you export a model or interface from the device template. You can't tell by looking at an exported model or interface JSON that a command is an offline command.
1065+
Offline commands are marked as `durable` if you export the model as DTDL.
10661066

10671067
Offline commands use [IoT Hub cloud-to-device messages](../../iot-hub/iot-hub-devguide-messages-c2d.md) to send the command and payload to the device.
10681068

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
@@ -180,7 +180,7 @@ The request body has some required fields:
180180
* `capabilityModel` : Every device template has a capability model. A relationship is established between each module capability model and a device model. A capability model implements one or more module interfaces.
181181

182182
> [!TIP]
183-
> The device template JSON is not a standard DTDL document. The device template JSON includes IoT Central specific data such as cloud property definitions and display units. You can use the device template JSON format to import and export device templates in IoT Central by using the REST API and the CLI.
183+
> The device template JSON is not a standard DTDL document. The device template JSON includes IoT Central specific data such as cloud property definitions and display units. You can use the device template JSON format to import and export device templates in IoT Central by using the REST API, the CLI, and the UI.
184184
185185
There are some optional fields you can use to add more details to the capability model, such as display name and description.
186186

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ Cloud-to-device messages:
212212
- Require the device to implement a message handler to process the cloud-to-device message.
213213

214214
> [!NOTE]
215-
> This option is only available in the IoT Central web UI. This setting isn't included if you export a model or component from the device template.
215+
> Offline commands are marked as `durable` if you export the model as DTDL.
216216
217217
## Cloud properties
218218

articles/iot-central/core/howto-use-commands.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ The following snippet shows the JSON representation of the command in the device
9999
```
100100

101101
> [!TIP]
102-
> You can export a device model from the device template page.
102+
> You can export a device model or interface from the device template page.
103103
104104
You can relate this command definition to the screenshot of the UI using the following fields:
105105

0 commit comments

Comments
 (0)