This is the official release of openHAB 2.3.0.
The binaries are available on Bintray and via "Stable" on our APT repository.
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:
- Notes about the Core runtime
- 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 Addons
The following add-ons are newly introduced with the 2.3 release:
2.x Core
Type | Issue# | Change |
---|---|---|
Enhancements | #646 | Fix backup creation when using custom directory |
#678 | Some improvements to demo sitemap and items | |
#655 | Upgrade to Karaf 4.1.5 | |
#274 | support special words in dashboard tile URL's. | |
#4390 | Added item metadata infrastructure | |
#5178 | Added LATEST and EARLIEST group functions for DateTime groups | |
#5588 | Added usage help for inbox console command | |
#4848 | Allow configuration of a broadcast address | |
#5417 | Avoid sending update notification for a chart widget having a refresh argument | |
#5253 | Handle audio exceptions more gracefully | |
#5315 | Introduced discovery for USB devices with serial port | |
#4818 | Introduced unit support with new QuantityType | |
Bug Fixes | #4383 | Added support for quoted strings in rule triggers |
#5417 | Avoid sending update notification for a chart widget having a refresh argument | |
#5442 | Catch and handle exception from chart image generation | |
#5499 | Consider color conditions when producing sitemap events | |
#5299 | Fixed daylight saving time (DST) bug in scheduled jobs | |
#5437 | Fixed NPE in RuleEngine if startup rule has an error | |
#5549 | Fixed pattern parsing for patterns with square brackets | |
#5241 | Fixed stopping of currently playing streams | |
#4982 | Fixed unique item name validation | |
#5523 | Fixed wrong order of widgets after sitemap changes |
2.x Addons
User Interfaces
UI | Type | Issue# | Change |
---|---|---|---|
Basic | Enhancements | #5073 | Made home icon clickable |
#5071 | Show label and icon for Mapview widgets | ||
Bug Fixes | #4920 | Fixed handling of MJPEG video | |
#5061 | Fixed live update for Microsoft Edge | ||
Classic | Enhancements | #5078 | Show label and icon for Mapview widgets |
HABPanel | Enhancements | #302 | Ability to add Switch items to charts (translate ON/OFF to 1/0) |
#279 | Add tooltips in icon picker | ||
#259 | Button: Add display options | ||
#256 | Internationalization/localization | ||
#276 | Pin drawer & improve widgets resize handling | ||
#263 | Prompt user to confirm dashboard removal | ||
Bug Fixes | #266 | Chart/timeline: Fixed date calcs, 2D period, optional serviceId | |
#288 | Fixed NaN display when dimmer issued ON/OFF command | ||
#280 | Fixed rendering bug with the experimental dashboard mobile mode | ||
#278 | Updated ESH Classic Iconset description file | ||
#277 | Use browser language if unset on server | ||
Paper | Enhancements | #5576 | Added editor for item metadata |
#5169 | Display representation property in Things view & Inbox | ||
#5046 | Expanded config parameter description to 3 lines | ||
#5067 | Made chart service settings available | ||
#5092 | Only update item state on state changed events | ||
#5088 | Remember selected tab in URL query parameter | ||
Bug Fixes | #5125 | Fixed binding expert configuration |
Binding | Type | Issue# | Change |
---|---|---|---|
Air Quality | Enhancements | #3555 | Added support for units of measurements (QuantityType), added autodiscovery, implemented retry-mechanism |
Astro | Enhancements | #5386 | Added channel group descriptions |
#4829 | Added moon age in percent and degree | ||
Bug Fixes | #5539 | Fixed time drift of positional job | |
AVM FRITZ | Enhancements | #3051 | Added missing channel 'device_locked' to FRITZ!DECT 301 |
#3022 | Added support for groups | ||
#3477 | Incorporated Units of Measurement | ||
Bug Fixes | #3245 | Fix for precision issues for setpoint | |
BigAssFan | Enhancements | #3303 | Add support for standalone lights |
Bug Fixes | #3136 | Fix processing of fan smartmode messages | |
CM11a | Bug Fixes | #3320 | Binding failed to initialize under certain conditions |
CoolMasterNet | Bug Fixes | #3395 | Fix fan speed commands not working |
digitalSTROM | Enhancements | #3182 | Major update with many features and improvements |
DMX | Enhancements | #4812 | Added support for tunable white and improved brightness handling |
Exec | Enhancements | #2983 | Improve documentation |
Freebox | Bug Fixes | #3224 | fix compatibility with firmware 3.5.x |
FS Internet Radio | Enhancements | #5130 | Added further radio models to auto discovery |
Gardena | Enhancements | #3520 | Added mower statistics |
#3574 | Added support for smart power plug | ||
Harmony Hub | Bug Fixes | #3496 | Fix for trigger channels not working on some hubs & for power off complete trigger not being passed |
Homekit | Enhancements | #3332 | Make bridge name configurable |
Homematic | Enhancements | #3102 | Added CCU autodiscovery |
#3101 | Added CONT to press trigger channel | ||
#3140 | Dynamically assign reconfigurable channels for HM-MOD-EM-8 | ||
#3263 | Fixed first display line for HM-Dis-WM55 and HM-Dis-EP-WM55 | ||
#3391 | Put controller into install_mode on DiscoveryService#start() | ||
#3544 | Updated HmIP batteries and descriptions | ||
Bug Fixes | #3444 | Fixed shifted line for HM-Dis-EP-WM55 | |
JeeLink | Enhancements | #3561 | Add support for LaCrosseGateways |
#3174 | Add support for sensors with multiple channels | ||
#3065 | Added support for PCA301 sockets | ||
Bug Fixes | #3108 | Corrected behavior were results were discarded because of too much deviation | |
#3081 | Fix alternating values after sensor reconfiguration | ||
Keba | Enhancements | #2844 | Add support for new firmwares & move to synchronous communication |
Kodi | Enhancements | #3557 | Added check to prevent an IllegalStateException |
#3207 | Added dynamic state descriptions for opening pvr stream channels | ||
#3271 | Added new channel to play a favorite | ||
#3023 | Feature faster fast forward | ||
#3479 | Improvements for playing audio notifications | ||
LIFX | Enhancements | #4866 | Added power on color feature |
#5039 | Added support for new LIFX products such as Tile and Beam | ||
Loxone | Enhancements | #2978 | Token-based authentication and encryption of commands |
Bug Fixes | #3252 | Fix for dimmer switch off | |
MiHome | Enhancements | #3290 | corrected discovery of ctrl_ln1.aq1 & add device inclusion to gateway |
Milight | Bug Fixes | #3093 | Fix white mode, night mode and disco mode (#3021) |
Nest | Enhancements | #3024 | Add last_connection, last_online_change and last_manual_test_time channels |
#3147 | Handle deletion of devices and structures from account | ||
#3150 | Support Fahrenheit temperature values using QuantityType | ||
Netatmo | Enhancements | #3529 | Add units of measurement using QuantityType |
#2987 | Added timestamp 'channel' to NAModule2 (wind gauge) and NAModule3 (rain gauge) | ||
Bug Fixes | #3073 | Changed ZoneId from UTC to system default time | |
Network | Bug Fixes | #3503 | Fix the windows ping problem for local subnets. |
#3501 | When there is a failure to connect mark the service absent rather than present. | ||
Niko Home Control | Enhancements | #3337 | Improvement of rollershutter PercentType implementation. |
NTP | Bug Fixes | #5233 | Display the time which was returned from the NTP server |
#5251 | Prevent NPEs if no configuration is available | ||
Oceanic | Enhancements | #3179 | Provide a work-around for serial port access |
One Bus Away | Bug Fixes | #3116 | Make sure that the data is successfully polled |
Onkyo | Bug Fixes | #3131 | Corrected the displaying of album art by setting the correct mime type |
Pioneer AVR | Enhancements | #2542 | Support for 2014, 2015, 2016 lineup of Pioneer AVRs |
Plugwise | Enhancements | #3491 | Add units to measurements using QuantityType |
Pulse Audio | Enhancements | #2933 | Implement type filters for the different PulseAudio types |
RFXCOM | Enhancements | #2981 | Added support for thermostat3 |
#2979 | Adding support for CURRENT messages | ||
#3105 | Extended support for lighting4 messages | ||
Sonos | Enhancements | #4846 | Added property for storing the 'notificationvolume' and removed 'notificationvolume' channel |
Bug Fixes | #4813 | Improve handling of stop channel | |
Squeezebox | Enhancements | #3190 | Add LMS favorites channels to server and player |
#3036 | Support for mixer volume command added | ||
Bug Fixes | #3231 | Changes to properly resume player after text to speech messages | |
System Info | Enhancements | #3543 | Updated underlying oshi library to 3.4.5 |
TPLinkSmartHome | Enhancements | #3015 | Added support for additional devices: KB100, KB130, KP100, LB200 and LB230 |
#3076 | Added support for HS110v2 devices and added channel for reading power value of bulbs | ||
Tradfri | Enhancements | #4930 | Improved gateway firmware version check |
Bug Fixes | #4999 | Correctly support "TRADFRI bulb E12 WS opal 400lm" | |
WeatherUnderground | Enhancements | #5072 | Added new channel pressureTrend |
#5070 | Added new channels containing the icon key | ||
#5074 | Convert system language to WU language | ||
WiFiLED | Bug Fixes | #2496 | Fix for setting Colors + white when called directly after each other |
Windcentrale | Enhancements | #3497 | Add units to measurements using QuantityType |
YamahaReceiver | Bug Fixes | #3264 | Compatibility fixes and improvements for 2.3.0 |
Z-Way | Bug Fixes | #3254 | prevent slowing down over time |
Zigbee | Enhancements | #179 | Support Discovery of USB dongles (for some Telegesis and one Ember dongle) |
#120 | Add AIS CIE System converter into converter factory | ||
#156 | Add battery voltage channel | ||
#201 | Add Carbon Monoxide Detector | ||
#132 | Add configuration and support for Ember concentrator | ||
#98 | Add handleRemoval handler to send leave command to device | ||
#149 | Add humidity and pressure converters | ||
#99 | Add power converter to display power readings | ||
#210 | Add RMS current and voltage converters | ||
#172 | Add support for serial port flow control in the Ember dongle | ||
#197 | Add UoM for Pressure and Temperature | ||
#65 | Added support for lights supporting only XY color | ||
#66 | Additions: Configuration, Polling, Channel Consolidation | ||
#121 | Color converter enhancements to support CT and Attribute discovery | ||
#96 | Improve network performance during discovery | ||
#95 | Improve property discovery performance | ||
#177 | Remove ColorHelper and use HSBType methods for color conversion | ||
#159 | Split dongles into separate bundles | ||
Bug Fixes | #89 | Update libraries to fix Telegesis / Ember concurrent queue issue | |
#91 | Update ZigBee Property Discovery to update inbox with manufacturer and model | ||
ZWave | Enhancements | #871 | Add support for including controllers |
#846 | Don't initialise sleeping devices that are already initialised | ||
#787 | Refactor inclusion code into separate class for readability and testing | ||
Bug Fixes | #782 | Fix error in binary switch converter when NOGET is true | |
#854 | Fix error with inclusion transaction timeout |
1.x Addons
Binding | Type | Issue# | Change |
---|---|---|---|
Bticino | Enhancements | #5486 | Several enhancements for Heating Control / Door Lock / Shutter / Dimmer |
CalDav | Bug Fixes | #5391 | Fix NPE during updateItemsForEvent |
CUL transport | Enhancements | #5329 | Throttle commands, which are sent to the CUL |
CUL | Bug Fixes | #5434 | Bugfix issue 5433 |
Epson Projector | Enhancements | #5446 | Fixed timeouts to meet specification |
#5505 | Improved connection stability | ||
Fritzbox Tr064 | Enhancements | #5568 | Add switch to change call deflection on/off (#5290) |
#5443 | Close connection and re-init in case of failure (#5331) | ||
Bug Fixes | #5536 | Fix the ArrayIndexOutOfBoundsException | |
GPIO | Bug Fixes | #5576 | Fixed Arguments Error |
IHC | Enhancements | #5444 | NPE fix |
Intertechno | Enhancements | #5316 | Added support for Intertechno V3 protocol |
JDBC Persistence | Bug Fixes | #5394 | Fix storage of time values for DATETIMEITEM. |
KNX | Enhancements | #5513 | Added file description and specific mappings |
#5277 | Update generic KNXCoreTypeMapper | ||
LgTv | Bug Fixes | #5393 | Trap IllegalArgumentException during deactivate() |
MQTT | Enhancements | #5519 | Allow broker URL and clientID to be modified while running |
Bug Fixes | #5554 | Improve error handling for config processing | |
Mystrom Eco Power | Enhancements | #5482 | Add feature and config files to support OH2 compatibility |
Neohub | Enhancements | #5439 | Add Holiday and HolidayDays fields |
#5438 | Handle out of range values for temperatures | ||
Nest | Enhancements | #5563 | January 2018 API update |
Novelan Heat Pump | Enhancements | #5503 | Add new simple state without time |
Open Energy Monitor | Enhancements | #5560 | Added value cache to minimize item updates |
#5340 | - direct serial port support | ||
Panstamp | Enhancements | #5489 | binding fixes |
Pilight | Bug Fixes | #5464 | Fix NullPointerExceptions in the checkItemState() method |
Pushbullet | Enhancements | #5516 | Added ability to push notes to a channel |
Pushover | Enhancements | #5483 | Added Receipts and Callback API for handling of emergency-priority notifications |
#5527 | added support for attachment/image push | ||
Serial | Bug Fixes | #5572 | Fix a binding configuration parsing error |
#5543 | Fix configuration parsing error in the serial binding | ||
Swegon Ventilation | Enhancements | #5561 | Added value cache to minimize item updates |
Telegram Action | Enhancements | #5504 | Send base64 image with Telegram message |
Bug Fixes | #5418 | Fix sending of photos with authentication | |
UCP Relayboard | Enhancements | #5465 | Add configurations for OH2 compatibility |
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.2 stable release or one of the latest 2.3 SNAPSHOT builds, switching to openHAB 2.3.0 stable is done in just a few steps:
- Connect to the SSH command line and execute:
sudo openhabian-config
- Select the "Update" option
- Wait for the openHABian update to finish, reenter the openHABian configuration tool
- Select the "openHAB 2.3.0 stable" option
Package-based Installations
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
-
Change to your openHAB root directory (e.g.
cd /opt/openhab2
) -
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
- 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.3.0/distributions/openhab/src/main/resources/bin/update)" -- 2.3.0
Windows
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
Chart settings
The path to the chart settings was updated from org.eclipse.smarthome.ui.chart
to org.eclipse.smarthome.chart
.
AVM Fritz Binding
The FRITZ_Powerline_546E_Solo
is no longer a thing-type
. It now is a bridge-type
. This can lead to errors after an upgrade when using an existing FRITZ_Powerline_546E_Solo
device. It has to be removed and added again to work properly (see here).
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 Number
by 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 Number
by Number:Temperature
for the temperature channnels. An update of the rules based on these items could be necessary too.
Yamaha Receiver Binding
The configuration parameter names now use lower camel case convention. Change 'HOST' to 'host', 'PORT' to 'port' etc.