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-hub-device-update/device-update-raspberry-pi.md
+27-30Lines changed: 27 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ In this tutorial, you:
22
22
> - Assign a tag to your IoT device.
23
23
> - Import the image update.
24
24
> - Deploy the image update.
25
-
> -Monitor the update deployment.
25
+
> -View update deployment history.
26
26
27
27
## Prerequisites
28
28
@@ -51,15 +51,15 @@ Add your device to the device registry in your IoT hub and get the connection st
51
51
52
52
The *Tutorial_RaspberryPi3.zip* file has all the required files for the tutorial. Download the file from the **Assets** section of the latest release on the [GitHub Device Update Releases page](https://github.com/Azure/iot-hub-device-update/releases), and unzip it.
53
53
54
-
In the extracted *Tutorial_RaspberryPi3* folder, the *adu-base-image-raspberrypi3.wic* file is the base image that you can flash onto the Raspberry Pi board. The *adu-update-image-raspberrypi3-1.2.0.swu* SWUpdate file, *example-a-b-update.sh* custom SWUpdate script, and *EDS-ADUClient.yocto-update.1.2.0.importmanifest.json* manifest are the update files you import through Device Update.
54
+
In the extracted *Tutorial_RaspberryPi3* folder, the *adu-base-image-raspberrypi3.wic* file is the base image that you can flash onto the Raspberry Pi board. The base image uses a Yocto build based on the 3.4.4 release. The image has the Device Update agent and SWUpdate, which enables the Device Update dual partition update. For more information about the Yocto layers, see [Build a custom Linux-based system with Device Update agent using the Yocto Project](https://github.com/Azure/iot-hub-device-update-yocto).
55
55
56
-
The base image uses a Yocto build based on the 3.4.4 release. The image has the Device Update agent and SWUpdate, which enables the Device Update dual partition update. For more information about the Yocto layers, see [Build a custom Linux-based system with Device Update agent using the Yocto Project](https://github.com/Azure/iot-hub-device-update-yocto).
56
+
The *adu-update-image-raspberrypi3-1.2.0.swu* SWUpdate file, *example-a-b-update.sh* custom SWUpdate script, and *EDS-ADUClient.yocto-update.1.2.0.importmanifest.json* manifest are the update files you import through Device Update.
57
57
58
58
### Use bmaptool to flash the SD card
59
59
60
60
Use an OS flashing tool to install the Device Update base image on the SD card you use in the Raspberry Pi device. The following instructions use `bmaptool` to flash to the SD card. Replace the `<device>` placeholder with your device name and the `<path to image>` placeholder with the path to the downloaded image file.
61
61
62
-
1. Install the `bmaptool` utility if you don't have it.
62
+
1. Install the `bmap-tools` utility if you don't have it.
63
63
64
64
```shell
65
65
sudo apt-get install bmap-tools
@@ -87,7 +87,7 @@ Use an OS flashing tool to install the Device Update base image on the SD card y
87
87
>[!TIP]
88
88
>For faster flashing, you can download the bimap file and the image file and put them in the same directory.
89
89
90
-
## Configure the Device Update agent on Raspberry Pi
90
+
## Install the Device Update agent on Raspberry Pi
91
91
92
92
>[!IMPORTANT]
93
93
>Azure Device Update for IoT Hub software is subject to the following license terms:
@@ -105,7 +105,7 @@ Use an OS flashing tool to install the Device Update base image on the SD card y
105
105
ssh raspberrypi3 -l root
106
106
```
107
107
108
-
## Create the Device Update configuration files
108
+
###Create the Device Update configuration files
109
109
110
110
The Device Update *du-config.json* and *du-diagnostics-config.json* configuration files must be on the device. To create the files, run the following commands in the terminal signed in to the Raspberry Pi.
111
111
@@ -189,7 +189,7 @@ The Device Update *du-config.json* and *du-diagnostics-config.json* configuratio
189
189
190
190
Status should appear as alive and green.
191
191
192
-
## Connect the device in IoT Hub
192
+
## Connect to the device in IoT Hub and add a group tag
193
193
194
194
1. On the [Azure portal](https://portal.azure.com) IoT hub page for your Device Update instance, select **Device management** > **Devices** from the left navigation.
195
195
1. On the **Devices** page, select the link with your device name.
@@ -204,18 +204,17 @@ The Device Update *du-config.json* and *du-diagnostics-config.json* configuratio
204
204
205
205
Device Update uses groups to organize devices. Device Update automatically sorts devices into groups based on their assigned tags and compatibility properties. Each device can belong to only one group, but groups can have multiple subgroups to sort different device classes. For more information about tags and groups, see [Manage device groups](create-update-group.md).
206
206
207
-
1. In the device twin, delete any existing Device Update tag values by setting them to null, and then add the following new Device Update group tag:
207
+
1. In the device twin, delete any existing Device Update tag values by setting them to null, and then add the following new Device Update group tag. If you're using a Module Identity with the Device Update agent, add the tag in the **Module Identity Twin** instead of the device twin.
208
208
209
209
```json
210
210
"tags": {
211
211
"ADUGroup": "<CustomTagValue>"
212
212
},
213
213
```
214
-
The following screenshot shows where to add the tag.
214
+
The following screenshot shows where in the file to add the tag.
215
215
216
216
:::image type="content" source="media/import-update/device-twin-ppr.png" alt-text="Screenshot that shows twin with tag information.":::
217
217
218
-
If you're using a Module Identity with the Device Update agent, add the tag in the **Module Identity Twin** instead of the device twin.
219
218
220
219
1. Select **Save**.
221
220
@@ -230,7 +229,7 @@ Device Update uses groups to organize devices. Device Update automatically sorts
230
229
:::image type="content" source="media/import-update/storage-account-ppr.png" alt-text="Screenshot that shows Storage accounts and Containers.":::
231
230
232
231
> [!TIP]
233
-
> Using a new container each time you import an update avoids accidentally importing files from previous updates. If you don't use a new container, be sure to delete any files from the existing container.
232
+
> Using a new container each time you import an update prevents accidentally importing files from previous updates. If you don't use a new container, be sure to delete any files from the existing container.
234
233
235
234
1. On the container page, select **Upload**, drag and drop or browse to and select the update files you downloaded, and then select **Upload**. After they upload, the files appear on the container page.
236
235
@@ -246,48 +245,46 @@ The import process begins, and the screen switches to the **Updates** screen. Af
246
245
247
246
:::image type="content" source="media/import-update/update-ready-ppr.png" alt-text="Screenshot that shows job status.":::
248
247
249
-
### View device groups
250
-
251
-
On the **Groups and Deployments** tab at the top of the **Updates** page, view the list of groups and the update compliance chart. The update compliance chart shows the count of devices in various states of compliance: **On latest update**, **New updates available**, and **Updates in progress**. For more information, see [Device Update compliance](device-update-compliance.md).
252
-
253
-
:::image type="content" source="media/create-update-group/updated-view.png" alt-text="Screenshot that shows the update compliance view." lightbox="media/create-update-group/updated-view.png":::
248
+
## Deploy the update
254
249
255
-
You should see a device group that contains the device you set up in this tutorial, along with any available updates for the devices in the group. If there are devices that don't meet the device class requirements of the group, they appear in a corresponding invalid group.
250
+
You can use the group tag you applied to your device to deploy the update to the device group. Select the **Groups and Deployments** tab at the top of the **Updates** page and view the list of groups and the update compliance chart. The update compliance chart shows the count of devices in various states of compliance: **On latest update**, **New updates available**, and **Updates in progress**. For more information, see [Device Update compliance](device-update-compliance.md).
256
251
257
-
## Deploy the update
252
+
You should see the device group that contains the device you set up in this tutorial, along with the available updates for the devices in the group. If there are devices that don't meet the device class requirements of the group, they appear in a corresponding invalid group.
258
253
259
-
1. After the group is created, you should see a new update available for your device group with a link to the update under **Best update**. You might need to refresh.
254
+
:::image type="content" source="media/create-update-group/updated-view.png" alt-text="Screenshot that shows the update compliance view." lightbox="media/create-update-group/updated-view.png":::
260
255
261
-
1. Select the target group by selecting the group name. On the **Group details**page, you see the group details in the **Group basics** tab.
256
+
To deploy the best available update to the new user-defined group from this view, select **Deploy**next to the group.
262
257
263
-
:::image type="content" source="media/deploy-update/group-basics.png" alt-text="Screenshot that shows group details." lightbox="media/deploy-update/group-basics.png":::
258
+
To initiate the deployment:
264
259
265
-
1.To initiate the deployment, go to the **Current deployment**tab and select **Deploy** next to the desired update in the **Available updates** section. The best available update for a group is denoted with a **Best** highlight.
260
+
1.Select the **Current deployment** tab on the **Group details**page, and then select **Deploy** next to the desired update in the **Available updates** section. The best available update for the group is denoted with a **Best** highlight.
266
261
267
262
:::image type="content" source="media/deploy-update/select-update.png" alt-text="Screenshot that shows selecting an update." lightbox="media/deploy-update/select-update.png":::
268
263
269
-
1. Schedule your deployment to start immediately or in the future, and then select **Create**.
270
-
271
-
> [!TIP]
272
-
> By default, the **Start** date and time is 24 hours from your current time. Be sure to select a different date and time if you want the deployment to begin earlier.
264
+
1. On the **Create deployment** page, schedule your deployment to start immediately or in the future, and then select **Create**.
273
265
274
266
:::image type="content" source="media/deploy-update/create-deployment.png" alt-text="Screenshot that shows creating a deployment." lightbox="media/deploy-update/create-deployment.png":::
275
267
276
-
1. Under **Deployment details**, **Status** turns to **Active**, and the selected update in **Available updates** is marked with **(deploying)**.
268
+
> [!TIP]
269
+
> By default, the **Start** date and time is 24 hours from your current time. Be sure to select a different date and time if you want the deployment to begin sooner.
270
+
271
+
1. Under **Deployment details**, **Status** turns to **Active**. Under **Available updates**, the selected update is marked with **(deploying)**.
277
272
278
273
:::image type="content" source="media/deploy-update/deployment-active.png" alt-text="Screenshot that shows the deployment as Active." lightbox="media/deploy-update/deployment-active.png":::
279
274
280
-
1.View the compliance chart to see that the update is now in progress. After your device successfully updates, your compliance chart and deployment details update to reflect that status.
275
+
1.On the **Updates** page, view the compliance chart to see that the update is now in progress. After your device successfully updates, your compliance chart and deployment details update to reflect that status.
281
276
282
277
:::image type="content" source="media/deploy-update/update-succeeded.png" alt-text="Screenshot that shows the update succeeded." lightbox="media/deploy-update/update-succeeded.png":::
283
278
284
-
## Monitor the update deployment
279
+
## View update deployment history
280
+
281
+
To view deployment history:
285
282
286
283
1. Select the **Deployment history** tab at the top of the **Group details** page, and select the **details** link next to the deployment you created.
287
284
288
285
:::image type="content" source="media/deploy-update/deployments-history.png" alt-text="Screenshot that shows Deployment history." lightbox="media/deploy-update/deployments-history.png":::
289
286
290
-
1.Select **Refresh**On the **Deployment details** page to view the latest status details.
287
+
1. On the **Deployment details** page, select **Refresh** to view the latest status details.
291
288
292
289
:::image type="content" source="media/deploy-update/deployment-details.png" alt-text="Screenshot that shows deployment details." lightbox="media/deploy-update/deployment-details.png":::
Copy file name to clipboardExpand all lines: articles/iot-hub-device-update/device-update-simulator.md
+10-8Lines changed: 10 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
2
title: Azure Device Update for IoT Hub using a simulator agent
3
-
description: Get started with Device Update for Azure IoT Hub using the Ubuntu 18.04 x64 simulator agent.
3
+
description: Get started with Device Update for Azure IoT Hub using the Ubuntu simulator agent.
4
4
author: kgremban
5
5
ms.author: kgremban
6
6
ms.date: 11/25/2024
@@ -22,12 +22,12 @@ In this tutorial, you:
22
22
> - Download and install an image update.
23
23
> - Import the image update.
24
24
> - Deploy the image update.
25
-
> -Monitor the update deployment.
25
+
> -View update deployment history.
26
26
27
27
## Prerequisites
28
28
29
29
- An IoT device
30
-
- An Ubuntu 18.04 x64 physical or virtual machine
30
+
- An Ubuntu 18.04 or higher x64 physical or virtual machine
31
31
- A [Device Update account and instance configured with an IoT hub](create-device-update-account.md)
32
32
33
33
## Register and configure a device and module
@@ -38,7 +38,7 @@ Add the device to the device registry in your IoT hub. Every device that connect
38
38
1. In the navigation pane, select **Device management** > **Devices**.
39
39
1. On the **Devices** page, select **Add Device**.
40
40
1. Under **Device ID**, enter a name for the device. Ensure that **Autogenerate keys** checkbox is selected.
41
-
1. Select **Save**. The device appears in the list on the **Devices** page.
41
+
1. Select **Save**. The device appears in the list on the **Devices** page.
42
42
43
43
### Create a module identity
44
44
@@ -52,7 +52,7 @@ For this tutorial, you create a module identity for the Device Update agent that
52
52
1. Select **Save**. The new module identity appears on the device page under **Module Identities**.
53
53
1. Select the module name, and on the **Module Identity Details** page, select the **Copy** icon next to **Connection string (primary key)**. Save this *module connection string* to use when you configure the Device Update agent.
54
54
55
-
### Add a tag to your module twin
55
+
### Add a group tag to your module twin
56
56
57
57
You can assign a tag to any device that's managed by Device Update to assign the device to a Device Update group. The tag can be in the device twin or in the module twin as in this tutorial. Each device can be assigned to only one Device Update group.
58
58
@@ -224,17 +224,19 @@ On the **Groups and Deployments** tab, you should see the new update available f
224
224
225
225
1. Select the group name to view its details.
226
226
227
-
1. On the group details page, you should see that there's one new update available. Select **Deploy** to start the deployment.
227
+
1. On the **Group details** page, you should see that there's one new update available. Select **Deploy** to start the deployment.
228
228
229
229
:::image type="content" source="media/device-update-simulator/group-details.png" alt-text="Screenshot that shows starting a group update deployment." lightbox="media/deploy-update/select-update.png":::
230
230
231
231
1. The update you imported is listed as the best available update for this group. Select **Deploy**.
232
232
233
233
1. Schedule your deployment to start immediately, and then select **Create**.
234
234
235
-
On the group details page, navigate to the **Current updates** tab. Under **Deployment details**, **Status** turns to **Active**. After your device successfully updates, return to the **Updates** page. You should see that your compliance chart and deployment details updated to include the installed update.
235
+
1. Navigate to the **Current updates** tab. Under **Deployment details**, **Status** turns to **Active**.
236
236
237
-
## Monitor the update deployment
237
+
1. After your device successfully updates, return to the **Updates** page. You should see that your compliance chart and deployment details updated to include the installed update.
238
+
239
+
## View update deployment history
238
240
239
241
1. Return to the group details page and select the **Deployment history** tab.
0 commit comments