Difference between revisions of "OM2M/Developer"

Revision as of 12:53, 3 August 2014

Prerequisite

• Eclipse kepler IDE: available on this link: http://www.eclipse.org/kepler/
• OM2M source code: you can download OM2M from this link: http://wiki.eclipse.org/OM2M/Download
• Maven: It’s available on the the Eclipse Kepler IDE
• Tycho: Available on the marketplace of maven

Build OM2M from source: step by step

Download OM2M source code

• Select Windiow->Show View -> Other .
• In the dialog box, select the Git view.
• Click on “Clone a Git repository”.

Git clone

• Clone the OM2M project using the following link: http://git.eclipse.org/gitroot/om2m/org.eclipse.om2m.git. In the first page, enter the mentionned link in the URI’s location field. Click Next .
  

  Git clone

• In the second page, keep the “master” branch checkbox selected and click Next.

Git clone

• In the third page, check the “clone submodules” and “import all existing projects after clone finishes” checkboxes and click “Finish”.

Git clone

• The OM2M project is now cloned and is visible on the Git repositories’ and Package’ explorers.

Git clone

• Now we will add the required libraries. This step will be removed when all third libraries will be validated by Eclipse.
• Download the libraries from this link: http://wiki.eclipse.org/OM2M/Download
• Extract OM2M-libs and add the following libraries to "org.eclipse.om2m" repository as follows:
  • "db4o-core-java5-8.1-SNAPSHOT.jar" library under "org.eclipse.om2m.core\libs",
  • "obix.jar" library under "org.eclipse.om2m.commons\libs",
  • "xsd" folder under "org.eclipse.om2m.commons\src\main\resources".

Build OM2M using maven

• Before building the OM2M project, you need to add “Tycho” to Maven plugin. (Why? more details) To do so, click Window -> Preferences -> maven -> discovery -> open catalog and type Tycho. Check the “Tycho Configurator” checkbox.

Git clone

• Select “org.eclipse.om2m” package and right click. Select “Run as -> maven install”.
• Two Eclipse products will be generated after a successful built:
  • The NSCL product can be found on this directory: "om2m/org.eclipse.om2m/org.eclipse.om2m.site.nscl/target/products/nscl/<os>/<ws>/<arch>"
  • The GSCL product can be found on this directory: "om2m/org.eclipse.om2m/org.eclipse.om2m.site.gscl/target/products/gscl/<os>/<ws>/<arch>"

Develop your interworking proxy unit plug-in

We will start this section by demonstring how to create a plug-in in eclipse and associate it to the om2m platform. Then, we will implement the created plug-in, named "interworking proxy", by adding a MonitorSample class to simulate a sensor behavior and a ControllerSample class to manage a simulated actuator.

Create the interworking proxy unit plug-in

To create the interworking proxy plug-in, we will follow these steps:

• The plug-in project creation,
• The maven conversion,
• The addition of the created plug-in to a parent project,
• Enabling an automatic build,
• Including the created plug-in to om2m platform' product(s).

Step 1: The plug-in project creation

Create a new plug-in project called org.eclipse.om2m.sample.ipu via File → New → Other → Plug-in Project. Enter the data as depicted in the following screenshots.

create a plug-in project: step 1

create a plug-in project: step 2

Uncheck the Create a plug-in using one of the templates checkbook and press the Finish button.

create a plug-in project: step 3

As result the following project is created.

sample ipu plug-in

 Step 2: The maven conversion

Once the sample.ipu plug-in created, we will convert it to a maven project. Before that, we will open the build.properties file in XML and update the src attributes as depicted in the following figure.

build-properties build

Select the created org.eclipse.om2m.sample.ipu → right click → configure → maven to maven project. Enter the data as illustrated in the following.

Develop the monitor’ interworking unit plug-in

Develop the controller’ interworking unit plug-in

Test Scenario