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-linux.md
+16-20Lines changed: 16 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ In this quickstart you learn how to:
23
23
* Install and start the IoT Edge runtime on a virtual device.
24
24
* Remotely deploy a module to an IoT Edge device.
25
25
26
-

26
+
:::image type="content" source="./media/quickstart-linux/install-edge-full.png" alt-text="Diagram of Quickstart architecture for device and cloud.":::
27
27
28
28
This quickstart walks you through creating a Linux virtual machine that's configured to be an IoT Edge device. Then, you deploy a module from the Azure portal to your device. The module used in this quickstart is a simulated sensor that generates temperature, humidity, and pressure data. The other Azure IoT Edge tutorials build upon the work you do here by deploying additional modules that analyze the simulated data for business insights.
29
29
@@ -47,7 +47,7 @@ Cloud resources:
47
47
48
48
Start the quickstart by creating an IoT hub with Azure CLI.
49
49
50
-

50
+
:::image type="content" source="./media/quickstart-linux/create-iot-hub.png" alt-text="Diagram of how to create an IoT hub in the cloud.":::
51
51
52
52
The free level of 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.
53
53
@@ -63,7 +63,7 @@ The following code creates a free **F1** hub in the resource group **IoTEdgeReso
63
63
64
64
Register an IoT Edge device with your newly created IoT hub.
65
65
66
-

66
+
:::image type="content" source="./media/quickstart-linux/register-device.png" alt-text="Diagram of how to register a device with an IoT Hub identity.":::
67
67
68
68
Create a device identity for your IoT Edge 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.
69
69
@@ -83,13 +83,13 @@ Since IoT Edge devices behave and can be managed differently than typical IoT de
83
83
az iot hub device-identity connection-string show --device-id myEdgeDevice --hub-name {hub_name}
84
84
```
85
85
86
-

86
+
:::image type="content" source="./media/quickstart/retrieve-connection-string.png" alt-text="Screenshot of the connection string from CLI output." lightbox="./media/quickstart/retrieve-connection-string.png":::
87
87
88
88
## Configure your IoT Edge device
89
89
90
90
Create a virtual machine with the Azure IoT Edge runtime on it.
91
91
92
-

92
+
:::image type="content" source="./media/quickstart-linux/start-runtime.png" alt-text="Diagram of how to start the runtime on a device.":::
93
93
94
94
The IoT Edge runtime is deployed on all IoT Edge devices. It has three components. The *IoT Edge security daemon* starts each time an IoT Edge device boots and bootstraps the device by starting the IoT Edge agent. The *IoT Edge agent* facilitates deployment and monitoring of modules on the IoT Edge device, including the IoT Edge hub. The *IoT Edge hub* manages communications between modules on the IoT Edge device, and between the device and IoT Hub.
95
95
@@ -141,7 +141,7 @@ This template takes the following parameters:
141
141
142
142
Once the deployment is complete, you should receive JSON-formatted output in the CLI that contains the SSH information to connect to the virtual machine. Copy the value of the **public SSH** entry of the **outputs** section:
143
143
144
-

144
+
:::image type="content" source="./media/quickstart-linux/outputs-public-ssh.png" alt-text="How to retrieve public ssh value from output." lightbox="./media/quickstart-linux/outputs-public-ssh.png":::
145
145
146
146
### View the IoT Edge runtime status
147
147
@@ -180,11 +180,7 @@ Your IoT Edge device is now configured. It's ready to run cloud-deployed modules
180
180
181
181
Manage your Azure IoT Edge device from the cloud to deploy a module that will send telemetry data to IoT Hub.
182
182
183
-

Include content included below to support versioned steps in Linux quickstart. Can update include file once Windows quickstart supports v1.2 -->
183
+
:::image type="content" source="./media/quickstart-linux/deploy-module.png" alt-text="Diagram of how to deploy a module from cloud to device.":::
188
184
189
185
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.
190
186
@@ -202,42 +198,42 @@ Follow these steps to start the **Set Modules** wizard to deploy your first modu
202
198
203
199
1. On the upper bar, select **Set Modules**.
204
200
205
-

201
+
:::image type="content" source="./media/quickstart-linux/select-set-modules.png" alt-text="Screenshot that shows location of the Set Modules tab.":::
206
202
207
203
### Modules
208
204
209
205
The first step of the wizard is to choose which modules you want to run on your device.
210
206
211
207
Under **IoT Edge Modules**, open the **Add** drop-down menu, and then select **Marketplace Module**.
212
208
213
-

209
+
:::image type="content" source="./media/quickstart-linux/add-marketplace-module.png" alt-text="Screenshot that shows the Add drop-down menu.":::
214
210
215
211
In **IoT Edge Module Marketplace**, search for and select the `Simulated Temperature Sensor` module. The module is added to the IoT Edge Modules section with the desired **running** status.
216
212
217
213
Select **Next: Routes** to continue to the next step of the wizard.
218
214
219
-

215
+
:::image type="content" source="./media/quickstart-linux/view-temperature-sensor-next-routes.png" alt-text="Screenshot that shows continuing to the next step after the module is added.":::
220
216
221
217
### Routes
222
218
223
219
A route named *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.
224
220
225
-

221
+
:::image type="content" source="./media/quickstart-linux/route-next-review-create.png" alt-text="Screenshot that shows the new temperature sensor route and shows the location of the Next: Review + create button.":::
226
222
227
223
Select **Next: Review + create**.
228
224
229
225
### Review and create
230
226
231
-
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**.
227
+
Review the JSON file, and then select **Create**. The JSON file defines all of the modules that you deploy to your IoT Edge device.
232
228
233
229
>[!Note]
234
230
>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.
235
231
236
232
After you create the module deployment details, the wizard returns you to the device details page. View the deployment status on the **Modules** tab.
237
233
238
-
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.
234
+
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.
239
235
240
-

236
+
:::image type="content" source="./media/quickstart-linux/view-deployed-modules.png" alt-text="Screenshot that shows the SimulatedTemperatureSensor in the list of deployed modules." lightbox="./media/quickstart-linux/view-deployed-modules.png":::
241
237
242
238
## View generated data
243
239
@@ -251,7 +247,7 @@ Open the command prompt on your IoT Edge device again, or use the SSH connection
251
247
sudo iotedge list
252
248
```
253
249
254
-

250
+
:::image type="content" source="./media/quickstart-linux/iotedge-list-2-version-1.4.png" alt-text="Screenshot that shows three modules on your device." lightbox="./media/quickstart-linux/iotedge-list-2-version-1.4.png":::
255
251
256
252
View the messages being sent from the temperature sensor module:
257
253
@@ -262,7 +258,7 @@ View the messages being sent from the temperature sensor module:
262
258
>[!TIP]
263
259
>IoT Edge commands are case-sensitive when referring to module names.
264
260
265
-

261
+
:::image type="content" source="./media/quickstart-linux/iotedge-logs.png" alt-text="Screenshot that shows data from your module in the output console." lightbox="./media/quickstart-linux/iotedge-logs.png":::
266
262
267
263
You can also watch the messages arrive at your IoT hub by using the [Azure IoT Hub extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=vsciot-vscode.azure-iot-toolkit).
0 commit comments