openhab / openhab-addons

openHAB Add-ons 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 add-on development, follow our guidelines and tutorials over at . If you are interested in openHAB Core development, we invite you to come by on . Add-ons in other repositories Some add-ons are not in this repository, but still part of the official openHAB distribution. An incomplete list of other repositories follows below: • • • Development / Repository Organization openHAB add-ons are Java) files. The openHAB build system is based on Maven. The official IDE (Integrated development environment) is Eclipse. You find the following repository structure: Command line build To build all add-ons from the command-line, type in: 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 option. For example to build only the astro binding: If you have a binding that has dependencies that are dynamically as specified in the feature.xml you can create a instead of a file. A 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 file run Maven with the goal : To improve build times you can add the following options to the command: | Option | Description | | ----------------------------- | --------------------------------------------------- | | | 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 | | | Build a single add-on | For example you can skip checks and tests during development with: 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. Translations 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: Code Quality 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: Integration Tests When your add-on also has an integration test in the directory, you may need to update the runbundles in the file when the Maven dependencies change. Maven can resolve the integration test dependencies automatically by executing: The build generates a file per bundle in the respective bundle directory. How to develop via an Integrated Development Environment (IDE) We have assembled some step-by-step guides for different IDEs on our developer documentation website: Happy coding!