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-edge/quickstart.md
+18-25Lines changed: 18 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ In this quickstart, you'll learn how to:
25
25
* Install and start the IoT Edge for Linux on Windows runtime on your device.
26
26
* Remotely deploy a module to an IoT Edge device and send telemetry.
27
27
28
-

28
+
:::image type="content" source="./media/quickstart/install-edge-full.png" alt-text="Diagram that shows the architecture of this quickstart for your device and cloud.":::
29
29
30
30
This quickstart walks you through how to set up your Azure IoT Edge for Linux on Windows device. Then, you'll deploy a module from the Azure portal to your device. The module you'll use is a simulated sensor that generates temperature, humidity, and pressure data. Other Azure IoT Edge tutorials build on the work you do here by deploying modules that analyze the simulated data for business insights.
31
31
@@ -64,7 +64,7 @@ Make sure your IoT Edge device meets the following requirements:
64
64
65
65
Start by creating an IoT hub with the Azure CLI.
66
66
67
-

67
+
:::image type="content" source="./media/quickstart/create-iot-hub.png" alt-text="Diagram that shows the step to create an I o T hub..":::
68
68
69
69
The free level of Azure IoT Hub works for this quickstart. If you've used IoT Hub in the past and already have a hub created, you can use that IoT hub.
70
70
@@ -80,7 +80,7 @@ If you get an error because you already have one free hub in your subscription,
80
80
81
81
Register an IoT Edge device with your newly created IoT hub.
82
82
83
-

83
+
:::image type="content" source="./media/quickstart/register-device.png" alt-text="Diagram that shows the step to register a device with an I o T hub identity.":::
84
84
85
85
Create a device identity for your simulated device so that it can communicate with your IoT hub. The device identity lives in the cloud, and you use a unique device connection string to associate a physical device to a device identity.
86
86
@@ -102,13 +102,13 @@ IoT Edge devices behave and can be managed differently than typical IoT devices.
102
102
103
103
1. Copy the value of the `connectionString` key from the JSON output and save it. This value is the device connection string. You'll use it to configure the IoT Edge runtime in the next section.
104
104
105
-

105
+
:::image type="content" source="./media/quickstart/retrieve-connection-string.png" alt-text="Screenshot that shows the connectionString output in Cloud Shell." lightbox="./media/quickstart/retrieve-connection-string.png":::
106
106
107
107
## Install and start the IoT Edge runtime
108
108
109
109
Install IoT Edge for Linux on Windows on your device, and configure it with the device connection string.
110
110
111
-

111
+
:::image type="content" source="./media/quickstart/start-runtime.png" alt-text="Diagram that shows the step to start the IoT Edge runtime.":::
112
112
113
113
Run the following PowerShell commands on the target device where you want to deploy Azure IoT Edge for Linux on Windows. To deploy to a remote target device using PowerShell, use [Remote PowerShell](/powershell/module/microsoft.powershell.core/about/about_remote) to establish a connection to a remote device and run these commands remotely on that device.
114
114
@@ -194,7 +194,7 @@ Run the following PowerShell commands on the target device where you want to dep
194
194
195
195
1. Enter 'O' or 'R' to toggle **Optional diagnostic data** on or off, depending on your preference. A successful deployment is pictured below.
196
196
197
-

197
+
:::image type="content" source="./media/quickstart/successful-powershell-deployment.png" alt-text="A successful deployment will say Deployment successful at the end of the messages." lightbox="./media/quickstart/successful-powershell-deployment.png":::
198
198
199
199
1. Provision your device using the device connection string that you retrieved in the previous section. Replace the placeholder text with your own value.
200
200
@@ -208,13 +208,7 @@ Your IoT Edge device is now configured. It's ready to run cloud-deployed modules
208
208
209
209
Manage your Azure IoT Edge device from the cloud to deploy a module that sends telemetry data to IoT Hub.
210
210
211
-

Include content included below to support versioned steps in Linux quickstart. Can update include file once Windows quickstart supports v1.2
217
-
-->
211
+
:::image type="content" source="./media/quickstart/deploy-module.png" alt-text="Diagram that shows the step to deploy a module.":::
218
212
219
213
One of the key capabilities of Azure IoT Edge is deploying code to your IoT Edge devices from the cloud. *IoT Edge modules* are executable packages implemented as containers. In this section, you'll deploy a pre-built module from the [IoT Edge Modules section of Azure Marketplace](https://azuremarketplace.microsoft.com/marketplace/apps/category/internet-of-things?page=1&subcategories=iot-edge-modules) directly from Azure IoT Hub.
220
214
@@ -233,37 +227,36 @@ Follow these steps to deploy your first module from Azure Marketplace.
233
227
234
228
1. On the upper bar, select **Set Modules**.
235
229
236
-

230
+
:::image type="content" source="./media/quickstart/select-set-modules.png" alt-text="Screenshot that shows location of the Set Modules tab.":::
237
231
238
232
1. Under **IoT Edge Modules**, open the **Add** drop-down menu, and then select **Marketplace Module**.
239
233
240
-

234
+
:::image type="content" source="./media/quickstart/add-marketplace-module.png" alt-text="Screenshot that shows the Add drop-down menu.":::
241
235
242
236
1. In **IoT Edge Module Marketplace**, search for and select the `Simulated Temperature Sensor` module.
243
237
244
238
The module is added to the IoT Edge Modules section with the desired **running** status.
245
239
246
240
1. Select **Next: Routes** to continue to the next step of the wizard.
247
241
248
-

242
+
:::image type="content" source="./media/quickstart/view-temperature-sensor-next-routes.png" alt-text="Screenshot that shows where to select the Next:Routes button.":::
249
243
250
-
1. On the **Routes** tab, remove the default route, **route**, and then select **Next: Review + create** to continue to the next step of the wizard.
244
+
1. On the **Routes** tab select **Next: Review + create** to continue to the next step of the wizard.
251
245
252
-
>[!Note]
253
-
>Routes are constructed by using name and value pairs. You should see two routes on this page. The default route, **route**, sends all messages to IoT Hub (which is called `$upstream`). A second route, **SimulatedTemperatureSensorToIoTHub**, was created automatically when you added the module from Azure Marketplace. This route sends all messages from the simulated temperature module to IoT Hub. You can delete the default route because it's redundant in this case.
246
+
:::image type="content" source="./media/quickstart/route-next-review-create.png" alt-text="Screenshot that shows the location of the Next: Review + create button.":::
254
247
255
-

256
-
257
-
1. Review the JSON file, and then select **Create**. The JSON file defines all of the modules that you deploy to your IoT Edge device. You'll see the **SimulatedTemperatureSensor** module and the two runtime modules, **edgeAgent** and **edgeHub**.
248
+
1. Review the JSON file in the **Review + create** tab. The JSON file defines all of the modules that you deploy to your IoT Edge device. You'll see the **SimulatedTemperatureSensor** module and the two runtime modules, **edgeAgent** and **edgeHub**.
258
249
259
250
>[!Note]
260
251
>When you submit a new deployment to an IoT Edge device, nothing is pushed to your device. Instead, the device queries IoT Hub regularly for any new instructions. If the device finds an updated deployment manifest, it uses the information about the new deployment to pull the module images from the cloud then starts running the modules locally. This process can take a few minutes.
261
252
253
+
1. Select **Create** to deploy.
254
+
262
255
1. After you create the module deployment details, the wizard returns you to the device details page. View the deployment status on the **Modules** tab.
263
256
264
257
You should see three modules: **$edgeAgent**, **$edgeHub**, and **SimulatedTemperatureSensor**. If one or more of the modules has **YES** under **SPECIFIED IN DEPLOYMENT** but not under **REPORTED BY DEVICE**, your IoT Edge device is still starting them. Wait a few minutes, and then refresh the page.
265
258
266
-

259
+
:::image type="content" source="./media/quickstart/view-deployed-modules.png" alt-text="Screenshot that shows Simulated Temperature Sensor in the list of deployed modules.":::
267
260
268
261
## View the generated data
269
262
@@ -286,7 +279,7 @@ The module that you pushed generates sample environment data that you can use fo
286
279
sudo iotedge list
287
280
```
288
281
289
-

282
+
:::image type="content" source="./media/quickstart/iotedge-list-screen.png" alt-text="Verify your temperature sensor, agent, and hub are running.":::
290
283
291
284
1. View the messages being sent from the temperature sensor module to the cloud using the following Linux command:
292
285
@@ -297,7 +290,7 @@ The module that you pushed generates sample environment data that you can use fo
297
290
>[!IMPORTANT]
298
291
>IoT Edge commands are case-sensitive when they refer to module names.
299
292
300
-

293
+
:::image type="content" source="./media/quickstart/temperature-sensor-screen.png" alt-text="Screenshot of the output logs of the Simulated Temperature Sensor module.":::
301
294
302
295
You can also use the [Azure IoT Hub extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=vsciot-vscode.azure-iot-toolkit) to watch messages arrive at your IoT hub.
0 commit comments