Editors - Different Ways to Simplify Your Textual Configuration

Currently there are several existing solutions, that can help you configuring your openHAB instance in a textual way. This documentation page can give you some guidance in choosing the right one for you and setting it up.

openHAB VS Code Extension

openHAB VS Code is an extension for the Visual Studio Code editor. You can find it in the Microsoft Visual Studio Marketplace.

openHAB VS Code Extension demo

Installation

  1. Install Visual Studio Code if not yet available.
  2. Open the extension sidebar. openHAB VS Code Extension alternative installation
  3. Search for openHAB and install the extension.

Visit the Extensions GitHub Page for further Informations

Rule Validation

This extension has the ability to check rules and validate them through a so called Language Server. (If youn want to know more about this in general look here.) The validation needs a running openHAB installation in your environment and can be activated with some simple steps. You can find all important information in the extensions readme file.

Eclipse SmartHome Designer

The Eclipse SmartHome Designer is a specialized version of the Eclipse IDE for openHAB. Just like known from other IDEs, the Designer allows to browse and edit the configuration files of your openHAB setup, with the advantage of syntax highlighting, syntax checking and autocompletion.

Network Preparations

If your openHAB instance is set up on a different device or a dedicated system, the Designer can be installed and executed on your personal PC or Mac. The Designer needs to be able to access the configuration files on the remote openHAB host.

You have to have a network share set up on the remote host and mounted on your local device. Steps needed to so are specific to the hosts operation system. How to setup and use Samba on a Linux system is described in the Linux article. If you are using openHABian, the needed set of network shares is already configured for you, you just need to mount them locally.

Attention Windows users: Directly accessing network shares (UNC paths) is not supported. Please be sure to mount the network share to a drive letter prior to using the SmartHome Designer.

Setup

The downloaded .zip archive contains the Designer executable.

  • Windows: Extract the archive to a path of your choosing, e.g. C:\designer
  • Linux: Extract the archive to a path of your choosing, e.g. /opt/designer
  • Max OSX: Extract the archive to your applications folder

First Launch

After launching the Designer executable you will see an empty configuration file pane on the top left.

SmartHome Designer standard view

Click on the “Select a configuration folder” icon at the top right of the configuration window and navigate to your openHAB configuration folder (containing items, rules, …).

SmartHome Designer configuration folder selection

The configuration pane should now list the different configuration folders:

SmartHome Designer standard view with loaded configuration

Usage

You can now start to create and modify your configuration files. Changes are automatically loaded by the openHAB runtime. More details about the syntax of the different configuration files can be found in the Configuration chapter.

Hint: Press <Ctrl + N> to create a new file.

Other Editor Integrations

The here summarized projects provide syntax highlighting for different text editors, but have no on top functionality like the two tools above.

mcedit

mcedit is an editor which comes with mc (Midnight Commander). You can find the syntax files and installation instructions on openhab-mcedit.

Notepad++

Notepad++ is a free source code editor for Windows. Version 6.2 or above is required. You can find the syntax files on openhab-samples and install the files like it is described in the editors documentation.

Vim

Vim is a text editor in Linux systems. You can find the syntax file and installation instructions on openhab-vim.

Nano

Nano is a common editor in Linux systems. You can find the syntax file and installation instructions on openhabnano.

Textwrangler

Textwrangler is a text and code editor for MAC OS X. You can find the syntax file and installation instructions on openhab-syntax-textwrangler.