Skip to content

rwaldron/iot-hub-node-intel-edison-getstartedkit

BranchesTags
 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

35 Commits
command_center
command_center
 
 
command_center_node
command_center_node
 
 
img
img
 
 
remote_monitoring
remote_monitoring
 
 
.gitignore
.gitignore
 
 
CONTRIBUTING.md
CONTRIBUTING.md
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 

Repository files navigation

services platforms author
iot-hub, stream-analytics, event-hubs, web-apps, documentdb, storage-accounts
yocto, node
hegate

Get Started with Microsoft Azure IoT Starter Kit - Intel Edison

This page contains technical information to help you get familiar with Azure IoT using the Azure IoT Starter Kit - Intel Edison. You will find two tutorials that will walk you through different scenarios. The first tutorial will show you how to connect your Azure IoT Starter kit to our Remote Monitoring preconfigured solution from Azure IoT Suite. In the second tutorial, you will leverage Azure IoT services to create your own IoT solution.

You can choose to start with whichever tutorial you want to. If you've never worked with Azure IoT services before, we encourage you to start with the Remote Monitoring solution tutorial, because all of the Azure services will be provisioned for you in a built-in preconfigured solution. Then you can explore how each of the services work by going through the second tutorial.

We hope you enjoy the tutorials! Please provide feedback if there's anything that we can improve.

Don't have a kit yet?: Click here

Running a Simple Remote Monitoring Solution with the Intel Edison

This tutorial describes the process of taking your Intel Edison Grove kit, and using it to develop a temperature, humidity and pressure reader that can communicate with the cloud using the  Microsoft Azure IoT SDK. 

Table of Contents

1.1 Tutorial Overview

In this tutorial, you'll be doing the following:

  • Setting up your environment on Azure using the Microsoft Azure IoT Suite Remote Monitoring preconfigured solution, getting a large portion of the set-up that would be required done in one step.
  • Setting your device and sensors up so that it can communicate with both your computer, and Azure IoT.
  • Updating the device code sample to include our connection data and send it to Azure to be viewed remotely.

1.2 Before Starting

1.2.1 Required Software

1.2.2 Required Hardware

  • Intel Edison Grove kit
    • Two USB Mini cables

1.3 Create a New Azure IoT Suite Remote Monitoring solution and Add Device

  • Log in to Azure IoT Suite with your Microsoft account and click Create a New Preconfigured Solution

Note: For first time users, click here to get your Azure free trial which gives you 200USD of credit to get started.

  • Click select in the Remote Monitoring option
  • Type in a solution name. For this tutorial we’ll be using “EdisonSuite” (You will have to name it something else. Make it unique. I.E. "ContosoSample")

Note: Make sure to copy down the names and connection strings mentioned into a text document for reference later.

  • Choose your subscription plan and geographic region, then click Create Solution
  • Wait for Azure to finish provisioning your IoT suite (this process may take up to 10 minutes), and then click Launch

Note: You may be asked to log back in. This is to ensure your solution has proper permissions associated with your account.

  • Open the link to your IoT Suite’s “Solution Dashboard.” You may have been redirected there already.
  • This opens your personal remote monitoring site at the URL <Your Azure IoT Hub suite name>.azurewebsites.net (e.g. EdisonSuite.azurewebsites.net)
  • Click Add a Device at the lower left hand corner of your screen
  • Add a new custom device
  • Enter your desired device ID. In this case we’ll use “Edison_Grove”, and then click Check ID
  • If Device ID is available, go ahead and click Create
  • Make note of your device ID, Device Key, and IoT Hub Hostname to enter into the code you’ll run on your device later 

Warning: The Remote Monitoring solution provisions a set of Azure IoT Services in your Azure account. To avoid unnecessary Azure consumption, you can do two things:

  1. Disable the simulated devices created with the solution (Go to Devices>>Select the device>> on the device details menu on the right, clich on Disable Device. Repeat with all the simulated devices).

  2. Stop your remote monitoring solution while you are working on the next steps. (See: Troubleshooting)

1.4 Prepare your device

If this is the first time you use your Intel Edison board, you will have to follow some steps to assemble it.

  • Please follow steps 1-4 of the instructions. Intel's IDE (Step 5) is optional for our tutorial.
  • Flash your board with the latest firmware

1.5 Connect the Grove Sensor Module to your Device

  • Begin by placing the Base Shield over the pins on your Intel Edison board
  • Using this image as a reference, connect your Grove sensor and the Intel Edison
  • For sensor pins, we will use the following wiring:
Edison Port Component
A0 Temperature

At the end of your work, your Intel Edison should be connected with a working sensor. We'll test it in the next sections.

1.6 Modify, build and run the Remote Monitoring sample

  • In your Edison boards command line, type the following command to transfer the files to your board:
wget https://raw.githubusercontent.com/Azure-Samples/iot-hub-node-intel-edison-getstartedkit/master/remote_monitoring/remote_monitoring.js
wget https://raw.githubusercontent.com/Azure-Samples/iot-hub-node-intel-edison-getstartedkit/master/remote_monitoring/package.json
  • Open the file remote_monitoring.js in a text editor using the command:
vi remote_monitoring.js
  • Vi is not your normal text editor - Here is a guide to some of the important controls:
x	  Delete character to the right of cursor
X	  Delete character to the left of cursor
:x	  Exit, saving changes

Movement
h	  Move left
j	  Move down
k	  Move up
l	  Move right

[ESC] returns the editor to command mode after entering one of the below modes: 
i	  Insert before cursor
a	  Append after cursor
  • Locate the following code in the file and update your connection data:
var hostName = '<IOTHUB_HOST_NAME>';
var deviceId = '<DEVICE_ID>';
var sharedAccessKey = '<SHARED_ACCESS_KEY>';

  • Save with [Escape]:wq[Enter]

  • Run the sample application using the following commands:

npm install
node remote_monitoring.js

1.7 View the Sensor Data from the Remote Monitoring Portal

  • Once you have the sample running, visit your dashboard by visiting azureiotsuite.com and clicking “Launch” on your solution
  • Make sure the “Device to View” in the upper right is set to your device
  • If the demo is running, you should see the graph change as your data updates in real time!

Note: Make sure to stop your remote monitoring solution once you have completed this to avoid unnecesary Azure consumption!

1.8 Next steps

Please visit our Azure IoT Dev Center for more samples and documentation on Azure IoT.

Using Microsoft Azure IoT Services to Identify Temperature Anomalies

This tutorial describes the process of taking your Microsoft Azure IoT Starter Kit for the Intel Edison, and using it to develop a temperature and humidity reader that can communicate with the cloud using the Microsoft Azure IoT SDK.

Table of Contents

2.1 Tutorial Overview

This tutorial has the following steps:

  • Provision an IoT Hub instance on Microsoft Azure and adding your device.
  • Prepare the device, get connected to the device, and set it up so that it can read sensor data.
  • Configure your Microsoft Azure IoT services by adding Event Hub, Storage Account, and Stream Analytics resources.
  • Prepare your local web solution for monitoring and sending commands to your device.
  • Update the sample code to respond to commands and include the data from our sensors, sending it to Microsoft Azure to be viewed remotely.

The end result will be a functional command center where you can view the history of your device's sensor data, a history of alerts, and send commands back to the device.

2.2 Before Starting

2.2.1 Required Software

2.2.2 Required Hardware

  • Intel Edison Grove kit
    • Two USB Mini cables

2.3 Connect the Sensor Module to your Device

  • Begin by placing the Base Shield over the pins on your Intel Edison board
  • Using this image as a reference, connect your Grove sensor and the Intel Edison
  • For sensor pins, we will use the following wiring:
Edison Port Component
A0 Temperature
D8 LED Socket Kit

At the end of your work, your Intel Edison should be connected with a working sensor. We'll test it in the next sections.

2.4 Create a New Microsoft Azure IoT Hub and Add Device

  • To create your Microsoft Azure IoT Hub and add a device, follow the instructions outlined in the Setup IoT Hub Microsoft Azure Iot SDK page.
  • After creating your device, make note of your connection string to enter into the code you’ll run on your device later

Note: Make sure to copy down the names and connection strings mentioned into a text document for reference later.

2.5 Create an Event Hub

Event Hub is an Azure IoT publish-subscribe service that can ingest millions of events per second and stream them into multiple applications, services or devices.

  • Log on to the Microsoft Azure Portal
  • Click on New -> Internet of Things-> Event Hub
  • After being redirected, click "Custom Create", Enter the following settings for the Event Hub (use a name of your choice for the event hub and the namespace):
    • Event Hub Name: EdisonEventHub
    • Region: Your choice
    • Subscription: Your choice
    • Namespace Name: Your Project Namespace, in our case “Edison2Suite”
  • Click the arrow to continue.
  • Choose to create 4 partitions and retain messages for 7 days.
  • Click the check at the bottom right hand corner to create your event hub.
  • Click on your Edison2Suite service bus (what you named your service bus)
  • Click on the Event Hubs tab
  • Select the EdisonEventHub eventhub and go in the Configure tab in the Shared Access Policies section, add a new policy:
    • Name = readwrite
    • Permissions = Send, Listen
  • Click Save at the bottom of the page, then click the Dashboard tab near the top and click on Connection Information at the bottom
  • Copy down the connection string for the readwrite policy you created.

2.6 Create a Storage Account for Table Storage

Now we will create a service to store our data in the cloud.

  • Log on to the Microsoft Azure Portal
  • In the menu, click New and select Data + Storage then Storage Account
  • Choose Classic for the deployment model and click on Create
  • Enter the name of your choice (We chose edisonstorage) for the account name, Standard-RAGRS for the type, choose your subscription, select the resource group you created earlier, then click on Create
  • You should try to create the storage account in the same region as your IoT Hub and Event Hub if possible.
  • Once the account is created, find it in the resources blade or click on the pinned tile, go to Settings, Keys, and write down the primary connection string.

2.7 Create a Stream Analytics job to Save IoT Data in Table Storage and Raise Alerts

Stream Analytics is an Azure IoT service that streams and analyzes data in the cloud. We'll use it to process data coming from your device.

  • Log on to the Microsoft Azure Portal

  • In the menu, click New, then click Internet of Things, and then click Stream Analytics Job

  • Enter a name for the job (We chose “EdisonStorageJob”), a preferred region, then choose your subscription. At this stage you are also offered to create a new or to use an existing resource group. Choose the resource group you created earlier (In our case, Edison2Suite).

  • Once the job is created, open your Job’s blade or click on the pinned tile, and find the section titled “Job Topology” and click the Inputs tile. In the Inputs blade, click on Add

  • Enter the following settings:

    • Input Alias = TempSensors
    • Source Type = Data Stream
    • Source = IoT Hub
    • IoT Hub = Edison2Suite (use the name for the IoT Hub you create before)
    • Shared Access Policy Name = service
    • Shared Access Policy Key = The service primary key saved from earlier
    • IoT Hub Consumer Group = "" (leave it to the default empty value)
    • Event serialization format = JSON
    • Encoding = UTF-8

  • Back to the Stream Analytics Job blade, click on the Query tile (next to the Inputs tile). In the Query settings blade, type in the below query and click Save:

SELECT
    DeviceId,
    EventTime,
    MTemperature as TemperatureReading
INTO
    TemperatureTableStorage
from TempSensors
WHERE
   DeviceId is not null
   and EventTime is not null

SELECT
    DeviceId,
    EventTime,
    MTemperature as TemperatureReading
INTO   
    TemperatureAlertToEventHub
FROM
    TempSensors
WHERE MTemperature > 25

Note: You can change the 25 to 0 when you're ready to generate alerts to look at. This number represents the temperature in degrees celsius to check for when creating alerts. 25 degrees celsius is 77 degrees fahrenheit.

  • Back to the Stream Analytics Job blade, click on the Outputs tile and in the Outputs blade, click on Add
  • Enter the following settings then click on Create:
    • Output Alias = TemperatureTableStorage
    • Sink = Table Storage
    • Storage account = edisonstorage (The storage you made earlier)
    • Storage account key = (The primary key for the storage account made earlier, can be found in Settings -> Keys -> Primary Access Key)
    • Table Name = TemperatureRecords Your choice - If the table doesn’t already exist, Local Storage will create it
    • Partition Key = DeviceId
    • Row Key = EventTime
    • Batch size = 1
  • Back to the Stream Analytics Job blade, click on the Outputs tile, and in the Outputs blade, click on Add
  • Enter the following settings then click on Create:
    • Output Alias = TemperatureAlertToEventHub
    • Source = Event Hub
    • Service Bus Namespace = Edison2Suite
    • Event Hub Name = edisoneventhub (The Event Hub you made earlier)
    • Event Hub Policy Name = readwrite
    • Event Hub Policy Key = Primary Key for readwrite Policy name (That's the one you wrote down after creating the event hub)
    • Partition Key Column = 0
    • Event Serialization format = JSON
    • Encoding = UTF-8
    • Format = Line separated
  • Back in the** Stream Analytics blade**, start the job by clicking on the **Start **button at the top

Note: Make sure to stop your Command Center jobs once you have when you take a break or finish to avoid unnecessary Azure consumption! (See: Troubleshooting)

2.8 Node Application Setup

  • If you do not have it already, install Node.js and NPM.
    • Windows and Mac installers can be found here: https://nodejs.org/en/download/
      • Ensure that you select the options to install NPM and add to your PATH.
    • Linux users can use the commands:
sudo apt-get update
sudo apt-get install nodejs
sudo apt-get install npm
  • Additionally, make sure you have cloned the project repository locally by issuing the following command in your desired directory:
git clone https://github.com/Azure-Samples/iot-hub-node-intel-edison-getstartedkit.git
  • Open the command_center_node folder in your command prompt (cd path/to/command_center_node) and install the required modules by running the following:
npm install -g bower
npm install
bower install

  • Open the config.json file and replace the information with your project. See the following for instructions on how to retrieve those values.

    • eventhubName:
      • Open the Classic Azure Management Portal
      • Open the Service Bus namespace you created earlier
      • Switch to the EVENT HUBS page
      • You can see and copy the name of your event hub from that page
    • ehConnString:
      • Click on the name of the event hub from above to open it
      • Click on the "CONNECTION INFORMATION" button along the bottom.
      • From there, click the button to copy the readwrite shared access policy connection string.
    • deviceId:
      • Use the information on the Manage IoT Hub to retrieve your deviceId using either the Device Explorer or iothub-explorer tools.
    • iotHubConnString:
      • In the Azure Portal
      • Open the IoT Hub you created previously.
      • Open the "Settings" blade
      • Click on the "Shared access policies" setting
      • Click on the "service" policy
      • Copy the primary connection string for the policy
    • storageAccountName:
      • In the Azure Portal
      • Open the classic Storage Account you created previously to copy its name
    • storageAccountKey:
      • Click on the name of the storage account above to open it
      • Click the "Settings" button to open the Settings blade
      • Click on the "Keys" setting
      • Click the button next to the "PRIMARY ACCESS KEY" top copy it
    • storageTableName:
      • This must match the name of the table that was used in the Stream Analytics table storage output above.
      • If you used the instructions above, you would have named it TemperatureRecords
      • If you named it something else, enter the name you used instead.
{
    "port": "3000",
    "eventHubName": "event-hub-name",
    "ehConnString": "Endpoint=sb://name.servicebus.windows.net/;SharedAccessKeyName=readwrite;SharedAccessKey=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa=",
    "deviceId": "iot-hub-device-name",
    "iotHubConnString": "HostName=iot-hub-name.azure-devices.net;SharedAccessKeyName=service;SharedAccessKey=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa=",
    "storageAcountName": "aaaaaaaaaaa",
    "storageAccountKey": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa==",
    "storageTable": "TemperatureRecords"
}
  • Now it is time to run it! Enter the following command:
node server.js
  • You should then see something similar to:
app running on http://localhost:3000
  • Visit the url in your browser and you will see the Node app running!

To deploy this project to the cloud using Azure, you can reference Creating a Node.js web app in Azure App Service.

Next, we will update your device so that it can interact with all the things you just created.

2.9 Modify Device Sample

  • In your Edison boards command line, type the following command to transfer the files to your board:
wget https://raw.githubusercontent.com/Azure-Samples/iot-hub-node-intel-edison-getstartedkit/master/command_center/command_center.js
wget https://raw.githubusercontent.com/Azure-Samples/iot-hub-node-intel-edison-getstartedkit/master/command_center/package.json
  • Open the file command_center.js in a text editor using the command (Nano is another editor you can use if you are running the v3.0 image on your Edison):
vi command_center.js
  • Vi is not your normal text editor - Here is a guide to some of the important controls:
x	  Delete character to the right of cursor
X	  Delete character to the left of cursor
:x	  Exit, saving changes

Movement
h	  Move left
j	  Move down
k	  Move up
l	  Move right

[ESC] returns the editor to command mode after entering one of the below modes: 
i	  Insert before cursor
a	  Append after cursor

  • Locate the following code in the file and update your connection data. See below for information how how to retrieve these values:

    • connectionString:
      • Use the "Device Explorer" or "iothub-explorer" tools as documented on the Manage IoT Hub page to retrieve the connection string for the device you created previously.
      • Replace <IOT_HUB_DEVICE_CONNECTION_STRING> below with that name.
    • sharedAccess
var connectionString = '<IOT_HUB_DEVICE_CONNECTION_STRING>';

  • Save with [Escape]:wq[Enter]

  • Run the sample application using the following commands:

npm install
node command_center.js
  • Data is now being sent off at regular intervals to Microsoft Azure!

2.10 View Your Command Center Application

Head back to your Node application and you will have a fully functional command center, complete with a history of sensor data, alerts that display when the temperature got outside a certain range, and commands that you can send to your device remotely.

Note: Make sure to stop your Command Center jobs once you have when you finish to avoid unnecessary Azure consumption! (See: Troubleshooting)

2.11 Next steps

Please visit our Azure IoT Dev Center for more samples and documentation on Azure IoT.

Troubleshooting

Stopping Provisioned Services

  • In the Microsoft Azure Portal
    • Click on "All Resources"
    • For each Stream Analytics and Web App resource:
      • Click on the resource and click the "Stop" button in the new blade that appears
    • For each IoT Hub resource:
      • Click on the resource and click the "Devices" button in the new blade that appears
      • Click on each device in the list and click the "Disable" button that appears in the new blade at the bottom

About

Get started with Intel Edison Azure IoT Starter Kit

Resources

Readme

License

MIT license
Activity

Stars

0 stars

Watchers

3 watching

Forks

1 fork
Report repository

Releases

No releases published

Packages

 
 
 

Languages

  • JavaScript 70.2%
  • HTML 29.8%