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

Features

• Code snippets for openHAB, including Design Patterns by Rich Koshak
• Syntax highlighting for the openHAB DSL (rules, items, scripts and sitemaps).
• Integrated quick search of openHAB Docs page (Alt + Shift + O)
• Integrated quick search of openHAB Community
• Integrated Basic UI browser window (Ctrl + Alt + O or editor title icon)
• Integration with openHAB REST API
• List of all Items accessible from the tree view
• Code completions
• Language Server Protocol support

Configuration

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

• openhab.host (mandatory), default: openhabianpi
• openhab.port (optional), default: 8080

openhab.host 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)

{
	"openhab.host": "localhost",
	"openhab.port": 80
}

Configuration example (macOS)

{
	"openhab.host": "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. In order to enable this feature in VSCode, please make sure that misc-lsp (Misc / Language Server Support) add-on is installed on your openHAB instance.

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
}

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 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)

Known Issues

Check out existing issues in the repository.

Release Notes

See CHANGELOG.md file for the details.

---

For More Information

• openHAB Documentation
• openHAB Community

Enjoy!