This repository contains the official set of add-ons that are implemented on top of openHAB Core APIs. Add-ons that got accepted in here will be maintained (e.g. adapted to new core APIs) by the openHAB Add-on maintainers.
To get started with binding development, follow our guidelines and tutorials over at https://www.openhab.org/docs/developer.
If you are interested in openHAB Core development, we invite you to come by on https://github.com/openhab/openhab-core.
Some add-ons are not in this repository, but still part of the official openHAB distribution. An incomplete list of other repositories follows below:
openHAB add-ons are Java
The openHAB build system is based on Maven. The official IDE (Integrated development environment) is Eclipse.
You find the following repository structure:
+-- bom Maven buildsystem: Bill of materials
| +-- openhab-addons Lists all extensions for other repos to reference them
| +-- ... Other boms
+-- bundles Official openHAB extensions
| +-- org.openhab.binding.airquality
| +-- org.openhab.binding.astro
| +-- ...
+-- features Part of the runtime dependency resolver ("Karaf features")
+-- itests Integration tests. Those tests require parts of the framework to run.
| +-- org.openhab.binding.astro.tests
| +-- org.openhab.binding.avmfritz.tests
| +-- ...
+-- src/etc Auxilary buildsystem files: The license header for automatic checks for example
+-- tools Static code analyser instructions
+-- CODEOWNERS This file assigns people to directories so that they are informed if a pull-request
would modify their add-ons.
To build all add-ons from the command-line, type in:
mvn clean install
Most of the time you do not need to build all bindings, but only the binding you are working on.
To simply build only your binding use the
For example to build only the astro binding:
mvn clean install -pl :org.openhab.binding.astro
If you have a binding that has dependencies that are dynamically as specified in the feature.xml you can create a
.kar instead of a
.kar file will include the feature.xml and when added to openHAB will load and activate any dependencies specified in the feature.xml file.
To create a
.kar file run maven with the goal
mvn clean install karaf:kar -pl :org.openhab.binding.astro
To improve build times you can add the following options to the command:
|Skip the static analysis (Checkstyle, FindBugs)
|Skip the execution of tests
|Skip the compilation and execution of tests
|Skip the Karaf feature verification
|Skip the Spotless code style checks
|Work offline so Maven does not download any updates
|Build in parallel, using 1 thread per core
-pl :<add-on directory>
|Build a single add-on
For example you can skip checks and tests during development with:
mvn clean install -DskipChecks -DskipTests -pl :org.openhab.binding.astro
Adding these options improves the build time but could hide problems in your code. Parallel builds are also less easy to debug and the increased load may cause timing sensitive tests to fail.
Add-on translations are managed via Crowdin. The English translation is taken from the openHAB-addons GitHub repo and automatically imported in Crowdin when changes are made to the English i18n properties file. When translations are added or updated and approved in Crowdin, a pull request is automatically created by Crowdin. Therefore translations should not be edited in the openHAB-addons repo, but only in Crowdin. Otherwise translation are overridden by the automatic process.
To fill the English properties file run the following maven command on an add-on:
This command can also update the file when things or channel are added or updated.
In some cases the command does not work, and requires the full plug-in name. In that case use:
To check if your code is following the code style run:
To reformat your code so it conforms to the code style you can run:
When your add-on also has an integration test in the
itests directory, you may need to update the runbundles in the
itest.bndrun file when the Maven dependencies change.
Maven can resolve the integration test dependencies automatically by executing:
mvn clean install -DwithResolver -DskipChecks
The build generates a
.jar file per bundle in the respective bundle
We have assembled some step-by-step guides for different IDEs on our developer documentation website: