Skip to content

Commit

Permalink
added info about Paper UI and a screencast for binding skeleton creation
Browse files Browse the repository at this point in the history
Signed-off-by: Kai Kreuzer <kai@openhab.org> (github: @kaikreuzer)
  • Loading branch information
kaikreuzer committed Feb 5, 2015
1 parent 527b51f commit 24f624a
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
2 changes: 2 additions & 0 deletions docs/sources/development/bindings.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ As a first step, you need to decide in which namespace you want to develop your

## Creating a skeleton

_Note:_ Here you can find a [screencast of the binding skeleton creation](http://youtu.be/30nhm0yIcvA).

For the openHAB namespace: Once you have [set up your IDE](ide.md), you can go ahead and create a skeleton for your binding. For this, go into your git repository under `<your repository>/addons/binding` and call the script `create_openhab_binding_skeleton.sh` with a single parameter, which is your binding name in camel case (e.g. 'ACMEProduct' or 'SomeSystem'). When prompted, enter your name as author and hit "Y" to start the skeleton generation.

For the Eclipse SmartHome namespace: You need to have a private fork of the Eclipse SmartHome project (https://github.com/eclipse/smarthome). In the local checkout of this git repository, go to `<your eclipse smarthome repository>/binding` and call the script `create_esh_binding_skeleton.sh` with a single parameter, which is your binding name in camel case (e.g. 'ACMEProduct' or 'SomeSystem'). When prompted, enter your name as author and hit "Y" to start the skeleton generation.
Expand Down
5 changes: 4 additions & 1 deletion docs/sources/development/ide.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Make sure that you have the following things installed on your computer:

## Setup Instructions

_Note:_ You can find a [screencast of the IDE setup on YouTube](https://www.youtube.com/watch?v=8XbQkKd9wkE).
_Note:_ Here you can find a [screencast of the IDE setup on YouTube](https://www.youtube.com/watch?v=8XbQkKd9wkE).

Here are step-by-step instructions:

Expand All @@ -31,3 +31,6 @@ Here are step-by-step instructions:
To produce a binary zip of the runtime yourself, you can simply call `mvn clean package` from the repository root and you will find the result in the folder distribution/target.

To run a single test you have to use following command: `mvn -o org.eclipse.tycho:tycho-surefire-plugin:0.20.0:test` which activates the tycho-surefire-specific goal for OSGI unit test using the fragment bundle xxxx.test on xxxx bundle. The maven -o (offline) option accelerates the project dependency resolution by 10-20x since it lets maven search its local repository. Normally, snapshot-enabled projects are using external repositories to find latest built packages.

Note that the Paper UI is not yet contained in the official repository and is thus missing in your workspace at this point. You can manually add it by [downloading the binary](https://raw.githubusercontent.com/openhab/openhab.repo/master/org/openhab/ui/org.openhab.ui.paperui/2.0.0-SNAPSHOT/org.openhab.ui.paperui-2.0.0-SNAPSHOT.jar) and then import it into your workspace by selecting `File->Import->Plug-in Development->Plug-ins and Fragments' from the menu, choosing `Import from->Directory` your download folder and adding the Paper UI bundle on the next page.

0 comments on commit 24f624a

Please sign in to comment.