Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rangv/AzureIoTCentralEFlow
https://github.com/rangv/AzureIoTCentralEFlow
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/rangv/AzureIoTCentralEFlow
- Owner: rangv
- Created: 2021-02-02T15:24:06.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-03-15T02:31:28.000Z (almost 4 years ago)
- Last Synced: 2024-01-28T23:08:49.331Z (11 months ago)
- Size: 42.3 MB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-iotcentral - Azure IoT Edge for Linux on Windows (EFLOW) with IoT Central - Edge (miscellaneous)
README
## Azure IoT Edge for Linux on Windows (EFLOW) with IoT Central
Azure IoT Edge for Linux on Windows allows you to run containerized Linux workloads alongside Windows applications in Windows IoT deployments. Businesses that rely on Windows IoT to power their edge devices can now take advantage of the cloud-native analytics solutions being built in Linux.
This tutorial demonstrates EFLOW device provisioned and managed from IoT Central.
Docs for [Azure IoT Edge for Linux on Windows](https://docs.microsoft.com/en-us/windows/iot/iot-enterprise/eflow).
In this tutorial, you learn how to:
> * Create a device template for an IoT Edge device
> * Create an IoT Edge device in IoT Central
> * Connect & Provision the device
## Prerequisites
Complete the [Create an Azure IoT Central application](https://docs.microsoft.com/en-us/azure/iot-central/core/quick-deploy-iot-central) quickstart to create an IoT Central application using the **Custom app > Custom application** template.
To complete the steps in this tutorial, you need an active Azure subscription.
If you don't have an Azure subscription, create a [free account](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin.
Download the IoT Edge manifest file from GitHub. Right-click on the following link and then select **Save link as**: [EnvironmentalSensorManifest.json](https://raw.githubusercontent.com/Azure-Samples/iot-central-docs-samples/master/iotedge/EnvironmentalSensorManifest.json)
## Create device template
In this section, you create an IoT Central device template for an IoT Edge device. You import an IoT Edge manifest to get started, and then modify the template to add telemetry definitions and views:
### Import manifest to create template
To create a device template from an IoT Edge manifest:
1. In your IoT Central application, navigate to **Device templates** and select **+ New**.
1. On the **Select template type** page, select the **Azure IoT Edge** tile. Then select **Next: Customize**.
1. On the **Upload an Azure IoT Edge deployment manifest** page, enter *Environmental Sensor Edge Device* as the device template name. Then select **Browse** to upload the **EnvironmentalSensorManifest.json** you downloaded previously. Then select **Next: Review**.
1. On the **Review** page, select **Create**.
1. Select the **Manage** interface in the **SimulatedTemperatureSensor** module to view the two properties defined in the manifest:
### Add telemetry to manifest
An IoT Edge manifest doesn't define the telemetry a module sends. You add the telemetry definitions to the device template in IoT Central. The **SimulatedTemperatureSensor** module sends telemetry messages that look like the following JSON:
```json
{
"machine": {
"temperature": 75.0,
"pressure": 40.2
},
"ambient": {
"temperature": 23.0,
"humidity": 30.0
},
"timeCreated": ""
}
```
To add the telemetry definitions to the device template:
1. Select the **Manage** interface in the **Environmental Sensor Edge Device** template.
1. Select **+ Add capability**. Enter *machine* as the **Display name** and make sure that the **Capability type** is **Telemetry**.
1. Select **Object** as the schema type, and then select **Define**. On the object definition page, add *temperature* and *pressure* as attributes of type **Double** and then select **Apply**.
1. Select **+ Add capability**. Enter *ambient* as the **Display name** and make sure that the **Capability type** is **Telemetry**.
1. Select **Object** as the schema type, and then select **Define**. On the object definition page, add *temperature* and *humidity* as attributes of type **Double** and then select **Apply**.
1. Select **+ Add capability**. Enter *timeCreated* as the **Display name** and make sure that the **Capability type** is **Telemetry**.
1. Select **DateTime** as the schema type.
1. Select **Save** to update the template.
The **Manage** interface now includes the **machine**, **ambient**, and **timeCreated** telemetry types:
### Add views to template
The device template doesn't yet have a view that lets an operator see the telemetry from the IoT Edge device. To add a view to the device template:
1. Select **Views** in the **Environmental Sensor Edge Device** template.
1. On the **Select to add a new view** page, select the **Visualizing the device** tile.
1. Change the view name to *View IoT Edge device telemetry*.
1. Select the **ambient** and **machine** telemetry types. Then select **Add tile**.
1. Select **Save** to save the **View IoT Edge device telemetry** view.
### Publish the template
Before you can add a device that uses the **Environmental Sensor Edge Device** template, you must publish the template.
Navigate to the **Environmental Sensor Edge Device** template and select **Publish**. On the **Publish this device template to the application** panel, select **Publish** to publish the template:
## Add IoT Edge device
Now you've published the **Environmental Sensor Edge Device** template, you can add a device to your IoT Central application:
1. In your IoT Central application, navigate to the **Devices** page and select **Environmental Sensor Edge Device** in the list of available templates.
1. Select **+ New** to add a new device from the template. On the **Create new device** page, select **Create**.
You now have a new device with the status **Registered**:
### Get the device credentials
When you deploy the IoT Edge device later in this tutorial, you need the credentials that allow the device to connect to your IoT Central application. The get the device credentials:
1. On the **Device** page, select the device you created.
1. Select **Connect**.
1. On the **Device connection** page, make a note of the **ID Scope**, the **Device ID**, and the **Primary Key**. You use these values later.
1. Select **Close**.
You've now finished configuring your IoT Central application to enable an IoT Edge device to connect.
## Install and provision Azure IoT Edge for Linux on a Windows device
Follow this document to install and provision Edge for Linux on a windows device.
>
> You are not required to create an IoTHub with this tutorial. When you go thru the steps from the doc below skip the step of creating IoT Hub since you will connecting to IoT Central.
[Install and provision Azure IoT Edge for Linux on a Windows device](https://docs.microsoft.com/en-us/azure/iot-edge/how-to-install-iot-edge-on-windows?view=iotedge-2018-06&tabs=windowsadmincenter)
For this tutorial pick **option 2** to provision your device, Provisioning via DPS using symmetric keys. Provide the **scope ID**, **registration ID** and the **primary key** you captured in previous steps.
```azurepowershell-interactive
Provision-EflowVm -provisioningType symmetric -scopeId -registrationId -symmKey
```
Go To Device Details page on IoT Central and you will see telemetry flowing from your device
