openHAB

This page is part of archived documentation for openHAB 4.3. Go to the current stable version

# IntelliJ IDE

# Prerequisites

  • git, Maven, IntelliJ and Java 17 are installed

# Install openHAB distribution

  1. Install the official openHAB distribution (opens new window)
  2. Start the distribution in debug mode (use ./start_debug.sh instead of ./start.sh in step 4)

This article refers to the directory where you installed the distribution as <DISTRO_DIR>.

# Build the addons repository

  1. Fork and clone the openhab addons repository (opens new window) into a new directory (Reference <ADDON_DIR> from now on for this article) with git clone https://github.com/<yourgitusername>/openhab-addons (replace git user name accordingly)

  2. Open IntelliJ and create a new project from existing sources (File | New | Project from existing sources) and pick <ADDON_DIR>/pom.xml

    IntelliJ will start importing, indexing and building, it will take while, wait until finished (see status bar)

  3. Use Maven to clean & install the addons project

    • mvn clean install in the root of <ADDON_DIR> using commandline Maven (or IntelliJ Maven view)
    • some of the add-ons might fail to build - if it's not the one, you're interested in that should not bother you
    • when the Maven project finished, you should find the freshly built addon JAR in the target directory

# Debug your addon

  1. Copy the addon JAR to Openhab distribution created before

    • cp target/<ADDON_NAME>.jar <DISTRO_DIR>/addons

  2. The running instance of the openhab distribution should pick up your new addon & start it

    • you can type log:tail in the openhab console to stream the openhab logs

  3. Create a Remote Debug runtime configuration in IntelliJ:

    • open menu Run | Edit configurations
    • click the + sign to add a "Remote" configuration
    • adapt the module setting to the root (org.openhab.addons.reactor)
    • click OK
    • start the debug configuration
    • the IntelliJ console should log: Connected to the target VM, address: 'localhost:5005', transport: 'socket'

Remote Debug Run Configuration

You can now add breakpoints to your project now and your test distro should stop there.

Caught a mistake or want to contribute to the documentation? Edit this page on GitHub (opens new window)