Skip to content

Commit d2aff33

Browse files
Merge pull request #267968 from eshashah-msft/patch-2
Update device-update-plug-and-play.md
2 parents ea2a71e + 53a2d1c commit d2aff33

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

articles/iot-hub-device-update/device-update-plug-and-play.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Understand how Device Update for IoT Hub uses IoT Plug and Play
33
description: Device Update for IoT Hub uses to discover and manage devices that are over-the-air update capable.
44
author: eshashah-msft
55
ms.author: eshashah
6-
ms.date: 2/2/2023
6+
ms.date: 3/4/2024
77
ms.topic: concept-article
88
ms.service: iot-hub-device-update
99
---
@@ -23,11 +23,11 @@ Model ID is how smart devices advertise their capabilities to Azure IoT applicat
2323

2424
Device Update for IoT Hub requires the IoT Plug and Play smart device to announce a model ID as part of the device connection. [Learn how to announce a model ID](../iot/concepts-developer-guide-device.md#model-id-announcement).
2525

26-
Device Update has 2 PnP models defined that support DU features. The Device Update model, '**dtmi:azure:iot:deviceUpdateContractModel;2**', supports the core functionality and uses the device update core interface to send update actions and metadata to devices and receive update status from devices.
26+
Device Update has several PnP models defined that support DU features. The Device Update model, '**dtmi:azure:iot:deviceUpdateContractModel;3**', supports the core functionality and uses the device update core interface to send update actions and metadata to devices and receive update status from devices.
2727

28-
The other supported model is **dtmi:azure:iot:deviceUpdateModel;2** which extends **deviceUpdateContractModel;2** and also uses other PnP interfaces that send device properties and information and enable diagnostic features. Learn more about the [Device Update Models and Interfaces Versions] (https://github.com/Azure/iot-plugandplay-models/tree/main/dtmi/azure/iot).
28+
The other supported model is **dtmi:azure:iot:deviceUpdateModel;3** which extends **deviceUpdateContractModel;3** and also uses other PnP interfaces that send device properties and information and enable diagnostic features. Learn more about the [Device Update Models and Interfaces Versions] (https://github.com/Azure/iot-plugandplay-models/tree/main/dtmi/azure/iot).
2929

30-
The Device Update agent uses the **dtmi:azure:iot:deviceUpdateModel;2** which supports all the latest features in the [1.0.0 release](understand-device-update.md#flexible-features-for-updating-devices). This model supports the [V5 manifest version](import-concepts.md).
30+
The Device Update agent uses the **dtmi:azure:iot:deviceUpdateModel;3** which supports all the latest features in the [1.1.0 release](https://github.com/Azure/iot-hub-device-update/releases/). This model supports the [V5 manifest version](import-concepts.md).Older manifests will work with the latest agents but new features require the use of the latest manifest version.
3131

3232
### Agent metadata
3333

@@ -54,7 +54,7 @@ The **deviceProperties** field contains the manufacturer and model information f
5454
|----|------|---------|-----------|
5555
|manufacturer|string|device to cloud|The device manufacturer of the device, reported through `deviceProperties`. This property is read from one of two places - first, the DeviceUpdateCore interface attempts to read the 'aduc_manufacturer' value from the [Configuration file](device-update-configuration-file.md). If the value isn't populated in the configuration file, it defaults to reporting the compile-time definition for ADUC_DEVICEPROPERTIES_MANUFACTURER. This property is reported only at boot time. <br><br> Default value: 'Contoso'.|
5656
|model|string|device to cloud|The device model of the device, reported through `deviceProperties`. This property is read from one of two places - first, the DeviceUpdateCore interface attempts to read the 'aduc_model' value from the [Configuration file](device-update-configuration-file.md). If the value isn't populated in the configuration file, it defaults to reporting the compile-time definition for ADUC_DEVICEPROPERTIES_MODEL. This property is reported only at boot time. <br><br> Default value: 'Video'|
57-
|contractModelId|string|device to cloud|This property is used by the service to identify the base model version being used by the Device Update agent to manage and communicate with the agent.<br>Value: 'dtmi:azure:iot:deviceUpdateContractModel;2' for devices using DU agent version 1.0.0. <br>**Note:** Agents using the 'dtmi:azure:iot:deviceUpdateModel;2' must report the contractModelId as 'dtmi:azure:iot:deviceUpdateContractModel;2' as deviceUpdateModel;2 is extended from deviceUpdateModel;2|
57+
|contractModelId|string|device to cloud|This property is used by the service to identify the base model version being used by the Device Update agent to manage and communicate with the agent.<br>Value: 'dtmi:azure:iot:deviceUpdateContractModel;3' for devices using DU agent version 1.1.0. <br>**Note:** Agents using the 'dtmi:azure:iot:deviceUpdateModel;2' must report the contractModelId as 'dtmi:azure:iot:deviceUpdateContractModel;3' as deviceUpdateModel;3 is extended from deviceUpdateContractModel;3|
5858
|aduVer|string|device to cloud|Version of the Device Update agent running on the device. This value is read from the build only if ENABLE_ADU_TELEMETRY_REPORTING is set to 1 (true) during compile time. Customers can choose to opt out of version reporting by setting the value to 0 (false). [How to customize Device Update agent properties](https://github.com/Azure/iot-hub-device-update/blob/main/docs/agent-reference/how-to-build-agent-code.md).|
5959
|doVer|string|device to cloud|Version of the Delivery Optimization agent running on the device. The value is read from the build only if ENABLE_ADU_TELEMETRY_REPORTING is set to 1 (true) during compile time. Customers can choose to opt out of the version reporting by setting the value to 0 (false). [How to customize Delivery Optimization agent properties](https://github.com/microsoft/do-client/blob/main/README.md#building-do-client-components).|
6060
|Custom compatibility Properties|User Defined|device to cloud|Implementer can define other device properties to be used for the compatibility check while targeting the update deployment.|
@@ -68,10 +68,9 @@ IoT Hub device twin example:
6868
"deviceProperties": {
6969
"manufacturer": "contoso",
7070
"model": "virtual-vacuum-v1",
71-
"contractModelId": "dtmi:azure:iot:deviceUpdateContractModel;2",
72-
"aduVer": "DU;agent/0.8.0-rc1-public-preview",
73-
"doVer": "DU;lib/v0.6.0+20211001.174458.c8c4051,DU;agent/v0.6.0+20211001.174418.c8c4051"
74-
},
71+
"contractModelId": "dtmi:azure:iot:deviceUpdateContractModel;3",
72+
"aduVer": "DU;agent/1.1.0",
73+
},
7574
"compatPropertyNames": "manufacturer,model",
7675
"lastInstallResult": {
7776
"resultCode": 700,

0 commit comments

Comments
 (0)