Skip to content

openHAB 2.3 Release Notes

Kai Kreuzer edited this page Aug 13, 2018 · 1 revision

New and Noteworthy

The openHAB 2.3 release 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.

Quick links:

Relevant Changes

Enhancements
Bug Fixes

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

The following changes were done on existing 2.x add-ons:

  • Yamaha Receiver Binding
    • Fix #2758: [YamahaReceiver] Problem with HDMI input.
    • Fix #3034: [YamahaReceiver] VolumeDB is not updated.
    • Fix #3062: [YamahaReceiver] ‘Zone_2’ of Yamaha HTR-xxx receiver completely incontrollable.
    • Fix RX-V3900 compatibility.
    • Fix Tuner: The Tuner play info was not working (tested on HTR-4069).
    • Feature: Added Straight surround program.
    • Feature: Introduced zone channel settings for minimum and maximum volume in dB.
    • Feature: Added setting for default album image URL.
    • Minor improvement (compatibility discovery, optimizations, developer documentation).
    • Compatibility break: Changed underlying settings name to follow the lower camel case convention (see discussion here). For main thing settings changed from HOST to host, PORT to port. For zone thing settings changed from ZONE to zone. See the updated binding documentation. Recommended to re-add your things (via PaperUI) and set new settings.

Paper UI

Enhancements
Bug Fixes

The following changes were done on existing openHAB 1.x add-ons:

If you are working with an openHABian setup, the upgrade is quite easy. Regardless of if you are currently using the openHAB 2.2 stable release or one of the latest 2.2 SNAPSHOT builds, switching to openHAB 2.3.0 stable is done in just a few steps:

  1. Connect to the SSH command line and execute: sudo openhabian-config
  2. Select the "Update" option
  3. Wait for the openHABian update to finish, reenter the openHABian configuration tool
  4. Select the "openHAB 2.3.0 stable" option

For package based installations, you may be asked to replace some configuration files in /var/lib/openhab2. For best results select yes at each of these prompts. Old configurations can be found in the same place, but with dpkg-old appended to it.

APT

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 2.3.0 and it's optional addons with:

sudo apt-get install openhab2=2.3.0-1

## optional addons for offline installation ##
sudo apt-get install openhab2-addons=2.3.0-1
sudo apt-get install openhab2-addons-legacy=2.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 2.3.0 and its optional addons with:

sudo yum install openhab2-2.3.0

## optional addons for offline installation ##
sudo yum install openhab2-addons-2.3.0
sudo yum install openhab2-addons-legacy-2.3.0

Manual Installations

Offical update scripts are available that let you update your 2.2 installation to version 2.3:

Linux/MacOS

  1. Change to your openHAB root directory (e.g. cd /opt/openhab2)

  2. If you are upgrading from a version after and including 2.2.0, then simply run the command:

sudo ./runtime/bin/update 2.3.0
  1. If you are upgrading from a version before 2.1.0, you can download and run the update script in one command using:
sh -c "$(curl -fsSL https://raw.githubusercontent.com/openhab/openhab-distro/2.2.0/distributions/openhab/src/main/resources/bin/update)" -- 2.3.0

Windows

This is the first stable version with a Windows update script, therefore you will need to download the one packaged with 2.3.0 to upgrade. To do this, make sure to download update.ps1 and backup.ps1 from the github repository (right-click the page then "Save-As") then save it to the runtime/bin folder of openHAB. To start the update process, run PowerShell as an administrator and use the following commands. Assuming you have openHAB saved in C:\openHAB:

cd C:\openHAB
. .\runtime\bin\update.ps1
Update-openHAB -OHVersion 2.3.0

Now that openHAB has updated, you only need to run the above commands again for future versions.

Breaking Changes that Require Manual Interaction after the Upgrade

General Changes

Chart settings

The path to the chart settings was updated from org.eclipse.smarthome.ui.chart to org.eclipse.smarthome.chart.

Nest Binding

The camera Thing Type now has channel groups. Add camera# before the channel ID in the channel UID of existing camera channels. The time_to_target_mins channel of the thermostat Thing Type is renamed to time_to_target.

Netatmo Binding

The Netatmo binding is now using the new unit of measurement system allowing easy unit conversions. Item types have to be updated like for example replacing Numberby Number:Temperature for the temperature channnels. An update of the rules based on these items could be necessary too.

The following channels were removed: BoilerOn, BoilerOff, Unit, WindUnit and PressureUnit.

Oceanic Binding

The softener Thing Type does no longer exist and is replaced by the serial and ethernet Thing Types

Weather Underground Binding

The Weather Underground binding is now using the new unit of measurement system allowing easy unit conversions. Item types have to be updated like for example replacing Numberby Number:Temperature for the temperature channnels. An update of the rules based on these items could be necessary too.