Skip to content

openHAB 3.1 Release Notes

Kai Kreuzer edited this page Aug 11, 2021 · 5 revisions

This is the official release of openHAB 3.1.0.

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

New and Noteworthy

The openHAB 3.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 3.1 is fully backward compatibility to openHAB 3.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:

Relevant Changes

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

Add-on Type Issue
aha Waste Collection Binding #10387
AirQ Binding #10048
Android Debug Bridge Binding #9259
Benq Projector Binding #10341
Bluetooth Govee Binding #8610
BMW ConnectedDrive Binding #8576
Bosch Smart Home Binding #8629
Broadlinkthermostat Binding #9260
Dali Binding #10093
Ecotouch Binding #10010
Enphase Binding #9883
Espmilighthub Binding #9218
Folderwatcher Binding #10045
Generac Mobilelink Binding #9322
GPIO Binding #1334
Haassohn Pelletstove Binding #10595
Hayward Omnilogic Binding #8685
HCC Rubbish Collection Binding #9975
Home Connect Binding #9187
Homewizard Binding #9831
IO Metrics Binding #9890
JS Scripting Automation #8516
Luxtronik Heatpump Binding #9669
MEC Meter Binding #9075
Miele Cloud Binding #9146
Modbus SBC Binding #9174
MyQ Binding #9347
OmniLink Binding #8922
PID Controller Automation #9512
PiLight Binding #9744
PlugwiseHA Binding #9504
PWM Automation #10205
Qbus Binding #9191
Resol Binding #9449
Roku Binding #9571
Semsportal Binding #10100
Solarwatt Binding #10091
Surepetcare Binding #9713
Tivo Binding #9302
VDR Binding #9947
Ventaair Binding #9979
Warmup Binding #8562
WebThing Binding #9555

The following improvements were made:

Type Issue Change
Enhancements 2133 Integrate micrometer metering
1505 Add 'ChannelDescriptionChangedEvent'
1884 Script dependency tracking
1885 Provide Script Names to Script Engines
1891 User-defined scope in AccessTokenResponse
1897 Add ability for scripts to create unmanaged rules
1965 Add support for RTU encoding over TCP
1984 Support dimensionless QuantityType commands.
2018 Align all threads to naming convention
2043 Add rule condition for not a holiday
2046 Add 'Range' profile
2050 Extend serial port implementation
2052 Add method to read all files with specific extensions in 'transform/' folder
2053 Improve error logging when adding rules
2057 Cache parsed script in order to improve performance
2059 Include group label in warn log message
2065 Add getPoolNames method to ThreadPoolManager
2069 Add category for system channel type 'power'
2088 Add ActionService to support using Semantics features in Rules
2101 Add cache for Basic Authentication
2123 Sort group item by string
2125 Add rule rest endpoint and backend operation for rule execution simulation
2126 Add current owner to PortInUseException
2127 Remove dependencies on deprecated libraries
2144 Devices may apply a grace period for removal from the Inbox
2147 Add Timer.getExecutionTime()
2155 Restore zero byte files from backup
2157 Add system default channel type to control color temperature in Kelvin
2164 Equals and hashcode implementation for ModbusRegisterArray
2183 Make absolute color temperature channel type advanced
2194 Tag rule metric with human readable rule name in addition
2199 Modbus poolconfig handling
2222 Add automation script StartLevels
2264 Upgrade to OSGi R7 and Karaf 4.3.1
2278 Upgrade Xtext/Xtend to 2.25.0, LSP4J to 0.10.0
2297 Add i18n properties files for DefaultSystemChannels and Profiles
2298 Switch properties files encoding from ISO-8859-1 to UTF-8
2306 Translation of configurable services
2307 Filter duplicate broadcast addresses for service configuration if multiple network interfaces are available
2313 Ignore illegal thing status updates from REMOVING
2316 Upgrade Aries JAX-RS Whiteboard to 2.0.0
2318 Add editable flag for ItemChannelLinks by introducing an EnrichedItemChannelLinkDTO
2319 Upgrade Units of Measurement dependencies
2327 Upgrade hivemq-mqtt-client to 1.2.2, Netty to 4.1.63.Final
2330 Clearer error messages
2333 Add i18n feature for labels of ConfigurableServices
2343 Inbox/approve: new response code 400
2348 Implement hostnameValidated flag for secure MQTT connections
2351 Add "timestamp-offset" Profile
2361 Expose Channel Type UIDs of default System Channel Types
2364 Add "timestamp-trigger" Profile
2365 Support parsing localized strings with DecimalType, PercentType and QuantityType
2368 Log warning if profile cannot be created
2383 Change 'ConfigDescriptionParameterDTO' field serialization 'defaultValue' -> 'default'
2388 Expose TriggerHandlerCallback scheduler
2401 Add GALLON_LIQUID_US and GALLON_PER_MINUTE to UoM
2402 Make UUID available to users
2410 Add method to publish whole 'StateDescriptionFragment'
2413 Enhance sitemap SSE event with a new boolean field
2417 Add a system setting to define how to sort group members
Bug Fixes 1985 Fix NPE in ScriptError if INode is empty
1986 Fix invalid day of week max check
1992 Harden ChartServlet against NPEs when no 'period' parameter is given
2003 Update rule dsl filename to rule uid mapping
2009 Expire group item states
2020 Correctly handle file extension when looking up script
2036 Fix varianceSince and deviationSince
2049 Prevent errors in log when client closes the HTTP connection
2072 Fix parsing integer & booleans parameters in UI component based sitemaps
2077 Avoid disappearing rules by correctly checking the model and its type
2104 Also return command line execution result in case of error return code
2114 Should return STDERR if STDOUT is empty
2153 Fix to allow timer reschedule after termination
2165 Fix changing temperature via Basic UI
2178 Support sitemaps created through UI in proxy
2179 Prevent internal server error on invalid link requests on REST API
2186 Change annotation of getPreferredVoice method to allow null results
2190 Mitigation fix for earlier triggers
2203 Fix sitemap proxy URL provided by Rest API
2208 Fix MQTT QoS levels setting
2212 Fix memory leak caused by invalid UI DSL rule
2224 Allow sink to be null
2229 Fix createChannelBuilders not using overriden label/description
2258 Fix wrong/missing OpenAPI ApiResponse content
2263 Merged semantics packages in order to make API consistent
2272 Workaround for nrjavaserial issues: do not disconnect serial
2284 Upgrade jamod (to get rid of case with fragmented packets)
2289 Fix dependency issue in io.monitor bundle
2292 Upgrade org.apache.servicemix.specs.activation-api-1.2.1 to fix mail sending
2315 Modbus TCP robust against fragmentation/segmentation and more clear error message when all bytes are not received with Modbus/RTU
2337 Match on complete channel UID
2338 Approval with newThingId: only one segment allowed
2345 Update runtime BOM for hivemq-mqtt-client upgrade
2349 Display raw item state when formatting fails
2353 Remove update of timestamp on Change/Update for Item update
2398 Ephemeris Offset fix
2399 Fix links to group members in REST response
2412 Create a deep copy of the first found fragment before merging other fragments into it
UI Type Issue Change
Basic UI Enhancements 1120 Reload page when the state/command description is updated
1121 Enhance displayed message when SSE subscription failed
Bug Fixes 1065 Consider height parameter for mapview sitemap element
860 Fix proxy calls for sitemaps created through the UI
habpanel Bug Fixes 1078 Initialize configuration-provided widgets
Main UI Enhancements 724 Sort popup dialogs by name and jump to selected item on open
741 Add NotHolidayCondition in ephemeris quick selection
778 Add refresh interval for images
799 Autofocus most searchbars on desktop
800 Script editor: Basic hints for unknown modes
812 Auth system refactoring
814 Upgrade ECharts to v5, add support for ECharts gauge & chart widget
830 Fix incompatible locale format
831 Modelview deletekey functionality
833 Integrate ESLint into our development and CI process
835 Add a HABPanel like layouting page
841 Makes the item clickable in the Channel/Item link view
842 Add Control-S save feature to item edit
850 Add support for pie charts
867 Add ability to save service configuration with Ctrl-S on the keyboard
887 show confirmation dialog on changes
890 Allow customisation of location-card badges.
916 Add link to material items in MainUI
917 Add missing link to f7 input docs
918 List available colors for toggle UI items
920 Show ThingUID instead of ThingTypeUID for discovery result
921 Show ThingUID instead of ThingTypeUID for scan result
937 Refactor grid layout new item positioning
945 Rework itemMetadataWidget
964 Use unhashed browser urls, fixes #710
977 Migrate clock to system widget
979 Add stylesheet configuration to widgets
992 Allow width/height for floorplan marker as advanced params
993 Add trendSampling to doc
1000 Check if item exists when creating new, fixes #573
1002 Add slot for slides to oh-swiper, fixes #840
1012 Rework oh-knob and oh-slider, fixes #1003
1017 Google Assistant: Rework metadata UI - Part 1
1020 Google Assistant: Rework metadata UI - Part 2
1027 Use vector version of openHAB logo
1029 Implement link editable flag
1036 Extend visible parameter evaluation, fixes #880
1049 Default values for widget property parameters
1056 Enlarge border around openHAB logo for aesthetics
1063 Add Badge for BatteryLow warning
1074 Improvements for multimedia badges
1077 Change 'ConfigDescriptionParameterDTO' field serialization 'defaultValue' -> 'default'
1099 Upgrade echarts to 5.1.2
1106 Enable linking of trigger channels
Bug Fixes 698 Add additional CSP contents to enable videojs and ipcamera binding
718 Allow diacritics in search bars
721 Add thermostatTemperatureSetpointHigh and ...Low to Metadadata UI list
723 Show current GA metadata when editing
726 Do not concatenate search for items
727 Take all door subclasses in door location glance badge (except GarageDoor)
737 removed ItemStateEvent if case
767 Show correct alexa metadata categories for group items
768 Fix personal widgets ordering
769 Fallback to UIDs if things have no label during sorting.
770 Fix measurement badges display condition.
771 Consider blinds open when state is ON or 0 in blinds glance
772 Consider alarms part of equipment in location glance badges
773 Only show list indexes on mobile devices
774 Don't show edit/save buttons in model if item is not editable
775 Inbox: Fix error when deleting, add ability to set custom ID
776 Invoke the script editor directly for file-provisioned rules
787 Fix personal widget ordering (again)
795 Adding validation on channel id when adding a channel
803 Setup wizard: add empty values for language, region
804 Don't propagate loop to child widgets contexts
805 Don't update the model until save
806 Don't generate empty tags when clearing semantics in picker
807 Handle invalid links
818 Auth adjustments
819 Parse group w/ quantity base type & aggregation + parameters
820 Rule editor: remove keyboard shortcuts when a module is open
821 Fix model item creation, API explorer
822 Allow managed links to non-managed items
823 Thing editing improvements
829 Add missing homekit characteristics
843 Use consistent media types in UI Components editors
873 Fix step configuration in parameter-number.vue
874 Fix multiple selection for INTEGER options
877 Minor UI element fixes
883 Fix ctrl+save on settings pages
908 Avoid HEAD request
913 make trendline always show latest value (newest datapoint 60 minutes old otherwise)
935 Array.prototype.flat doesn't exist on older browsers, added fallback
941 Fix null reference layout-edit
943 adjust configuration menu for list items, fixes #892
944 Fix confirmation dialog in widget editor for newly created widgets
950 Fix type "number" for list separator in Designer
953 Generalize chart periods, fixes #808
954 Run search filter on item list page reinit, fixes #861
958 add missing page check in page-view
959 limit keyboard shortcuts to single modifier key
962 Fix wrong widget editor mode when splitted horizontally
963 fix dialog on metadata removal
973 Fix some misc minor issues
974 Apply layout page styles in edit mode, fixes #972
975 recalculate oh-slider when rendered, fixes #967
976 Replace double percent sign in chart unit, fixes #870, fixes #928
980 Show copy icon for thing and channel uids, fixes #396, fixes #475
1001 Fix group slider triggering change, fixes #789
1013 fix small bug in widget mixin
1015 Show error message when link cannot be removed, fixes #903
1016 Fix display error at tech info on iOS, fixes #849
1019 Fix sitemap creation
1022 Google Assistant: Renamed "Secondary User Verification" parameters
1023 Fix height description in grid layout properties
1043 Link and Profile related fixes
1045 Use status instead of message for error responses to detect Unauthorized requests
1046 Fix Z-Wave network map not rendering when a node has no zwave_neighbours property
1048 Don't navigate back after removing an invalid link
1052 Change unit from "lux" to "lx" on badges
1053 Fix raster favicons
1054 Fix profile filtering
1055 Fix model not displayed if not ready on home page tabs
1057 Fix oh-cell "on" evaluation
1070 Fix layout pages' grid item button & Allow link to be added when there is none
1073 Item picker: load items when passed an empty array
1085 Apply cronLastSpecificDomDay to DOW-field instead of DOM-field
1093 Add link: fix profile selection
1095 Fix analyzer back button if another popup was opened
1117 Revert analyzer z-index changes
1118 Add as Thing (with custom ID) - suggest last segment only
1119 Realign "Copy UID" buttons
Add-on Type Issue Change
airthings Enhancements 10456 Add support for Airthings Wave Mini
amazondashbutton Bug Fixes 9988 Fix representation property
Amazonechocontrol Bug Fixes 9644 Fix SmartHomeDevice channels
9812 Fix thermostat handler
9982 Fix routines
10084 Fix smarthome device naming
astro Bug Fixes 9474 Fix for incorrect calculation of next season
atlona Enhancements 9385 Add support for the AT-PRO3HD66M
Bug Fixes 9631 Volume level should be a whole number
10279 Fix PROPERTY_VERSION not displaying correct value on UHD models
automower Enhancements 8802 Add planner, calendar and command channels
avmfritz Enhancements 9464 Minor improvements in code and documentation
9467 Add humidity channel for DECT440
9514 Pimp properties and channel types with proper categories
10492 Add support for HAN-FUN blinds
10716 Add support for publishing ChannelDescriptionChangedEvents
10760 Add support for HAN-FUN outlets / simple on-off devices
Bug Fixes 9734 Add initial refresh of Call Monitor channels and improved thread handling
9753 Fix channel update for DECT440 rocker
9778 Add warning if temperature command cannot be converted to Celsius
10659 Fix wrong dial code in status info
bigassfan Enhancements 9472 Add representation property
bluetooth Enhancements 8970 Change characteristic read/write to use CompletableFutures
10209 Adapt labels of discovery results to standard
Bug Fixes 10099 Expire discovery snapshots so that devices can be rediscovered
10153 Graciously handle systems without DBus
10155 Define supported bridge types for generic BT devices
10187 Fix disappearing bluetooth devices in Inbox
bluetooth.bluegiga Enhancements 10148 Introduce better initialization functionality
Bug Fixes 9442 Improve illegal frame receiving handling
bluetooth.generic Enhancements 10122 Enable BLE notification for linked channels
buienradar Bug Fixes 9804 Avoid to much log noise
caddx Bug Fixes 10317 Correct thing status on bridge initialization
chromecast Enhancements 9228 Initialize connection to devices asynchronously
10245 Added play URL actions to chromecast binding
Bug Fixes 9596 Prevent exception when formatting value
comfoair Enhancements 9401 Improve data handling
Bug Fixes 10685 Fix data handling for restricted devices
daikin Enhancements 9602 Add energy usage day & week
Daikinmadoka Enhancements 9368 New channels and fixes
deconz Enhancements 9513 Pimp properties and channel types with proper categories
9686 Add channel to enable / disable motion sensor
9914 Add ontime feature
10126 Use system default channel types for lights
10217 Pimp properties and channel types with proper categories
10900 Add support for publishing ChannelDescriptionChangedEvents
Bug Fixes 9583 Properly initialize colorMode
9614 Refactor and fix connection issues
9915 Fix loglevel
9955 Fix missing re-connect if first request timed out
10132 Fix wrong channel type for extended color light
10486 Prevent exception when formatting value
10729 Make lightgroup switch off if brightness is set to 0
10829 Set "ontime" option only if thing has got an ONTIME channel
denonmarantz Bug Fixes 9511 Run the Telnet socket in a dedicated thread
digitalSTROM Enhancements 10444 Shade angle support for GR things
Bug Fixes 9834 Fix concurrency issue
draytonwiser Enhancements 9649 Add comfort mode option to boiler controller
9650 Fix typos in log messages and class names
9706 Expose Smart Plug Power Metering, Improve null handling
Bug Fixes 9806 MDNS Fixes
dwdunwetter Bug Fixes 9594 Fix channel updates
10421 Set channel states to UNDEF instead of NULL
10556 Prevent exception when formatting valuevalue
dynamodb Enhancements 9937 Dynamodb QuantityType and data expiration (TTL) support. Update AWS SDK
ecobee Enhancements 10772 Logging improvements
Bug Fixes 9450 Fix weather forecast pressure units
9522 Rework discovery
9632 Fix actions broken by recent PR
10255 Fix logging levels
Elero Transmitter Stick Bug Fixes 9562 Drop responses that do not fit the command that was sent.
enocean Enhancements 9468 Add support for Heat Recovery Ventilation devices (#9465)
10157 Improve device discovery and added SMACK capability (#10156)
10852 Add support for eltako rollershutter frm60
Bug Fixes 10577 Fix discovery of D2-50 devices
epsonprojector Enhancements 9375 Add ESC/VP.net handshake for projectors with built-in ethernet
Bug Fixes 9770 Fix "projector-tcp"-Thing gets stuck after Power-off via TCP
10079 Always set ready=true on disconnect and improve documentation
10266 Fix ONLINE status reporting
exec Enhancements 10021 Add support for *BSD OSes
fmiweather Enhancements 10765  Fix to work with new API
fronius Enhancements 9209 Add support for Fronius Smart Meter
Bug Fixes 9912 Fix invalid json error on meter data
ftpupload Enhancements 10127 Add configurable passive port
globalcache Enhancements 9471 Add representation property
gpstracker Enhancements 10356 Force channel triggering without previous state
Bug Fixes 10374 Support for military grade GPS accuracy (<1yd)
groovyscripting Enhancements 10721 Update Groovy to 3.0.8
hdpowerview Bug Fixes 10118 Eliminate nightly crash dump
10450 Correctly embed dependency in binding
helioseasycontrols Enhancements 9772 Internationalization + actions for messages - Attempt 2
heos Enhancements 9935 Fix runtime error; Support for new Denon "Home" speaker added
9941 Update pause/stop handling
homekit Enhancements 9475 Add support for QR code based pairing
9932 Mapping configuration improvements
10019 Add support for dimmer item for slat accessories
10051 Add support for number and dimmer item types to window covering
10169 Add support for flag "inverted" to lock accessory
10212 Extend support of flag "inverted" to other accessories
Bug Fixes 9484 Fix metadata changes not seen until restart
9769 Fix pairing after addon update
10074 Min and max temperature units according to useFahrenheitTemperature
10076 Make use of openHAB mDNS service
10286 Make usage of mDNS configurable
Homematic Enhancements 10035 Remove Apache Commons
Bug Fixes 9692 Fix two (re)connection problems
10224 Additional check for convert to double
10813 Smaller fixes and conversion of properties files to UTF-8
hpprinter Enhancements 10549 Prevent "handler disposed" warnings on shutdown
http Enhancements 9509 Add rate-limiting to channel refresh
9584 Add pre-emptive basic authentication and fix header handling
9601 Enable UoM for number channels
10022 Add POST/PUT support for state requests
Bug Fixes 9618 Fix missing escaping of URLs
9626 Fix initial refresh
9981 Fix duplicate commands on PlayerItemConverter
10213 Fix Player Converter State Issue
10897 Fix parsing of Color RGB values
hue Enhancements 9856 Use system default channel types for lights
9939 Add support for different color temperature capabilities and added Channel to set value in Kelvin
9985 Implementing "UPnP Devices may apply a grace period"
10137 Remove internal vendor Map and minor additional improvements
10718 Add support for publishing ChannelDescriptionChangedEvents
Bug Fixes 9367 Make sure the serial number will be in lowercase
9502 Catch exception if 'AllGroup' does not exist
9685 Fix configuration update for parameter 'ledindication'
9687 Fix German translations for motion sensor
10199 Eliminate NPE in #9985
10608 Change default color mode for color commands to XY
10609 Fix ColorTemperature set to UNDEF
hueemulation Bug Fixes 9463 Correct format of UDN and serialNumber fields in description.xml
iaqualink Bug Fixes 10853 Fix critical login issue due to changed auth URLs.
icalendar Enhancements 9383 Add last_update-channel
9501 Optimization of eventfilter-search and more debug output
9911 Use cache folder to store calendar file
10810 Short events parallel to longer current events are now also shown as current event
Bug Fixes 9678 Fix issues with moved events and wrong displayed events
9849 Ensure DecimalType will be used if no unit given
icloud Bug Fixes 10710 Fix invalid iCloud response: null
ihc Enhancements 10856 Support for TLSv1.2
Bug Fixes 9956 Fix extensible channel names
influxdb Enhancements 9943 Add option for using metadata value as measurement name
Bug Fixes 9545 Treat a stored 1 AND 1.0 as true
10680 Fix problem querying old historical data
10888 Fix history queries if items are not tagged
innogysmarthome Bug Fixes 9677 NullPointerException fixed which could occur when no device state is available (#9660)
insteon Bug Fixes 10620 Delay setting state of network to UNKNOWN
10708 Add a read timeout when getting data from the Insteon 2245-222 hub
ipcamera Enhancements 9766 Fix for Instar and HLS.
10078 Improve Dahua alarms
Bug Fixes 10319 Improve Hikvision alarm reliability
10351 Fix warning wrongly when Image poll time is >9 seconds.
10846 Fix null URL channels and fix multiple cameras use the same ffmpeg output folder.
irobot Enhancements 9775 Add command "cleanRegions" to clean specific regions only
Bug Fixes 10860 Fix password discovery and command sending for Roomba I-Models. (using gson)
jablotron Bug Fixes 9809 Fix programmable gates channels are not visible in the O…
jdbc Enhancements 9426 Return QuantityTypes for number items with dimension
10524 Add missing config parameters for sqltypes of IMAGE an PLAYER item types
Bug Fixes 9445 Consider local timezone to create time filter
9904 Do not define bundle related versions in OH feature file
10501 Use TypeParser to get matching Item State
10542 Increase size of column type for Location Item
jinja Bug Fixes 10581 Empty string result when binding is missing
js Enhancements 9646 Add 'ConfigOptionProvider' to provide filenames ending with '.js' in Profile configuration
keba Bug Fixes 10399 Robustness improvements on communication error
KNX Bug Fixes 9533 Fix DateTime Control channel label
kodi Enhancements 10717 Add support for publishing ChannelDescriptionChangedEvents
Bug Fixes 9597 Prevent exception when formatting value
kostalinverter Enhancements 8574 Add Second Generation (Piko10-20) type inverters
10779 Add new channels frequency and cosphi
lcn Enhancements 10305 Add dimmer profile parameter to be accessible via UI
10645 Shorten labels
10770 Improve readme; Allow special module IDs <5
Bug Fixes 9761 Fix displaying of "not enough licenses" message
9991 Fix several bugs in measurement processing with firmware before 2013
10115 Fix RVar setpoint modification for modules before 2006
lgwebos Bug Fixes 10404 Fix Text Message Size Bug
lifx Enhancements 10384 Improve firmware version support
linky Enhancements 9774 Set channel to UNDEF when data not yet available
9840 One unique method to update daily and weekly data channels
Bug Fixes 9423 Handle case when data from yesterday is still NaN
linuxinput Enhancements 9582 Improve thread names
10730 Handle all kinds of buttons
Bug Fixes 10634 Fix to thing properties
10742 Use correct channelTypeUID for key-press channels
loxone Enhancements 10185 Support for HTTPS websocket connections.
10585 Implementation of EIB Dimmer
Bug Fixes 9624 Fix communication deadlock when receiving websocket and sending keepalive messages
10086 Fix representation property
luftdateninfo Enhancements 10643 Add internal sensor support
lutron Enhancements 10302 Add support for bridged RadioRA (classic) systems
magentatv Enhancements 10267 Adapt to new Telekom OAuth flow (required to retrieve the userId)
map Enhancements 9641 Add 'ConfigOptionProvider' to provide filenames ending with '.map' in Profile configuration
mcp32017 Bug Fixes 10293 Update Pi4J to 1.4 so binding works with Java 11
melcloud Bug Fixes 10133 Fix representation property
miele Bug Fixes 9536 Use dedicated thread for event listening
miio Enhancements 9371 Change vacuum segment channel from undef to -
9379 Suggest correct devicenames in readmehelper
9380 Add support for xiaomi.airconditions c/ma/mc/mh/mt models
9384 Update many channels with tags, categories & QuantityTypes
9752 Improve Mi Water Purifier 600G yunmi.waterpuri.lx8.
9756 Improve Airpurifiers
9787 Add support for nwt.derh.wdh318efw1 Internet Dehumidifier
9795 Add support for chungmiplug 212a01
9798 Add support for viomi.waterheater.e1
9859 Add support for dreame vacuum d9
9861 Add support for Mijia Smart Pet Water Dispensers
9878 Add support for viomi S9 vacuum (v18)
9885 Add support for zhimi airpurifier 3C (mb4)
9959 Allow all quantitytypes and units
9968 Add support for zhimi.humidifier.cb2 Smartmi Evaporative Humidifier
10036 Add channel for is_locating
10037 Add support yeelink.light.colora Yeelight Smart LED Bulb 1SE
10180 Additional vacuum channels for advanced rules
10181 Add support for deerma Humidifier
10182 Add support for cgllc.airm.cgdn1 Qingping Air Monitor Lite
10183 Add support for zhimi.airpurifier.vb2 Mi Air Purifier Pro H
10229 Add support for Smartmi Standing Fan 3 zhimi.fan.za5
10231 Add support 5 zhimi heaters
10254 Add support for dreame vacuums p2036.p2041o,p2056o,p2057
10531 Add support for Mi Smart LED Bulb Essential (yeelink.light.color5)
10534 Add support for Smartmi Air Purifier zhimi.airpurifier.za1
10602 Add support several new roborock vacuums
10603 Add support for yeelink.light.lamp15 Yeelight Screen Light Bar
10763 Add support for Yeelight 1S (mono4)
10855 Add support for Mi Smart Standing Fan Pro Global (dmaker.fan.p15)
10873 Improve dreame mc1808 channels
10882 Improve zhimi fan channels
10893 Add support gateway lumi.gateway.mieu01
Bug Fixes 9865 Fix printed zone clean command
9888 Fix channels with invalid names
9901 Fix double status update
9966 Validate response id matching command id
9970 Remove unit from color temperature
10032 Update zhimi humiddifier ca4
10065 Fix datatype for brightness of the ambient light
10190 Fix bundle restart error
10269 Add functions for Vacuums P2009/2036/2157
10394 Fix viomi's battary_life property
10601 Handle invalid rssi response
10714 Also refresh after custom commands
10854 Avoid NPE when rssi is missing
10869 Fix typo in temperatue unit
10880 Fix discovery issue for devices with dot in ID
10894 Fix typo
modbus Enhancements 9435 Add support for RTU encoding over TCP
9945 Modbus transformations: cascaded/chained transformations and new-style transformation string
9980 Gain-offset profile (QuantityType support) and writing of individual bits of holding registers
10147 Fix defaults for tcp and serial things and some other minor cleanup
modbus e3dc Enhancements 10647 Add default state patterns
Bug Fixes 10536 Fix wrong E3/DC Emergency Power Possible bit
mongodb Enhancements 10202 Collection per Item
Bug Fixes 10584 Fix error 500 and various improvements
mpd Bug Fixes 10166 Fix invalid volume
mqtt Bug Fixes 9758 Only unsubscribe if we subscribed before
9760 Remove default for contact/switch alternate on/off message
mqtt.generic Bug Fixes 9927 Fix trigger channel definition
10587 Fix percentage range
mystrom Enhancements 9910 Add support for myStrom Bulb
nanoleaf Enhancements 10029 Add Shapes & beta-firmware support
10101 Refactor code to use core features and more
Bug Fixes 9786 Fix color temperature setting
neato Bug Fixes 9564 Fix NPE in discovery service
10724 Fix slow cleaning of robot
neeo Bug Fixes 9929 Fix forwardActionServlet and code improvements
neohub Enhancements 10522 Quality improvements
10598 Thermostats now support setpoint changes in steps of 0.5 Celsius
nest Enhancements 8947 Add support for Smart Device Management (SDM) API
netatmo Enhancements 9531 Pimp channel types with proper categories
10544 Fix the thresholds for the WifiStatus channel
nibeheatpump Enhancements 9376 Add device support for SMO40 control
Bug Fixes 9958 Fix data parsing
10135 Fix compile error in RasPi
nikobus Enhancements 10047 Add option to reverse rollershutter commands
Bug Fixes 9603 Open connection on refresh even if no modules exist
9716 Refresh impacted modules on simulated button press
10795 Remove required=true for parameters with default value
nikohomecontrol Enhancements 10281 Add shutter invert and fix connection with NHC does not recover
Bug Fixes 10546 Fix energy meter
novafinedust Enhancements 10005 Optimizations on access to the serial port
10210 Use fire and forget commands to configure device
onewire Bug Fixes 9833 Fix absolute humidity channel type
openhab-cloud Bug Fixes 10600 Accept all Jetty supported http method types
openthermgateway Enhancements 9516 Add Diagnostics indication channel
10040 Added support for firmware version 5.0
openweathermap Enhancements 9717 Added new supported languages
10343 Added support for Air Pollution API
Bug Fixes 9832 Fixed UV-Index Channel Group Creation
openwebnet Enhancements 10191 Add support for Energy Meter
10508 Added refresh of devices after reboot or disconnect
10565 Energy meter returns always zero power if no other device has subscribed to power measures
10756 Add support for Thermoregulation (standalone thermostat and sensors)
10822 Replace scheduleAtFixedRate by scheduleWithFixedDelay
10865 Rename thermoregulation's (WHO=4) things
Bug Fixes 10397 Move to io.github.openwebnet4j 0.4.1 from Maven Central
10775 Shutter position is set UNDEF after reboot
oppo Bug Fixes 10306 Fix setting verbose mode at startup
pioneeravr Enhancements 10328 Add support for Pioneer VSX-922 AVR
10329 Add channel for changing MCACC Memory profile on AVR
powermax Enhancements 9817 Improve error handling for Powermax binding
pulseaudio Enhancements 10423 Add pulseaudio sink as openhab audio sink
10731 Add "idle timeout" to Pulseaudio audio sink
pushover Enhancements 10422 Add universal action providing all available parameters
10817 Provide the ability to specify a timeout in the config
10840 Minor improvements for handling sounds, Fix SAT findings
Bug Fixes 10437 Add exception handling and synchronize method
radiothermostat Enhancements 10194 Add Remote Temperature channel
10819 Add job to set thermostat clock automatically from the binding
remoteopenhab Enhancements 9657 Consider the remote item pattern formatter
10138 Connection to the remote server through openHAB Cloud
10885 Listen to the new ChannelDescriptionChangedEvent even…
Bug Fixes 9638 Handle IllegalArgumentException when building channels
10049 Suppress the IP check
10870 Avoid registering conflicting filters for SSE connection
rfxcom Enhancements 10825 Add support for TFA 30.3233.1 rainmeter
10830 Convert unsigned byte to int properly
10832 Read multiple bytes at a time over serial connection
10833 Add support for receiving RAW messages
10834 New sub types for undecoded messages
10844 Update interface message support
10866 Enable Raw message transmission
10877 Add support for additional blinds
10879 Add firmware type, avoid crashing on unknown.
10891 Add Novy extractor fans
rotel Bug Fixes 10165 Fix command to select PC USB source (ASCII v2 mode)
samsungtv Bug Fixes 9525 UPnP devices discovery refactored
9923 Fix WebSocket TVs stay UNKNOWN until first power-on
satel Bug Fixes 9718 Fix thing discovery
scale Enhancements 9640 Add 'ConfigOptionProvider' to provide filenames ending with '.scale' in Profile configuration
SenecHome Enhancements 10657 Catch and ignore malformed JSON
10687 Extend with additional channels, refactor and various improvements
Bug Fixes 9521 Fix BatteryState, should be a String
sensebox Bug Fixes 10348 Gracefully handle JsonSyntaxException
shelly Enhancements 9508 Improved documentation, support for UNI, 1L, Color Bulb
10054 Shelly Motion, minor improvements
10220 Improve Motion Support, Support CoIoT Unicast, fixes
10276 New Shelly Manager (more detailed information, status, integrated firmware upgrade)
10618 Vibration event for DW2
10815  1PM/1L/2.5: New device#supplyVoltage; Motion: Missing channel for vibration; UNI: Unit for ADC voltage; PF for EM; Bulb: fix range for color temp
siemensrds Enhancements 9808 Hide already instantiated Things in the InBox
smartmeter Bug Fixes 9781 Fix flooding logs with warnings if serial port is not accessible
10007 Fix NPE while trying to get ChannelType
10008 Fix trying to create channels from invalid data
10088 Fix Thing OFFLINE Communication Error due Exception in last PR
smartthings Bug Fixes 9889 Fix discovery service bug and enhancement to SmartApp
smhi Enhancements 9387 Add aggregated channels for daily forecast.
Bug Fixes 10794 Catch exception that could cause binding to stop updating channels
10851 Fix exception in aggregation function when daily forecast is empty
snmp Enhancements 10681 Apply UoM to number channels from an SNMP target
somfytahoma Enhancements 10023 Retry command submission when tahoma gateway is busy.
10299 Add tag representation_property in things XML files
10300 Setting of channels at init + UoM for channels
10347 New method to send a command to several devices in the same place
10498 added support for the Bioclimatic Pergola thing
10611 Open to other portals
Bug Fixes 10336 Improved handling of target temperature command
10355 Fix bug causing Gateway and Actiongroup never get ONLINE
10453 Avoid potential NPE
10488 Fix action groups execution
sonos Enhancements 9916 Add support for Sonos Arc/Arc SL + new controls for sub/surround speakers
9918 Add bass/treble/loudness controls
9952 Add sub/surround controls to Beam, Playbar and Playbase
9962 Add support for Sonos Move
9998 Add new channels for battery (Sonos Move)
9999 Add new channel for microphone (Arc, Beam, Move, One)
10596 Add support for Sonos Roam
10759 Add new channel heightlevel for Sonos ARC / ARC SL
Bug Fixes 10323 Fix discovery of Ikea SYYMFONISK models
10599 Play notification while playing virtual line-in
squeezebox Enhancements 10196 Add sleep channel
10778 Map player connection state to thing status
Bug Fixes 10244 Fix Spotify and Tidal favorites
sunspec Bug Fixes 10175 Handle fp numbers for voltage types
Synopanalyzer Bug Fixes 10113 Add French localization
tacmi Enhancements 10095 Fix unintended toggleing and add update policy
tado Enhancements 9801 Hide already instantiated Things in the InBox
10550 Prevent "handler disposed" warnings on shutdown
Tankerkoenig Enhancements 10070 Lower minimum refresh interval
teleinfo Bug Fixes 9724 Fix memory leak
tellstick Enhancements 10020 Add support for Tellstick local API
Bug Fixes 9634 Fix NoClassDefFoundError that caused the Tellstick addon to not work properly
10378 Fix for NPE
tesla Bug Fixes 9802 Correctly handle floating point numbers for estimatedbatteryrange channel
10259 Add SSO handler to authenticate against Tesla SSO service
10872 Prevent NPE
tibber Enhancements 9814 Add channel and channel corrections due to API changes
touchwand Enhancements 10748 Add support for Risco alarm system sensors and AcWand thermostat
tplinksmarthome Enhancements 9800 Add suppport for the TP-Link Kasa KP115 Smart WiFi Plug with Energy Monitoring
tr064 Enhancements 9505 Add rule action for phonebook
9519 Add new channels for DSL Max & Current Down-/Upstream Rate
9529 Log warning if config invalid
9543 Improve error handling
9655 Fix wanBlockByIP channel and improvements to paramater handling
9733 Normalize numbers in phone book entries.
10447 Use Util.getAndUnmarshalXML method to retrieve phonebook
Bug Fixes 9454 fix fritz.box lookup
9488 Fix missing SOAP connector initialization
9527 Fix CRCErrors channel
9671 Fix comment in SOAP request
9693 Reduce network load and improve XML handling
9739 Merge duplicate phone book entries
9749 Fix parameter patterns
9954 Fix wrong unit in TotalBytes
10523 Fix wrong time parsing
10660 Fix wrong pattern to normalize phone numbers
10905 Add representation property for Things
tradfri Enhancements 9864 Use system default channel types for lights
Bug Fixes 9629 Fix NPE if gateway is unreachable
unifi Enhancements 10041 Add support for UniFi OS
ValloxMV Enhancements 10324 Add Co2 measurement
Bug Fixes 10555 Fix co2 channel
velbus Enhancements 10058 Fix reading of alarm clock status on VMB4AN and added support for VMBVP1
10664 Add new functionality PRESSED and LONG PRESSED
Bug Fixes 10627 Fix parsing of channel bytes on VMB4AN.
velux Enhancements 9477 Enable background discovery
Bug Fixes 9794 Fix a couple of bugs if the Bridge contains one or more Scenes
10119 Stability checks and improvements in slip io
10449 Fix synchronisation of handler initialization and disposal
venstarthermostat Enhancements 10736 Venstar thermostat away mode enhancement
Bug Fixes 10740 Use doubles over Int or float types when processing temperatures, fix Checkstyle Warnings
verisure Enhancements 10580 Add channel for low battery warning for supported thing types
voicerss Enhancements 10146 Add further supported languages
10184 Add support for voices
WebThing Bug Fixes 10579 If WebThing network connection is crashed, WebThing will not be reconnected
WlanThermo Enhancements 9579 Add support for new Nano V3, Mini V3, Link V1, Mini V1/V2(ESP32) devices [V3.x]
WLED Bug Fixes 9863 Fix brightness handling for HSBType
10252 Fix White LED turns on to max brightness for any RGB changes
yeelight Enhancements 10222 Add mono4 and strip6
yioremote Enhancements 10480 Update and improve of the reconnection of the plugin
Bug Fixes 9574 Fix sendIRCode action
Zigbee Enhancements 620 Refactor channel converter to support device configuration during discovery
630 Add fingerprint CLI command
631 Improve management of command response handling
646 Add metering channels
654 Update to ZSS 1.4.0
Bug Fixes 645 Don't reinitialise network multiple times
648 Persist network configuration after network is ONLINE
657 Fix polling linked channels
zoneminder Bug Fixes 9600 Rework discovery to not use the thing handler thread
9672 Fix most recent event query
ZWave Enhancements 1480 Add RGBW color mode
1490 Extend Door Lock Command Class
1492 Ignore duplicate controller configuration
1493 Add channels that are linked to the poll set.
1551 Convert commands to channels datatype if possible
1603 Add unit & label to MeterScale.E_KVAR & MeterScale.E_KVARH
Bug Fixes 1470 Fix lux units

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

  1. Connect to the SSH command line and execute: sudo openhabian-config
  2. When being asked, answer that you want to update.
  3. Select the menu entry"03 - Install openHAB" option.
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.1.0 and its optional add-ons with:

sudo apt-get install openhab=3.1.0-1

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

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.1.0 and its optional add-ons with:

sudo yum install openhab-3.1.0-1

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

Official update scripts are available that let you update your 3.0.x installation to version 3.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 3.1.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.1.0

Xiaomi MiIo Binding

Many channels have been converted from Number to a Number with dimension, e.g. temperature channels have been changed from Number to Number:Temperature. Please see the binding documentation for details.

Keba Binding

Introduced Units of Measurements and the channel 'pwmpilotcurrent' was replaced by 'maxpilotcurrentdutycyle'. Items must be adapted and things created through the UI must be recreated.

Nest Binding

The binding now also supports the SDM API. To keep using the WWN API, add the 'wwn_' prefix to Thing Types in files or recreate the WWN Nest Things using the UI with your current WWN account configuration parameters.