Skip to content

Commit 925e735

Browse files
committed
Add tutorial outline
1 parent 87c3bf7 commit 925e735

File tree

9 files changed

+144
-24
lines changed

9 files changed

+144
-24
lines changed

articles/iot-accelerators/iot-accelerators-remote-monitoring-add-edge-device.md

Lines changed: 11 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -14,38 +14,28 @@ ms.topic: conceptual
1414

1515
# Add an IoT Edge device to your Remote Monitoring solution accelerator
1616

17-
To add an [IoT Edge](../iot-edge/about-iot-edge.md) device to your solution accelerator, you register it with the IoT hub that's part of your deployment. In the current version of the Remote Monitoring solution accelerator, you can use either the Azure portal or the Azure CLI to add an Edge device.
17+
To add an [IoT Edge](../iot-edge/about-iot-edge.md) device to your solution accelerator, complete the following two steps:
1818

19-
This article shows you how to use the Azure CLI to add an Edge device. You need the name you chose when you deployed your solution accelerator to complete the steps in this how-to guide.
19+
1. Add the Edge device on the **Devices** page in the Remote Monitoring solution accelerator web UI.
20+
1. Install the IoT Edge runtime on your Edge device.
2021

21-
[!INCLUDE [cloud-shell-try-it.md](../../includes/cloud-shell-try-it.md)]
22+
## Add the IoT Edge device
2223

23-
## Find your IoT hub
24+
To add an IoT Edge device to the Remote Monitoring solution accelerator, navigate to the **Devices** page in the web UI and click **+ New device**.
2425

25-
Before you can add a device, you need to know the name of your IoT hub. The IoT hub was created when you deployed the Remote Monitoring solution accelerator. The following command lists the contents in the resource group that contains all the Azure resources used by your Remote Monitoring solution. The name of the resource group is the name you chose when you deployed the Remote Monitoring solution accelerator:
26+
In the **New device** panel, choose **IoT Edge device**. You can leave the default values for the other settings. The click **Apply**:
2627

27-
```azurecli-interactive
28-
# The resource group name is the name of your Remote Monitoring solution
29-
# You can see a list of your resource groups using:
30-
# az group list -o table
31-
az resource list -g {resource group name} -o table
32-
```
28+
![Add IoT Edge device](media/iot-accelerators-remote-monitoring-add-edge-device/addedgedevice.png)
3329

34-
Make a note of the name of the IoT hub, you need this name in the following section.
30+
### Alternative ways to add an IoT Edge device
3531

36-
## Register your device to IoT Hub
37-
38-
Before an IoT Edge device can connect to an IoT hub, you must register it.
39-
40-
You have three options for registering an IoT Edge device. Make sure you add the Edge device to the IoT hub you identified in the previous section:
32+
It's also possible to register an IoT Edge device directly with the IoT Hub instance in your solution accelerator. You need to know the name of the IoT hub in your solution accelerator before you follow any of these how-to guides:
4133

4234
- [Register a new Azure IoT Edge device from the Azure portal](../iot-edge/how-to-register-device-portal.md)
4335
- [Register a new Azure IoT Edge device with Azure CLI](../iot-edge/how-to-register-device-cli.md)
4436
- [Register a new Azure IoT Edge device from Visual Studio Code](../iot-edge/how-to-register-device-vscode.md)
4537

46-
When you register a device with the IoT hub in the Remote Monitoring solution accelerator, it's listed on the **Devices** page in the web UI:
47-
48-
TODO - Add a screenshot here.
38+
When you register a device directly with the IoT hub in the Remote Monitoring solution accelerator, it's listed on the **Devices** page in the web UI.
4939

5040
## Install the IoT Edge runtime
5141

@@ -59,5 +49,4 @@ Before you can deploy modules to your Edge device, you must install the IoT Edge
5949

6050
## Next steps
6151

62-
TODO - make sure this next step is updated.
63-
Now that you have prepared your IoT Edge device, the next step is to deploy modules to it.
52+
Now that you have prepared your IoT Edge device, the next step is to deploy modules to it. See [Import an IoT Edge package into your Remote Monitoring solution accelerator](iot-accelerators-remote-monitoring-import-edge-package.md)
Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
---
2+
title: Detect anomalies at the edge in an Azure solution tutorial | Microsoft Docs
3+
description: In this tutorial you learn how to monitor your IoT Edge devices using the Remote Monitoring solution accelerator.
4+
author: dominicbetts
5+
manager: timlt
6+
ms.author: dobett
7+
ms.service: iot-accelerators
8+
services: iot-accelerators
9+
ms.date: 10/12/2018
10+
ms.topic: tutorial
11+
ms.custom: mvc
12+
13+
# As an operator of an IoT monitoring solution, I want to detect anomalies at the edge in order to reduce the volume of telemetry sent to my Remote Monitoring solution and to respond quickly to those anomalies.
14+
---
15+
16+
# Tutorial: Detect anomalies at the edge with the Remote Monitoring solution accelerator
17+
18+
In this tutorial, you configure the Remote Monitoring solution to respond to anomalies detected by an IoT Edge device. IoT Edge devices let you process telemetry at the edge to reduce the volume of telemetry sent to the solution and to enable faster responses to events on devices. To learn more about the benefits of edge processing, see [What is Azure IoT Edge](../iot-edge/about-iot-edge.md).
19+
20+
To introduce edge processing with remote monitoring, this tutorial uses a simulated oil pump jack device. This oil pump jack is managed by an organization called Contoso and is connected to the Remote Monitoring solution accelerator. Sensors on the oil pump jack measure metrics such as temperature and pressure. Operators at Contoso know that an abnormal increase in temperature can cause the oil pump jack to slow down. Operators at Contoso don't need to monitor the device's temperature when it's within its normal range.
21+
22+
Contoso wants to deploy an intelligent edge module to the oil pump jack that detects temperature anomalies. Another edge module sends alerts to the Remote Monitoring solution. When an alert is received, a Contoso operator can dispatch a maintenance technician. Contoso could also configure an automated action, such as sending an email, to run when the solution receives an alert.
23+
24+
This tutorial uses your local Windows development machine as an IoT Edge device. You install edge modules to simulate the oil pump jack device and to detect the temperature anomalies.
25+
26+
In this tutorial, you:
27+
28+
>[!div class="checklist"]
29+
> * Add an IoT Edge device to the solution
30+
> * Import a package that defines the modules to run on the device
31+
> * Deploy the package to your IoT Edge device
32+
> * View alerts from the device
33+
34+
If you don't have an Azure subscription, create a [free account](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin.
35+
36+
[!INCLUDE [iot-accelerators-tutorial-prereqs](../../includes/iot-accelerators-tutorial-prereqs.md)]
37+
38+
The tutorial uses your local Windows machine to host the IoT Edge runtime. To install the IoT Edge runtime, you must have [Docker for Windows](https://docs.docker.com/docker-for-windows/install/) installed and configured to use Linux containers.
39+
40+
[!INCLUDE [cloud-shell-try-it.md](../../includes/cloud-shell-try-it.md)]
41+
42+
## Add an IoT Edge device
43+
44+
There are two steps to add an IoT Edge device to your Remote Monitoring solution accelerator. This section shows you how to use:
45+
46+
* Add an IoT Edge device on the **Devices** page in the Remote Monitoring web UI.
47+
* Windows Powershell to install the IoT Edge runtime on your local Windows device.
48+
49+
### Add an IoT Edge device to your solution
50+
51+
To add an IoT Edge device to the Remote Monitoring solution accelerator, navigate to the **Devices** page in the web UI and click **+ New device**.
52+
53+
In the **New device** panel, choose **IoT Edge device**. You can leave the default values for the other settings. The click **Apply**:
54+
55+
[![Add IoT Edge device](./media/iot-accelerators-remote-monitoring-edge/addedgedevice-inline.png)](./media/iot-accelerators-remote-monitoring-edge/addedgedevice-expanded.png#lightbox)
56+
57+
Make a note of the device connection string, you need it later in this tutorial.
58+
59+
When you register a device with the IoT hub in the Remote Monitoring solution accelerator, it's listed on the **Devices** page in the web UI:
60+
61+
[![New IoT Edge device](./media/iot-accelerators-remote-monitoring-edge/newedgedevice-inline.png)](./media/iot-accelerators-remote-monitoring-edge/newedgedevice-expanded.png#lightbox)
62+
63+
To make it easier to manage the IoT Edge devices in the solution, create a device group and add the IoT Edge device:
64+
65+
1. On the **Devices** page, click **Manage device groups**.
66+
1. Click **Add new device group**. Create a new device group with the following settings:
67+
68+
| Setting | Value |
69+
| ------- | ----- |
70+
| Name | EdgeDevices |
71+
| Field | Tags.IsEdge |
72+
| Operator | = Equals |
73+
| Value | Y |
74+
| Type | Text |
75+
76+
1. Click **Save**.
77+
1. Select the **MyRMEdgeDevice** device in the list on the **Devices** page and then click **Jobs**.
78+
1. Create a job to add the **IsEdge** tag to the device using the following settings:
79+
80+
| Setting | Value |
81+
| ------- | ----- |
82+
| Job | Tag |
83+
| Job Name | AddEdgeTag |
84+
| Key | IsEdge |
85+
| Value | Y |
86+
87+
1. Click **Apply**.
88+
89+
You IoT Edge device is now in the **EdgeDevices** group.
90+
91+
### Install the Edge runtime
92+
93+
An Edge device requires the Edge runtime to be installed. In this tutorial, you install the Edge runtime on your local Windows computer to test the scenario.
94+
95+
1. Make sure that Docker is running on your local Windows machine.
96+
1. Open an elevated PowerShell prompt on your local machine. Installing the IoT Edge runtime requires administrative permissions.
97+
1. Run the following PowerShell command to install the IoT Edge runtime:
98+
99+
```PowerShell
100+
. {Invoke-WebRequest -useb aka.ms/iotedge-win} | Invoke-Expression; `
101+
Install-SecurityDaemon -Manual -ContainerOs Linux
102+
```
103+
104+
1. When prompted, use the device connection string you made a note of previously.
105+
106+
1. Use the following PowerShell commands to verify the IoT Edge is running:
107+
108+
```PowerShell
109+
Get-Service iotedge
110+
iotedge list
111+
```
112+
113+
If the runtime started correctly, you see the **edgeHub** and **edgeAgent** processes have a status of **running**.
114+
115+
## Import a package
116+
117+
## Deploy a package
118+
119+
## Monitor the device
120+
121+
## Next steps
122+
123+
This tutorial showed you how add and configure an IoT Edge device in the Remote Monitoring solution accelerator. To learn more about working with IoT Edge packages in the Remote Monitoring solution, see the following how-to guide:
124+
125+
> [!div class="nextstepaction"]
126+
> [Import an IoT Edge package into your Remote Monitoring solution accelerator](iot-accelerators-remote-monitoring-import-edge-package.md)

articles/iot-accelerators/iot-accelerators-remote-monitoring-import-edge-package.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,5 +56,4 @@ You've now uploaded an IoT Edge deployment manifest as a package. On the **Deplo
5656

5757
## Next steps
5858

59-
TODO - make sure this next step is updated.
60-
Now that you have prepared your IoT Edge device, the next step is to deploy modules to it.
59+
Now that you have learned how to deploy modules to an IoT Edge device from the Remote Monitoring solution, the next step is to learn more about [IoT Edge](../iot-edge/about-iot-edge.md).
76.9 KB
Loading
76.9 KB
Loading
76.9 KB
Loading
142 KB
Loading
67.5 KB
Loading

articles/iot-accelerators/toc.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@
3131
href: iot-accelerators-remote-monitoring-root-cause-analysis.md
3232
- name: Use alerts and fix device issues
3333
href: iot-accelerators-remote-monitoring-maintain.md
34+
- name: Detect anomalies at the edge
35+
href: iot-accelerators-remote-monitoring-edge.md
3436

3537
- name: Concepts
3638
items:
@@ -77,6 +79,10 @@
7779
href: iot-accelerators-connecting-pi-node.md
7880
- name: MXChip IoT DevKit
7981
href: iot-accelerators-arduino-iot-devkit-az3166-devkit-remote-monitoringv2.md
82+
- name: Add an IoT Edge device
83+
href: iot-accelerators-remote-monitoring-add-edge-device.md
84+
- name: Import an IoT Edge package
85+
href: iot-accelerators-remote-monitoring-import-edge-package.md
8086
- name: Integrate SIM data
8187
href: iot-accelerators-remote-monitoring-telefonica-sim.md
8288
- name: Create a simulated device

0 commit comments

Comments
 (0)