API specification: Difference between revisions

From OneM2M-Hackathon-Dallas-2018
No edit summary
 
(25 intermediate revisions by the same user not shown)
Line 1: Line 1:
<div class="noautonum">__TOC__</div>
== Demonstration high level architecture  ==
[[File:Diagram.png]]
==  Prerequisites ==
The following tools are required to run this demonstration.
*JAVA 1.8
*Arduino IDE 1.8.5
*NodeJS
==  Download the project ==
Download the oneM2M demo project from Github from the following link:
https://github.com/mbenalaya
The project contains the following folders:
*onem2m-platform
*onem2m-device
*onem2m-app
== Start oneM2M platform instance==
__TOC__
__TOC__
The oneM2M platform is available on folder “oneM2M Platform”
===Configure the platform===
You can keep the default configuration for a local demonstration. The platform will listen on ports 8080 and 8443. The database is reset after each restart.
If needed, you can change the configuration of the platform by editing the file “configuration/config.ini”.
===Start the platform===
Start the platform by executing the "start.bat" script on Windows or "start.sh" on Linux and Mac OS.
[[File:Console.png]]
===Login to oneM2M web interface===
Open the following URL in your browser to access the oneM2M platform web interface:
https://127.0.0.1:8080/webpage
[[File:Login.png]]
Enter "Cae-admin" as originator then click on “connect”.
[[File:Resource-tree.png]]
==Connect your IoT Device==
The arduino source code and required libraries are available on the folder onem2m-device.
===Schematics===
*Breadboard
*Nodemcu board
*LED
*Luminosity Sensor
*1Kohm resistance
Connect the LED and luminosity sensor to the Nodemcu board using:
[[File:Board-plan.png]]
Real wiring:
[[File:Real-wiring.jpg]]
===Download and install arduino IDE===
Download and install the Arduino IDE v1.8.5 from the following link:
https://www.arduino.cc/en/Main/Software
NB: We don’t recommend to use the Arduino Web Editor for this demonstration because the nodemcu board is not supported.
===Add Nodemcu board to Arduino IDE===
Firstly open the Arduino IDE
Go to files and click on the preference in the Arduino IDE
[[File:Arduino-ide.png]]
copy the below code in the Additional boards Manager
http://arduino.esp8266.com/stable/package_esp8266com_index.json
click OK to close the preference Tab.
After completing the above steps , go to Tools and board, and then select board Manager
[[File:Arduino-ide2.png]]
Navigate to esp8266 by esp8266 community and install the software for Arduino.
[[File:Arduino-ide3.png]]
Once all the above process been completed you are ready to program the nodemcu board with Arduino IDE.
===Add Arduino “Timer.h” library===
The “Timer.h” library is available on the zip folder “Timer-master.zip”.
Go to Sketch, and then select “include library”.
Chose the “Add .ZIP library” option
[[File:Arduino-ide4.png]]
Select the zip folder “Timer-master.zip” then confirm.
NB: You don’t have to extract the zip content.


== Venue ==
===Configure the oneM2M sketch===
Open the sketch “onem2m-adn.ino” in your Arduino IDE.


9-10 March 2018
Set your WIFI parameters
The University of Texas at Dallas
*const char* ssid = "XXXXXXXX";
T1 Auditorium
*const char* password = "XXXXXXXX";
800 W Campbell Rd
Richardson, TX 75080


[[Media: premises map at UTD.pdf | premises map at UTD (TBD) ]]
Set the IP address of the oneM2M platform
*const char* host = "XXXXXXXX";


== 1. Demonstration high level architecture  ==


[[File:Diagram.png]]
===Compile the oneM2M sketch===
 
 
Click on verify button [[File:Button1.png]] to compile the sketch.
 
 
Compilation output:
 
[[File:Compiliation.png]]
 
 
===Upload the oneM2M sketch to Nodemcu board.===
 
 
 
 
Click on upload button [[File:Button2.png]] to upload the sketch to the nodemcu board .
 
 
Upload output:
 
[[File:Compiliation2.png]]
 
 
===Debug the code execution using serial monitor===
 
Cick on [[File:Button3.png]] button to open the Arduino Serial Monitor to display the Nodemcu console.
 
 
Then after opening the Serial Monitor select 115200 from the drop-down list.
 
[[File:Monitor.png]]
 
 
===Check IoT device resources on oneM2M web interface===
You should see “mydevice1” Application Entity resource with “luminosity” an “led” containers created on the oneM2M resource tree.


== Eclipse OM2M open source project ==
[[File:Resource-tree2.png]]
Eclipse OM2M offers a full open source implementation of the oneM2M standard. It supports all types of interfaces and nodes defined in the standard including “Infrastructure Node”, “Middle Node”, “Application Service Node” and “Application Dedicated Node”.  Each node may host a set of applications and a Common Service Entity including capabilities for communication protocol bindings, device interworking, management, security, etc. Eclipse OM2M relies on a modular architecture, designed on top of a protocol-independent kernel, running on top of an OSGi layer and is highly extensible via plugins which make a promising candidate for integration and experimentation.
http://www.eclipse.org/om2m/




==Connect your IoT application==
The luminosity monitoring application source code is available on the folder onem2m-app


== Target audience ==
===Configure application===
The audience targeted by this tutorial includes software architects and developers as well as academic and industrial researchers, and PhD students who can benefit from the different parts of the tutorial including the theoretical as well as the technical aspects related to IoT standards.
Open the file onem2m-monitor.js with a text editor.


Set the IP address of the oneM2M platform. You can keep localhost if you are running the oneM2M platform and the application in the same machine.


== Outline of the tutorial ==
===Start the application===


The tutorial will be structured in two main parts. In the first part, we will develop the foundations and the technical background that will be useful for the attendees for getting started with the oneM2M common architecture’s main concepts, features and interfaces. In the second part, we will conduct the technical learning part. This will consist of interactive training that will address the different issues necessary for developers. This includes understanding and manipulating the oneM2M API for developing applications and integrating devices on top of the Eclipse OM2M platform.
Start the nodejs oneM2M application using the following command:
> node onem2m-monitor.js


'''The structure of the tutorial is the following:'''
[[File:Console2.png]]


* Technical Presentations
** IoT, Vision and Challenges
** oneM2M Common Architecture for IoT
** Eclipse OM2M, Open Source oneM2M-based Platform


* Demonstrations and API manipulations
===Check IoT application resource on oneM2M web interface===
** Hands-on oneM2M, development of your IoT Applications
** Interworking with legacy and vendor-specific technologies
** Towards Semantic IoT, oneM2M Base Ontology


You should see “mymonitor1” Application Entity resource created on the oneM2M resource tree.


[[File:Resource-tree3.png]]




== Hackathon Agenda ==
==Demonstration==


* Day #1 (9 March 2018) - presentations; tutorials; hackathon rules
If you hide the luminosity sensor with your hand for few seconds, you should see the led switched ON by the monitoring application and vice versa.
**Friday morning
***Introductions
***IoT, Vision and Challenges
***Tutorial on oneM2M
****oneM2M Common Architecture for IoT
****Open source (Eclipse OM2M) introduction
****Example of projects using HW provided
**Friday afternoon
***Form teams
***Per team, select one of the challenges to be solved. The solution must use the oneM2M architecture.
***Additional requirements may be specified.
****Each project to use the HW provided.
****Requirement to use the oneM2M service platform.
****Application to be created for PC, web or mobile (IOS, Android).
***The teams develop their projects on Friday evening after dinner until 21:00.


* Day #2 (10 March 2018) - hackathon team work; awards and certificates
[[File:Final-result.png]]
**Saturday morning
***The teams develop and finalize their projects.
**Saturday afternoon
***Presentation of each project
***Projects are reviewed by the jury during coffee break
***Awards

Latest revision as of 11:56, 2 March 2018

Demonstration high level architecture

Diagram.png


Prerequisites

The following tools are required to run this demonstration.

  • JAVA 1.8
  • Arduino IDE 1.8.5
  • NodeJS


Download the project

Download the oneM2M demo project from Github from the following link:

https://github.com/mbenalaya

The project contains the following folders:

  • onem2m-platform
  • onem2m-device
  • onem2m-app


Start oneM2M platform instance

The oneM2M platform is available on folder “oneM2M Platform”

Configure the platform

You can keep the default configuration for a local demonstration. The platform will listen on ports 8080 and 8443. The database is reset after each restart.

If needed, you can change the configuration of the platform by editing the file “configuration/config.ini”.

Start the platform

Start the platform by executing the "start.bat" script on Windows or "start.sh" on Linux and Mac OS.

Console.png


Login to oneM2M web interface

Open the following URL in your browser to access the oneM2M platform web interface: https://127.0.0.1:8080/webpage

Login.png


Enter "Cae-admin" as originator then click on “connect”.

Resource-tree.png


Connect your IoT Device

The arduino source code and required libraries are available on the folder onem2m-device.

Schematics

  • Breadboard
  • Nodemcu board
  • LED
  • Luminosity Sensor
  • 1Kohm resistance

Connect the LED and luminosity sensor to the Nodemcu board using:

Board-plan.png


Real wiring:

Real-wiring.jpg

Download and install arduino IDE

Download and install the Arduino IDE v1.8.5 from the following link: https://www.arduino.cc/en/Main/Software

NB: We don’t recommend to use the Arduino Web Editor for this demonstration because the nodemcu board is not supported.


Add Nodemcu board to Arduino IDE

Firstly open the Arduino IDE Go to files and click on the preference in the Arduino IDE

Arduino-ide.png


copy the below code in the Additional boards Manager

http://arduino.esp8266.com/stable/package_esp8266com_index.json

click OK to close the preference Tab.

After completing the above steps , go to Tools and board, and then select board Manager

Arduino-ide2.png


Navigate to esp8266 by esp8266 community and install the software for Arduino.

Arduino-ide3.png


Once all the above process been completed you are ready to program the nodemcu board with Arduino IDE.

Add Arduino “Timer.h” library

The “Timer.h” library is available on the zip folder “Timer-master.zip”.

Go to Sketch, and then select “include library”. Chose the “Add .ZIP library” option


Arduino-ide4.png


Select the zip folder “Timer-master.zip” then confirm. NB: You don’t have to extract the zip content.

Configure the oneM2M sketch

Open the sketch “onem2m-adn.ino” in your Arduino IDE.

Set your WIFI parameters

  • const char* ssid = "XXXXXXXX";
  • const char* password = "XXXXXXXX";

Set the IP address of the oneM2M platform

  • const char* host = "XXXXXXXX";


Compile the oneM2M sketch

Click on verify button Button1.png to compile the sketch.


Compilation output:

Compiliation.png


Upload the oneM2M sketch to Nodemcu board.

Click on upload button Button2.png to upload the sketch to the nodemcu board .


Upload output:

Compiliation2.png


Debug the code execution using serial monitor

Cick on Button3.png button to open the Arduino Serial Monitor to display the Nodemcu console.


Then after opening the Serial Monitor select 115200 from the drop-down list.

Monitor.png


Check IoT device resources on oneM2M web interface

You should see “mydevice1” Application Entity resource with “luminosity” an “led” containers created on the oneM2M resource tree.

Resource-tree2.png


Connect your IoT application

The luminosity monitoring application source code is available on the folder onem2m-app

Configure application

Open the file onem2m-monitor.js with a text editor.

Set the IP address of the oneM2M platform. You can keep localhost if you are running the oneM2M platform and the application in the same machine.

Start the application

Start the nodejs oneM2M application using the following command: > node onem2m-monitor.js

Console2.png


Check IoT application resource on oneM2M web interface

You should see “mymonitor1” Application Entity resource created on the oneM2M resource tree.

Resource-tree3.png


Demonstration

If you hide the luminosity sensor with your hand for few seconds, you should see the led switched ON by the monitoring application and vice versa.

Final-result.png

Retrieved from "https://wiki.plugtests.net/oneM2M-Hackathon-Dallas-2018/index.php?title=API_specification&oldid=105"