THIS PROJECT IS ARCHIVED

Eclipse SmartHome Packaging Sample

This repo contains a sample of how to create a small working runtime package that uses the Eclipse SmartHome framework. You can use this example to build an own minimal distribution with a very optimized memory footprint.

It uses Eclipse Concierge as a light-weight OSGi framework.

1. Prerequisites - Install Maven

Please use the instructions on main project's readme to install maven: https://github.com/eclipse/smarthome#1-prerequisites

• Make sure mvn command is available on your path.
• Make sure you're using a JDK 8.

2. Checkout

Checkout the source code from GitHub, e.g. by running:

git clone https://github.com/eclipse/smarthome-packaging-sample.git

3. Build the distribution

Run

mvn clean install

The maven build will create an ZIP file with all required components like

• the Concierge runtime
• Eclipse SmartHome bundles
• 3rd party bundles
• start scripts

You can find the created distribution under /target/smarthome-packaging-sample-.zip

The directory structure of the distribution

• addons: Folder for hotdeployment of bundles
• runtime: Contains the runtime
  • concierge: Contains the Conciege OSGi runtime
    • system: Contains commons and 3rd party bundles
      • org.eclipse.concierge: Concierge OSGi Framework and all Concierge bundles
      • org.eclipse.smarthome: All SmartHome bundles
      • org.eclipse.jetty: All Jetty bundles
  • etc: Quartz configuration, Jetty configuration, keystore
• userdata: This folder is created during the first startup and contains persistent userdata and the OSGi storage.

4. Start runtime

The minimum requirement for running this distribution is:

• JavaSE 8, or JavaSE Embedded 8, or Azul Zulu-Embedded 8
• At the moment a Full-JRE is required as few bundles have dependencies to it.
• It is planned to run this distribution on JavaSE 8 compact 2 profile

Extract the distribution zip file and start the runtime:

unzip smarthome-packaging-sample-<version>.zip
./start.sh

5. Using the UI

The distribution already includes the PaperUI. Goto: http://your-host:8080/ you will be redirected to /paperui/index.html

Also included is the Apache Felix Web Console. The Apache Felix Web Console is a simple tool to inspect and manage OSGi framework Goto: http://your-host:8080/system/console/

Customizing the distribution

Concierge configuration with xargs file

The .xargs file can contain both runtime properties for configuring the framework, as well as a set of framework commands. Properties are declared as -Dkey=value. The following commands are allowed:

• -install <bundle URL> : installs a bundle from a given bundle URL
• -start <bundle URL> : starts a bundle that was previously installed from the given bundle URL
• -istart <bundle URL> : install and starts a bundle from a given bundle URL
• -all <file directory> : install and start all .jar files in a given directory
• -initlevel <level> : sets the startlevel that will be used for all next bundles to be installed
• -skip : skips the remainder of the .xargs file (handy for debugging)

See for more details: https://www.eclipse.org/concierge/documentation.php#basic

How to add further bundles?

1. Add your bundle as dependency in the pom.xml. For example:

  <!-- Eclipse SmartHome dependencies - Bindings -->
        <dependency>
            <groupId>org.eclipse.smarthome.binding</groupId>
            <artifactId>org.eclipse.smarthome.binding.wemo</artifactId>
            <version>${esh.version}</version>
        </dependency>

2. Add the install and startup command to XARGS file. For example:

# Eclipse SmartHome Bindings. Start all bindings here
-istart ${esh.dir}/org.eclipse.smarthome.binding.wemo-${esh.version}*.jar

The bundle couldn't be started? Please check the following conditions:

• Is the JAR file included in the assembled ZIP? Check the /src/assemble/concierge.xml which defines the included file sets of the assembly.
• Maybe the required import-packages are not satisfied. Add another bundle which exports the required packages.

Change the OSGi Shell

The sample does already include two versions of OSGi shell implementations:

• Concierge Shell (default)
• Apache Felix GoGo

If you want using Apache Felix GoGo simple uncomment the GoGo bundles and remove startup of Concierge shell like:

# -istart ${concierge.dir}/org.eclipse.concierge.shell-${concierge.version}*.jar
-istart ${system.dir}/org.apache.felix.gogo.runtime-0.*.jar
-istart ${system.dir}/org.apache.felix.gogo.command-0.*.jar
-istart ${system.dir}/org.apache.felix.gogo.shell-0.*.jar

At next startup you will see the g! prompt instead of concierge>

Passing own options to JVM

You can use JAVA_OPTS for passing own parameter to JVM e.g. the Java Heap size etc.

Changing Logging backend

This distribution uses java.util.logging (JUL) as logging backend to put all logging information to files or console. This is the most resource effective solution, as it only requires a bridge from slf4j to JUL (size about 8 kB).

If you want to change the logging to another backend, e.g. logback, read here for more information.

Limitations

The sample packaging does not contain any model bundles from Eclipse SmartHome, therefore no textual configuration is supported, i.e. there are no .items, .rule, .thing, etc. files. Therefore please use the Paper UI for configuration and the new rule engine to manage rules.