openHAB 2.1 Release Notes

New and Noteworthy

The openHAB 2.1 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.

A few major new changes to highlight are the Eclipse IoT Marketplace integration, which allows browsing and installing of 3rd party add-ons, which are not part of the official distribution. Furthermore, there is now a new alternative to the Designer for editing the config files: The new VS Code Extension for openHAB - it isn't yet available in the official Microsoft store, but nonetheless easy to install.

Relevant Changes

• Core Runtime: New features & Enhancements, bug fixes
• 2.x Add-ons: New features, enhancements, bug fixes
• 1.x Add-ons: New features, enhancements, bug fixes
• Upgrade Process for APT, RPM, Manual Installations
  • Breaking Changes that Require Manual Interaction after the Upgrade

Core Runtime

New Features & Enhancements

• #149 - add openHAB version and build info to dashboard footer
• #158 - automatically set the system location, if browser allows it
• #464 - removed default sitemap setting for Basic UI
• #434 - Change gnu to posix tar to support large UID/GID
• #412 - Consider OPENHAB_* environment variables on startup
• #3707 - upgraded to latest JmDNS 3.5.2 patch releases
• #3634 - Add 2D as new chart period
• #3593 - Provide better status information when bridge is missing
• #3587 - Implemented unique geolocation for ESH installation
• #3500 - Provide JSON streaming for REST resources
• #3429 - Only restore backup if there indeed was an unreadable file.
• #3420 - Added ConsoleCommand for adding/removing tags to/from items
• #3365 - OSGI Console: ability to trigger channel with null event
• #3274 - Introduce function NONE for item groups
• #3076 - Initial contribution of an IoT Market extension service
• #3001 - Provide a trigger for thing Online/Offline status in rule.
• #2981 - added state descriptions to some system channels
• #2872 - validate models before loading them
• #2753 - Use Jetty's ProxyServlet implementation
• #3234 - Add createTimerWithArgument method for rules

Bug Fixes

• #115 - fixed dangling audio streams if files are played concurrently
• #458 - Fix refresh intervals for charts in the demo sitemap
• #3088 - fix race condition which could leave a thing in INITIALIZING
• #2992 - Stop blaming handlers for being queued
• #2915 - fixed INCREASE/DECREASE of master volume for Mac
• #3169 - fix NPE in Configuration.toString()
• #3148 - fixes bug when ignoring hidden files
• #3222 - retain order of channels in ChannelTypeResource

2.x Add-ons

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

• #3653 - IKEA Trådfri Binding
• #2134 - BigAss Fan Binding
• #2085 - OneBusAway Binding
• #2035 - D-Link Smart Home Binding
• #2009 - SleepIQ Binding
• #1812 - ZoneMinder Binding
• #1738 - AirQuality Binding
• #1703 - Tankerkönig Binding
• #1589 - Niko Home Control Binding
• #1573 - Synop Message Analyzer Binding
• #1543 - SenseBox Binding
• #1535 - Windcentrale Binding
• #1367 - Gardena Binding
• #1329 - Folding@home Binding
• #1252 - Atlona PRO3 Binding
• #1242 - LG TVs serial Binding
• #1202 - Bosch Indego Connect Binding
• zigbee#1 - ZigBee Binding
• #432 - Eclipse IoT Market Extension

Enhancements on Existing 2.x Add-ons:

• #3654 - [Paper UI] provide group functions for Contact base item
• #3101 - [Paper UI] Show channel description on long press
• #3693 - [Basic UI] encode state in icon URL for colorpicker widget
• #3669 - [Basic UI] improvements for non SSE browsers
• #3576 - [Basic UI] fit images into main container
• #3526 - [Basic UI] dynamic update of the frame title
• #3379 - [Basic UI] now updates new sitemap widgets without restart
• #3055 - [Basic UI] Display of image items in classi/basic UI
• #3725 - [Astro] Background discovery for location changes
• #3586 - [WeMo] Support for WeMo Coffee Maker
• #3447 - [LIFX] Various improvements
• #3384 - [LIFX] Added signalstrength channel, improved online/offline detection and exception handling
• #3324 - [LIFX] Added Thing properties
• #3312 - [LIFX] Add i18n support
• #2953 - [LIFX] Add support for MultiZone Light Control
• #3421 - [FSRadio] Add support for AUNA Connect 150 Radio
• #3249 - [FSRadio] Add support for Roberts Stream 93i Radio
• #2838 - [Sonos] Added Album cover art channel
• #3540 - [JSONPath] Updated jsonpath libs to version 2.1.0
• #2390 - [Yamaha] add support for 5ch Stereo (@mclassen2)
• #2331 - [RFXCOM] Add message handling HomeConfort and KEELOQ and add config options for FS20, HomeConfort and KEELOQ (@mjagdis)
• #2330 - [RFXCOM] Add support for UV sensors (@mjagdis)
• #2329 - [RFXCOM] Support all data from wind sensors (@mjagdis)
• #2328 - [RFXCOM] Enhance Somfy RTS support (@mjagdis)
• #2260 - [RFXCOM] Add chime devices (@mjagdis)
• #2256 - [RFXCOM] Improved TX handling (@mjagdis)
• #2291 - [RFXCOM] Add a bridge option to disable discovery (@mjagdis)
• #2101 - [RFXCOM] Fixes to shutdown and packet reading thread (@mjagdis)
• #2311 - [Globalcache] Implement bi-directional support for serial devices (@mhilbush)
• #2307 - [Tesla] Move Event Stream to a separate Thread to speed up processing… (@kgoderis)
• #2270 - [Keba] Fixes various issues (@kgoderis)
• #2211 - [Z-Way] Update Z-Way library and add new device types (@pathec)
• #2207 - [Systeminfo] Added channel 'usedPercent' for channel groups 'memory', 'swap' and '… (@cweitkamp)
• #2189 - [VoiceRSS] add support for AAC format (@lolodomo)
• #2171 - [VoiceRSS] add support for OGG format (@lolodomo)
• #2181 - [ImperiHome] added support for Shutter/Thermostat device, fix behaviour of ElectricityDevice (@pdegeus)
• #2164 - [Freebox] add audio sink for AirPlay devices (@lolodomo)
• #2137 - [Freebox] use HTTPS API when available (@lolodomo)
• #2112 - [Freebox] hotfix for compatibility with firmware 3.4.0 (@lolodomo)
• #2161 - [Feed] Added gzip support (@meisterfuu)
• #2136 - [Homematic] optimized gateway detection and suppress warning for HM-Sen-MDIR-WM55 due wrong metadata (@gerrieg)
• #2081 - [Homematic] Optimized ThingHandler and fixed virtual datapoint handling (@gerrieg)
• #2135 - [Russound] Added discovery of new devices (@tmrobert8)
• #2130 - [Squeezebox] Add duration channel for now playing track (@mhilbush)
• #2110 - [Milight] Make v6 bridges keep alive interval configurable (@davidgraeff)
• #2084 - [Kodi] Added channels for opening PVR TV or Radio streams (@cweitkamp)
• #2083 - [AllPlay] Update native Windows libraries & fix reference to x64 library (@dominicdesu)
• #2080 - [Oceanic] switched to simpler byte-driven serial reader (@kgoderis)
• #2070 - [Harmony] several improvements (@wborn)

Bug Fixes on Existing 2.x Add-ons:

• #3656 - [Paper UI] Ignore unknown parameter context
• #3612 - [PaperUI] Fix merging of configuration & default values
• #3631 - [Basic UI] fix update of page title
• #3575 - [Basic UI] fix refresh of charts
• #3493 - [Basic UI] Treat Switch on NumberItem not as ON/OFF Switch
• #3403 - [Basic UI] Avoid double event on slider change
• #3368 - [Basic UI] several fix for selection and switch with mappings
• #3042 - [Basic UI] restore SSE subscription after connection loss
• #3039 - [Basic UI] send ON/OFF events from colorpicker
• #2932 - [Basic UI] make sliders less broken in MS Edge
• #3495 - [Classic UI] fix dynamic widget visibility and dynamic update of the page title
• #3461 - [Astro] fix NPE in case it's not really dark at night
• #3621 - [Hue] handle authentication failures during scan gracefully
• #2385 - [Milight] Prevent listing non Milight bridge devices in the discovery. (@davidgraeff)
• #2381 - [Homematic] Prevent ClassCastException in case of unexpectect message types (@MHerbst)
• #2221 - [Homematic] NPE if a system variable is present in homegear (fixes #1437) (@falkena)
• #2068 - [Homematic] Fixed NPE if datapoint name is null (@gerrieg)
• #2366 - [RFXCOM] Make LWRF mood buttons work (@mjagdis)
• #2338 - [milight] Fix brightness and colour temperature for V3 white bulbs (@MikeJMajor)
• #2313 - [DSCAlarm] Various Fixes and Enhancements (@RSStephens)
• #2308 - [AllPlay] Update native AllJoyn library for linux x86 and x64 (@dominicdesu)
• #2209 - [AllPlay] Update library (fix for deadlock) and add input interface (@dominicdesu)
• #2303 - [Kodi] Fix audio sink (#2301) (@andreasreinhardt)
• #2279 - [kodi] Improvements in Kodi thing status handling (@cweitkamp)
• #2230 - [Systeminfo] Added validation for pid to avoid DeviceNotFoundException's (@cweitkamp)
• #2210 - [openHAB Cloud] Don't hardcode the use of https for X-Forwarded-Proto (@FlorianSW)
• #2201 - [Harmony] Fixes issue with reconnects to Harmony Hubs (@digitaldan)
• #2156 - [Harmony] Fix button command timeouts (@wborn)
• #2198 - [Globalcache] Fix for non-globalcache devices (@mhilbush)
• #2138 - [Homekit] Fix NPE which happens on Color light before value is set on item (@dsundberg)
• #2052 - [Homekit] Fix to read minimum and maximum temperature from configuration (@WzDrg)
• #2129 - [Chromecast] playback not working when existing track is paused (@abedwardsw)
• #2062 - [Chromecast] handle refresh / reconnect (@holmes)
• #1799 - [Chromecast] fix audio sink (when requesting multiple times) (@lolodomo)
• #2094 - [SilverCrest] Fixed some NPE's (@jmvaz)
• #2046 - [Lutron] Ignore "extra" GNET> prompts (@jeffsf)
• #1970 - [RME/Oceanic] : Fix LF/CR handling in the SerialThingHandler (@kgoderis)
• #1826 - [RME/Oceanic] Workaround for high CPU Load in RXTX/nrjavaserial lib (@kgoderis)
• #1887 - [Avmfritz] Fixed NPE if temperature, powermeter or switch model is null (@cweitkamp)
• #1800 - [Onkyo] Fixed audiosink for TX-NR656 (@marcelrv)
• #1780 - [Network] Corrected usage of native Linux ping utility (@davidgraeff)
• #1770 - [Z-Way] Corrected roller shutter behaviour (@pathec)
• #1752 - [MAX!] Fix initiation when not in exclusive mode (@marcelrv)

1.x Add-ons

The following add-ons have been newly introduced:

• #5203 - isy Binding (@mitchmitchell)
• #3083 - WR3223 Ventilation Controller Binding (@frami)
• #5092 - Cisco Spark Action (#5090) (@tdeckers)

And these were successfully tested and added to the distro:

• #5082 - Piface Binding
• #5083 - ekey Binding
• #5217 - MAX! CUL Binding
• #5230 - IEC 62056-21 Meter Binding

Enhancements on Existing 1.x Add-ons:

• #5216 - [Pushover] Changed root-tag to 'response' and added warning if the Pushover response contains an info-tag (@cweitkamp)
• #5187 - [Weather] Add feels like temperature for ForecastIO (@kabili207)
• #5180 - [Weather] Added converter mps -> km/h to OpenWeatherMap wind speed property (@cweitkamp)
• #5045 - [Weather] Allow Forecastio to request units other than SI (@9037568)
• #5186 - [CalDAV] Allow the Unicode Line Separator character (@9037568)
• #5181 - [Ecotouch] Add divider for analog values and additional temperature values (#5165) (@Digitalvitamin)
• #5176 - [GPIO] Update GPIOGenericBindingProvider.java (@jokercho)
• #5167 - [Serial] Modified Serial binding for ON/OFF commands (@marekhalmo)
• #5162 - [Satel] Support for troubles added (@druciak)
• #5158 - [Epsonprojector] Add additional ColorMode and AspectRatio values (from 5030UB projector) (@jaydonoghue)
• #5137 - [Epsonprojector] Improvements (@paulianttila)
• #5148 - [ZWave] Added Fibaro FGS-213 (@RafalLukawiecki)
• #5144 - [ZWave] Add TZWP-100 (@cdjackson)
• #5130 - [ZWave] Update products.xml (@cristhiampaul)
• #5126 - [ZWave] Database update: Fibaro Wall Plug (Z-Wave+) (@bodiroga)
• #5053 - [ZWave] updates (@dmize)
• #5048 - [ZWave] database update: McoHome CO2 monitor (@TheNetStriker)
• #5044 - [ZWave] Add Qubino ZMNHUD (@xiboy)
• #5043 - [ZWave] Support ZD2102 from Zipato (@xiboy)
• #5057 - [ZWave] Added to device database, Schlage BE469 Touchscreen deadbolt lock (@mnoram)
• #5142 - [Swegon] improvements (@paulianttila)
• #5141 - [Telegram] sendTelegram() now returns "false" if an exception is thrown. (@planetrenner-martin)
• #5123 - [Pushover] Default Value Usage Fix (@CrackerStealth)
• #5121 - [Gcal] Fix misspellings of calendar (@watou)
• #5117 - [CalDAV] Various configuration fixes (@9037568)
• #5098 - [Modbus] transformation support (@ssalonen)
• #5080 - [Dropbox] Enable use of generated access token (@9037568)
• #5065 - [MQTT] Allow longer Client ID values (@9037568)
• #5060 - [Cups] Upgrade cups binding to the newest cups4j library (@9037568)
• #5054 - [Insteonplm] add support for smoke bridge (@berndpfrommer)

Bug Fixes on Existing 1.x Add-ons:

• #5220 - [Fritzboxtr064] Reset HTTP auth cache in case of connection errors (@tensberg)
• #5208 - [SNMP] memory leak fix (@sconwayaus)
• #5031 - [SNMP] Fix some errors (@J-N-K)
• #5184 - [Serial] OH2 Compatibility issue with RegexTransformation service (@marekhalmo)
• #5177 - [Insteonplm] fixed bug with start/stop manual change (@berndpfrommer)
• #5169 - [Insteonplm] fixed bug introduced with PR #5054 (@berndpfrommer)
• #5153 - [CalDAV] Avoid null pointer exceptions in the loadEvents() method (@9037568)
• #5152 - [CalDAV] Fix race condition causing NPE (@gedejong)
• #5133 - [IEC6205621meter] Fix ArrayIndexOutOfBoundsException (@9037568)
• #5114 - [Squeeze] Fix playing time error (@9037568)
• #5113 - [TCPBinding] Prevent null pointer exception in UDPBinding (@9037568)
• #5108 - [DSCAlarm] Bug Fix: DSC Alarm Command 060 Not Working (@RSStephens)
• #5101 - [Cups] Fix 'no printer for path' error (@9037568)
• #5095 - [Cul] Fix formatting and synchronization issues (@9037568)
• #5091 - [TinkerForge] Exception during event dispatch - updating LCD 20x4 (@JamesDodds)
• #5088 - [Modbus] Eventually close borrowed connections also when config changes (@ssalonen)
• #5085 - [GPIO] Accept any object type in configuration (@watou)
• #5080 - [Dropbox] Enable use of generated access token (@9037568)
• #5070 - [FHT] time update message (@bbesser)
• #5037 - [FHT] padding of temperature control hex string (@bbesser)
• #5049 - [ComfoAir] Optimize serial connection (@csowada)
• #5041 - [JDBC] Update sqlite to latest version (@ramunasd)
• #5040 - [Fatekplc] Number item and value from discrete register (@slawekjaranowski)
• #5039 - [GCal] Ensure number updates and commands survive round trip (@watou)

Upgrade Process

openHABian

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

1. Execute on the SSH command line: 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.1.0 stable" option

Package-based Installations

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 conditions are met, simply upgrade by using:

sudo apt-get update
sudo apt-get upgrade

Alternatively, you can force apt to install 2.1.0 and it's optional addons with:

sudo apt-get install openhab2=2.1.0-1

## optional addons for offline installation ##
sudo apt-get install openhab2-addons=2.1.0-1
sudo apt-get install openhab2-addons-legacy=2.1.0-1

RPM

openHAB is now also distributed as RPM packages for systems that use systemd service manager. 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 conditions are met, simply upgrade using your systems package manager (yum, dnf, etc.)

sudo yum update

Alternatively, you can force yum to install 2.1.0 and it's optional addons with:

sudo yum install openhab2-2.1.0

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

Manual Installations

Offical update scripts are available that let you update your 2.0 installation to version 2.1:

Unix + MacOS

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

2. Run the following command:

sh -c "$(curl -fsSL https://raw.githubusercontent.com/openhab/openhab-distro/master/distributions/openhab/src/main/resources/bin/update)"

Read the installation instructions for more information, or to upgrade from another version of openHAB2 (such as from a snapshot to 2.1 Stable or visa-versa).

Windows

t.b.c.

Breaking Changes that Require Manual Interaction after the Upgrade

General Changes

• Group Items without a base type no longer receive state updates. If you rely on such events (e.g. because you react on it in rules), you will need to add a type information, i.e. instead of Group MyLights, you should define Group:Switch MyLights. Here is some more technical background about it.

Astro Binding

The altitude configuration parameter has been removed as the altitude can now be specified as a third segment in the geolocation parameter. If you have specified your sun and moon through things-files, please update them accordingly.