|
|
(97 intermediate revisions by 3 users not shown) |
Line 1: |
Line 1: |
− | In this tutorial, you can download already built OM2M binaries or learn how to build OM2M from source code by yourself using command line or Eclipse.
| |
− |
| |
| __TOC__ | | __TOC__ |
| | | |
− | = Prerequisites = | + | == Official Releases == |
− | * JAVA 1.7 or later is required to run OM2M.
| + | {|border="1" width="100%" class="wikitable" |
− | * Apache Maven 3 or later is required to build OM2M.
| + | ! Download |
− | | + | ! Date |
− | = Download already built OM2M binaries = | + | ! Description |
− | * Download OM2M binaries from this link: [https://www.dropbox.com/s/054athqx1y2wkkn/OM2M.zip?dl=0 OM2M.zip].
| + | ! Release Notes |
− | * Extract the archive. You will find the NSCL and GSCL products.
| + | |- |
− | * Use start.bat for windows or start.sh for linux to start NSCL and GSCL. '''(JAVA 1.7 is required to run OM2M)'''
| + | | [https://www.eclipse.org/downloads/download.php?file=/om2m/releases/eclipse-om2m-v1.3.0.zip Eclipse OM2M v1.3.0] || March 13, 2018 || Bug fixing and new features|| [https://wiki.eclipse.org/OM2M/Roadmap#Release_1.3.0_.28March_13.2C_2018.29 Release notes] |
− | | + | |- |
− | = Build OM2M from source code using Command line =
| + | | [https://www.eclipse.org/downloads/download.php?file=/om2m/releases/1.2.0/eclipseom2m-v-1.2.0.zip Eclipse OM2M v1.2.0] || January 04, 2018 || Bug fixing || [https://wiki.eclipse.org/OM2M/Roadmap#Release_1.2.0_.28January_04.2C_2018.29 Release notes] |
− | | + | |- |
− | == Clone OM2M project ==
| + | | [https://www.eclipse.org/downloads/download.php?file=/om2m/releases/1.1.0/eclipse-om2m-v1.1.0.zip Eclipse OM2M v1.1.0] || October 09, 2017 || oneM2M 2.0 support, new features, and bug fixing ||[https://wiki.eclipse.org/OM2M/Roadmap#Release_1.1.0_.28October_09.2C_2017.29 Release notes] |
− | * Clone the OM2M project using git with the following command:
| + | |- |
− | <pre>
| + | | [https://www.eclipse.org/downloads/download.php?file=/om2m/releases/1.0.0/OM2M-1.0.0.zip Eclipse OM2M v1.0.0] || June 22, 2016 || oneM2M 1.0 support, new features, and bug fixing ||[https://wiki.eclipse.org/OM2M/Roadmap#Release_1.0.0_.28June_22.2C_2016.29 Release notes] |
− | git clone http://git.eclipse.org/gitroot/om2m/org.eclipse.om2m.git
| + | |- |
− | </pre>
| + | | [https://www.eclipse.org/downloads/download.php?file=/om2m/releases/0.8.0/OM2M-0.8.0.zip Eclipse OM2M v0.8.0 ] || April 8, 2015 || smartM2M 1.0 support ||[https://wiki.eclipse.org/OM2M/Roadmap#Release_0.8.0_.28April_8.2C_2015.29 Release notes] |
− | | + | |} |
− | == Add required libraries ==
| + | |
− | '''(This step will be removed when all third libraries are validated by Eclipse)'''
| + | |
− | | + | |
− | * To help you take advantage of the OM2M platform, we decided to provide the source code and ask you to manually add libraries currently being validated by Eclipse:
| + | |
− | * Download required libraries from this link: [https://www.dropbox.com/s/jxpdrstsvwqwnsr/OM2M-libs.zip?dl=0 OM2M-libs.rar]
| + | |
− | * Extract OM2M-libs and copy 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 command line ==
| + | |
− | * '''Apache Maven 3 is required to build OM2M.'''
| + | |
− | * Got to the "org.eclipse.om2m" directory.
| + | |
− | * Build OM2M using the following command: (An internet connection is required to download dependencies)
| + | |
− | <pre>
| + | |
− | mvn clean install
| + | |
− | </pre>
| + | |
− | | + | |
− | * 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>"
| + | |
− | | + | |
− | * You can also import the "org.eclipse.om2m" project as maven project in the Eclipse RPC IDE, and use Eclipse maven tools to build the OM2M platform.
| + | |
− | | + | |
− | = Build OM2M from source code using Eclipse IDE =
| + | |
− | | + | |
− | == Install Eclipse IDE ==
| + | |
− | * Install Eclipse Kepler (Eclipse for RCP and RAP Developers).
| + | |
− | * You can download it from this link: https://www.eclipse.org/downloads/packages/eclipse-rcp-and-rap-developers/keplersr2
| + | |
− | | + | |
− | == Configure Maven Proxy (Only if requried) ==
| + | |
− | | + | |
− | If you are required to use a proxy server to access the Internet, then you have to configure maven proxy settings as follows:
| + | |
− | | + | |
− | * Select Window -> Preferences -> Maven -> User settings
| + | |
− | * You will find the warning message "''settings.xml file doesn't exist''" .
| + | |
− | * Move to the .m2 directory location and create the settings.xml file and put this snippet.
| + | |
− | <pre>
| + | |
− | <settings>
| + | |
− | <proxies>
| + | |
− | <proxy>
| + | |
− | <active>true</active>
| + | |
− | <protocol>http</protocol>
| + | |
− | <host>proxy-host</host>
| + | |
− | <port>proxy-port</port>
| + | |
− | </proxy>
| + | |
− | </proxies>
| + | |
− | </settings>
| + | |
− | </pre>
| + | |
− | | + | |
− | == Install Tycho plugin ==
| + | |
− | | + | |
− | === Tycho quick install using Eclipse Maven Marketplace ===
| + | |
− | * Click Window -> Preferences -> maven -> discovery -> open catalog and type Tycho. Check the “Tycho Configurator” checkbox.
| + | |
− | [[File:git_clone5bis.png|thumb|center|600px|Eclipse Maven marketplace]]
| + | |
− | | + | |
− | === Tycho Manual install using the Eclipse Update repository (Only if requried) ===
| + | |
− | | + | |
− | It happens that the Tycho plugin do not appears in the Eclipse Maven marketplace, then you have to install it manually using the following steps
| + | |
− | | + | |
− | * Select Help -> Install New Software.
| + | |
− | * Click on the Add button.
| + | |
− | [[File:tycho_install1.png|thumb|center|600px|Tycho install]]
| + | |
− | | + | |
− | * Put in the ''name field'' "tycho0.8" and in the ''location filed'' this url "http://repo1.maven.org/maven2/.m2e/connectors/m2eclipse-tycho/0.8.0/N/LATEST/"
| + | |
− | * Press on on ok button and check the "m2e extensions" and "Tycho Project Configurators" checkboxes and click on next.
| + | |
− | [[File:tycho_install2.png|thumb|center|600px|Tycho install]]
| + | |
− | | + | |
− | * Select the "Tycho Project Configurators" and click on Next.
| + | |
− | [[File:tycho_install3.png|thumb|center|600px|Tycho install]]
| + | |
− | | + | |
− | * Accept the terms of use and click on Finish.
| + | |
− | | + | |
− | * Update your project: Select the package "org.eclipse.om2m" -> right click -> maven -> update Project.
| + | |
− | | + | |
− | == 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.
| + | |
− | | + | |
− | == Add required libraries ==
| + | |
− | '''(This step will be removed when all third libraries are validated by Eclipse)'''
| + | |
− | | + | |
− | * To help you take advantage of the OM2M platform, we decided to provide the source code and ask you to manually add libraries currently being validated by Eclipse:
| + | |
− | * Download required libraries from this link: [https://www.dropbox.com/s/jxpdrstsvwqwnsr/OM2M-libs.zip?dl=0 OM2M-libs.rar]
| + | |
− | * Extract OM2M-libs and copy 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"
| + | |
− | | + | |
− | * After adding the required librairies, update the org.eclipse.om2m package. To do so, select the package "org.eclipse.om2m" -> right click -> maven -> update Project.
| + | |
− | | + | |
− | == Build the project using maven in Eclipse ==
| + | |
− | | + | |
− | * 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>"
| + | |
− | | + | |
− | == Test OM2M ==
| + | |
− | | + | |
− | * '''JAVA 1.7 is required to run OM2M.'''
| + | |
− | * Go to the NSCL product directory: "om2m/org.eclipse.om2m/org.eclipse.om2m.site.nscl/target/products/nscl/<os>/<ws>/<arch>".
| + | |
− | * You can start the NSCL directly by executing the nscl native launcher. The executable file is called "nscl.exe" on windows, and is called "nscl" on Linux and Mac OS.
| + | |
− | | + | |
− | * You can also start the NSCL by invoking the JVM as follows:
| + | |
− | <pre>
| + | |
− | java -jar -ea -Declipse.ignoreApp=true -Dosgi.clean=true -Ddebug=true plugins/org.eclipse.equinox.launcher_1.3.0.v20140415-2008.jar -console -noExit
| + | |
− | </pre>
| + | |
− | | + | |
− | * Once the NSCL is started, you will see an OSGi console. You can type “ss” to report a summary status of all installed bundles. Type "exit" to shutdown.
| + | |
− | [[File:OM2M-start-NSCL.jpg|center|600px|thumb|NSCL OSGi console]]
| + | |
− | | + | |
− | * Open your browser and connect to the address "127.0.0.1:8080" to access the NSCL web interface.
| + | |
− | * Enter username "admin" and password "admin" then click on login button to display the NSCL resource tree.
| + | |
| | | |
− | [[File:OM2M-web-authentication.jpg|center|300px|thumb|NSCL web interface: authentication]]
| + | == Dev releases == |
| | | |
− | * After a successful authentication, the NSCL resource will be displayed. You can see the "nscl" SclBase sub-resources and attributes.
| + | {|border="1" width="100%" class="wikitable" |
− | * You can disconnect by clicking on the "Logout" button.
| + | ! Download |
| + | ! Date |
| + | ! Description |
| + | ! Notes |
| + | |- |
| + | | [https://www.dropbox.com/s/nzgd57yxw1osyp4/OM2M-DEV-10072019.zip?dl=1 OM2M-DEV-10072019] |
| + | || July 10, 2019 || Bug fixing || |
| + | Fixed Bugs: <br> |
| + | [https://bugs.eclipse.org/bugs/show_bug.cgi?id=540074 540074] |
| + | [https://bugs.eclipse.org/bugs/show_bug.cgi?id=543030 543030] |
| + | [https://bugs.eclipse.org/bugs/show_bug.cgi?id=531929 531929] |
| + | [https://bugs.eclipse.org/bugs/show_bug.cgi?id=543639 543639] <br> |
| + | [https://bugs.eclipse.org/bugs/show_bug.cgi?id=544316 544316] |
| + | [https://bugs.eclipse.org/bugs/show_bug.cgi?id=529725 529725] |
| + | |- |
| + | | [https://www.dropbox.com/s/d7rwi26tkzokih7/OM2M-DEV-20112018.zip?dl=1 OM2M-DEV-20112018] |
| + | || November 20, 2018 || New features and bug fixing || |
| + | |- |
| + | | [https://www.dropbox.com/s/n9pez3aw1l7jhb0/OM2M-DEV-13-11-2016.zip?dl=1 OM2M-DEV-13112016] |
| + | || November 13, 2016 || Bug fixing || |
| + | Fixed Bugs: <br> |
| + | [https://bugs.eclipse.org/bugs/show_bug.cgi?id=507443 507443] |
| + | |- |
| + | | [https://www.dropbox.com/s/uh20fepedxp1gkr/OM2M-DEV-30-07-2016.zip?dl=1 OM2M-DEV-30072016] |
| + | || July 30, 2016 || Bug fixing || |
| + | Fixed Bugs: <br> |
| + | [https://bugs.eclipse.org/bugs/show_bug.cgi?id=497579 497579] |
| + | [https://bugs.eclipse.org/bugs/show_bug.cgi?id=495606 495606] |
| + | [https://bugs.eclipse.org/bugs/show_bug.cgi?id=498911 498911] |
| + | |- |
| + | | [https://www.dropbox.com/s/r020j0p47vc5mup/OM2M-DEV-24-04-2016.zip?dl=1 OM2M-DEV-24042016] |
| + | || April 24, 2016 || Bug fixing || |
| + | Features and fixed Bugs: <br> |
| + | [https://bugs.eclipse.org/bugs/show_bug.cgi?id=491796 491796] |
| + | [https://bugs.eclipse.org/bugs/show_bug.cgi?id=491797 491797] |
| + | [https://bugs.eclipse.org/bugs/show_bug.cgi?id=491791 491791] |
| + | [https://bugs.eclipse.org/bugs/show_bug.cgi?id=488769 488769] <br> |
| + | [https://bugs.eclipse.org/bugs/show_bug.cgi?id=488268 488268] |
| + | [https://bugs.eclipse.org/bugs/show_bug.cgi?id=488269 488269] |
| + | [https://bugs.eclipse.org/bugs/show_bug.cgi?id=484399 484399] |
| + | [https://bugs.eclipse.org/bugs/show_bug.cgi?id=473505 473505] |
| + | |} |
| | | |
− | [[File:OM2M-web-nscl.jpg|center|500px|thumb|NSCL web interface: nscl sclBase resource]] | + | == Source code == |
| + | Click [http://git.eclipse.org/c/om2m/org.eclipse.om2m.git here] to access OM2M source code repository. |