Skip to content

Latest commit

 

History

History
437 lines (309 loc) · 44.5 KB

CHANGELOG.md

File metadata and controls

437 lines (309 loc) · 44.5 KB

Changelog

5.8.0

Type Namespace Description Reference Breaking
Enhancement items ItemPersistence: Add PersistedItem::instant #396 No

Also see the Release Milestone.

5.7.2

Type Namespace Description Reference Breaking
Documentation actions Add new ColorUtil methods to CoreUtil docs #388 No
Bugfix rules Rule Builder: Fix wrong type defs for send(command) #389 No
Bugfix rules Rule Builder: Fix condition callback type def #390 No
Bugfix cache Advice to not store objects in shared cache #391 No
Bugfix items Fix type def issues caused by private method in Item class #394 No

Also see the Release Milestone.

5.7.1

Type Namespace Description Reference Breaking
Bugfix Properly handle null input in internal instanceof checks #385 No

Also see the Release Milestone.

5.7.0

Type Namespace Description Reference Breaking
Bugfix osgi Fix type defs of getService 9c87bb7 No
Enhancement rules Rule Builder: Add offset support for DateTimeTrigger #382 No
Bugfix time Default to user-configured timezone #383 No
Enhancement items Item: Add sendIncreaseCommand/sendDecreaseCommand methods #371 No

Please note that with this release the utils.javaInstantToJsInstant and utils.javaZDTToJsZDT methods have moved to the time namespace, and utils.javaZDTToJsZDTWithDefaultZoneSystem has been replaced by time.javaZDTToJsZDT. The old methods are still available for backwards compatibility, but considered deprecated.

Also see the Release Milestone.

5.6.0

Type Namespace Description Reference Breaking
Enhancement items ItemPersistence: Add medianSince, medianUntil and medianBetween methods #376 No
Enhancement rules Add offset & timeOnly to event information for DateTimeTrigger #379 No
Enhancement triggers Support offset param for DateTimeTrigger #380 No
Enhancement items ItemPersistence: Add toString overrides for PersistedState & PersistedItem #381 No

Please note that the signature of DateTimeTriggers has changed. The old signature is still supported, but considered deprecated. See the openhab-js : triggers : DateTimeTrigger JSDoc for more information.

Also see the Release Milestone.

5.5.0

Type Namespace Description Reference Breaking
Enhancement actions NotificationBuilder: Make message optional (default to empty string) #370 No
Enhancement rules JSRule: Support rules without triggers #372 No
Bugfix rules RuleBuilder: Fix type defs for .if() and .then() 7b46659 No

Also see the Release Milestone.

5.4.0

Type Namespace Description Reference Breaking
Enhancement actions NotificationBuilder: Support multiple args for addUserId #362 No
Enhancement utils Replace isJsInstanceOfJavaType method with instanceof #364 Yes
Bugfix Use instanceof helpers for Item and Quantity class instead of instanceof #365 No
Bugfix actions ScriptExecution: Fix missing timer identifier for UI scripts #367 No

Also see the Release Milestone.

5.3.3 (5.3.2)

Type Namespace Description Reference Breaking
Bugfix rules SwitchableJSRule: Fix restore previous state fails for switch Item #355 No
Bugfix time toZDT: Fix JSDoc for when parameter says param is required #357 No
Bugfix items getItem: Don't declare null as return value as this is normally not returned #358 No
Bugfix rules RuleBuilder: Mark fn for then(fn) as optional (wrong JSDoc) #359 No
Bugfix rules JSRule: Always sanitize passed in rule UID #360 No

Also see the Release Milestone.

5.3.1 (5.3.0)

Type Namespace Description Reference Breaking
Enhancement actions Add notification builder #351 No
Enhancement actions Mark some actions deprecated as replaced by better APIs #351 No
Enhancement actions Notification Builder: Add support for updating/hiding notifications #353 No

These two releases are coupled together as 5.3.1 contains follow-up changes for 5.3.0. Use 5.3.1 instead of 5.3.0.

Also see the Release Milestone.

5.2.0

Type Namespace Description Reference Breaking
Enhancement items ItemPersistence: Add lastChange and nextChange methods #350 No

Also see the Release Milestone.

5.1.2 (5.1.1)

Type Namespace Description Reference Breaking
Bugfix helpers Fix isInstant check & Improve isXXXX checks in general #348 & #349 No

These two releases are coupled together as 5.1.2 contains follow-up changes for 5.1.1. Use 5.1.2 instead of 5.1.1.

Also see the Release Milestone.

5.1.0

Type Namespace Description Reference Breaking
Bugfix Quantity Fix type definitions ee0a59a5 No
Enhancement rules Add original input to event data for file-bases rules #334 No
Bugfix items ItemPersistence: Fix multi-threaded access exception when persisting states #339 No
Enhancement items ItemPersistence: Add support for persisting TimeSeries #341 No
Enhancement items TimeSeries: Add support for using Instant as timestamp #342 No
Enhancement items Item: Fix sendCommandIfDifferent fails to compare Quantity #343 No

Also see the Release Milestone.

5.0.0

Type Namespace Description Reference Breaking
Clean-Up Remove deprecated methods and fields #332 Yes
Enhancement items ItemHistory: Adjust to core changes & Add new methods for future states #331 Yes

Please note that this release drops support for openHAB 4.1.x. From now on, openHAB 4.2.0 is the minimum requirement for full compatibility.

Read the release community post to learn about adjusting your scripts & rules to the breaking changes.

Also see the Release Milestone.

4.9.0

Type Namespace Description Reference Breaking
Enhancement time Upgrade JS-Joda (date & time library) #323 No
Enhancement rules SwitchableJSRule: Add option to specify name of Switch item #325 No
Enhancement items Remove the Item suffix from Item.type #325 Yes

Also see the Release Milestone.

4.8.0

Type Namespace Description Reference Breaking
Enhancement actions Export CoreUtil actions #319 No
Enhancement rules JSRule: Update MIME type shown in the UI c8c664a No

Also see the Release Milestone.

4.7.3

Type Namespace Description Reference Breaking
Bugfix items Fix updating/commanding Item with undefined fails b30c794 No
Bugfix things Fix getThing doesn't return null if Thing is not existent #315 No

Also see the Release Milestone.

4.7.1

Type Namespace Description Reference Breaking
Bugfix time Fix toZDT fails when injection caching is enabled because instanceof checks don't work #312 No

Also see the Release Milestone.

4.7.0

Type Namespace Description Reference Breaking
Enhancement triggers Add GenericEventTrigger #300 No
Bugfix rules Fix Rule Builder type defs not available 5ad1938 No
Enhancement items ItemHistory: Add getAllStatesBetween & getAllStatesSince methods #309 No
Bugfix time Default to system timezone in toZDT if zone is not explicitly provided #307 No
Enhancement actions ScriptExecution: Support passing params to createTimer in setTimeout-style #311 No

Also see the Release Milestone.

4.6.0

Type Namespace Description Reference Breaking
Bugfix Fix instance of Item checks don't work #290 No
Enhancement rules Rule Builder: Add DateTime & TimeOfDay triggers & Improve type defs #291 No
Enhancement rules Add event information for time-based and manual/run-rule triggers #286 No
Enhancement rules Rule Builder: Add fromOn & fromOff to Item trigger config #297 No
Enhancement items Use registry instead of provider #298 No

Also see the Release Milestone.

4.5.1

Type Namespace Description Reference Breaking
Bugfix items Fix null handling in sendCommand/postUpdate methods of Item #282 No
Bugfix Infrastructure Disable Webpack TerserPlugin for cached globals injection #283 No

Also see the Release Milestone.

4.5.0

Type Namespace Description Reference Breaking
Enhancement Quantity Support Item for Quantity construction & divide/multiply methods #275 No

Also see the Release Milestone.

4.4.0

Type Namespace Description Reference Breaking
Enhancement utils Add Java to JS conversion for Instant & ZonedDateTime #267 No
Bugfix rules Preserve disabled state of switchable rules after restarting #271 No
Enhancement Configure webpack to keep class and function names #273 No
Enhancement rules Add name of triggering group to event object #268 No
Bugfix things Fix Thing.setX methods don't persist changes to ThingRegistry #274 No

Note: The changes on the event object require openHAB 4.0.0(.M4) or newer.

Also see the Release Milestone.

4.3.0

Type Namespace Description Reference Breaking
Enhancement Quantity Refactor exports for better internal use b77b6e3 No
Enhancement items Use data type classes instead of type definitons for ItemMetadata & HistoricItem e0f0ca1 & 858ce86 No
Bugfix items Fix Item semantics location & equipment #261 No
Enhancement Quantity Minor improvements & Make quantityState null when unit is missing #263 No

Also see the Release Milestone.

4.2.1

Type Namespace Description Reference Breaking
Bugfix rules Adjust event object for recent core changes #260 No

Also see the Release Milestone.

Please note that openHAB >= 4.0.0(.M2) (or >= SNAPSHOT #3391) requires at least this version.

4.2.0

Type Namespace Description Reference Breaking
Enhancement items Add missing semantic actions to ItemSemantics #252 No
Bugfix Quantity Improve availability of symbol property c03241d No
Bugfix items Accept Quantity as argument for postUpdate & sendCommand bdd1b98 No

Also see the Release Milestone.

4.1.0

Type Namespace Description Reference Breaking
Enhancement utils Add access to library version #244 No
Bugfix items Fix error handling for quantityState #243 No
Bugfix items Fix silent failure of ItemHistory.historicState #248 No
Bugfix items Fix ItemHistory.latestState doesn’t return string #249 No

Also see the Release Milestone.

4.0.0

Type Namespace Description Reference Breaking
Enhancement items Refactor metadata & itemchannllink APIs & add additional functionality #212 Yes
Enhancement Quantity Rename comparison methods #211 Yes
Bugfix actions & triggers Remove arg type checks as they cause trouble & addon now logs stack on IllegalArgumentException Commit 9975507 No
Bugfix rules SwitchableJSRule: Fix deprecation warning of EventObj Commit 0df9462 No
Bugfix items Metadata: Return configuration as JS obj instead of Java Map #222 No
Enhancement time Add isBefore(Date/Time/DateTime) and isAfter(Date/Time/DateTime) #227 No
Enhancement items ItemHistory: return an object with state and timestamp instead of just state where applicable #228 Yes
Enhancement items Metadata: Accept Item as param in addition to Item name #230 No
Enhancement items Allow Item lookup by name directly on the items namespace #233 No
Enhancement items Add numericState & quantityState properties to Item & HistoricItem #234 No
Enhancement items Extend metadata & itemchannellink methods with additional functionality #223 No
Enhancement osgi Migrate from addon- to core-provided lifecycle tracker #237 No

Also see the Release Milestone.

3.2.0

Type Namespace Description Reference Breaking
Enhancement triggers Add support for Item as argument & Add arg type checks #194 No
Enhancement items ItemHistory: Add new persistence methods #196 No
Enhancement rules Display execute code of JSRule in MainUI #199 No
Enhancement time Support ISO8601 string parsing in toZDT #202 No
Enhancement time Add isBetweenDates & isBetweenDateTimes polyfills to ZonedDateTime #203 No
Enhancement items ItemHistory: ItemHistory: Add previousStateTimestamp method #205 No
Enhancement Quantity Add UoM/Quantity handling functionality by wrapping QuantityType #206 No
Fix items Respect the toString method of the raw Java Item #198 No
Fix things Respect the toString method of the raw Java Thing #198 No
Cleanup things Remove unused ThingBuilder & ChannelBuilder #198 No
Bugfix things Fix bridgeUID member of Thing not working Commit fec416a No
Bugfix Fix & Improve type definitions #209 No
Bugfix items Fix time.ZonedDateTime not working as command or state update #213 No
Bugfix rules Catch persistence exceptions in SwitchableJSRule creation #214 No

Also see the Release Milestone.

3.1.0

Type Namespace Description Reference Breaking
Enhancement utils Support all data types in dumpObject Commit 144e6a9 No
Enhancement cache Reimplementation to use the new core caches #191 No

Also see the Release Milestone.

3.0.0

Type Namespace Description Reference Breaking
Enhancement items ItemHistory: Change return types of min/max between/since to number #175 Yes
Cleanup rules Remove unused rule providers #183 Yes
Enhancement actions Add Transformation actions as a class with arg type checking #180 No
Cleanup Remove unused & non-working providers Commit 83dac55d No

Also see the Release Milestone.

2.1.1

Type Namespace Description Reference Breaking
Enhancement actions Don't deprecate ScriptExecution.createTimer #171 No

Also see the Release Milestone.

2.1.0

Type Namespace Description Reference Breaking
Enhancement items Add semantics to the Item class #167 No
Docs Timer polyfills now behave like standard JS #169 No
Docs Remove raw Java timer creation methods & openHAB Timer #169 No
Bugfix actions Warn when the raw Java timer creation methods are accessed #169 No

Also see the Release Milestone.

2.0.4

Type Namespace Description Reference Breaking
Docs Update timer docs #161 No
Bugfix actions Fix get(), thingActions() & dynamic exports #165 No

Also see the Release Milestone.

2.0.3

Type Namespace Description Reference Breaking
Enhancement triggers Add DateTime Trigger #154 No
Enhancement items ItemHistory: Add missing methods & Enable type defs #158 No
Docs actions Update docs for naming timers #160 No

Also see the Release Milestone.

2.0.2

Type Namespace Description Reference Breaking
Bugfix time isBetweenTimes fails with: TypeError: time.toZDT is not a function #151 No
Enhancement items Update JSDoc to fix type definitions for return of getters #152 No
Enhancement things Update JSDoc to fix type definitions for return of getters #152 No

Also see the Release Milestone.

2.0.1

Type Namespace Description Reference Breaking
Bugfix rules Strip dashes in generated rule UIDs #144 No
Bugfix rules Fix itemName & triggerType unavailable for Group in Item****Triggers #146 No
Enhancement actions Enable type definitions & Extend with NotificationAction #148 No

Also see the Release Milestone.

2.0.0

Type Namespace Description Reference Breaking
Bugfix rules Failed rule run logs a useful error message #116 No
Enhancement utils Allow dumpObject to also dump own properties #121 No
Bugfix rules Fix removeItem not working #122 No
Enhancement triggers Add PWM Automation trigger #126 No
Enhancement triggers Add PID Automation trigger #131 No
Enhancement things Add Thing class & add getThing(s) #132 No
Enhancement rules Refactor EventObject to only hold properties with values #136 Yes
Enhancement Add type definitions for better autocompletion #137 No

Also see the Release Milestone.

1.2.3

Changelog is incomplete!

Namespace Description Reference Breaking
items addItem(...) and updateItem(...) use itemConfig as parameter #109 Yes
time Add timeUtils #101 No

1.2.2

Changelog is incomplete!

Namespace Description Reference Breaking
items item.history.lastUpdate() returns ZonedDateTime instead of Date #67 Yes