SDK installation

Download the OGEMA SDK from

http://88.198.127.166/sef342jnEfRF3jbROrm4r32r3fk/developer/index.html

unzip the file and run the top binary/executable file to start the installation. If your internet connection requires a Proxy, a few special configurations are required, see section Using a Proxy below. If you do not have yet Java installed you will get an error. In this case install a JDK right away from the Oracle JDK download page. Note: it is important that the installer version matches the Java version; if you have a 32-bit Java installed, you need to select the 32-bit installer as well. Most users nowadays should be fine with the 64-bit Java and installer, though.

The following options are recommended to be used as default.

First page of installer:

  • Choose 'Eclipse IDE for OGEMA Developers'
  • Make sure to choose the latest JDK installed as Java VM. Do not choose a JRE as this may cause problems when building OGEMA projects later on. If the dropdown does not offer any Java VM with 'jdk' in its name, go to the Oracle JDK download page to get and install the latest JDK.
  • Otherwise use default values

Data URI image

Second page of installer:

  • This page allows you to install some optional modules, such as an SVN connector, or plugins for Javascript development. Most users can simply proceed to the next page.
  • Optional: Also choose OGEMA git Repositories - these will be checked out and imported into your Eclipse workspace.
    If you have not used OGEMA on the development PC before it is recommended NOT to check this option as this may require you to build the OGEMA framework before you can run apps and the framework bundles will be rather disturbing in the workspace when you get started. The following tutorial assumes that you do not check out any git repositories via the SDK installer.
    Note: if you select a non-public repository here, which grants access based on private keys, the key must be configured for use with the respective repository in the ~/.ssh/config file, where ~ denotes the home directory. If no configuration is provided, the standard key ~/.ssh/id_rsa is used.

Third page of installer

  • Enable "Show all variables"
  • Choose "Root install folder": This is the folder where the Eclipse instance will be placed; keep defaults for other fields

On Confirmation page just click Finish.

Note that the OGEMA SDK Plugin is currently not yet signed as official Eclipse extension. So you have to accept that unsigned content is installed during the installation process (you will be asked for your confirmation).

If you get an error regarding network connections there might be a problem with your proxy settings in case you are using a proxy. You can adapt the proxy settings in the installer with the icon (second from legt in the bottom row of the installer dialog, all pages). You can restart the installation after changing proxy settings.

When Eclipse starts you have to choose a workspace location where the initial workspace will be generated. Now you can setup your development environment and learn basics how to use it or check the SDK tuturial contents.

Note: Additional information for setting up the SDK to access services of the OGEMA Alliance can be found in the OGEMA Alliance Space (Alliance members only).

Using a Proxy

The simplest way to configure the proxy settings is to use global settings for your operating system. In addition, it is necessary to configure Maven for use with a Proxy. Instead of using a system-wide proxy setting, it is possible to configure the Eclipse installer to use a proxy.

System wide settings:

  • Windows 7: (German: Systemsteuerung -> search for Internetoptionen -> Verbindungen -> LAN-Einstellungen -> Proxy-Server für LAN verwenden)

Maven configuration

  • The Maven configuration is done in a file settings.xml, placed in the folder ~/.m2, where ~ denotes your home directory. If the folder .m2 does not exist yet, you need to create it, but note that the folder may be hidden (Linux and Windows). Windows Explorer by default does not allow the creation of files/folders starting with a dot, but it is possible from the command line: click on the Start menu, type cmd into the search field. In the console, type mkdir .m2
  • Download the sample configuration file with proxy settings. Note that you need to adapt the host and port fields in the <proxies> entries to match your own proxy.

SDK components

The SDK consists of an adapted version of the Eclipse IDE, together with several plugins that are required to develop efficiently with OGEMA, including in particular

  • OGEMA plugin: provides a Wizard for creating new apps. (TODO link to own page)
  • Maven plugin (m2e): OGEMA uses Maven as build system. The SDK comes with several plugins for convenient handling of Maven projects.
  • Git connector: git is the most popular version control system, and the OGEMA source code itself is hosted on a git repository. It is not required to use git, though, you can manage your code in any way you like.
  • SVN connector (optional): an alternative version control system. This is not installed by default.

If you already have Eclipse installed, we still recommend to install a fresh instance for the OGEMA development. It is possible to install as many Eclipse instances on a computer as you like and disk space permits, and this way the settings for the different types of projects that you are working on can be adjusted individually, without affecting other workspaces.

Note that the first SDK installation may take some time, since software components are downloaded from multiple repositories (mostly Eclipse repos). Eclipse supports the sharing of libraries between different installations in so called P2 bundle pools, so if you need to install Eclipse again, it will be considerably faster (provided you do not disable pooling). The default location of the bundle pool is the <HOME>/.p2 directory.

Command line tools

If you prefer to use Maven and git from the command line over the graphical tools provided by Eclipse, then you need to install them separately.

  • For Maven see https://maven.apache.org/download.cgi
  • git: https://git-scm.com/;Windows users aiming for the console may want to install the git bash as well (contained in the standard git download for windows), which is a sort of Bash emulation for Windows, and handy for git operations.

Search and install updates

Updates for the SDK are provided regularly, but they are not installed automatically as this requires a restart of the Eclipse environment. To search for updates in Eclipse, go to Help ->Check for Updates:

CheckForUpdates.png

You may be offered updates also for other components besides the OGEMA SDK Plugin. We recommend to install all updates available. As during the initial installation you will be asked to accept the installation of unsigned content.

Next


  • SDK tutorial overview: start the OGEMA tutorial, download example applications and get hands-on information about programming OGEMA applications
  • OGEMA wiki: complete reference for concepts such as the Resource database, the REST interface, hardware manager, etc.
  • Documentation: the OGEMA API reference
Tags:
Created by Jan Lapp on 2016/06/28 12:21