Skip to content

Developer Set up Instructions Eclipse OpenIoT v0.1.1

Jump to bottom
nkef edited this page Dec 22, 2014 · 1 revision

Table of Contents

INTERGRATION ENVIORMENT SETUP

Source code location

Documentation

Development Platform

  • Eclipse Integrated Development Environment (IDE) – Latest Version
  • Java SDK 1.7+ - Latest Version
  • JBOSS AS 7.1.1 (Please use only this version)
  • Maven 3.1 (Or Latest)

Environmental Path

  • The following variables needs to be set for successful running of maven, JBOSS and java
    • JAVA_HOME
    • MAVEN_HOME
  • The following path needs to be set
    • Java bin directory
    • Maven bin directory
The following is a useful link on how to setup maven.

http://www.mkyong.com/maven/how-to-install-maven-in-windows/

ECLIPSE Install Guide

This document aims to provide a step-by-step instruction to deploy the OpenIoT components. This document will not focus on LSM installation. The current document is developed to use the LSM on deri’s server. The following iterations will include instructions on installing and configuring LSM.

OpenIoT Modules Required for Integration

  • Under UI Folder
    • ui.requestCommons
    • ui.requestDefinition
    • ui.requestPresentation
    • ide/ide.core
  • Under modules
    • Scheduler
      • scheduler.core
      • scheduler.client
    • SDUM
      • sdum.core
      • sdum.client
    • LSM Lite (If this gives error, don’t worry. For now ignore LSM as we will use DERI’s LSM server. I will update the document when I successfuly install and configure LSM locally).
    • x-gsn
  • Under utils
    • Utils.commons

Pre-requisites

  1. Install maven
    • Download maven from http://maven.apache.org/
    • Set the path to the maven bin directory
    • Ensure you can run the mvn –version command from terminal or command prompt
  2. Install Eclipse Juno (or latest version). The following eclipse plugins needs to be installed to get a working environment without any errors. If you use a different version of eclipse, please update the following tools with corresponding version.
    • Maven 2 Eclipse plugin – This is required to run maven commands from Eclipse and also import POM files into Eclipse as a eclipse-maven project -http://download.eclipse.org/technology/m2e/releases
    • Install JBOSS Maven Support and JBOSS Web and Java EE Development tools – http://download.jboss.org/jbosstools/updates/stable/juno
    • JIBX Eclipse plugin 1.1.6a from http://jibx.sourceforge.net/eclipse/
    • Web Tools Platform 3.4.2 - http://download.eclipse.org/webtools/repository/juno/
    • Note 1:
      • For JBOSS Web and Java EE Development Tools, only install
          • Context and Dependency Injection Tools
          • Forge Tools
          • JBOSS JAX-RS Rools
          • JBOSS Tools Java Standard Tools
          • JBoss Tools JSF
          • JBoss Tools RichFaces
          • JBoss Tools Visual Page Editor
          • JBoss WebService Tools
          • JBossAS Tools
    • Note 2:
      • If you use a more recent version of eclipse, please replace the URl with corresponding version specific plugins.
    • Note 3:
      • When using Eclipse Kepler, as much as possible, install the above plugins from the Eclipse Marketplace by searching for plugins by name.
    • Note 4:
      • All these plugins can be installed from eclipse “install new software” option from under Help menu.
  3. Download JBoss 7.1.
    1. Unzip JBOSS to a directory in your hard drive.
  4. In Eclipse, under Windows->Show View->Other, search for servers.
    1. In the server window, right click and select new.
    2. If you have all the above plugin and tools installed, you will see an option for JBOSS 7.1 under the server options
    3. Select the location of JBOSS (the location on your drive previously unzipped).
    4. Start the JBOSS server from eclipse (a small play icon in the server window) to test and ensure JBOSS is starting and running successfully.
  5. Download the OpenIoT sources from github using your favorite git client or if using bash using the command - git clone https://github.com/OpenIotOrg/openiot.git
  6. Install the LSMLib into the maven store
    1. The lsm lib is under the utils directory of the OpenIoT source.
    2. There is a bat file with the command to install a jar file into your local maven repository.
    3. Run this and ensure the maven output results in Success.

Eclipse Workspace and Project setup

  1. Start eclipse and create a new workspace.
  2. Import the following projects into eclipse using the file->import->maven project option.
    1. scheduler.core
    2. scheduler.client
    3. sdum.core
    4. ui.requestCommons
    5. ui.requestDefinition
    6. ui.requestPresentation
    7. utils.commons
    8. x-gsn
    • Note: If maven complains about a JIXB plugin go ahead and import the project. This error is temporary and we will fix it later.
  3. Each project should import successfully, download all the POM dependencies.
    • Note: At this stage, there will be some errors shown by eclipse IDE. Complete step 9 to ensure all errors are fixed except for xGSN errors which is a eclipse bug and not an error.
  4. The above projects are dependent on the utils.commons and ui.requestCommons (Note: First run utils.commons and then requestCommons to avoid any errors in maven build).
    1. Other project might pop up a missing dependency error. Don’t worry yet.
    2. Right click on the utils.commons project and choose run as-> maven build … (choose the one with three dots)
    3. In the new window, for goals enter the word “install”
    4. This will compile the project, generate the jar and install it in the maven repository.
    5. Repeat the same steps for the ui.requestCommons project.
  5. Right Click on the other projects and run maven->update project
  6. Now all errors should be resolved and only x-gsn will indicate couple of error. Ignore this as the error is due to incompatibility to eclipse maven plugin with some x-gsn configurations.
  7. Copy the openiot.properties file from the utils.common/src/main/resources/properties to the jboss folder standalone/configuration
  8. For the below projects, right click on project name, select maven build … and enter the following for the goal “jboss-as:deploy”
    1. ui.requestDefinition
    2. ui.requestPresentation
    3. sdum.core
    4. scheduler.core
  9. Check the JBOSS console for any errors. If no errors are generated, you have successfully deployed the OpenIoT platform on your local JBOSS server.

Troubleshooting Setup

Note: To solve a JAXB exception, in the pom files of the ui.requestDefinition and ui.requestPresentation insert the following lines somewhere in the <dependencies> section 

        <dependency>
        <groupId>org.eclipse.persistence</groupid>
        <artifactId>org.eclipse.persistence.moxy</artifactid>
        <version>2.5.1</version>
        </dependency>

Running the openiot platform

To run the platform, we first need to configure xGSN so that we have some live data being pushed into LSM. The current documentation is limited to pushing data to LSM server running on DERI. Once we have a successful xGSN setup, we can run the Request Definition and Request Presentation user interfaces to compose a new service.

xGSN

The first component setup was xGSN. This was to ensure that there was sensor data available to be used later on by the request application

Wiki reference

LSM configuration properties

The following are the LSM configuration properties used

Figure 1. LSM Configuration properties

Creating virtual sensor xml file

During tested it was observed that the only “SensorType” and “SourceType” property that worked was “GSN”. This also leads to the issue discussed later on all sensor sources are visible on the request definition map as sensor type GSN. This makes it difficult to differentiate between sources.

Figure 2. Metatdata Description of Virtual Sensor in XML

Creating virtual sensor metadata file

For testing purposes, a CSV file was used as the source for test data to upload to LSM. This can be seen in the wrapper below. The CSV file is in the GSN folder under data directory

Figure 3. Virtual Sensor Description

Setting up new sensor in wrappers.properties

Figure 4. wapper.properties file

Registering new sensor with LSM – through xGSN

The wiki provides documentation on how to register a sensor using the existing batch file in the xGSN folder. However due to issues with class path length, the code within the batch file has to be re-written to the following.

Figure 5. Sensor registration

The following command is executed against the file. Execute this command from the xGSN parent folder.

  • “lsm-register.bat virtual-sensors\netatomo_csiro_ws01_az.xml.metadata”
When the metadata configuration file is passed to this method we have the following results Figure 6. Sensor registration Successful

Once this is complete the new sensor ID is provided by the LSM registration process and the user must update the metadata file with the ID.

Figure 7. Change Sensor ID

Running xGSN from Command Prompt

To run xGSN from command prompt (windows), please update the entire .bat file with the following 

    java –classpath “./target/*;./target/dependencies/*” -splash:lib/logo.png -Dorg.apache.commons.logging.Log=org.apache.commons.logging.impl.Log4JLogger -Dorg.mortbay.log.LogFactory.noDiscovery=false org.openiot.gsn.Main 22232

The following command is executed to start xGSN. Execute this command from the xGSN parent folder. 

    gsn-start.bat

Debugging / Running xGSN through development environment

To run the Main method within the project, the port number on which the server will be set up on needs to be passed as arguments.

Figure 8. Run/Debug Setup

When executed the following debug shows a successful pushing of data to the LSM cloud

Figure 9. successful logging of data

Scheduler Core/Client

The scheduler core is the core service that will be deployed on JBOSS. The scheduler service can be tested by opening the following URL

http://localhost:8080/scheduler.core/rest/services

The scheduler client is a java application with Swing UI to test the services of the scheduler.core service.

Here is a quick summary of the function. Some of the functions are still unclear.

Welcome - Will ping the server to test it is running

Discover – The discover service will discover the list of sensors within the given latitude and longitude

Register user – will register a new user with LSM (the new user will be stored into the graph as indicated by the configuration property file previously copied to the JBOSS store).

Login – the second register user section will test if a user is valid by authenticating the user against LSM.

Oamo and Osmo – These functions are used to get rdf information of users and services from the LSM store.

Figure 10. Scheduler client

sDUM

The SDUM core is the core service that will be deployed on JBOSS. The SDUM service can be tested by opening the following URL

http://localhost:8080/sdum.core/rest/services

The sdum client is a java application with Swing UI to test the services of the sdum.core service.

Similar to the scheduler client application, the wiki / cookbook does not seem to provide any documentation on this client application. This makes it difficult for user to start using.

From experimentation, the following is the function of the client UI

Welcome – will test if the sdum.core service has been successfully deployed

Poll – the poll for service will take a service id and get the rdf data related to the service id

note: currently, there is no way to find the service id when using the user interfaces. The scheduler API if used directly without the request definition ui can provide the user with service id’s

Figure 11. Sdum client

Request Definition

The request definition interface can be access from http://localhost:8080/ui.requestDefinition

  1. Create a new user
  2. Login with the new user
  3. Compose a new service
  4. Validate the design
  5. Save the design
Please refer to the OpenIoT Wiki on more detailed procedures. Please explore both user and develop sections.

Request Presentation

The request definition interface can be access from http://localhost:8080/ui.requestPresentation

  1. Login with same user id
  2. Load your application
  3. Click on current application-force dashboard refresh
  4. Data should become available in the selected output format
Please refer to the OpenIoT Wiki on more detailed procedures. Please explore both user and develop sections.
footer

Main

Learn

Users

Developers

Community

##Roadmap

Other

Clone this wiki locally