Installing the SAT Runtime Bundles

This section describes how to install the SAT runtime bundles such that they are available to your Eclipse development environment. The SAT runtime is provided as a set of OSGi bundles in JAR format. How you install the bundles will be dictated by the development tools you are using and the configuration of your development-time testing environment. While there are many possible ways to install and use the SAT runtime bundles, this section describes just one possible way.

The SAT runtime is packaged as an Eclipse update site, this is intended for scenarios where you wish to update your runtime target device using Eclipse's Update Configurator. Warning While using the SAT runtime's update site to install the bundles into the Eclipse IDE is harmless, it is not recommended.

It is recommended that the Eclipse Plug-in Development Environment (PDE) be used for developing OSGi bundles. The PDE defines the concept of a target platform that is used when launching the OSGi platform using an Equinox OSGi Framework launcher. Using a target platform to test your OSGi application is recommended since it allows you to accurately define the bundles that will be available when your application is deployed on a runtime target device.

  1. Start by defining up a PDE Target Platform in your local file system. This is where the bundles against which you wish to compile and run will be specified.
  2. In the Eclipse IDE select Window > Preferences... and then choose Plug-in Development > Target Platform. Set the Location field to the target platform folder you created.
  3. Copy the Equinox 3.2.2 runtime bundles into the PDE target platform. The PDE target platform should look like this:
    Eclipse3.2.2/
      targets/
        equinox/
          eclipse/
            features/
              ...Equinox Features...
            plugins/
              ...Equinox Plug-ins...
            
  4. In the Eclipse3.2.2 folder create a folder called plugins. This is where additional runtime bundles will be placed, allowing you to keep the PDE target platform and Equinox runtime pristine. Doing so makes it easy to upgrade the Equinox runtime bundle and the additional runtime bundles.
  5. In the plugins folder create a folder called sat-runtime and within that create a folder called eclipse. Copy the SAT runtime features and plugins into this folder. Next we're going to create a link from the target platform to this folder. The PDE target platform should look like this:
    Eclipse3.2.2/
      plugins/
        sat-runtime/
          eclipse/
            features/
              ...SAT Features...
            plugins/
              ...SAT Plugins...
      targets/
        equinox/
          eclipse/
            features/
              ...Equinox Features...
            plugins/
              ...Equinox Plug-ins...
            
  6. In the target platform folder, create a links folder. This folder is special in that it is recognized by the Eclipse IDE, which processes each .link file it contains.
  7. In the links folder create a file called sat-runtime.link that contains the following line:
    path=C:/Eclipse3.2.2/plugins/sat-runtime
            
    This file tells the Eclipse IDE to consider the specified path as part of the PDE target platform. The PDE target platform should look like this:
    Eclipse3.2.2/
      plugins/
        sat-runtime/
          eclipse
            features/
              ...SAT Features...
            plugins/
              ...SAT Plugins...
      targets/
        equinox/
          eclipse/
            features/
              ...Equinox Features...
            links/
              sat-runtime.link
            plugins/
              ...Equinox Plug-ins...
            
  8. In the Eclipse IDE select Window > Preferences... and then choose Plug-in Development > Target Platform. Click the Reload button to synchronize the IDE with the target platform in the local file system.
  9. Checking the Group plug-ins by location checkbox is recommended presents the target platform bundles grouped by folder location. See the screen shot below.

Target Platform