Find file Copy path
176 lines (119 sloc) 6.34 KB

openHAB VS Code Extension

openHAB is a vendor and techology agnostic open source automation software for your home. This Visual Studio Code extension allows you to work with openHAB configuration files (like *.items, *.rules, *.sitemap and *.script) thanks to the syntax highlighting, code snippets and integrated search.

The extension is designed with openHAB 2.x in mind - most snippets and design patterns will work in openHAB 2.x


  • Syntax highlighting for the openHAB DSL (rules, items, scripts and sitemaps).
  • Code snippets for openHAB, including Design Patterns by Rich Koshak
  • Integrated quick search of openHAB Docs page (Alt + Shift + O)
  • Integrated quick search of openHAB Community
  • Integrated Basic UI (or Classic UI) browser window (Ctrl + Alt + O or editor title icon)
  • Integrated Paper UI preview for the Items and Things
  • Integration with openHAB REST API
  • List of all Items accessible from the tree view
  • Code completions
  • Language Server Protocol support - syntax validation
  • Dynamic Items creation from Thing's channels
  • Quick Karaf console access
  • Add Items to Sitemap with one click

openHAB2 code snippets

integrated search engine


You are able to configure the hostname and port for the Sitemap preview.

  • (mandatory), default: openhabianpi
  • openhab.port (optional), default: 8080 will also work with the IP address of your openHAB instance, instead of the hostname.

These settings should work fine on Windows machines and openHAB installations using the recommended openHABian setup. They should be edited if you use macOS or *NIX systems or manual openHAB installations.

To edit these settings, simply add overrides to either your user settings or your workspace settings in your Visual Studio Codes preferences.

For further informations on how to change your settings, visit the official Visual Studio Code docs.

Configuration example (local)

	"": "localhost",
	"openhab.port": 80

Configuration example (macOS)

	"": "openhabianpi.local",
	"openhab.port": 8080

Integration with openHAB REST API

This VSCode extension connects to the openHAB REST API by default. The connection is used to display list of Items in the left side tree view. It's also utilized for code completions.

If you're using this extension just for the syntax highlighting and don't want to involve the REST API, you can disable it by providing the following parameter in your User Settings (Ctrl + Shift + S):

"openhab.useRestApi": false

You may need to reload the VSCode window to take effect.

Validating the Rules

This extension comes with Language Server Protocol support. Language servers allow you to add your own validation logic to files open in VS Code. openHAB from version openHAB 2.2.0 Build #1065 (SNAPSHOT) has the Language Server exposed on 5007 port. openHAB 2.2 since build #1084 has LSP feature enabled in the runtime, so there are no additional steps for you to make it work.

In the unlikely case that your language server is running on a port other than the default one this is how it can be changed in the configuration:

	"openhab.lspPort": 5007

If you don't want to have your openHAB files validated by Language Server, simply disable it in the extension:

	"openhab.lspEnabled": false

Accessing remote openHAB

Accessing remote openHAB from service like myopenhab is not possible, given that you need an access to the file system in order to read and write to the configuration files. Although, you can access the Items and Things through the REST API. Note that LSP (content assist for rules and syntax validation) won't be exposed, so you'll need to disable it too.

The following configuration will allow you to access REST API remotely:

    "": "",
    "openhab.port": 80,
    "openhab.lspEnabled": false,
    "openhab.username": "your_myopenhab_email",
    "openhab.password": "your_myopenhab_password",

Sitemap preview with Basic UI

openHAB VS Code Extension allows you to preview the sitemap structure in the Basic UI running on your openHAB server instance.

If you have a sitemap file active in your editor and open Basic UI (Ctrl + Alt + O or editor title icon), you'll land directly on the sitemap you're working on.

You can optionally set openhab.sitemapPreviewUI parameter to classicui if you prefer Classic UI instead:

	"openhab.sitemapPreviewUI": "classicui"

Intelligent sitemap preview

You need to have openHAB server running in order to preview changes. The extension assumes that you access your openHAB config files from either:

Samba share (e.g. \\OPENHABIANPI\openHAB-conf\) Local folder (e.g. c:\openhab\configuration)

Quick Karaf console access

Quick Karaf console access

This extension allows you to run openHAB Karaf console directly from the editor. Note that you need to have:

  • ssh installed on your environment
  • Karaf exposed to the external interface
  • configuration parameter set properly

This feature allows you to modify the new param and e.g. show the openHAB logs immediately:

    "openhab.karafCommand": "ssh openhab@%openhabhost% -p 8101 -t 'log:tail'",

Things Explorer demo

Things Explorer

Sitemap Insert demo

Quick insert Items into Sitemap

Known Issues

Check out existing issues in the repository.

Release Notes

See file for the details.

For More Information