Skip to content

Commit 6131d17

Browse files
ttorblettorble
authored
Merge pull request #246715 from alexbuckgit/alexbuckgit/docutune-autopr-20230729-210625-0658274-ignore-build
[BULK] DocuTune - Fix formatting issues (part 10)
2 parents 5b933cb + da07ef5 commit 6131d17

File tree

9 files changed

+311
-311
lines changed

9 files changed

+311
-311
lines changed

‎articles/iot-develop/quickstart-devkit-stm-b-u585i-iot-hub.md‎

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -158,39 +158,39 @@ You can use the **Termite** app to monitor communication and confirm that your d
158158

159159
```output
160160
Starting Azure thread
161-
162-
161+
162+
163163
Initializing WiFi
164-
SSID: ***********
165-
Password: ***********
164+
SSID: ***********
165+
Password: ***********
166166
SUCCESS: WiFi initialized
167-
167+
168168
Connecting WiFi
169-
FW: V2.1.11
170-
MAC address: ***********
171-
Connecting to SSID '***********'
172-
Attempt 1...
169+
FW: V2.1.11
170+
MAC address: ***********
171+
Connecting to SSID '***********'
172+
Attempt 1...
173173
SUCCESS: WiFi connected
174-
174+
175175
Initializing DHCP
176-
IP address: 192.168.0.67
177-
Mask: 255.255.255.0
178-
Gateway: 192.168.0.1
176+
IP address: 192.168.0.67
177+
Mask: 255.255.255.0
178+
Gateway: 192.168.0.1
179179
SUCCESS: DHCP initialized
180-
180+
181181
Initializing DNS client
182-
DNS address: 192.168.0.1
182+
DNS address: 192.168.0.1
183183
SUCCESS: DNS client initialized
184-
184+
185185
Initializing SNTP time sync
186-
SNTP server 0.pool.ntp.org
187-
SNTP time update: Feb 24, 2023 21:20:23.71 UTC
186+
SNTP server 0.pool.ntp.org
187+
SNTP time update: Feb 24, 2023 21:20:23.71 UTC
188188
SUCCESS: SNTP initialized
189-
189+
190190
Initializing Azure IoT Hub client
191-
Hub hostname: ***********.azure-devices.net
192-
Device id: mydevice
193-
Model id: dtmi:azurertos:devkit:gsg;2
191+
Hub hostname: ***********.azure-devices.net
192+
Device id: mydevice
193+
Model id: dtmi:azurertos:devkit:gsg;2
194194
SUCCESS: Connected to IoT Hub
195195
```
196196
> [!IMPORTANT]
@@ -201,7 +201,7 @@ Keep Termite open to monitor device output in the following steps.
201201
202202
## View device properties
203203
204-
You can use Azure IoT Explorer to view and manage the properties of your devices. In the following sections, you use the Plug and Play capabilities that are visible in IoT Explorer to manage and interact with the STM DevKit. These capabilities rely on the device model published for the STM DevKit in the public model repository. You configured IoT Explorer to search this repository for device models earlier in this quickstart. In many cases, you can perform the same action without using plug and play by selecting IoT Explorer menu options. However, using plug and play often provides an enhanced experience. IoT Explorer can read the device model specified by a plug and play device and present information specific to that device.
204+
You can use Azure IoT Explorer to view and manage the properties of your devices. In the following sections, you use the Plug and Play capabilities that are visible in IoT Explorer to manage and interact with the STM DevKit. These capabilities rely on the device model published for the STM DevKit in the public model repository. You configured IoT Explorer to search this repository for device models earlier in this quickstart. In many cases, you can perform the same action without using plug and play by selecting IoT Explorer menu options. However, using plug and play often provides an enhanced experience. IoT Explorer can read the device model specified by a plug and play device and present information specific to that device.
205205
206206
To access IoT Plug and Play components for the device in IoT Explorer:
207207
@@ -228,15 +228,15 @@ To access IoT Plug and Play components for the device in IoT Explorer:
228228
229229
To view device properties using Azure IoT Explorer:
230230
231-
1. Select the **Properties (read-only)** tab. There's a single read-only property to indicate whether the led is on or off.
231+
1. Select the **Properties (read-only)** tab. There's a single read-only property to indicate whether the led is on or off.
232232
1. Select the **Properties (writable)** tab. It displays the interval that telemetry is sent.
233233
1. Change the `telemetryInterval` to *5*, and then select **Update desired value**. Your device now uses this interval to send telemetry.
234234

235235
:::image type="content" source="media/quickstart-devkit-stm-b-u585i-iot-hub/iot-explorer-set-telemetry-interval.png" alt-text="Screenshot of setting telemetry interval on STM DevKit in IoT Explorer.":::
236236

237237
1. IoT Explorer responds with a notification. You can also observe the update in Termite.
238238
1. Set the telemetry interval back to 10.
239-
239+
240240
To use Azure CLI to view device properties:
241241

242242
1. Run the [az iot hub device-twin show](/cli/azure/iot/hub/device-twin#az-iot-hub-device-twin-show) command.
@@ -326,7 +326,7 @@ To use Azure CLI to call a method:
326326
{
327327
"payload": {},
328328
"status": 200
329-
}
329+
}
330330
```
331331
332332
1. Check your device to confirm the LED state.
@@ -352,7 +352,7 @@ For debugging the application, see [Debugging with Visual Studio Code](https://g
352352
353353
In this quickstart, you built a custom image that contains Azure RTOS sample code, and then flashed the image to the STM DevKit device. You connected the STM DevKit to Azure, and carried out tasks such as viewing telemetry and calling a method on the device.
354354
355-
As a next step, explore the following articles to learn more about using the IoT device SDKs, or Azure RTOS to connect devices to Azure IoT.
355+
As a next step, explore the following articles to learn more about using the IoT device SDKs, or Azure RTOS to connect devices to Azure IoT.
356356
357357
> [!div class="nextstepaction"]
358358
> [Connect a general simulated device to IoT Hub](quickstart-send-telemetry-iot-hub.md)

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

Lines changed: 45 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ If you are migrating from a device level agent to adding the agent as a Module i
2929
The following IoT device over the air update types are currently supported with Device Update:
3030

3131
* Linux devices (IoT Edge and Non-IoT Edge devices):
32-
* [Image A/B update](device-update-raspberry-pi.md)
32+
* [Image A/B update](device-update-raspberry-pi.md)
3333
* [Package update](device-update-ubuntu-agent.md)
3434
* [Proxy update for downstream devices](device-update-howto-proxy-updates.md)
3535

@@ -40,7 +40,7 @@ The following IoT device over the air update types are currently supported with
4040
* [Understand support for disconnected device update](connected-cache-disconnected-device-update.md)
4141

4242

43-
## Prerequisites
43+
## Prerequisites
4444

4545
If you're setting up the IoT device/IoT Edge device for [package based updates](./understand-device-update.md#support-for-a-wide-range-of-update-artifacts), add packages.microsoft.com to your machine’s repositories by following these steps:
4646

@@ -73,13 +73,13 @@ If you're setting up the IoT device/IoT Edge device for [package based updates](
7373
## How to provision the Device Update agent as a Module Identity
7474

7575
This section describes how to provision the Device Update agent as a module identity on
76-
* IoT Edge enabled devices, or
76+
* IoT Edge enabled devices, or
7777
* Non-Edge IoT devices, or
78-
* Other IoT devices.
78+
* Other IoT devices.
7979

8080
To check if you have IoT Edge enabled on your device, please refer to the [IoT Edge installation instructions](../iot-edge/how-to-provision-single-device-linux-symmetric.md?preserve-view=true&view=iotedge-2020-11).
81-
82-
Follow all or any of the below sections to add the Device update agent based on the type of IoT device you are managing.
81+
82+
Follow all or any of the below sections to add the Device update agent based on the type of IoT device you are managing.
8383

8484
### On IoT Edge enabled devices
8585

@@ -89,58 +89,59 @@ 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).
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

96-
- For latest agent versions from packages.microsoft.com: Update package lists on your device and install the Device Update agent package and its dependencies using:
96+
- For latest agent versions from packages.microsoft.com: Update package lists on your device and install the Device Update agent package and its dependencies using:
9797

9898
```shell
9999
sudo apt-get update
100100
```
101-
101+
102102
```shell
103103
sudo apt-get install deviceupdate-agent
104104
```
105-
105+
106106
- For any 'rc' i.e. release candidate agent versions from [Artifacts](https://github.com/Azure/iot-hub-device-update/releases) : Download the .deb file to the machine you want to install the Device Update agent on, then:
107-
107+
108108
```shell
109109
sudo apt-get install -y ./"<PATH TO FILE>"/"<.DEB FILE NAME>"
110110
```
111111
- If you are setting up a [MCC for a disconnected device scenario](connected-cache-disconnected-device-update.md), then install the Delivery Optimization APT plugin:
112112

113-
```shell
114-
sudo apt-get install deliveryoptimization-plugin-apt
115-
```
116-
117-
1. After you've installed the device update agent, you will need to edit the configuration file for Device Update by running the command below.
113+
```shell
114+
sudo apt-get install deliveryoptimization-plugin-apt
115+
```
116+
117+
1. After you've installed the device update agent, you will need to edit the configuration file for Device Update by running the command below.
118118
119119
```shell
120-
sudo nano /etc/adu/du-config.json
120+
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 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).
123-
124-
5. You are now ready to start the Device Update agent on your IoT device.
122+
123+
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).
124+
125+
1. You are now ready to start the Device Update agent on your IoT device.
125126
126127
### On Iot Linux devices without IoT Edge installed
127128
128129
Follow these instructions to provision the Device Update agent on your IoT Linux devices.
129130
130131
1. Install the IoT Identity Service and add the latest version to your IoT device by following instructions in [Installing the Azure IoT Identity Service](https://azure.github.io/iot-identity-service/installation.html#install-from-packagesmicrosoftcom).
131132
132-
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).
133-
133+
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).
134+
134135
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).
135136
136-
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.
137+
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.
137138

138139
```shell
139-
sudo nano /etc/adu/du-config.json
140+
sudo nano /etc/adu/du-config.json
140141
```
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).
142+
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).
142143

143-
5. You are now ready to start the Device Update agent on your IoT device.
144+
5. You are now ready to start the Device Update agent on your IoT device.
144145

145146
### Other IoT devices
146147

@@ -149,24 +150,24 @@ The Device Update agent can also be configured without the IoT Identity service
149150
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).
150151

151152
1. Log onto the machine or IoT Edge device/IoT device.
152-
153+
153154
1. Open a terminal window.
154155

155156
1. Add the connection string to the [Device Update configuration file](device-update-configuration-file.md):
156157

157158
1. Enter the below in the terminal window:
158-
159-
- [For Ubuntu agent](device-update-ubuntu-agent.md) use: sudo nano /etc/adu/du-config.json
160-
- [For Yocto reference image](device-update-raspberry-pi.md) use: sudo nano /adu/du-config.json
161-
159+
160+
- [For Ubuntu agent](device-update-ubuntu-agent.md) use: sudo nano /etc/adu/du-config.json
161+
- [For Yocto reference image](device-update-raspberry-pi.md) use: sudo nano /adu/du-config.json
162+
162163
1. Copy the primary connection string
163-
164-
- If Device Update agent is configured as a module copy the module's primary connection string.
165-
- Otherwise copy the device's primary connection string.
166-
167-
3. Enter the copied primary connection string to the 'connectionData' field's value in the du-config.json file. 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)
168-
169-
1. Now you are now ready to start the Device Update agent on your IoT device.
164+
165+
- If Device Update agent is configured as a module copy the module's primary connection string.
166+
- Otherwise copy the device's primary connection string.
167+
168+
1. Enter the copied primary connection string to the 'connectionData' field's value in the du-config.json file. 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)
169+
170+
1. Now you are now ready to start the Device Update agent on your IoT device.
170171
171172
## How to start the Device Update Agent
172173
@@ -179,13 +180,13 @@ This section describes how to start and verify the Device Update agent as a modu
179180
```shell
180181
sudo systemctl restart deviceupdate-agent
181182
```
182-
183+
183184
1. You can check the status of the agent using the command below. If you see any issues, refer to this [troubleshooting guide](troubleshoot-device-update.md).
184-
185+
185186
```shell
186187
sudo systemctl status deviceupdate-agent
187188
```
188-
189+
189190
You should see status OK.
190191
191192
1. On the IoT Hub portal, go to IoT device or IoT Edge devices to find the device that you configured with Device Update agent. There you will see the Device Update agent running as a module. For example:
@@ -211,11 +212,11 @@ If you run into issues, review the Device Update for IoT Hub [Troubleshooting Gu
211212
You can use the following tutorials for a simple demonstration of Device Update for IoT Hub:
212213

213214
- [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.
214-
215+
215216
- [Package Update: Getting Started using Ubuntu Server 18.04 x64 Package agent](device-update-ubuntu-agent.md)
216-
217+
217218
- [Proxy Update: Getting Started using Device Update binary agent for downstream devices](device-update-howto-proxy-updates.md)
218-
219+
219220
- [Getting Started Using Ubuntu (18.04 x64) Simulator Reference Agent](device-update-simulator.md)
220221

221222
- [Device Update for Azure IoT Hub tutorial for Azure-Real-Time-Operating-System](device-update-azure-real-time-operating-system.md)

0 commit comments

Comments
 (0)