Skip to content

Latest commit

 

History

History
223 lines (138 loc) · 12.7 KB

AlarmClockREADME.md

File metadata and controls

223 lines (138 loc) · 12.7 KB
Raw

Smart Alarm Clock

Introduction

This smart alarm clock application is part of a series of how-to Intel® IoT code sample exercises using the Intel® IoT Developer Kit, Intel® Edison development platform, cloud platforms, APIs, and other technologies.

From this exercise, developers will learn how to:

  • Connect the Intel® Edison development platform, a computing platform designed for prototyping and producing IoT and wearable computing products.
  • Interface with the Intel® Edison platform IO and sensor repository using MRAA and UPM from the Intel® IoT Developer Kit, a complete hardware and software solution to help developers explore the IoT and implement innovative projects.
  • Run this code sample in Eclipse* IoT Edition, an IDE for creating new applications that interact with sensors, actuators, and so on, enabling you to get a quick start on developing software for your Intel® Edison or Galileo board.
  • Set up a web application server to set the alarm time and store this alarm data using Azure Redis Cache* from Microsoft* Azure*, cloud services for connecting IoT solutions including data analysis, machine learning, and a variety of productivity tools to simplify the process of connecting your sensors to the cloud and getting your IoT project up and running quickly.
  • Invoke the services of the Weather Underground* API for accessing weather data.

What It Is

Using an Intel® Edison board, this project lets you create a smart alarm clock that:

  • can be accessed with your mobile phone via the built-in web interface to set the alarm time;
  • displays live weather data on the LCD;
  • keeps track of how long it takes you to wake up each morning, using cloud-based data storage.

Hardware requirements

The "smart" alarm clock requires the following components from the Grove Starter Kit Plus:

  1. Intel® Edison with an Arduino* breakout board
  2. Grove* Rotary Analog Sensor
  3. Grove* Buzzer
  4. Grove* Button
  5. Grove* RGB LCD

Software requirements

  1. Eclipse* IoT Edition
  2. Microsoft* Azure* account
  3. Weather Underground* API key

How It Works

This "smart" alarm clock has a number of useful features.

  • Set the alarm time using a web page served directly from the Edison itself, using your mobile phone.
  • When the alarm goes off, the buzzer sounds, and the LCD display indicates its time to get up.
  • The rotary dial can be used to adjust the brightness of the display.
  • In addition, the smart alarm clock can access daily weather data via the Weather Underground API, and displays it on the LCD once you press the button when getting up.
  • Optionally, store how long it takes you to get up each day using the "Intel IoT Example Datastore" running on your own server, such as a Microsoft Azure or IBM Bluemix account.

How To Setup

To begin, clone the Intel IoT Examples with git on your computer:

$ git clone https://github.com/hybridgroup/intel-iot-examples.git

Not sure how to do that? Here is an excellent guide from Github on how to get started.

Adding The Code To Eclipse IoT

You use the Eclipse "Import Wizard" to import an existing project into the workspace as follows:

  • From the main menu bar, select "File > Import..."

  • The "Import wizard" dialog will open.

  • Select "General > Existing Project into Workspace" and click on the "Next" button.

  • Choose "Select root directory", then click on the associated "Browse" button to locate the directory that contains the project files.

  • Under "Projects" select the directory with the project files which you would like to import.

  • Click on the "Finish" button to import the files into Eclipse.

  • Your main .cpp program will now be in your workspace under the src folder.

Connecting The Grove Sensors

You will need to have the Grove Shield connected to the Arduino-compatible breakout board, in order to plug in all the various Grove devices into the Grove shield. Make sure you have the tiny VCC switch on the Grove Shield set to the "5V" position.

Plug one end of a Grove cable into the "Rotary Analog Sensor", then connect the other end to the "A0" port on the Grove Shield.

Connect one end of a Grove cable into the "Button", then plug the other end into the "D4" port on the Grove Shield.

Plug one end of a Grove cable into the "Buzzer", then connect the other end to the "D5" port on the Grove Shield.

Connect one end of a Grove cable into the "RGB LCD", then plug the other end into any of the "I2C" ports on the Grove Shield.

Intel Edison Setup

This example uses the crow web microframework library to provide a simple to use, yet powerful web server. The crow library requires the libboost package be installed on the Intel Edison, as well as adding the needed include and lib files to the Eclipse G++ Cross Compiler and G++ Cross Linker.

Update the opkg base feeds, so you can install the needed dependencies. Instructions on how to do this are located here: http://alextgalileo.altervista.org/edison-package-repo-configuration-instructions.html If you've already done this, you can skip to the next step.

Now, install the boost libraries onto the Edison, by running:

opkg update
opkg install boost-dev

Copy the Libraries

Next, you need to copy the libraries and include files from the Edison to your machine where you run Eclipse, so the G++ Cross Compiler and G++ Cross Linker can find them. The easiest way to do this is by running the scp command from your computer (NOT the Edison).

scp -r [email protected]:/usr/include/boost ~/Downloads/iotdk-ide-linux/devkit-x86/sysroots/i586-poky-linux/usr/include
scp [email protected]:/usr/lib/libboost* ~/Downloads/iotdk-ide-linux/devkit-x86/sysroots/i586-poky-linux/usr/lib

Change the [email protected] to match whatever username and IP address that you have set your Edison to.

Change ~/Downloads/iotdk-ide-linux to match the location on your machine where you have installed the Eclipse IoT Development Kit.

Copy the Libraries on Windows

  1. Download and install WinSCP https://winscp.net/eng/download.php
  2. Once WinSCP is installed run the application.

3. Under the "File Protocol" select SCP.

4. "Host Name" is your Edison ip address. "User Name" is root. Finally the "Password" is whatever you set it up as when you configured your Edison.

5. You will then come to a screen similar to the above image.

6. On this page you will need to move up a few directories until you are in the / directory.

7. Once you are in the correct directory then go to this directory from the root /usr/include/boost grab the folder and drag it to /Downloads/iotdk-ide-linux/devkit-x86/sysroots/i586-poky-linux/usr/include folder. (This file may not be in your downloads directory, in the example I have it on my desktop)

8. Once this process is finished you will need to move up in both directories to /usr/lib/ and grab all 36 files that start with "libboost*" respectively an move them to /Downloads/iotdk-ide-linux/devkit-x86/sysroots/i586-poky-linux/usr/lib.(This file may not be in your downloads directory, in the example I have it on my desktop)

  1. Once finished you may close the WinSCP application.

Note that you will need to have turned on SSH by running the configure_edison --password command on the Edison. Once you've set the password, make sure you write it down. You only need to do this one time and it will be set when you reboot your Edison.

This example also uses the restclient-cpp library to perform REST calls to the remote data server. The code for restclient-cpp can be found in the lib directory. The restclient-cpp library requires the libcurl package, which is already installed on the Intel Edison by default.

You will also want to set the current time zone to match the zone you are in. You do this using the timedatectl program on the Edison itself. For example:

timedatectl set-timezone America/Los_Angeles

Running The Code On Edison

When you're ready to run the example, you can click on the "Run" icon located in the menubar at the top of the Eclipse editor. This will compile the program using the Cross G++ Compiler, link it using the Cross G++ Linker, transfer the binary to the Edison, and then execute it on the Edison itself.

Weather Underground Data Setup

To optionally fetch the real-time weather information, you will need to get an API key from the Weather Underground web site at http://www.wunderground.com/weather/api/

You will not be able to retrieve weather conditions without obtaining a Weather Underground API key first. You can still run the example, just without the weather data.

To run the example with the optional weather data intefgration, you need to set the API_KEY environment variable. You can do this in Eclipse by:

  1. Select the "Run" menu and choose "Run Configurations". The "Run Configurations" dialog will be displayed.
  2. Click on "alarm-clock" under "C/C++ Remote Application". This will display the information for your application.
  3. Add the environment variables to the field for "Commands to execute before application" so it ends up looking like this, except using the API key that correspond to your own setup:
chmod 755 /tmp/alarm-clock; export API_KEY="YOURKEY"
  1. Click on the "Apply" button to save your new environment variables.

Now when you run your program using the "Run" button, it should be able to retrieve real-time weather data from the Edison.

Data Store Server Setup

You can optionally store the data generated by this example program in a backend database deployed using Node.js, and the Redis datastore. You use your own account on a hosted service such as Microsoft Azure or IBM Bluemix.

For information on how to setup your own cloud data server, go to:

https://github.com/hybridgroup/intel-iot-examples-datastore

Running The Example With The Cloud Server

To run the example with the optional backend datastore you need to set the SERVER and AUTH_TOKEN environment variables. You can do this in Eclipse by:

  1. Select the "Run" menu and choose "Run Configurations". The "Run Configurations" dialog will be displayed.
  2. Click on "doorbell" under "C/C++ Remote Application". This will display the information for the
  3. Add the environment variables to the field for "Commands to execute before application" so it ends up looking like this, except using the server and auth token that correspond to your own setup:
chmod 755 /tmp/alarm-clock;export API_KEY="YOURKEY"; export SERVER="http://intel-examples.azurewebsites.net/counter/logger/alarm-clock"; export AUTH_TOKEN="YOURTOKEN"
  1. Click on the "Apply" button to save your new environment variables.

Now when you run your program using the "Run" button, it should be able to call your server to save the data right from the Edison.

Running The Code On Edison

When you're ready to run the example, you can click on the "Run" icon located in the menubar at the top of the Eclipse editor. This will compile the program using the Cross G++ Compiler, link it using the Cross G++ Linker, transfer the binary to the Edison, and then execute it on the Edison itself.

After running the program you should have a similar output as in the image above.

When the program uploads to the Edison board your rgb lcd display will show the current time.

Regenerating the HTML and CSS

If you make any changes to either the index.html or styles.css files, you will need to regenerate the hex file used to serve up the assets on via the built-in Crow web server.

Setting The Alarm

The alarm is set using a single-page web interface served directly from the Intel® Edison board while the example program is running.

The web server runs on port 3000, so if the Intel® Edison board is connected to Wi-Fi* on 192.168.1.13, the address to browse to if you are on the same network is http://192.168.1.13:3000.