[homekit] Bugfixes, improvements and support for more accessories #5082

timcharper · 2019-03-10T23:04:55Z

This is a monster PR which includes work from both myself (@timcharper) and @ccutrer. Over the past couple of months we have been working to improve the HAP-Java plugin and simultaneously improving the openhab2 plugin. With the release of HAP-Java 1.1.5 we are now ready to integrate this work upstream.

A detailed changelog can be found below:

2.5.0-SNAPSHOT

Fixes

HAP-Java fixes

Several fixes HAP-Java from Cody Cutrer have been included in the release:

Thermostat fixes

Previously, the mapping of target and current thermostat mode was broken. It is considered illegal to return current mode of "AUTO", and resulted in an error. The issue has been fixed in my fork of homekit (see hap-java/HAP-Java#60)

Support for an item indicating the thermostat current mode has been added.

The homekit plugin configuration screen for paper-ui has been improved, adding groupings for each set of mappings.

The tag homekit:HeatingCoolingMode has been changed to homekit:TargetHeatingCoolingMode. The old tag is supported still, but you should update your thermostat tagged item, respectively.

Fix a characteristic subscription leak when the homekit addon is reloaded

Characteristic subscriptions would accumulate with each reload, causing noisy logs and a (not totally severe) memory leak. HAP-Java 1.1.5 has this issue patched. See hap-java/HAP-Java#54 for more information.

Breaking changes

Thermostat config options rename

The following config options have been renamed:

org.openhab.homekit:thermostatCoolMode to org.openhab.homekit:thermostatTargetModeCool
org.openhab.homekit:thermostatHeatMode to org.openhab.homekit:thermostatTargetModeHeat
org.openhab.homekit:thermostatAutoMode to org.openhab.homekit:thermostatTargetModeAuto
org.openhab.homekit:thermostatOffMode to org.openhab.homekit:thermostatTargetModeOff

Further, the following required config options have been specified:

org.openhab.homekit:thermostatCurrenModeCooling
org.openhab.homekit:thermostatCurrenModeHeating
org.openhab.homekit:thermostatCurrenModeOff

You will need to update your homekit configuration accordingly, either by editing your homekit config file, or by editing the configuration for the IO service using the paper UI.

New features

Added accessories

The following accessories are now supported:

Smoke sensors
CO detectors
Valves
Motion sensors
Leak sensors

NOTE: If you add motion sensors or leak sensors and they show they are unreachable, try toggling their value. For Z-wave devices the value is null until OpenHab2 receives the first value. In future release of the plugin the thing offline state will be used, and null item value will be interpreted as off.

See the README for instructions on configuring.

Allowing motion and leak accessories to be backed by Contact items

Some Z-wave devices configure these things to expose their channels as an OpenClosedType, rather than OnOffType, due to the fact that Contact items are read-only. We allow these boolean-like status accessories to be backed by either a Switch or a Contact item.

For Motion sensors, Open is considered "motion detected" (think "window open" as the actionable event). Similarly, leaks are reported if the backing Item is Open.

Debounce the refreshing of Homekit items

The plugin now waits for items to be stable for a full second before creating, removing, and deleting the associated homekit accessories. This greatly reduces the chaos, overhead, and misleading log messages when adding, removing, or changing multiple items at a time.

Contact and Occupancy Sensors support

Support is added for contact and occupancy sensors.

WindowCovering support

Merge in Epike's WindowCovering patch. The more-generic, Apple Homekit friendly label WindowCovering is used rather than Blinds. Users upgrading from Epike's patch should update their labels (Don't include both labels simultaneously, as Blinds is still supported, while deprecated).

A fix for WindowCovering support was merged in to HAP-Java 1.1.5. WindowCovering support is now enabled.

Support for optional battery levels with leak and motion sensors

With the refactoring, devices such as leak sensors and motion sensors can now optionally report when their battery is low. Battery level can be reported as a percentage (0-100, not 0.00 - 1.00), or as a switch (where ON == Low battery). More information on how this is configured can be seen in the README.

Internal improvements

Improved strategy for dealing with groups of items as a composite thing

The approach for dealing with grouped items has been refactored extensively, paving the way for devices to optionally include extra characteristics more easily.

Since item added/removed updates from OpenHab come in as a stream of additions and removals, one at a time, debouncing should be implemented in order to suppress the error messages of "device is lacking required characteristic" while OpenHab is in the process of reconfiguring some list of items. This will be implemented soon. For now, the functionality works, but the logs are a bit noisy.

Signed-off-by: Tim Harper <timcharper at gmail.com>

Also, improve logging

… characteristics at once

It causes the plugin to fail spectacularly; further investigation is required

For more information on the issue, see hap-java/HAP-Java#54

Updates trickle in one at a time; this means that if a complex accessory composed of 5 required items is added, then we get 5 individual add calls, with error messages reporting that the accessory is incomplete until the 5th comes in. By debouncing, we process all the additions in a single batch, sparing the user to sort through the noise.

Some Z-wave configurations expose them as switches, other as contact sensors.

* Homekit allows the targetMode to be specified, and the currentMode to be reported. * Improve configuration; add groupings for targetHeatingCoolingMode and currentHeatingCoolingMode value maps * Update docs * homekit:heatingCoolingMode is renamed to homekit:targetHeatingCoolingMode, for clarity

…ottom

changelog etc

timcharper · 2019-03-10T23:09:16Z

Signed-off-by: "Tim Harper" [email protected]

ccutrer · 2019-03-11T01:46:04Z

Signed-off-by: "Cody Cutrer" [email protected]

openhab-bot · 2019-03-21T00:19:04Z

This pull request has been mentioned on openHAB Community. There might be relevant details there:

https://community.openhab.org/t/announcing-some-improvements-to-the-homekit-plugin-for-openhab2/62729/81

davidgraeff

Thanks for the contribution.

I have noticed that your new classes have no javadoc.
For impl classes it is sufficient to have:

/**
 * {@inheritDoc}
 */

but for new interfaces and other types of classes a javadoc is required. I have also left some inline comments.

davidgraeff · 2019-04-01T20:34:05Z

...enhab.io.homekit/src/main/java/org/openhab/io/homekit/internal/HomekitAccessoryRegistry.java

@@ -36,79 +33,40 @@
 class HomekitAccessoryRegistry {

    private HomekitRoot bridge;
-    private final List<HomekitAccessory> createdAccessories = new LinkedList<>();
+    private final HashMap<String, HomekitAccessory> createdAccessories = new HashMap<>();


Please use the generic type as field type

davidgraeff · 2019-04-01T20:35:03Z

....openhab.io.homekit/src/main/java/org/openhab/io/homekit/internal/battery/BatteryStatus.java

+            return new NoBatteryStatus();
+        }
+    }
+}


Please check for missing newlines

davidgraeff · 2019-04-01T20:37:28Z

...homekit/src/main/java/org/openhab/io/homekit/internal/accessories/HomekitThermostatImpl.java

@@ -46,93 +50,93 @@
 *
 * @author Andy Lintner - Initial contribution
 */
-class HomekitThermostatImpl extends AbstractTemperatureHomekitAccessoryImpl<GroupItem>
-        implements BasicThermostat, GroupedAccessory {
+class HomekitThermostatImpl extends AbstractTemperatureHomekitAccessoryImpl<GroupItem> implements BasicThermostat {


Can you please annotate all (new) Impl classes with @NonNullByDefault?
That helps a lot to prevent NPEs to happen and fellow developers immediately know about a potential null access.

davidgraeff · 2019-04-01T20:41:40Z

....openhab.io.homekit/src/main/java/org/openhab/io/homekit/internal/HomekitChangeListener.java

+    /**
+     * Call after itemRegistry and settings are specified to initialize homekit devices
+     */
+    private void maybeInitialize() {


Is there a reason for this class not being a @Component?
The OSGi framework would resolve your requirements (ItemRegistry + HomekitSettings)
and you can use the activated method to do do what you currently do in maybeInitialize.

HomekitSettings would be a component in that scenario as well, which it probably isn't I guess?

davidgraeff · 2019-04-01T20:44:28Z

addons/io/org.openhab.io.homekit/META-INF/MANIFEST.MF

@@ -2,7 +2,7 @@ Manifest-Version: 1.0
 Automatic-Module-Name: org.openhab.io.homekit
 Bundle-ClassPath: 
 .,
- lib/com.beowulfe.hap.hap-1.1.4.jar,
+ lib/hap-1.1.5.jar,


Have you had a look at the new buildsystem?
The issue is, if I merge this PR, we add another 500kb of binary data to the repo (which is currently at 400 MB already) and with the buildsystem migration that need to happen anyway, we would render that binary data unused (git doesn't forget).

@davidgraeff I'll have a look; I'd much prefer to not commit this artifact to the repository. Anything you can point me to?

https://bintray.com/bintray/jcenter/com.beowulfe.hap%3Ahap

Is this upgrade needed to build? Otherwise we can upgrade the library easily with the migration PR.

If this is the only thing missing here, we should commit it. We have to do something about al those binaries in the source tree anyway, 500kB more or less make no difference IMO.

davidgraeff · 2019-04-14T11:21:22Z

@timcharper Are you still working on this?

J-N-K · 2019-05-01T15:09:44Z

@timcharper @ccutrer since this is one of the last two blocking PR for the bnd migration, how do you want to proceed?

davidgraeff · 2019-05-01T15:25:36Z

I can imagine that we perform the migration on master and additionally also on this branch. That way the guys have no additional conflicts and we can continue with the migration.

martinvw · 2019-05-02T15:29:45Z

@davidgraeff we do not use {@inheritdoc}, so rather leave it empty and add an @OverRide that should be enough 👍

J-N-K · 2019-05-09T10:43:14Z

@davidgraeff Apart from the necessary rebase, what is missing here? Do you consider the @Component part to be blocking?

davidgraeff · 2019-05-09T12:45:49Z

There is nothing blocking. There was one file in conflict that need to be resolved by the OP. And of course at the moment we need to apply the bnd migration patch to this PR as well.

J-N-K · 2019-05-09T12:58:10Z

@timcharper @ccutrer Would you mind me taking this over to get this merged? Is there any chance to get hap/1.1.5 pushed to bintray?

ccutrer · 2019-05-09T16:02:23Z

@J-N-K : yes, I'm fine with you pushing this through. Unfortunately @timcharper has had an arm injury, so his computer use has been severely limited. I personally don't have permissions or knowledge on how to push hap-1.1.5 to binary. Java isn't my forte, so I'm still learning the community and the tools.

J-N-K · 2019-05-10T14:01:33Z

Anyone else: I put a test-version in #5581, try it if you want. Thanks.

J-N-K · 2019-05-15T15:56:55Z

superseded by #5581

timcharper and others added 30 commits March 10, 2019 16:49

Update HAP-Java library to hap-1.1.5 release

1c3c537

Signed-off-by: Tim Harper <timcharper at gmail.com>

Homekit support for motion sensors, leak sensors and valves

697b225

Add support for Blinds

29be0ac

Add changes, documentation

67c08cc

Rename Blinds -> WindowCovering; documentation

4cbe185

Resolve senseless NULL checking

5228e8e

Also, improve logging

Refactor group accessory logic to construct the entire accessory with…

87c4346

… characteristics at once

battery level wip

2b5a4eb

Fix compile issue

5f1991e

Fix unregister issue with HomekitAccessoryRegistry

12a3ae5

Fix double subscribe issue with homekit valve

fb92058

Remove window covering support

e283500

It causes the plugin to fail spectacularly; further investigation is required

Bump hap plugin to include fix leaking sessions

55e1778

For more information on the issue, see hap-java/HAP-Java#54

Support for reporting battery level for leak and motion sensors

0355330

Update changelog

1ceb708

Remove extra comment

a4f7c5f

Allow motion sensors and leak sensors to be backed by contact sensors

ce09d9e

Some Z-wave configurations expose them as switches, other as contact sensors.

Update docs

ee477f9

Contact and occupancy sensors

69416b5

Re-enable window covering with the upstream hap fix

8fe63b0

window covering compatibility

78b6485

2.4.0-homekit-4 changelog

37277d4

Add core configuration group so all the config doesn't float to the b…

6ecb5bb

…ottom

Clarify readme and changes

d692c3c

Add documentation for OccupancySensor

e53af14

Add smoke and CO detectors to homekit (#2)

99da2a7

Switchable does _not_ support Dimmer items (#1)

50e89ce

Bump upstream HAP

3400b02

changelog etc

timcharper and others added 5 commits March 10, 2019 16:51

Note about contact sensor

11e561e

Contact sensors support battery level

8354fa0

satisfy lots of Code Analysis Tool warnings and errors

7c5724f

curate CHANGES for upstream

267df7a

Note about contributing

1e99f66

timcharper requested a review from andylintner as a code owner March 10, 2019 23:04

timcharper added 2 commits March 10, 2019 17:07

Remove the versioning line

84ae836

remove reference to actor

eb83b74

wborn added enhancement An enhancement or new feature for an existing add-on homekit labels Mar 10, 2019

wborn changed the title ~~Integrate Homekit changes upstream~~ [homekit] Bugfixes, improvements and support for more accessories Mar 10, 2019

Gozilla01 mentioned this pull request Mar 22, 2019

Update tags for homekit mvalla/openhab-addons#73

Closed

maggu2810 mentioned this pull request Mar 29, 2019

Migration to a Maven + Bnd based build system #5005

Closed

davidgraeff reviewed Apr 1, 2019

View reviewed changes

J-N-K added the awaiting feedback label May 1, 2019

J-N-K mentioned this pull request May 9, 2019

[homekit] Feature upgrade, bugfixes #5581

Merged

J-N-K closed this May 15, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[homekit] Bugfixes, improvements and support for more accessories #5082

[homekit] Bugfixes, improvements and support for more accessories #5082

timcharper commented Mar 10, 2019

timcharper commented Mar 10, 2019 •

edited

Loading

ccutrer commented Mar 11, 2019

openhab-bot commented Mar 21, 2019

davidgraeff left a comment •

edited

Loading

davidgraeff Apr 1, 2019

davidgraeff Apr 1, 2019

davidgraeff Apr 1, 2019

davidgraeff Apr 1, 2019

davidgraeff Apr 1, 2019

timcharper Apr 2, 2019

J-N-K Apr 2, 2019

J-N-K Apr 22, 2019

ccutrer Apr 22, 2019

J-N-K Apr 25, 2019

davidgraeff commented Apr 14, 2019

J-N-K commented May 1, 2019

davidgraeff commented May 1, 2019

martinvw commented May 2, 2019

J-N-K commented May 9, 2019

davidgraeff commented May 9, 2019

J-N-K commented May 9, 2019

ccutrer commented May 9, 2019

J-N-K commented May 10, 2019

J-N-K commented May 15, 2019

[homekit] Bugfixes, improvements and support for more accessories #5082

[homekit] Bugfixes, improvements and support for more accessories #5082

Conversation

timcharper commented Mar 10, 2019

2.5.0-SNAPSHOT

Fixes

HAP-Java fixes

Thermostat fixes

Fix a characteristic subscription leak when the homekit addon is reloaded

Breaking changes

Thermostat config options rename

New features

Added accessories

Allowing motion and leak accessories to be backed by Contact items

Debounce the refreshing of Homekit items

Contact and Occupancy Sensors support

WindowCovering support

Support for optional battery levels with leak and motion sensors

Internal improvements

Improved strategy for dealing with groups of items as a composite thing

timcharper commented Mar 10, 2019 • edited Loading

ccutrer commented Mar 11, 2019

openhab-bot commented Mar 21, 2019

davidgraeff left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

davidgraeff commented Apr 14, 2019

J-N-K commented May 1, 2019

davidgraeff commented May 1, 2019

martinvw commented May 2, 2019

J-N-K commented May 9, 2019

davidgraeff commented May 9, 2019

J-N-K commented May 9, 2019

ccutrer commented May 9, 2019

J-N-K commented May 10, 2019

J-N-K commented May 15, 2019

timcharper commented Mar 10, 2019 •

edited

Loading

davidgraeff left a comment •

edited

Loading