Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "OM2M/Developer"

(→‎Build OM2M from source using Eclipse)
(Edit link at the first line, was redirecting to Download page and not to Clone and build)
 
(55 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
'''Before doing this tutorial you have to''' [https://wiki.eclipse.org/OM2M/Clone clone and build OM2M using Eclipse]
 +
 
__TOC__
 
__TOC__
  
−
== Prerequisite ==
+
=Add a new plug-in to  OM2M=
−
* Eclipse kepler (for RCP and RAP Developers).
+
−
* To build the OM2M project into Eclipse, a Tycho m2e connector is needed. Installation of m2e connectors is accomplished as follows: click Window -> Preferences -> maven -> discovery -> open catalog  and type Tycho. Check the “Tycho Configurator” checkbox.
+
−
[[File:git_clone5bis.png|thumb|center|600px|Git clone]]
+
−
 
+
−
== Build OM2M from source using Eclipse ==
+
−
'''Clone The OM2M project'''
+
−
* Select Windiow->Show View -> Other .
+
−
* In the dialog box, select the Git view.
+
−
* Click on “Clone a Git repository”.
+
−
[[File:Git_clone.png|thumb|center|350px|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 mentioned link in the URI’s location field. Click Next .[[File:git_clonebis.png|thumb|center|600px|Git clone]]
+
−
 
+
−
* In the second page, keep the “master” branch checkbox selected and click Next.
+
−
[[File:git_clone2bis.png|thumb|center|600px|Git clone]]
+
−
 
+
−
* In the third page, check the “import all existing projects after clone finishes” and click “Finish”.
+
−
[[File:git_clone3bis2.png|thumb|center|600px|Git clone]]
+
−
 
+
−
* The OM2M project is now cloned and is visible on the Git repositories’ and Package’ explorers.
+
−
 
+
−
* 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'''
+
−
 
+
−
* 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 a new plug-in ==
+
== Clone and import OM2M  ==
 +
* Clone OM2M using the Eclipse IDE.
 +
* Import all nested projects into your workspace.
  
−
=== Create a new plug-in project ===
+
== Create a new plug-in project ==
  
 
*Create a new plug-in project called org.eclipse.om2m.sample.ipu via File → New → Other → Plug-in Project.
 
*Create a new plug-in project called org.eclipse.om2m.sample.ipu via File → New → Other → Plug-in Project.
Line 53: Line 23:
 
[[File:ipu4.png|thumb|center|600px|sample ipu plug-in]]
 
[[File:ipu4.png|thumb|center|600px|sample ipu plug-in]]
  
−
=== Convert the plugin into maven project ===
+
== Convert the plugin into maven project ==
  
 
*Open the build.properties file in XML and update the src attributes as depicted in the following figure.  
 
*Open the build.properties file in XML and update the src attributes as depicted in the following figure.  
Line 67: Line 37:
 
[[File:pom_edition.png|thumb|center|600px|maven conversion: Parent edition]]
 
[[File:pom_edition.png|thumb|center|600px|maven conversion: Parent edition]]
  
−
*We end this step by updating the plug-inf project. For this, select the "org.eclipse.om2m.sample.ipu" project → maven → update project.
+
*We end this step by updating the plug-in project. For this, select the "org.eclipse.om2m.sample.ipu" project → maven → update project.
  
−
=== Add the plugin as a maven module to the OM2M parent project ===
+
== Add the plugin as a maven module to the OM2M parent project ==
  
 
* In this part, we will add the created plug-in as a module to the om2m platform:
 
* In this part, we will add the created plug-in as a module to the om2m platform:
Line 89: Line 59:
 
</pre>
 
</pre>
  
−
=== Add the plugin to the OM2M product(s) ===
+
== Add the plugin to the OM2M product(s) ==
  
 
*The final step consists of adding the created plug-in to one of om2m platform products, i.e the ''gscl'' or the ''nscl'' executable. In the following, we choose to add the org.eclipse.om2m.sample.ipu plug-in to the gscl product:
 
*The final step consists of adding the created plug-in to one of om2m platform products, i.e the ''gscl'' or the ''nscl'' executable. In the following, we choose to add the org.eclipse.om2m.sample.ipu plug-in to the gscl product:
Line 99: Line 69:
 
* To check that the "org.eclipse.om2m.sample.ipu" was successfully added to the gscl product, run the gscl and verify in the console if the "org.eclipse.om2m.sample.ipu" is displayed.
 
* To check that the "org.eclipse.om2m.sample.ipu" was successfully added to the gscl product, run the gscl and verify in the console if the "org.eclipse.om2m.sample.ipu" is displayed.
 
[[File:run.png|thumb|center|600px|gscl product]]
 
[[File:run.png|thumb|center|600px|gscl product]]
 +
== Add required dependencies ==
 +
=== Add plugin dependencies ===
 +
* Open the manifest file of the created plugin and select Dependencies tab.
 +
* Add the dependencies depicted in the following figure.
 +
'''Important!''' You need to import om2m nested projects into your workspace to find them in the list below.
 +
[[File:DependenciesPlugin.png|thumb|center|700px|plugin dependencies]]
  
−
=== The IPU Monitor ===
+
=== Add jar dependencies (Only if required) ===
−
==== The Sensor class ====
+
If you want to add specific jar libraries to your plugin, you can follow these steps:
 +
* Create a "libs" folder on your plugin project.
 +
* Put required specific jar on the "libs" folder.
 +
* Open the manifest file of the created plugin and select "runtime" tab.
 +
* Go to the "classpath" tab and click on the "Add" button.
 +
* Select the required jar and click on "ok" button.
 +
[[File:jars.png|thumb|center|800px|plugin specific jar dependencies]]
  
−
* The sensor class allows us to manage a sensor by recovering its description, and its state.
+
= Develop an Interworking Proxy Unit (IPU) plugin =
 +
== IPU Activator ==
 +
 
 +
* The Activator class contains the implementation of the start() and stop() method used to activate and deactivate the IPU plugin.
 +
* In the start() method, the Activator registers the IPU Controller service on the registry to make it available for the CORE plugin. Then, it starts tracking the CORE SCL service to use it once it the CORE plugin is activated.
 +
* In the Stop() method, the Activator can execute some process to make a clean before deactivation such as stopping threads, handle exceptions, etc.
  
 
<source lang="java">
 
<source lang="java">
 
package org.eclipse.om2m.sample.ipu;
 
package org.eclipse.om2m.sample.ipu;
  
−
import obix.Contract;
+
import org.apache.commons.logging.Log;
−
import obix.Obj;
+
import org.apache.commons.logging.LogFactory;
−
import obix.Op;
+
import org.eclipse.om2m.core.service.SclService;
−
import obix.Str;
+
import org.eclipse.om2m.ipu.service.IpuService;
−
import obix.Uri;
+
import org.osgi.framework.BundleActivator;
−
import obix.io.ObixEncoder;
+
import org.osgi.framework.BundleContext;
 +
import org.osgi.framework.ServiceReference;
 +
import org.osgi.util.tracker.ServiceTracker;
  
−
public class Sensor {
+
public class Activator implements BundleActivator {
−
+
private static Log logger = LogFactory.getLog(Activator.class);
−
/** sensor state */
+
private ServiceTracker<Object, Object> sclServiceTracker;
−
    private static int state;
+
−
+
−
/**
+
−
    * Returns an obix XML representation describing the lamp.
+
−
    * @param sclId - SclBase id
+
−
    * @param appId - Application Id
+
−
    * @param stateCont - the STATE container id
+
−
    * @return Obix XML representation
+
−
    */
+
−
    public static String getDescriptorRep(String sclId, String appId, String stateCont, String aPoCPath) {
+
  
−
         // oBIX
+
         // Activate the plugin
−
        Obj obj = new Obj();
+
public void start(BundleContext context) throws Exception {
−
        obj.add(new Str("type", "Sensor"));
+
logger.info("IPU started");
−
        obj.add(new Str("location","Home"));
+
               
−
        obj.add(new Str("appId",appId));
+
                 // Register the IPU Controller service
−
        // OP GetState from SCL DataBase
+
logger.info("Register IpuService..");
−
        Op opState = new Op();
+
context.registerService(IpuService.class.getName(), new Controller(), null);
−
        opState.setName("getState");
+
logger.info("IpuService is registered.");
−
        opState.setHref(new Uri(sclId+"/"+"applications/"+appId+"/containers/"+stateCont+
+
−
                 "/contentInstances/latest/content"));
+
−
        opState.setIs(new Contract("retrieve"));
+
−
        opState.setIn(new Contract("obix:Nil"));
+
−
        opState.setOut(new Contract("obix:Nil"));
+
−
        obj.add(opState);
+
−
        // OP GetState from SCL IPU
+
−
        Op opStateDirect = new Op();
+
−
        opStateDirect.setName("getState(Direct)");
+
−
        opStateDirect.setHref(new Uri(sclId+"/"+"applications/"+appId+"/"+aPoCPath));
+
−
        opStateDirect.setIs(new Contract("retrieve"));
+
−
        opStateDirect.setIn(new Contract("obix:Nil"));
+
−
        opStateDirect.setOut(new Contract("obix:Nil"));
+
−
        obj.add(opStateDirect);
+
  
−
        return ObixEncoder.toString(obj);
+
                // Track the CORE SCL service
−
    }
+
sclServiceTracker = new ServiceTracker<Object, Object>(context,
−
 
+
SclService.class.getName(), null) {
−
    /**
+
public void removedService(ServiceReference<Object> reference, Object service) {
−
    * Returns an obix XML representation describing the current state.
+
logger.info("SclService removed");
−
    * @param appId - Application Id
+
}
−
    * @param value - current sensor state
+
−
    * @return Obix XML representation
+
−
    */
+
−
   
+
−
    public static String getStateRep(String appId, int value) {
+
−
        // oBIX
+
−
        Obj obj = new Obj();
+
−
        obj.add(new Str("type","sensor"));
+
−
        obj.add(new Str("location","Home"));
+
−
        obj.add(new Str("appId",appId));
+
−
        String strValue = Integer.toString(value);
+
−
        obj.add(new Str("state",strValue));
+
−
        return ObixEncoder.toString(obj);
+
−
 
+
−
    }
+
−
   
+
−
    /**
+
−
    * Gets SensorState
+
−
    * @return SensorState
+
−
    */
+
−
    public static void setState(int state) {
+
−
    int Value = 10 + (int)(Math.random()*100);
+
−
        Sensor.state = Value;
+
−
    }
+
  
 +
public Object addingService(ServiceReference<Object> reference) {
 +
logger.info("SclService discovered");
 +
SclService sclService = (SclService) this.context.getService(reference);
 +
final Monitor IpuMonitor = new Monitor(sclService);
 +
new Thread() {
 +
public void run() {
 +
try {
 +
IpuMonitor.start();
 +
} catch (Exception e) {
 +
logger.error("IpuMonitor error", e);
 +
}
 +
}
 +
}.start();
 +
return sclService;
 +
}
 +
};
 +
sclServiceTracker.open();
 +
}
 +
       
 +
        // Deactivate the plugin
 +
public void stop(BundleContext context) throws Exception {
 +
logger.info("IPU stopped");
 +
}
 
}
 
}
 +
 
</source>
 
</source>
  
−
==== The Actuator class ====
+
== IPU Monitor ==
  
−
* In this tutorial, we take a lamp as an actuator. Let's consider the following Lamp class which is dedicated to handle the information and state.
+
* The Monitor class creates one sensor application called "MY_SENSOR", and one actuator application called "MY_ACTUATOR". It creates two containers for each application: "DESCRIPTOR" container to store the description and "DATA" container to store the measurements. For each container the right oBIX XML payload is created as contentInstance.
 +
 
 +
* The Monitor starts two threads to listen to each application data as well. Once a new data is detected, the Monitor creates a new contentInstance including the measurement representation.
  
 
<source lang="java">
 
<source lang="java">
 
package org.eclipse.om2m.sample.ipu;
 
package org.eclipse.om2m.sample.ipu;
  
−
import obix.*;
+
import org.eclipse.om2m.commons.resource.*;
−
import obix.io.ObixEncoder;
+
import org.eclipse.om2m.commons.rest.*;
−
 
+
import org.eclipse.om2m.core.service.SclService;
−
public class Lamp {
+
−
/** Lamp state */
+
−
    private static boolean state = false;
+
  
−
+
public class Monitor {
−
/**
+
static SclService core;
−
    * Returns an obix XML representation describing the current state.
+
static String sclId = System.getProperty("org.eclipse.om2m.sclBaseId", "");
−
    * @param appId - Application Id
+
static String reqEntity = System.getProperty("org.eclipse.om2m.adminRequestingEntity", "");
−
    * @param value - current lamp state
+
static String ipuId = "sample";
−
    * @return Obix XML representation
+
static String actuatorId = "MY_ACTUATOR";
−
    */
+
static String sensorId = "MY_SENSOR";
−
+
static boolean actuatorValue = false;
−
public static String getStateRep(String appId, boolean initValue) {
+
static int sensorValue = 0;
−
// oBIX
+
          
−
        Obj obj = new Obj();
+
public Monitor(SclService sclService) {
−
        obj.add(new Str("type","LAMP"));
+
core = sclService;
−
        obj.add(new Str("location","Kitchen"));
+
−
        obj.add(new Str("appId",appId));
+
−
        obj.add(new Bool("state",initValue));
+
−
         return ObixEncoder.toString(obj);
+
 
}
 
}
−
 
−
public static String getDescriptorRep(String sclId, String appId, String stateCont, String aPoCPath) {
 
−
        // oBIX
 
−
        Obj obj = new Obj();
 
−
        obj.add(new Str("type", "LAMP"));
 
−
        obj.add(new Str("location","Home"));
 
−
        obj.add(new Str("appId",appId));
 
−
        // OP GetState from SCL DataBase
 
−
        Op opState = new Op();
 
−
        opState.setName("getState");
 
−
        opState.setHref(new Uri(sclId+"/"+"applications/"+appId+"/containers/"+stateCont+
 
−
                  "/contentInstances/latest/content"));
 
−
        opState.setIs(new Contract("retrieve"));
 
−
        opState.setIn(new Contract("obix:Nil"));
 
−
        opState.setOut(new Contract("obix:Nil"));
 
−
        obj.add(opState);
 
−
        // OP GetState from SCL IPU
 
−
        Op opStateDirect = new Op();
 
−
        opStateDirect.setName("getState(Direct)");
 
−
        opStateDirect.setHref(new Uri(sclId+"/"+"applications/"+appId+"/"+aPoCPath));
 
−
        opStateDirect.setIs(new Contract("retrieve"));
 
−
        opStateDirect.setIn(new Contract("obix:Nil"));
 
−
        opStateDirect.setOut(new Contract("obix:Nil"));
 
−
        obj.add(opStateDirect);
 
  
−
        return ObixEncoder.toString(obj);
+
public void start() {
−
    }
+
                // Create required resources for the Sensor
−
+
createSensorResources();
−
/**
+
                // Listen for the Sensor data
−
    * Gets lampState
+
listenToSensor();
−
    * @return lampState
+
−
    */
+
−
    public static boolean getState(String lampId) {
+
−
        return state;
+
−
    }
+
  
−
    /**
+
                // Create required resources for the Actuator
−
    * Sets lampState
+
createActuatorResources();
−
    */
+
                // Listen for the Actuator data
−
    public static void setState(boolean state) {
+
listenToActuator();
−
        Lamp.state = state;
+
}
−
    }
+
  
−
}
+
public void createSensorResources() {
−
</source>
+
String targetId, content;
 +
               
 +
                // Create the MY_SENSOR application
 +
targetId = sclId + "/applications";
 +
ResponseConfirm response = core
 +
.doRequest(new RequestIndication("CREATE", targetId, reqEntity,
 +
new Application(sensorId, ipuId)));
  
−
==== The IPU Monitor class ====
+
if (response.getStatusCode().equals(StatusCode.STATUS_CREATED)) {
 +
                        // Create the "DESCRIPTOR" container
 +
targetId = sclId + "/applications/" + sensorId + "/containers";
 +
core.doRequest(new RequestIndication("CREATE", targetId, reqEntity,
 +
new Container("DESCRIPTOR")));
 +
               
 +
                        // Create the "DATA" container
 +
core.doRequest(new RequestIndication("CREATE", targetId, reqEntity,
 +
new Container("DATA")));
  
−
* In the following, we give a snippet of the IpuMonitor class which perform the creation of the required M2M resources on the gscl resource tree to enable simulated M2M devices monitoring.  
+
                        // Create the description contentInstance
 +
content = Mapper.getSensorDescriptorRep(sclId, sensorId, ipuId);
 +
targetId = sclId + "/applications/" + sensorId
 +
+ "/containers/DESCRIPTOR/contentInstances";
 +
core.doRequest(new RequestIndication("CREATE", targetId, reqEntity,
 +
new ContentInstance(content.getBytes())));
 +
                       
 +
                        // Create the data contentInstance
 +
content = Mapper.getSensorDataRep(sensorValue);
 +
targetId = sclId + "/applications/" + sensorId
 +
+ "/containers/DATA/contentInstances";
 +
core.doRequest(new RequestIndication("CREATE", targetId, reqEntity,
 +
new ContentInstance(content.getBytes())));
 +
}
 +
}
  
−
* The org.eclipse.om2m.sample.ipu.IpuMonitor class locally triggers the SCLService.doRequest method to create applications, containers, and contentInstances resources on the gateway. In this tutorial, we create ''sensor_0'' and ''lamp_0'' application and each one has two containers: ''Descriptor'' to store the lamp/ sensor description and ''Data'' to store lamp/ senor measured values.
+
public void createActuatorResources() {
 +
String targetId, content;
 +
               
 +
                // Create the "MY_ACTUATOR" application
 +
targetId = sclId + "/applications";
 +
ResponseConfirm response = core.doRequest(new RequestIndication(
 +
"CREATE", targetId, reqEntity, new Application(actuatorId,ipuId)));
  
−
* We simulate a sensor that sends data every two seconds. This is performed by creating a new sensor_0 Data' contentInstance for each publication.  
+
if (response.getStatusCode().equals(StatusCode.STATUS_CREATED)) {
 +
                        // Create the "DESCRIPTOR" container
 +
targetId = sclId + "/applications/" + actuatorId + "/containers";
 +
core.doRequest(new RequestIndication("CREATE", targetId, reqEntity,
 +
new Container("DESCRIPTOR")));
  
−
*You notice that when creating a contentInstance of a Desccriptor/ Data Container we use getDescriptorRep getSateRep methods of the Sensor/ Lamp classes described above.
+
                        // Create the "DATA" container
−
----
+
core.doRequest(new RequestIndication("CREATE", targetId, reqEntity,
 +
new Container("DATA")));
  
−
<source lang="java">
+
                        // Create the description contentInstance
−
package org.eclipse.om2m.sample.ipu;
+
content = Mapper.getActutaorDescriptorRep(sclId, actuatorId, ipuId);
 +
targetId = sclId + "/applications/" + actuatorId
 +
+ "/containers/DESCRIPTOR/contentInstances";
 +
core.doRequest(new RequestIndication("CREATE", targetId, reqEntity,
 +
content));
  
−
import obix.*;
+
                        // Create the data contentInstance
−
import obix.io.ObixEncoder;
+
content = Mapper.getActuatorDataRep(actuatorValue);
 +
targetId = sclId + "/applications/" + actuatorId
 +
+ "/containers/DATA/contentInstances";
 +
core.doRequest(new RequestIndication("CREATE", targetId, reqEntity,
 +
content));
 +
}
 +
}
  
−
import org.apache.commons.logging.Log;
+
public void listenToSensor() {
−
import org.apache.commons.logging.LogFactory;
+
new Thread() {
−
import org.eclipse.om2m.commons.resource.Application;
+
public void run() {
−
import org.eclipse.om2m.commons.resource.ContentInstance;
+
while (true) {
−
import org.eclipse.om2m.commons.resource.StatusCode;
+
                                        // Simualte a random measurement of the sensor
−
import org.eclipse.om2m.commons.resource.Container;
+
sensorValue = 10 + (int) (Math.random() * 100);
−
import org.eclipse.om2m.commons.rest.RequestIndication;
+
−
import org.eclipse.om2m.commons.rest.ResponseConfirm;
+
−
import org.eclipse.om2m.core.service.SclService;
+
  
 +
                                        // Create a data contentInstance
 +
String content = Mapper.getSensorDataRep(sensorValue);
 +
String targetID = sclId + "/applications/" + sensorId
 +
+ "/containers/DATA/contentInstances";
 +
core.doRequest(new RequestIndication("CREATE", targetID,reqEntity,
 +
content));
  
−
public class IpuMonitor {
+
                                        // Wait for 2 seconds then loop
−
/** Logger */
+
try {
−
    private static Log LOGGER = LogFactory.getLog(IpuMonitor.class);
+
Thread.sleep(2000);
−
    /** Sclbase id */
+
} catch (InterruptedException e) {
−
    public final static String SCLID = System.getProperty("org.eclipse.om2m.sclBaseId","");
+
e.printStackTrace();
−
    /** Admin requesting entity */
+
}
−
    static String REQENTITY = System.getProperty("org.eclipse.om2m.adminRequestingEntity","");
+
}
−
    /** Generic create method name */
+
}
−
    public final static String METHOD_CREATE = "CREATE";
+
}.start();
−
    /** Generic execute method name */
+
}
−
    public final static String METHOD_EXECUTE = "EXECUTE";
+
−
    /** State container id */
+
−
    public final static String DATA = "DATA";
+
−
    /** Descriptor container id */
+
−
    public final static String DESC = "DESCRIPTOR";
+
−
    /** Discovered SCL service*/
+
−
    static SclService SCL;
+
−
    public final static String APOCPATH = "ipu";
+
−
    /**
+
−
    * Constructor
+
−
    * @param scl - discovered SCL
+
−
    */
+
−
   
+
−
    public IpuMonitor(SclService scl) {
+
−
        SCL=scl;
+
−
    }
+
−
   
+
−
    public void start () {
+
−
+
−
// Create initial resources for the sensor
+
−
        createLampResources("lamp_0", false, APOCPATH);
+
  
−
        // Create initial resources for the sensor
+
public void listenToActuator() {
−
        createSensorResources("sensor_0", APOCPATH);
+
new Thread() {
 +
public void run() {
  
−
} 
+
boolean memorizedActuatorValue = false;
−
    /**
+
while (true) {
−
    * Creates all required resources.
+
                                        // If the Actuator state has changed
−
    * @param appId - Application ID
+
if (memorizedActuatorValue != actuatorValue) {
−
    * @param aPoCPath - sensor aPocPath
+
                                                // Memorize the new Actuator state
−
    */
+
memorizedActuatorValue = actuatorValue;
−
 
+
−
public void createSensorResources(String appId, String aPoCPath) {
+
−
        // Create the Application resource
+
−
        ResponseConfirm response = SCL.doRequest(new RequestIndication(METHOD_CREATE,SCLID+
+
−
                  "/applications",REQENTITY,new Application(appId,aPoCPath)));
+
−
        // Create Application sub-resources only if application not yet created
+
−
            // Create DESCRIPTOR container sub-resource
+
−
            SCL.doRequest(new RequestIndication(METHOD_CREATE,SCLID+"/applications/"+appId+
+
−
                    "/containers",REQENTITY,new Container(DESC)));
+
−
            // Create STATE container sub-resource
+
−
            SCL.doRequest(new RequestIndication(METHOD_CREATE,SCLID+"/applications/"+appId+
+
−
                    "/containers",REQENTITY,new Container(DATA)));
+
−
           
+
−
            String content, targetID;
+
−
            // Create DESCRIPTION contentInstance on the DESCRIPTOR container resource
+
−
            content = Sensor.getDescriptorRep(SCLID, appId, DATA, aPoCPath);
+
−
            targetID= SCLID+"/applications/"+appId+"/containers/"+DESC+"/contentInstances";
+
−
            SCL.doRequest(new RequestIndication(METHOD_CREATE,targetID,REQENTITY,
+
−
                        new ContentInstance(content.getBytes())));
+
−
           
+
−
            while (true) {
+
−
 
+
−
            // Create initial contentInstance on the STATE container resource
+
−
            int initValue = 10 + (int)(Math.random()*100);
+
−
            content = Sensor.getStateRep(appId, initValue);
+
−
            targetID = SCLID+"/applications/"+appId+"/containers/"+DATA+"/contentInstances";
+
−
            SCL.doRequest(new RequestIndication(METHOD_CREATE,targetID,REQENTITY,
+
−
                          new ContentInstance(content.getBytes())));
+
 
    
 
    
−
            try {
+
                                                // Create a data contentInstance
−
Thread.sleep(2000);
+
String content = Mapper.getActuatorDataRep(actuatorValue);
−
} catch (InterruptedException e) {
+
String targetID = sclId + "/applications/" + actuatorId
−
// TODO Auto-generated catch block
+
+ "/containers/DATA/contentInstances";
−
e.printStackTrace();
+
core.doRequest(new RequestIndication("CREATE",targetID, reqEntity,
 +
content));
 +
}
 +
                         
 +
                                        // Wait for 2 seconds then loop
 +
try {
 +
Thread.sleep(2000);
 +
} catch (InterruptedException e) {
 +
e.printStackTrace();
 +
}
 +
}
 
}
 
}
−
            }
+
}.start();
−
    }
+
}
−
+
−
 
+
−
/**
+
−
    * Creates all required resources.
+
−
    * @param appId - Application ID
+
−
    * @param initValue - initial lamp value
+
−
    * @param aPoCPath - lamp aPocPath
+
−
    */
+
−
+
−
public void createLampResources(String appId, boolean initValue, String aPoCPath) {
+
−
        // Create the Application resource
+
−
        ResponseConfirm response = SCL.doRequest(new RequestIndication(METHOD_CREATE,SCLID+
+
−
                    "/applications",REQENTITY,new Application(appId,aPoCPath)));
+
−
        // Create Application sub-resources only if application not yet created
+
−
        if(response.getStatusCode().equals(StatusCode.STATUS_CREATED)) {
+
−
            // Create DESCRIPTOR container sub-resource
+
−
            SCL.doRequest(new RequestIndication(METHOD_CREATE,SCLID+"/applications/"+appId+
+
−
                            "/containers",REQENTITY,new Container(DESC)));
+
−
            // Create STATE container sub-resource
+
−
            SCL.doRequest(new RequestIndication(METHOD_CREATE,SCLID+"/applications/"+appId+
+
−
                            "/containers",REQENTITY,new Container(DATA)));
+
−
+
−
            String content, targetID;
+
−
            // Create DESCRIPTION contentInstance on the DESCRIPTOR container resource
+
−
            content = Lamp.getDescriptorRep(SCLID, appId, DATA, aPoCPath);
+
−
            targetID= SCLID+"/applications/"+appId+"/containers/"+DESC+"/contentInstances";
+
−
            SCL.doRequest(new RequestIndication(METHOD_CREATE,targetID,REQENTITY,
+
−
                              new ContentInstance(content.getBytes())));
+
−
 
+
−
            // Create initial contentInstance on the STATE container resource
+
−
            content = Lamp.getStateRep(appId, initValue);
+
−
            targetID = SCLID+"/applications/"+appId+"/containers/"+DATA+"/contentInstances";
+
−
            SCL.doRequest(new RequestIndication(METHOD_CREATE,targetID,REQENTITY,
+
−
                              new ContentInstance(content.getBytes())));
+
−
        }
+
−
    }
+
−
 
+
−
/**
+
−
    * Creates a ContentInstance resource on STATE container.
+
−
    * @param lampId - Application ID
+
−
    * @param value - measured state
+
−
    */
+
−
    public static void createContentResource(String lampId, boolean value) {
+
−
        // Creates lampCI with new State
+
−
        String content = Lamp.getStateRep(lampId, value);
+
−
        String targetID = SCLID+"/applications/"+lampId+"/containers/"+DATA+"/contentInstances";
+
−
        SCL.doRequest(new RequestIndication(METHOD_CREATE,targetID,REQENTITY,new ContentInstance(content.getBytes())));
+
−
    }
+
−
   
+
−
    /**
+
−
    * Sets the lamp state.
+
−
    * @param appId - Application ID
+
−
    * @param value - measured state
+
−
    */
+
−
   
+
−
    public static void setLampState(final String appId, String value) {
+
−
        final boolean newState;
+
−
        boolean currentState = Lamp.getState(appId);
+
−
        String str = Boolean.toString(currentState);
+
−
        if(value.equals(str)) {
+
−
            newState = !currentState;
+
−
            createContentResource(appId, newState);
+
−
        } else {
+
−
            newState = Boolean.parseBoolean(value);
+
−
            // Create the CI in the case when the newState is different to the Current Lamp State
+
−
            if (newState != currentState) {
+
−
                createContentResource(appId, newState);
+
−
            }
+
−
        }
+
−
        //Lamps.LAMPS_STATES.set(index, newState);
+
−
        Lamp.setState(newState);
+
−
    }
+
−
+
−
 
+
 
}
 
}
 
</source>
 
</source>
−
----
 
  
−
=== The IPU contoller ===
+
== IPU Mapper ==
−
* The org.eclipse.om2m.sample.ipu.IpuController implements the IpuService interface to enable communications from SCL to the org.eclipse.om2m.sample.ipu plug-in.
+
* Convert the description and the measured data of the device to oBIX XML representation.
−
 
+
−
* For each Retrieve request, we have to extract the application identifier (appId) from the requestIndication targetID attribute. Then extarct type and index from appId based on the appId template <type>_<index>.
+
−
 
+
−
* For each Execute request we have to extract the application appId and the action value from the requestIndication targetID.  
+
−
----
+
  
 
<source lang="java">
 
<source lang="java">
 
package org.eclipse.om2m.sample.ipu;
 
package org.eclipse.om2m.sample.ipu;
 +
import org.eclipse.om2m.commons.obix.*;
 +
import org.eclipse.om2m.commons.obix.io.ObixEncoder;
  
−
import org.apache.commons.logging.Log;
+
public class Mapper {
−
import org.apache.commons.logging.LogFactory;
+
−
import org.eclipse.om2m.commons.resource.ErrorInfo;
+
−
import org.eclipse.om2m.commons.resource.StatusCode;
+
−
import org.eclipse.om2m.commons.rest.RequestIndication;
+
−
import org.eclipse.om2m.commons.rest.ResponseConfirm;
+
−
import org.eclipse.om2m.ipu.service.IpuService;
+
  
 +
public static String getSensorDescriptorRep(String sclId, String appId, String ipuId) {
 +
Obj obj = new Obj();
  
 +
Op opGet = new Op();
 +
opGet.setName("GET");
 +
opGet.setHref(new Uri(sclId + "/applications/" + appId
 +
+ "/containers/DATA/contentInstances/latest/content"));
 +
opGet.setIs(new Contract("retrieve"));
 +
obj.add(opGet);
  
−
public class IpuController implements IpuService {
+
Op opGetDirect = new Op();
−
public final static String APOCPATH = "ipu";
+
opGetDirect.setName("GET(Direct)");
−
private static Log LOGGER = LogFactory.getLog(IpuController.class);
+
opGetDirect.setHref(new Uri(sclId + "/applications/" + appId + "/" + ipuId));
−
+
opGetDirect.setIs(new Contract("retrieve"));
−
+
obj.add(opGetDirect);
  
−
public ResponseConfirm doExecute(RequestIndication requestIndication) {
+
return ObixEncoder.toString(obj);
−
String[] info = requestIndication.getTargetID().split("/");
+
−
        String lampId = info[info.length-3];
+
−
        String type = lampId.split("_")[0];
+
−
        String value = info[info.length-1];
+
−
        String trueCase = "true";
+
−
        String falseCase = "false";
+
−
        try {
+
−
            if(type.equals("lamp")) {
+
−
                IpuMonitor.setLampState(lampId, value);
+
−
                if (value.equals(trueCase)) {
+
−
                javax.swing.JOptionPane.showMessageDialog(null, "the lamp is switched on");
+
−
                } else if (value.equals(falseCase)) {
+
−
                javax.swing.JOptionPane.showMessageDialog(null, "the lamp is switched off");
+
−
                }
+
−
                return new ResponseConfirm(StatusCode.STATUS_OK);
+
−
            } else{
+
−
                return new ResponseConfirm(StatusCode.STATUS_NOT_FOUND,type+" Not found");
+
−
            }
+
−
        } catch (Exception e) {
+
−
            LOGGER.error("IPU Lamp Error",e);
+
−
            return new ResponseConfirm(StatusCode.STATUS_NOT_IMPLEMENTED,"IPU Lamp Error");
+
−
        }
+
 
}
 
}
  
 +
public static String getActutaorDescriptorRep(String sclId, String appId, String ipuId) {
 +
Obj obj = new Obj();
  
−
+
Op opGet = new Op();
−
public ResponseConfirm doRetrieve(RequestIndication requestIndication) {
+
opGet.setName("GET");
−
String[] info = requestIndication.getTargetID().split("/");
+
opGet.setHref(new Uri(sclId + "/applications/" + appId
−
        String appId = info[info.length-2];
+
+ "/containers/DATA/contentInstances/latest/content"));
−
        String type= appId.split("_")[0];
+
opGet.setIs(new Contract("retrieve"));
−
        int contvalue;
+
obj.add(opGet);
−
        boolean value;
+
−
        String content=null;
+
−
        try {
+
−
        if (type.equals("sensor")){
+
−
            // Get a random Value for the sensor
+
−
        contvalue = 10 + (int)(Math.random()*100);
+
−
        content = Sensor.getStateRep(appId, contvalue);
+
−
        }
+
−
        else if (type.equals("lamp")){
+
−
        // Get the boolean Value for the lamp
+
−
        value = Lamp.getState(appId);
+
−
        content = Lamp.getStateRep(appId, value);
+
−
        }
+
−
        return new ResponseConfirm(StatusCode.STATUS_OK,content);
+
−
        } catch (Exception e) {
+
−
            LOGGER.error("Hello sample Error",e);
+
−
            return new ResponseConfirm(StatusCode.STATUS_NOT_IMPLEMENTED,"IPU Sample Error" );
+
−
        }
+
−
}
+
  
 +
Op opGetDirect = new Op();
 +
opGetDirect.setName("GET(Direct)");
 +
opGetDirect.setHref(new Uri(sclId + "/applications/" + appId + "/" + ipuId));
 +
opGetDirect.setIs(new Contract("retrieve"));
 +
obj.add(opGetDirect);
  
−
public ResponseConfirm doUpdate(RequestIndication requestIndication) {
+
Op opON = new Op();
−
return new ResponseConfirm(new ErrorInfo(StatusCode.STATUS_NOT_IMPLEMENTED,
+
opON.setName("ON");
−
                                        requestIndication.getMethod()+" Method not Implemented"));
+
opON.setHref(new Uri(sclId + "/applications/" + appId + "/" + ipuId + "/true"));
−
}
+
opON.setIs(new Contract("execute"));
 +
obj.add(opON);
  
−
+
Op opOFF = new Op();
−
public ResponseConfirm doDelete(RequestIndication requestIndication) {
+
opOFF.setName("OFF");
−
return new ResponseConfirm(new ErrorInfo(StatusCode.STATUS_NOT_IMPLEMENTED,
+
opOFF.setHref(new Uri(sclId + "/applications/" + appId + "/" + ipuId + "/false"));
−
                                      requestIndication.getMethod()+" Method not Implemented"));
+
opOFF.setIs(new Contract("execute"));
 +
obj.add(opOFF);
 +
 
 +
return ObixEncoder.toString(obj);
 
}
 
}
  
−
 
+
public static String getActuatorDataRep(boolean value) {
−
public ResponseConfirm doCreate(RequestIndication requestIndication) {
+
Obj obj = new Obj();
−
return new ResponseConfirm(new ErrorInfo(StatusCode.STATUS_NOT_IMPLEMENTED,
+
obj.add(new Bool("data", value));
−
                                      requestIndication.getMethod()+" Method not Implemented"));
+
return ObixEncoder.toString(obj);
 
}
 
}
  
−
+
public static String getSensorDataRep(int value) {
−
public String getAPOCPath() {
+
Obj obj = new Obj();
−
// TODO Auto-generated method stub
+
obj.add(new Int("data", value));
−
return APOCPATH;
+
return ObixEncoder.toString(obj);
 
}
 
}
−
 
 
}
 
}
 
</source>
 
</source>
  
−
=== The IPU Activator ===
+
== IPU Controller ==
−
This class customizes the starting and stopping of a the org.eclipse.om2m.sample.ipu plug-in.
+
 
−
----
+
*  Execute received requests from OM2M to the specific technologies.
 +
 
 
<source lang="java">
 
<source lang="java">
 
package org.eclipse.om2m.sample.ipu;
 
package org.eclipse.om2m.sample.ipu;
  
−
import org.apache.commons.logging.Log;
+
import org.eclipse.om2m.commons.resource.StatusCode;
−
import org.apache.commons.logging.LogFactory;
+
import org.eclipse.om2m.commons.rest.*;
−
import org.eclipse.om2m.core.service.SclService;
+
 
import org.eclipse.om2m.ipu.service.IpuService;
 
import org.eclipse.om2m.ipu.service.IpuService;
−
import org.osgi.framework.BundleActivator;
 
−
import org.osgi.framework.BundleContext;
 
−
import org.osgi.framework.ServiceReference;
 
−
import org.osgi.util.tracker.ServiceTracker;
 
  
 +
public class Controller implements IpuService {
  
 +
public ResponseConfirm doExecute(RequestIndication requestIndication) {
 +
String[] parts = requestIndication.getTargetID().split("/");
 +
String appId = parts[2];
 +
String value = parts[4];
  
−
public class Activator implements BundleActivator {
+
if (appId.equals(Monitor.actuatorId)) {
 +
Monitor.actuatorValue = Boolean.parseBoolean(value);
 +
return new ResponseConfirm(StatusCode.STATUS_OK);
 +
} else {
 +
return new ResponseConfirm(StatusCode.STATUS_NOT_FOUND, appId + " not found");
 +
}
 +
}
  
−
/*
+
public ResponseConfirm doRetrieve(RequestIndication requestIndication) {
−
* (non-Javadoc)
+
String[] parts = requestIndication.getTargetID().split("/");
−
* @see org.osgi.framework.BundleActivator#start(org.osgi.framework.BundleContext)
+
String appId = parts[2];
−
*/
+
String content;
−
+
−
/** Logger */
+
−
    private static Log logger = LogFactory.getLog(Activator.class);
+
−
    /** SCL service tracker */
+
−
    private ServiceTracker<Object, Object> sclServiceTracker;
+
−
   
+
−
public void start(BundleContext  context) throws Exception {
+
  
−
        logger.info("Register IpuService..");
+
if (appId.equals(Monitor.sensorId)) {
−
        context.registerService(IpuService.class.getName(), new IpuController(), null);
+
content = Mapper.getSensorDataRep(Monitor.sensorValue);
−
        logger.info("IpuService is registered.");
+
return new ResponseConfirm(StatusCode.STATUS_OK, content);
 +
} else if (appId.equals(Monitor.actuatorId)) {
 +
content = Mapper.getActuatorDataRep(Monitor.actuatorValue);
 +
return new ResponseConfirm(StatusCode.STATUS_OK, content);
 +
} else {
 +
return new ResponseConfirm(StatusCode.STATUS_NOT_FOUND, appId + " not found");
 +
}
  
−
        sclServiceTracker = new ServiceTracker<Object, Object>(context, SclService.class.getName(), null) {
+
}
−
            public void removedService(ServiceReference<Object> reference, Object service) {
+
−
                logger.info("SclService removed");
+
−
            }
+
  
−
            public Object addingService(ServiceReference<Object> reference) {
+
public ResponseConfirm doUpdate(RequestIndication requestIndication) {
−
                logger.info("SclService discovered");
+
return new ResponseConfirm(StatusCode.STATUS_NOT_IMPLEMENTED,
−
                SclService sclService = (SclService) this.context.getService(reference);
+
requestIndication.getMethod() + " not Implemented");
−
                final IpuMonitor IpuMonitor = new IpuMonitor(sclService);
+
−
                new Thread(){
+
−
                    public void run(){
+
−
                        try {
+
−
                            IpuMonitor.start();
+
−
                        } catch (Exception e) {
+
−
                            logger.error("IpuMonitor error", e);
+
−
                        }
+
−
                    }
+
−
                }.start();
+
−
                return sclService;
+
−
            }
+
−
        };
+
−
        sclServiceTracker.open();
+
−
    }
+
−
/*
+
−
* (non-Javadoc)
+
−
* @see org.osgi.framework.BundleActivator#stop(org.osgi.framework.BundleContext)
+
−
*/
+
−
public void stop(BundleContext context) throws Exception {
+
−
System.out.println("End Ipu sample");
+
 
}
 
}
  
 +
public ResponseConfirm doDelete(RequestIndication requestIndication) {
 +
return new ResponseConfirm(StatusCode.STATUS_NOT_IMPLEMENTED,
 +
requestIndication.getMethod() + " not Implemented");
 +
}
  
 +
public ResponseConfirm doCreate(RequestIndication requestIndication) {
 +
return new ResponseConfirm(StatusCode.STATUS_NOT_IMPLEMENTED,
 +
requestIndication.getMethod() + " not Implemented");
 +
}
 +
 +
public String getAPOCPath(){
 +
return Monitor.ipuId;
 +
}
 
}
 
}
 
</source>
 
</source>
−
 
−
== Test Scenario ==
 
−
* To check that the "sensor_0" and "lamp_0" applications are successfully created, run the NSCL and GSCL products.
 
−
* Then go to the GSCL OSGi console and enter the ''ss'' command to list all deployed plugins. Start the "org.eclipse.om2m.sample.ipu" plugin (id=28 in this example) by typing the following command: start 28.
 
−
* The interworking proxy plug-in creates all required resources to enable to monitor and control sensor and lamp remotely and in a standardized way.
 
−
 
−
Open the NSCL web interface (127.0.0.1:8080), and move to the GSCL resource tree. Click on the "applications" resource to list all registered applications. You will find the following resources:
 
−
* "lamp_0": an application resource enables to handle lamp 0.
 
−
* "sensor_0": an application resource enables to handle sensor 0.
 
−
 
−
 
−
[[File:applications.png|thumb|center|800px|Lamp and sensor applications]]
 
−
 
−
 
−
This figure illustrates a contentInstance description.
 
−
 
−
 
−
[[File:contentInstance.png|thumb|center|800px|ContentInstance resource]]
 
−
 
−
 
−
* Execute a command using the following uri: "http://127.0.0.1:8080/om2m/gcl/applications/lamp_0/ipu/true" to switch on the lamp. A message box will appear with the message "The lamp is switched on".
 
−
 
−
[[File:execute.png|thumb|center|800px|Switch on the lamp: the command]]
 
−
 
−
[[File:box.png|thumb|center|800px|Switch on the lamp: the message box]]
 

Latest revision as of 06:10, 12 November 2015

Before doing this tutorial you have to clone and build OM2M using Eclipse

Add a new plug-in to OM2M

Clone and import OM2M

  • Clone OM2M using the Eclipse IDE.
  • Import all nested projects into your workspace.

Create a new plug-in project

  • 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

Convert the plugin into maven project

  • Open the build.properties file in XML and update the src attributes as depicted in the following figure.
build-properties build
  • Select the created plug-in "org.eclipse.om2m.sample.ipu" → right click → configure → convert to maven project.
  • Enter the data as illustrated in the following and press the Finish button.
maven conversion: POM edition
  • Once the plug-in is converted, open the pom.xml file to edit the parent filed.
  • Click on "select Parent" icon and enter "org.eclipse.om2m" in the "Enter groupId, artifactId or sh1 prefix or pattern" field.
  • Select "org.om2m.eclipse" and press ok.
maven conversion: Parent edition
  • We end this step by updating the plug-in project. For this, select the "org.eclipse.om2m.sample.ipu" project → maven → update project.

Add the plugin as a maven module to the OM2M parent project

  • In this part, we will add the created plug-in as a module to the om2m platform:
    • Open the pom file of the org.eclipse.om2m package.
    • Go to the modules tab and press Add button.
    • Select the org.eclipse.ipu.om2m.sample.ipu plug-in and press ok.
    • Build the om2m package and its sub-projects. To do this, select the "om2m.org.eclipse" package → right click → Run as → maven install.
    • Check the org.eclipse.om2m.sample.ipu was successfully built. At the buid end, we should get this result.
om2m build
  • Remark: To keep the same display pattern for all the platform' plugins, you can add description and name tags to the org.eclipse.om2m.sample.ipu' pom.xml file. 
<project>
......
  <name>org.eclipse.om2m :: sample ipu</name>
  <description>org.eclipse.om2m :: sample ipu</description>
.....
</project>

Add the plugin to the OM2M product(s)

  • The final step consists of adding the created plug-in to one of om2m platform products, i.e the gscl or the nscl executable. In the following, we choose to add the org.eclipse.om2m.sample.ipu plug-in to the gscl product:
  • select the org.eclipse.om2m.site.gscl package.
  • open the om2m.product file.
  • Press Add button and Type org.eclipse.om2m.sample.ipu
  • Click on ok button and save.
  • Build the om2m package and its sub-projects: select the "om2m.org.eclipse" package -> right click -> Run as -> maven install.
  • To check that the "org.eclipse.om2m.sample.ipu" was successfully added to the gscl product, run the gscl and verify in the console if the "org.eclipse.om2m.sample.ipu" is displayed.
gscl product

Add required dependencies

Add plugin dependencies

  • Open the manifest file of the created plugin and select Dependencies tab.
  • Add the dependencies depicted in the following figure.

Important! You need to import om2m nested projects into your workspace to find them in the list below.

plugin dependencies

Add jar dependencies (Only if required)

If you want to add specific jar libraries to your plugin, you can follow these steps:

  • Create a "libs" folder on your plugin project.
  • Put required specific jar on the "libs" folder.
  • Open the manifest file of the created plugin and select "runtime" tab.
  • Go to the "classpath" tab and click on the "Add" button.
  • Select the required jar and click on "ok" button.
plugin specific jar dependencies

Develop an Interworking Proxy Unit (IPU) plugin

IPU Activator

  • The Activator class contains the implementation of the start() and stop() method used to activate and deactivate the IPU plugin.
  • In the start() method, the Activator registers the IPU Controller service on the registry to make it available for the CORE plugin. Then, it starts tracking the CORE SCL service to use it once it the CORE plugin is activated.
  • In the Stop() method, the Activator can execute some process to make a clean before deactivation such as stopping threads, handle exceptions, etc.
package org.eclipse.om2m.sample.ipu;
 
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.eclipse.om2m.core.service.SclService;
import org.eclipse.om2m.ipu.service.IpuService;
import org.osgi.framework.BundleActivator;
import org.osgi.framework.BundleContext;
import org.osgi.framework.ServiceReference;
import org.osgi.util.tracker.ServiceTracker;
 
public class Activator implements BundleActivator {
	private static Log logger = LogFactory.getLog(Activator.class);
	private ServiceTracker<Object, Object> sclServiceTracker;
 
        // Activate the plugin
	public void start(BundleContext context) throws Exception {
		logger.info("IPU started");
 
                // Register the IPU Controller service
		logger.info("Register IpuService..");
		context.registerService(IpuService.class.getName(), new Controller(), null);
		logger.info("IpuService is registered.");
 
                // Track the CORE SCL service
		sclServiceTracker = new ServiceTracker<Object, Object>(context,
				SclService.class.getName(), null) {
			public void removedService(ServiceReference<Object> reference, Object service) {
				logger.info("SclService removed");
			}
 
			public Object addingService(ServiceReference<Object> reference) {
				logger.info("SclService discovered");
				SclService sclService = (SclService) this.context.getService(reference);
				final Monitor IpuMonitor = new Monitor(sclService);
				new Thread() {
					public void run() {
						try {
							IpuMonitor.start();
						} catch (Exception e) {
							logger.error("IpuMonitor error", e);
						}
					}
				}.start();
				return sclService;
			}
		};
		sclServiceTracker.open();
	}
 
        // Deactivate the plugin
	public void stop(BundleContext context) throws Exception {
		logger.info("IPU stopped");
	}
}

IPU Monitor

  • The Monitor class creates one sensor application called "MY_SENSOR", and one actuator application called "MY_ACTUATOR". It creates two containers for each application: "DESCRIPTOR" container to store the description and "DATA" container to store the measurements. For each container the right oBIX XML payload is created as contentInstance.
  • The Monitor starts two threads to listen to each application data as well. Once a new data is detected, the Monitor creates a new contentInstance including the measurement representation.
package org.eclipse.om2m.sample.ipu;
 
import org.eclipse.om2m.commons.resource.*;
import org.eclipse.om2m.commons.rest.*;
import org.eclipse.om2m.core.service.SclService;
 
public class Monitor {
	static SclService core;
	static String sclId = System.getProperty("org.eclipse.om2m.sclBaseId", "");
	static String reqEntity = System.getProperty("org.eclipse.om2m.adminRequestingEntity", "");
	static String ipuId = "sample";
	static String actuatorId = "MY_ACTUATOR";
	static String sensorId = "MY_SENSOR";
	static boolean actuatorValue = false;
	static int sensorValue = 0;
 
	public Monitor(SclService sclService) {
		core = sclService;
	}
 
	public void start() {
                // Create required resources for the Sensor
		createSensorResources();
                // Listen for the Sensor data
		listenToSensor();
 
                // Create required resources for the Actuator
		createActuatorResources();
                // Listen for the Actuator data
		listenToActuator();
	}
 
	public void createSensorResources() {
		String targetId, content;
 
                // Create the MY_SENSOR application
		targetId = sclId + "/applications";
		ResponseConfirm response = core
				.doRequest(new RequestIndication("CREATE", targetId, reqEntity,
						new Application(sensorId, ipuId)));
 
		if (response.getStatusCode().equals(StatusCode.STATUS_CREATED)) {
                        // Create the "DESCRIPTOR" container
			targetId = sclId + "/applications/" + sensorId + "/containers";
			core.doRequest(new RequestIndication("CREATE", targetId, reqEntity,
					new Container("DESCRIPTOR")));
 
                         // Create the "DATA" container
			core.doRequest(new RequestIndication("CREATE", targetId, reqEntity,
					new Container("DATA")));
 
                         // Create the description contentInstance
			content = Mapper.getSensorDescriptorRep(sclId, sensorId, ipuId);
			targetId = sclId + "/applications/" + sensorId
					+ "/containers/DESCRIPTOR/contentInstances";
			core.doRequest(new RequestIndication("CREATE", targetId, reqEntity,
					new ContentInstance(content.getBytes())));
 
                         // Create the data contentInstance
			content = Mapper.getSensorDataRep(sensorValue);
			targetId = sclId + "/applications/" + sensorId
					+ "/containers/DATA/contentInstances";
			core.doRequest(new RequestIndication("CREATE", targetId, reqEntity,
					new ContentInstance(content.getBytes())));
		}
	}
 
	public void createActuatorResources() {
		String targetId, content;
 
                // Create the "MY_ACTUATOR" application
		targetId = sclId + "/applications";
		ResponseConfirm response = core.doRequest(new RequestIndication(
				"CREATE", targetId, reqEntity, new Application(actuatorId,ipuId)));
 
		if (response.getStatusCode().equals(StatusCode.STATUS_CREATED)) {
                        // Create the "DESCRIPTOR" container
			targetId = sclId + "/applications/" + actuatorId + "/containers";
			core.doRequest(new RequestIndication("CREATE", targetId, reqEntity,
					new Container("DESCRIPTOR")));
 
                         // Create the "DATA" container
			core.doRequest(new RequestIndication("CREATE", targetId, reqEntity,
					new Container("DATA")));
 
                        // Create the description contentInstance
			content = Mapper.getActutaorDescriptorRep(sclId, actuatorId, ipuId);
			targetId = sclId + "/applications/" + actuatorId
					+ "/containers/DESCRIPTOR/contentInstances";
			core.doRequest(new RequestIndication("CREATE", targetId, reqEntity, 
					content));
 
                        // Create the data contentInstance
			content = Mapper.getActuatorDataRep(actuatorValue);
			targetId = sclId + "/applications/" + actuatorId
					+ "/containers/DATA/contentInstances";
			core.doRequest(new RequestIndication("CREATE", targetId, reqEntity,	
					content));
		}
	}
 
	public void listenToSensor() {
		new Thread() {
			public void run() {
				while (true) {
                                        // Simualte a random measurement of the sensor
					sensorValue = 10 + (int) (Math.random() * 100);
 
                                        // Create a data contentInstance
					String content = Mapper.getSensorDataRep(sensorValue);
					String targetID = sclId + "/applications/" + sensorId
							+ "/containers/DATA/contentInstances";
					core.doRequest(new RequestIndication("CREATE", targetID,reqEntity, 
							content));
 
                                        // Wait for 2 seconds then loop
					try {
						Thread.sleep(2000);
					} catch (InterruptedException e) {
						e.printStackTrace();
					}
				}
			}
		}.start();
	}
 
	public void listenToActuator() {
		new Thread() {
			public void run() {
 
				boolean memorizedActuatorValue = false;
				while (true) {
                                        // If the Actuator state has changed
					if (memorizedActuatorValue != actuatorValue) {
                                                // Memorize the new Actuator state
						memorizedActuatorValue = actuatorValue;
 
                                                // Create a data contentInstance
						String content = Mapper.getActuatorDataRep(actuatorValue);
						String targetID = sclId + "/applications/" + actuatorId
								+ "/containers/DATA/contentInstances";
						core.doRequest(new RequestIndication("CREATE",targetID, reqEntity, 
								content));
					}
 
                                        // Wait for 2 seconds then loop
					try {
						Thread.sleep(2000);
					} catch (InterruptedException e) {
						e.printStackTrace();
					}
				}
			}
		}.start();
	}
}

IPU Mapper

  • Convert the description and the measured data of the device to oBIX XML representation.
package org.eclipse.om2m.sample.ipu;
import org.eclipse.om2m.commons.obix.*;
import org.eclipse.om2m.commons.obix.io.ObixEncoder;
 
public class Mapper {
 
	public static String getSensorDescriptorRep(String sclId, String appId, String ipuId) {
		Obj obj = new Obj();
 
		Op opGet = new Op();
		opGet.setName("GET");
		opGet.setHref(new Uri(sclId + "/applications/" + appId
				+ "/containers/DATA/contentInstances/latest/content"));
		opGet.setIs(new Contract("retrieve"));
		obj.add(opGet);
 
		Op opGetDirect = new Op();
		opGetDirect.setName("GET(Direct)");
		opGetDirect.setHref(new Uri(sclId + "/applications/" + appId + "/" + ipuId));
		opGetDirect.setIs(new Contract("retrieve"));
		obj.add(opGetDirect);
 
		return ObixEncoder.toString(obj);
	}
 
	public static String getActutaorDescriptorRep(String sclId, String appId, String ipuId) {
		Obj obj = new Obj();
 
		Op opGet = new Op();
		opGet.setName("GET");
		opGet.setHref(new Uri(sclId + "/applications/" + appId
				+ "/containers/DATA/contentInstances/latest/content"));
		opGet.setIs(new Contract("retrieve"));
		obj.add(opGet);
 
		Op opGetDirect = new Op();
		opGetDirect.setName("GET(Direct)");
		opGetDirect.setHref(new Uri(sclId + "/applications/" + appId + "/" + ipuId));
		opGetDirect.setIs(new Contract("retrieve"));
		obj.add(opGetDirect);
 
		Op opON = new Op();
		opON.setName("ON");
		opON.setHref(new Uri(sclId + "/applications/" + appId + "/" + ipuId + "/true"));
		opON.setIs(new Contract("execute"));
		obj.add(opON);
 
		Op opOFF = new Op();
		opOFF.setName("OFF");
		opOFF.setHref(new Uri(sclId + "/applications/" + appId + "/" + ipuId + "/false"));
		opOFF.setIs(new Contract("execute"));
		obj.add(opOFF);
 
		return ObixEncoder.toString(obj);
	}
 
	public static String getActuatorDataRep(boolean value) {
		Obj obj = new Obj();
		obj.add(new Bool("data", value));
		return ObixEncoder.toString(obj);
	}
 
	public static String getSensorDataRep(int value) {
		Obj obj = new Obj();
		obj.add(new Int("data", value));
		return ObixEncoder.toString(obj);
	}
}

IPU Controller

  • Execute received requests from OM2M to the specific technologies.
package org.eclipse.om2m.sample.ipu;
 
import org.eclipse.om2m.commons.resource.StatusCode;
import org.eclipse.om2m.commons.rest.*;
import org.eclipse.om2m.ipu.service.IpuService;
 
public class Controller implements IpuService {
 
	public ResponseConfirm doExecute(RequestIndication requestIndication) {
		String[] parts = requestIndication.getTargetID().split("/");
		String appId = parts[2];
		String value = parts[4];
 
		if (appId.equals(Monitor.actuatorId)) {
			Monitor.actuatorValue = Boolean.parseBoolean(value);
			return new ResponseConfirm(StatusCode.STATUS_OK);
		} else {
			return new ResponseConfirm(StatusCode.STATUS_NOT_FOUND, appId + " not found");
		}
	}
 
	public ResponseConfirm doRetrieve(RequestIndication requestIndication) {
		String[] parts = requestIndication.getTargetID().split("/");
		String appId = parts[2];
		String content;
 
		if (appId.equals(Monitor.sensorId)) {
			content = Mapper.getSensorDataRep(Monitor.sensorValue);
			return new ResponseConfirm(StatusCode.STATUS_OK, content);
		} else if (appId.equals(Monitor.actuatorId)) {
			content = Mapper.getActuatorDataRep(Monitor.actuatorValue);
			return new ResponseConfirm(StatusCode.STATUS_OK, content);
		} else {
			return new ResponseConfirm(StatusCode.STATUS_NOT_FOUND, appId + " not found");
		}
 
	}
 
	public ResponseConfirm doUpdate(RequestIndication requestIndication) {
		return new ResponseConfirm(StatusCode.STATUS_NOT_IMPLEMENTED,
				requestIndication.getMethod() + " not Implemented");
	}
 
	public ResponseConfirm doDelete(RequestIndication requestIndication) {
		return new ResponseConfirm(StatusCode.STATUS_NOT_IMPLEMENTED,
				requestIndication.getMethod() + " not Implemented");
	}
 
	public ResponseConfirm doCreate(RequestIndication requestIndication) {
		return new ResponseConfirm(StatusCode.STATUS_NOT_IMPLEMENTED,
				requestIndication.getMethod() + " not Implemented");
	}
 
	public String getAPOCPath(){
		return Monitor.ipuId;
	}
}
Retrieved from "https://wiki.eclipse.org/index.php?title=OM2M/Developer&oldid=393740"

This page was last modified 06:10, 12 November 2015 by François Aïssaoui. Based on work by Mahdi Ben Alaya and Ghada Gharbi.

Back to the top