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

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

Author: timcharper

addons/io/org.openhab.io.homekit/src/main/java/org/openhab/io/homekit/internal/accessories/AbstractHomekitAccessoryImpl.java

@@ -33,7 +33,7 @@ abstract class AbstractHomekitAccessoryImpl<T extends GenericItem> implements Ho
     private final ItemRegistry itemRegistry;
     private final HomekitAccessoryUpdater updater;
 
-    private Logger logger = LoggerFactory.getLogger(AbstractHomekitAccessoryImpl.class);
+    protected Logger logger = LoggerFactory.getLogger(AbstractHomekitAccessoryImpl.class);
 
     public AbstractHomekitAccessoryImpl(HomekitTaggedItem taggedItem, ItemRegistry itemRegistry,
             HomekitAccessoryUpdater updater, Class<T> expectedItemClass) {
@@ -48,7 +48,7 @@ public AbstractHomekitAccessoryImpl(HomekitTaggedItem taggedItem, ItemRegistry i
         }
         if (expectedItemClass != taggedItem.getItem().getClass()
                 && !expectedItemClass.isAssignableFrom(baseItem.getClass())) {
-            logger.error("Type {} is a {} instead of the expected {}", taggedItem.getItem().getName(),
+            logger.error("Item {} is of type {} instead of the expected {}", taggedItem.getItem().getName(),
                     baseItem.getClass().getName(), expectedItemClass.getName());
         }
     }

addons/io/org.openhab.io.homekit/src/main/java/org/openhab/io/homekit/internal/accessories/BooleanItemReader.java

@@ -0,0 +1,51 @@
+package org.openhab.io.homekit.internal.accessories;
+
+import org.eclipse.smarthome.core.items.Item;
+import org.eclipse.smarthome.core.library.items.ContactItem;
+import org.eclipse.smarthome.core.library.items.SwitchItem;
+import org.eclipse.smarthome.core.library.types.OnOffType;
+import org.eclipse.smarthome.core.library.types.OpenClosedType;
+import org.eclipse.smarthome.core.types.State;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Wraps either a SwitchItem or a ContactItem, interpretting the open / closed states accordingly.
+ *
+ * @author Tim Harper
+ *
+ */
+public class BooleanItemReader {
+    private final Item item;
+    private final OnOffType trueOnOffValue;
+    private final OpenClosedType trueOpenClosedValue;
+
+    private static Logger logger = LoggerFactory.getLogger(BooleanItemReader.class);
+
+    /**
+     *
+     * @param item                The item to read
+     * @param trueOnOffValue      If OnOffType, then consider true if this value
+     * @param trueOpenClosedValue if OpenClosedType, then consider true if this value
+     */
+    BooleanItemReader(Item item, OnOffType trueOnOffValue, OpenClosedType trueOpenClosedValue) {
+        this.item = item;
+        this.trueOnOffValue = trueOnOffValue;
+        this.trueOpenClosedValue = trueOpenClosedValue;
+        if (!(item instanceof SwitchItem) && !(item instanceof ContactItem)) {
+            logger.error("Item {} is a {} instead of the expected SwitchItem or ContactItem", item.getName(),
+                    item.getClass().getName());
+        }
+    }
+
+    Boolean getValue() {
+        State state = item.getState();
+        if (state instanceof OnOffType) {
+            return state == trueOnOffValue;
+        } else if (state instanceof OpenClosedType) {
+            return state == trueOpenClosedValue;
+        } else {
+            return null;
+        }
+    }
+}

addons/io/org.openhab.io.homekit/src/main/java/org/openhab/io/homekit/internal/accessories/HomekitLeakSensorImpl.java

@@ -13,11 +13,8 @@
 import org.eclipse.jdt.annotation.NonNull;
 import org.eclipse.smarthome.core.items.GenericItem;
 import org.eclipse.smarthome.core.items.ItemRegistry;
-import org.eclipse.smarthome.core.library.items.ContactItem;
-import org.eclipse.smarthome.core.library.items.SwitchItem;
 import org.eclipse.smarthome.core.library.types.OnOffType;
 import org.eclipse.smarthome.core.library.types.OpenClosedType;
-import org.eclipse.smarthome.core.types.State;
 import org.openhab.io.homekit.internal.HomekitAccessoryUpdater;
 import org.openhab.io.homekit.internal.HomekitTaggedItem;
 import org.openhab.io.homekit.internal.battery.BatteryStatus;
@@ -36,28 +33,19 @@ public class HomekitLeakSensorImpl extends AbstractHomekitAccessoryImpl<GenericI
     @NonNull
     private BatteryStatus batteryStatus;
 
+    private BooleanItemReader leakDetectedReader;
+
     public HomekitLeakSensorImpl(HomekitTaggedItem taggedItem, ItemRegistry itemRegistry,
             HomekitAccessoryUpdater updater, BatteryStatus batteryStatus) {
         super(taggedItem, itemRegistry, updater, GenericItem.class);
 
-        if (!(taggedItem.getItem() instanceof SwitchItem) && !(taggedItem.getItem() instanceof ContactItem)) {
-            logger.error("Item {} is a {} instead of the expected SwitchItem or ContactItem",
-                    taggedItem.getItem().getName(), taggedItem.getClass().getName());
-        }
-
+        this.leakDetectedReader = new BooleanItemReader(taggedItem.getItem(), OnOffType.ON, OpenClosedType.OPEN);
         this.batteryStatus = batteryStatus;
     }
 
     @Override
     public CompletableFuture<Boolean> getLeakDetected() {
-        State state = getItem().getState();
-        if (state instanceof OnOffType) {
-            return CompletableFuture.completedFuture(state == OnOffType.ON);
-        } else if (state instanceof OpenClosedType) {
-            return CompletableFuture.completedFuture(state == OpenClosedType.OPEN);
-        } else {
-            return CompletableFuture.completedFuture(null);
-        }
+        return CompletableFuture.completedFuture(this.leakDetectedReader.getValue());
     }
 
     @Override

addons/io/org.openhab.io.homekit/src/main/java/org/openhab/io/homekit/internal/accessories/HomekitMotionSensorImpl.java

@@ -10,9 +10,10 @@
 
 import java.util.concurrent.CompletableFuture;
 
+import org.eclipse.smarthome.core.items.GenericItem;
 import org.eclipse.smarthome.core.items.ItemRegistry;
-import org.eclipse.smarthome.core.library.items.SwitchItem;
 import org.eclipse.smarthome.core.library.types.OnOffType;
+import org.eclipse.smarthome.core.library.types.OpenClosedType;
 import org.openhab.io.homekit.internal.HomekitAccessoryUpdater;
 import org.openhab.io.homekit.internal.HomekitTaggedItem;
 import org.openhab.io.homekit.internal.battery.BatteryStatus;
@@ -25,23 +26,21 @@
  *
  * @author Tim Harper - Initial implementation
  */
-public class HomekitMotionSensorImpl extends AbstractHomekitAccessoryImpl<SwitchItem>
+public class HomekitMotionSensorImpl extends AbstractHomekitAccessoryImpl<GenericItem>
         implements MotionSensor, BatteryStatusAccessory {
     private BatteryStatus batteryStatus;
+    private BooleanItemReader motionSensedReader;
 
     public HomekitMotionSensorImpl(HomekitTaggedItem taggedItem, ItemRegistry itemRegistry,
             HomekitAccessoryUpdater updater, BatteryStatus batteryStatus) {
-        super(taggedItem, itemRegistry, updater, SwitchItem.class);
+        super(taggedItem, itemRegistry, updater, GenericItem.class);
+        this.motionSensedReader = new BooleanItemReader(taggedItem.getItem(), OnOffType.ON, OpenClosedType.OPEN);
         this.batteryStatus = batteryStatus;
     }
 
     @Override
     public CompletableFuture<Boolean> getMotionDetected() {
-        OnOffType state = getItem().getStateAs(OnOffType.class);
-        if (state == null) {
-            return CompletableFuture.completedFuture(null);
-        }
-        return CompletableFuture.completedFuture(state == OnOffType.ON);
+        return CompletableFuture.completedFuture(motionSensedReader.getValue());
     }
 
     @Override