Skip to content

Commit 20f9609

Browse files
authored
Merge pull request #229963 from eshashah-msft/master
Tutorial Improvements
2 parents eb6f78f + 593942c commit 20f9609

File tree

3 files changed

+137
-134
lines changed

3 files changed

+137
-134
lines changed

articles/iot-hub-device-update/device-update-agent-provisioning.md

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ Follow these instructions to provision the Device Update agent on [IoT Edge enab
8989

9090
1. Install the Device Update image update agent.
9191

92-
We provide sample images in the [Assets here](https://github.com/Azure/iot-hub-device-update/releases) repository. The swUpdate file is the base image that you can flash onto a Raspberry Pi B3+ board. The .gz file is the update you would import through Device Update for IoT Hub. For an example, see [How to flash the image to your IoT Hub device](./device-update-raspberry-pi.md#flash-an-sd-card-with-the-image).
92+
We provide sample images in the [Assets here](https://github.com/Azure/iot-hub-device-update/releases) repository. The swUpdate file is the base image that you can flash onto a Raspberry Pi B3+ board. The .gz file is the update you would import through Device Update for IoT Hub. For an example, see [How to flash the image to your IoT Hub device](./device-update-raspberry-pi.md).
9393

9494
1. Install the Device Update package update agent.
9595

@@ -119,7 +119,7 @@ Follow these instructions to provision the Device Update agent on [IoT Edge enab
119119
```shell
120120
sudo nano /etc/adu/du-config.json
121121
```
122-
Change the connectionType to "AIS" for agents who will be using the IoT Identity Service for provisioning. The ConnectionData field must be a empty string. Please note that all values with the 'Place value here' tag must be set. See [Configuring a DU agent](./device-update-configuration-file.md#example-du-configjson-file-contents).
122+
Change the connectionType to "AIS" for agents who will be using the IoT Identity Service for provisioning. The ConnectionData field must be an empty string. Please note that all values with the 'Place value here' tag must be set. See [Configuring a DU agent](./device-update-configuration-file.md#example-du-configjson-file-contents).
123123
124124
5. You are now ready to start the Device Update agent on your IoT device.
125125
@@ -131,22 +131,22 @@ Follow these instructions to provision the Device Update agent on your IoT Linux
131131
132132
2. Configure the IoT Identity Service by following the instructions in [Configuring the Azure IoT Identity Service](https://azure.github.io/iot-identity-service/configuration.html).
133133
134-
3. Finally install the Device Update agent. We provide sample images in [Assets here](https://github.com/Azure/iot-hub-device-update/releases), the swUpdate file is the base image that you can flash onto a Raspberry Pi B3+ board, and the .gz file is the update you would import through Device Update for IoT Hub. See example of [how to flash the image to your IoT Hub device](./device-update-raspberry-pi.md#flash-an-sd-card-with-the-image).
134+
3. Finally install the Device Update agent. We provide sample images in [Assets here](https://github.com/Azure/iot-hub-device-update/releases), the swUpdate file is the base image that you can flash onto a Raspberry Pi B3+ board, and the .gz file is the update you would import through Device Update for IoT Hub. See example of [how to flash the image to your IoT Hub device](./device-update-raspberry-pi.md).
135135
136136
4. After you've installed the device update agent, you will need to edit the configuration file for Device Update by running the command below.
137137

138138
```shell
139139
sudo nano /etc/adu/du-config.json
140140
```
141-
Change the connectionType to "AIS" for agents who will be using the IoT Identity Service for provisioning. The ConnectionData field must be a empty string. Please note that all values with the 'Place value here' tag must be set. See [Configuring a DU agent](./device-update-configuration-file.md#example-du-configjson-file-contents).
141+
Change the connectionType to "AIS" for agents who will be using the IoT Identity Service for provisioning. The ConnectionData field must be an empty string. Please note that all values with the 'Place value here' tag must be set. See [Configuring a DU agent](./device-update-configuration-file.md#example-du-configjson-file-contents).
142142

143143
5. You are now ready to start the Device Update agent on your IoT device.
144144

145145
### Other IoT devices
146146

147147
The Device Update agent can also be configured without the IoT Identity service for testing or on constrained devices. Follow the below steps to provision the Device Update agent using a connection string (from the Module or Device).
148148

149-
1. We provide sample images in the [Assets here](https://github.com/Azure/iot-hub-device-update/releases) repository. The swUpdate file is the base image that you can flash onto a Raspberry Pi B3+ board. The .gz file is the update you would import through Device Update for IoT Hub. For an example, see [How to flash the image to your IoT Hub device](./device-update-raspberry-pi.md#flash-an-sd-card-with-the-image).
149+
1. We provide sample images in the [Assets here](https://github.com/Azure/iot-hub-device-update/releases) repository. The swUpdate file is the base image that you can flash onto a Raspberry Pi B3+ board. The .gz file is the update you would import through Device Update for IoT Hub. For an example, see [How to flash the image to your IoT Hub device](./device-update-raspberry-pi.md).
150150

151151
1. Log onto the machine or IoT Edge device/IoT device.
152152

@@ -172,7 +172,7 @@ The Device Update agent can also be configured without the IoT Identity service
172172
173173
This section describes how to start and verify the Device Update agent as a module identity running successfully on your IoT device.
174174
175-
1. Log into the machine or device that has the Device Update agent installed.
175+
1. Log in to the machine or device that has the Device Update agent installed.
176176
177177
1. Open a Terminal window, and enter the command below.
178178
@@ -195,18 +195,12 @@ This section describes how to start and verify the Device Update agent as a modu
195195
196196
## How to build and run Device Update Agent
197197
198-
You can also build and modify your own customer Device Update agent.
199-
200-
Follow the instructions to [build](https://github.com/Azure/iot-hub-device-update/blob/main/docs/agent-reference/how-to-build-agent-code.md) the Device Update Agent
201-
from source.
198+
You can also build and modify your own customer Device Update agent. Follow the instructions to [build](https://github.com/Azure/iot-hub-device-update/blob/main/docs/agent-reference/how-to-build-agent-code.md) the Device Update Agent from source.
202199
203200
Once the agent is successfully building, it's time to [run](https://github.com/Azure/iot-hub-device-update/blob/main/docs/agent-reference/how-to-run-agent.md)
204-
the agent.
205-
206-
Now, make the changes needed to incorporate the agent into your image. Look at how to
201+
the agent. Now, make the changes needed to incorporate the agent into your image. Look at how to
207202
[modify](https://github.com/Azure/iot-hub-device-update/blob/main/docs/agent-reference/how-to-modify-the-agent-code.md) the Device Update Agent for guidance.
208203

209-
210204
## Troubleshooting guide
211205

212206
If you run into issues, review the Device Update for IoT Hub [Troubleshooting Guide](troubleshoot-device-update.md) to help unblock any possible issues and collect necessary information to provide to Microsoft.
@@ -216,7 +210,7 @@ If you run into issues, review the Device Update for IoT Hub [Troubleshooting Gu
216210

217211
You can use the following tutorials for a simple demonstration of Device Update for IoT Hub:
218212

219-
- [Image Update: Getting Started with Raspberry Pi 3 B+ Reference Yocto Image](device-update-raspberry-pi.md) extensible via open source to build you own images for other architecture as needed.
213+
- [Image Update: Getting Started with Raspberry Pi 3 B+ Reference Yocto Image](device-update-raspberry-pi.md) extensible via open source to build your own images for other architecture as needed.
220214

221215
- [Package Update: Getting Started using Ubuntu Server 18.04 x64 Package agent](device-update-ubuntu-agent.md)
222216

0 commit comments

Comments
 (0)