openhab/openhab-distro 3.3.0

openHAB 3.3.0

on GitHub

This is the official release of openHAB 3.3.0.

The binaries are available on Artifactory and via "Stable" on our APT repository.

New and Noteworthy

The openHAB 3.3 release is a feature release that contains many new features, enhancements and bug fixes, both for the core runtime and for many add-ons. You can find the most relevant ones listed in detail below.

openHAB 3.3 is fully backward compatible to openHAB 3.2 setups - there are only a few exceptions in certain bindings where manual action is required to adapt an existing setup, so please carefully check the section on breaking changes.

Quick links:

• Notes about new add-ons
• Notes about the core runtime
• Notes about the uis
• Notes about the add-ons
• Upgrade Process for openHABian, APT, RPM, Manual Installations
• Breaking Changes that require manual interaction after the upgrade.

Relevant Changes

New Add-ons

The following add-ons are newly introduced with the 3.3 release:

The following improvements were made:

Runtime

User Interfaces

Add-ons

Upgrade Process

openHABian

If you are working with an openHABian setup, switching to openHAB 3.3.0 stable depends on what version you’re upgrading from:

1. Use SSH to connect to the command line and run sudo openhabian-config.
2. When being asked, answer that you want to update openHABian (note that’s not about openHAB itself).
3. If needed check which version you run via menu option 00.
4. a) If you have been running a snapshot or milestone release of 3.3, select the first of the three entries menu entry 41 (“Release”).
   b) If you have been running a 3.x release version, select menu entry 02 “Upgrade System”.
   c) If you are still on openHAB 2.x, please pay extra attention to all release notes from your version up to these.
   You also need to upgrade openHABian: select menu entry 03 “Install openHAB” option.

Package-based Installations

APT (Debian / Ubuntu and derivatives)

Make sure that openHAB is sourced from the latest location, has the correct GPG signing key and that your system can download .deb packages via HTTPS by following the instructions for a stable installation in the docs.

If the above is correct, simply upgrade by using:

sudo apt-get update
sudo apt-get upgrade

Alternatively, you can force apt to install 3.3.0 and its optional add-ons with:

sudo apt-get install openhab=3.3.0-1

## optional add-ons for offline installation ##
sudo apt-get install openhab-addons=3.3.0-1

RPM

openHAB is also distributed in RPM packages. To use them, make sure that openHAB is sourced from the latest location, and has the correct GPG signing key for verification by following the stable installation instructions outlined in the docs.

If the above is correct, then simply upgrade using your systems package manager (yum, dnf, etc.)

sudo yum update

Alternatively, you can force apt to install 3.3.0 and its optional add-ons with:

sudo yum install openhab-3.3.0-1

## optional addons for offline installation ##
sudo yum install openhab-addons-3.3.0-1

Manual Installations

Official update scripts are available that let you update your 3.x installation to version 3.3:

Linux/MacOS

1. Change to your openHAB root directory (e.g. cd /opt/openhab)
2. Create a backup by calling sudo ./runtime/bin/backup.
3. Run the update command:

sudo ./runtime/bin/update 3.3.0

Windows

1. Make a backup of your openHAB installation folder.
2. Run PowerShell as an administrator and change to your openHAB root directory (e.g. cd C:\openHAB)
3. Run the update command:

. .\runtime\bin\update.ps1
Update-openHAB -OHVersion 3.3.0

Breaking Changes that Require Manual Interaction after the Upgrade

openHAB 3.3 brings improved configuration validation. This applies to item naming and thing/channel configuration.

Item names must not start with a number. If you have such an item in your configuration you’ll see a message about this in the log. You have to remove it (and probably create a new one). If the item was created via UI (“managed item”), you can use the “API Explorer” (in the Main UI / “Developer Tools”) to remove it.

Thing (and channel) configurations are described in openHAB by “configuration descriptions”. These define for each configuration parameter what type (e.g. text or integer) is required and what restrictions apply (e.g. only a given set of values or a range of values by defining minimum and maximum). This has always been the case and many bindings rely on the provided configuration to work properly. Starting with openHAB 3.3 a proper validation has been added that enforces correct configuration. If your configuration is invalid, the thing will stay offline and the thing status will show the result of the validation. Most common errors are wrong type (e.g. 1 instead of true for a boolean value) or values outside of the defined range. The thing will automatically work again after the configuration has been fixed.

BMW ConnectedDrive Binding

BMW replaced ConnectedDrive smartphone app by the MyBMW application. The underlying API is now disabled and the binding isn't working anymore. Switching to the newly introduced MyBMW Binding is recommended.

Daikin Binding

The channel 'specialmode-powerful' has been removed, and a r/w channel 'streamer' added. The channel 'specialmode' changed to read/write to control eco/powerful mode.

DanfossAirUnit Binding

The type of the channel 'humidity' was updated. You may need to remove and create your things again in case your things were previously created using UI and you want to use this channel.

Helios Binding

Firmware versions older than v2.21 are no longer supported.

JS Scripting Automation

'item.history.lastUpdate()' now returns 'time.ZonedDateTime' instead of 'Date'.

JS Scripting Automation

'addItem(...)' and 'updateItem(...)' use new itemConfig as parameter and 'createItem(...)' was removed.

MQTT Binding

Support for the MQTT System Broker has been removed. Replace 'mqtt:systemBroker' things with 'mqtt:broker' things.

Netatmo Binding

Things hierarchy and organization has changed as well as channel namings. You will need to remove and create again these things.

OmniLink Binding

The channel 'sysdate' has been renamed to 'system_date', and is now read only, to make these changes visible you may need to remove and recreate the controller thing. To synchronize the controller time there is now a new action synchronizeControllerTime that can be used with a time zone input (e.g. 'America/Denver').

Opentherm Gateway Binding

The 'otgw' Thing has been removed and split into a new 'openthermgateway' Bridge, and a new 'boiler' Thing. You will need to change your Thing and respective Item definitions.

RFXCOM Binding

The channel 'fanSpeed' of 'fan_lucci_dc' and 'fan_novy' has been renamed to 'fanSpeedControl', and 'fan_lucci_dc' has a new numeric channel 'fanSpeed'. You may need to remove and create your things again.

TapoControl Binding

L510_Series and L530_Series Things were renamed to L510 and L530 because of manufacturer changed naming with new HW-rev. You may need to remove and create again these things.

WLED Binding

Binding now uses Bridge and Thing structure. Delete and add a new bridge, and at least 1 thing for each segment you require.