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 Intel® XDK IoT Edition, an IDE for creating applications that interact with sensors and actuators, enabling a quick start for developing software for the Intel® Edison or Intel® 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*, Redis Store* from IBM* Bluemix*, or ElastiCache* using Redis* from Amazon* Web Services* (AWS*), different 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.
- Set up a MQTT-based server using IoT Hub* from Microsoft* Azure*, IoT* from IBM* Bluemix*, or IoT* from Amazon* Web Services* (AWS*), different cloud machine to machine messaging services based on the industry standard MQTT protocol.
- Invoke the services of the Weather Underground* API for accessing weather data.
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.
This smart alarm clock has a number of useful features. Set the alarm using a web page served directly from the Intel® Edison board, using your mobile phone. When the alarm goes off, the buzzer sounds, and the LCD indicates it’s 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 use it to change the color of the LCD. Optionally, all data can also be stored using the Intel IoT Examples Datastore running in your own Microsoft* Azure*, IBM* Bluemix*, or AWS* account.
Grove* Starter Kit Plus containing:
- Intel® Edison with an Arduino* breakout board
- Grove* Rotary Analog Sensor
- Grove* Buzzer.
- Grove* Button
- Grove* RGB LCD
- Intel® XDK IoT Edition
- Microsoft* Azure*, IBM* Bluemix*, or AWS* account (optional)
- Weather Underground* API key (optional)
To begin, clone the How-To Intel IoT Code Samples repository with Git* on your computer as follows:
$ git clone https://github.com/intel-iot-devkit/how-to-code-samples.git
Want to download a .zip file? In your web browser, go to https://github.com/intel-iot-devkit/how-to-code-samples and click the Download ZIP button at the lower right. Once the .zip file is downloaded, uncompress it, and then use the files in the directory for this example.
In Intel® XDK IoT Edition, select Import Your Node.js Project:
On the New Project screen, click on the folder icon:
Then, navigate to the directory where the example project exists, and select it:
Choose a name for the project, then click on the Create button. Then click on the Continue button to finish creating your project:
You need to connect to your Intel® Edison board from your computer to send code to it.
Click the IoT Device menu at the bottom left. If your Intel® Edison is automatically recognized, select it.
Otherwise, select Add Manual Connection.
In the Address field, type 192.168.2.15
. In the Port field, type 58888
.
Click Connect to save your connection.
Alternatively, you can set up the code manually on the Intel® Edison board.
Clone the How-To Intel IoT Code Samples repository to your Intel® Edison board after you establish an SSH connection to it, as follows:
$ git clone https://github.com/intel-iot-devkit/how-to-code-samples.git
Then, navigate to the directory with this example.
To install Git* on Intel® Edison, if you don’t have it yet, establish an SSH connection to the board and run the following command:
$ opkg install git
You need to have a Grove* Shield connected to an Arduino*-compatible breakout board to plug all the Grove* devices into the Grove* Shield. Make sure you have the tiny VCC switch on the Grove* Shield set to 5V.
-
Plug one end of a Grove* cable into the Grove* Rotary Analog Sensor, and connect the other end to the A0 port on the Grove* Shield.
-
Plug one end of a Grove* cable into the Grove* Button, and connect the other end to the D4 port on the Grove* Shield.
-
Plug one end of a Grove* cable into the Grove* Buzzer, and connect the other end to the D5 port on the Grove* Shield.
-
Plug one end of a Grove* cable into the Grove* RGB LCD, and connect the other end to any of the I2C ports on the Grove* Shield.
If you're running this code on your Intel® Edison manually, you need to install some dependencies.
To obtain the Node.js* modules needed for this example to execute on Intel® Edison, run the following command:
npm install
To optionally fetch the real-time weather information, you need to get an API key from the Weather Underground* web site:
http://www.wunderground.com/weather/api
You cannot retrieve weather conditions without obtaining a Weather Underground* API key first. You can still run the example, but without the weather data.
Pass your Weather Underground* API key to the sample program by modifying the WEATHER_API_KEY
key in the config.json
file as follows:
{
WEATHER_API_KEY: "YOURAPIKEY"
}
Optionally, you can store the data generated by this sample program in a backend database deployed using Microsoft* Azure*, IBM* Bluemix*, or AWS*, along with Node.js*, and a Redis* data store.
For information on how to set up your own cloud data server, go to:
https://github.com/intel-iot-devkit/intel-iot-examples-datastore
You can also optionally store the data generated by this sample program using MQTT*, a machine-to-machine messaging server. You can use MQTT* to connect to Microsoft* Azure*, IBM* Bluemix*, or AWS*.
For information on how to connect to your own cloud MQTT* messaging server, go to:
https://github.com/intel-iot-devkit/intel-iot-examples-mqtt
To configure the example for the optional real-time weather data, obtain a key from the Weather Underground* web site as documented above, and then change the WEATHER_API_KEY
and LOCATION
keys in the config.json
file as follows:
{
"WEATHER_API_KEY": "YOURAPIKEY",
"LOCATION": "San_Francisco"
}
To configure the example for the optional Microsoft* Azure*, IBM* Bluemix*, or AWS* data store, change the SERVER
and AUTH_TOKEN
keys in the config.json
file as follows:
{
"SERVER": "http://intel-examples.azurewebsites.net/logger/alarm-clock",
"AUTH_TOKEN": "s3cr3t"
}
To configure the example for both the weather data, as well as either the Microsoft* Azure*, IBM* Bluemix*, or AWS* data store, change the WEATHER_API_KEY
, LOCATION
, SERVER
, and AUTH_TOKEN
keys in the config.json
file as follows:
{
"WEATHER_API_KEY": "YOURAPIKEY",
"LOCATION": "San_Francisco"
"SERVER": "http://intel-examples.azurewebsites.net/logger/alarm-clock",
"AUTH_TOKEN": "s3cr3t"
}
For information on how to configure the example for the optional Microsoft* Azure*, IBM* Bluemix*, or AWS* MQTT messaging server, go to:
https://github.com/intel-iot-devkit/intel-iot-examples-mqtt/
When you're ready to run the example, make sure you saved all the files.
Click the Upload icon to upload the files to the Intel® Edison board.
Click the Run icon at the bottom of Intel® XDK IoT Edition. This runs the code on Intel® Edison.
If you made changes to the code, click Upload and Run. This runs the latest code with your changes on Intel® Edison.
You will see output similar to the above when the program is running.
To run the example manually on Intel® Edison, establish an SSH connection to the board and execute the following command:
node index.js
The alarm is set using a single-page web interface served directly from the Intel® Edison board while the sample program is running.
The web server runs on port 3000
, so if Intel® Edison 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
.
You can determine what IP address Intel® Edison is connected to by running the following command:
ip addr show | grep wlan
You will see the output similar to the following:
3: wlan0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast qlen 1000
inet 192.168.1.13/24 brd 192.168.1.255 scope global wlan0
The IP address is shown next to inet
. In the example above, the IP address is 192.168.1.13
.