openhab/openhab-distro 4.1.0

openHAB 4.1.0

on GitHub

This is the official release of openHAB 4.1.0.

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

New and Noteworthy

The openHAB 4.1 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 4.1 is backward compatible to openHAB 4.0 setups - there are only a few exceptions 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 removed 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:

Removed Add-ons

The following add-ons were removed from the distribution:

Runtime

The following improvements were made to the core and the distro:

User Interfaces

Add-ons

Upgrade Process

Backup your configuration

If you are on openHABian, sudo openhabian-config menu option 50 will do for you,
else use sudo openhab-cli backup. Get the resulting file from $OPENHAB_USERDATA/backups, $OPENHAB_USERDATA is accessible as a Samba share. Using SSH it is /var/lib/openhab/ on your system.

If you run a Raspberry, get another SD card (an "Endurance" labelled one) and create a mirror copy.
openhabian-config menu option 54 will do for you on the live system, else there's tools such as dd or WinDiskImager.
Should you ever need to revert to your old openHAB system or to redo the upgrade process, simply change SD cards and start over from where you had started.

openHABian

If you are working with an openHABian setup,

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. If on Raspberry, create an image copy of your SD card using menu option 54.
5. Switching to openHAB 4.1.0 release depends on what version you’re upgrading from:
   
   a) If you have been running a 4.0 release version, select menu entry 03 “Install or upgrade to latest openHAB” option.
   
   b) If you have been running a snapshot or milestone release of 4.1, select the first entry in menu option 41 (“Release”).

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.

Please specifically note that the "old" signing key expired on July 24, 2023 - if you are still using this, you will need to download the latest key. See https://community.openhab.org/t/linux-repo-public-key-is-expiring-soon/147905 for details.

If the above is correct, simply upgrade by using:

sudo apt-get update
sudo apt-get upgrade

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

sudo apt-get install openhab=4.1.0-1

## optional add-ons for offline installation ##
sudo apt-get install openhab-addons=4.1.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 4.1.0 and its optional add-ons with:

sudo yum install openhab-4.1.0-1

## optional add-ons for offline installation ##
sudo yum install openhab-addons-4.1.0-1

Manual Installations

Official update scripts are available that let you update your 4.0 installation to version 4.1:

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 4.1.0

Windows

1. Make a backup of your openHAB installation folder.
2. Run PowerShell as 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 4.1.0

Breaking Changes that Require Manual Interaction after the Upgrade

Changes in Add-ons

Energi Data Service Binding

• The channels 'net-tariff' and 'transmission-net-tariff' have been renamed to 'grid-tariff' and 'transmission-grid-tariff' respectively. Items should be relinked to the new channels.

Hue Binding

• The auto update policy for API v2 light channels has been changed to avoid multiple state updates. For this to work, you may need to remove and create your things again in case your things were previously created using UI.

JavaScript Scripting Automation

• The "useIncludedLibrary" configuration parameter has been renamed to "injectionCachingEnabled". In case you changed it, make sure to apply that change to the new parameter.

JDBC Persistence

• The add-on now uses H2 database 2.2. If you use H2 for storing data, your database needs to be migrated as described in https://h2database.com/html/migration-to-v2.html. It is also required to add ';NON_KEYWORDS=VALUE' to your H2 JDBC URL. See also openhab/openhab-addons#15726 for a Bash migration script.

LuxtronikHeatpump Binding

• The channel 'controlSignalCirculatingPump' has been changed to type 'Number:Dimensionless'. Items linked to this channel will need to have their Type manually updated.

Miele@home Binding

• The channel 'powerConsumption' has been renamed to 'energyConsumption'. Items should be relinked to the new channel.

MQTT EspMilightHub Binding

• Color bulbs no longer have a level channel. You may need to re-add your things for it to be removed. Link to the colour channel instead, even for Dimmer items.

MyBMW Binding

• Vehicle channels "charge-info" and "motion" removed, "charge-remaining", "last-fetched", "estimated-fuel-l-100km" and "estimated-fuel-mpg" added. Image options changed - now "VehicleStatus", "FrontView", "RearView", "FrontLeft" and "FrontRight" are available.

Twitter Binding has become X

• All related references to Twitter and Tweets have been replaced, please check your configuration (rules, actions, channels etc).