Add LeakSensor accessory and associated characteristics

Author: timcharper

src/main/java/com/beowulfe/hap/accessories/LeakSensor.java

@@ -0,0 +1,49 @@
+package com.beowulfe.hap.accessories;
+
+import java.util.Collection;
+import java.util.Collections;
+import java.util.concurrent.CompletableFuture;
+
+import com.beowulfe.hap.HomekitAccessory;
+import com.beowulfe.hap.HomekitCharacteristicChangeCallback;
+import com.beowulfe.hap.Service;
+import com.beowulfe.hap.impl.services.LeakSensorService;
+
+/**
+ * <p>
+ * A leak sensor that reports whether a leak has been detected.
+ * </p>
+ *
+ * <p>
+ * Leak sensors that run on batteries will need to implement this interface
+ * and also implement {@link BatteryStatusAccessory}.
+ * </p>
+ *
+ * @author Tim Harper
+ */
+public interface LeakSensor extends HomekitAccessory {
+
+    /**
+     * Retrieves the state of the leak sensor. If true then leak has been detected.
+     *
+     * @return a future that will contain the leak sensor's state
+     */
+    CompletableFuture<Boolean> getLeakDetected();
+
+    @Override
+    default Collection<Service> getServices() {
+        return Collections.singleton(new LeakSensorService(this));
+    }
+
+    /**
+     * Subscribes to changes in the leak sensor.
+     *
+     * @param callback the function to call when the state changes.
+     */
+    void subscribeLeakDetected(HomekitCharacteristicChangeCallback callback);
+
+    /**
+     * Unsubscribes from changes in the leak sensor.
+     */
+    void unsubscribeLeakDetected();
+}

src/main/java/com/beowulfe/hap/impl/characteristics/leaksensor/LeakDetectedStateCharacteristic.java

@@ -0,0 +1,38 @@
+package com.beowulfe.hap.impl.characteristics.leaksensor;
+
+import java.util.concurrent.CompletableFuture;
+
+import com.beowulfe.hap.HomekitCharacteristicChangeCallback;
+import com.beowulfe.hap.accessories.LeakSensor;
+import com.beowulfe.hap.characteristics.BooleanCharacteristic;
+import com.beowulfe.hap.characteristics.EventableCharacteristic;
+
+public class LeakDetectedStateCharacteristic extends BooleanCharacteristic implements EventableCharacteristic {
+
+    private final LeakSensor leakSensor;
+
+    public LeakDetectedStateCharacteristic(LeakSensor leakSensor) {
+        super("00000070-0000-1000-8000-0026BB765291", false, true, "Leak Detected");
+        this.leakSensor = leakSensor;
+    }
+
+    @Override
+    protected CompletableFuture<Boolean> getValue() {
+        return leakSensor.getLeakDetected();
+    }
+
+    @Override
+    protected void setValue(Boolean value) throws Exception {
+        // Read Only
+    }
+
+    @Override
+    public void subscribe(HomekitCharacteristicChangeCallback callback) {
+        leakSensor.subscribeLeakDetected(callback);
+    }
+
+    @Override
+    public void unsubscribe() {
+        leakSensor.unsubscribeLeakDetected();
+    }
+}

src/main/java/com/beowulfe/hap/impl/services/LeakSensorService.java

@@ -0,0 +1,16 @@
+package com.beowulfe.hap.impl.services;
+
+import com.beowulfe.hap.accessories.LeakSensor;
+import com.beowulfe.hap.impl.characteristics.leaksensor.LeakDetectedStateCharacteristic;
+
+public class LeakSensorService extends AbstractServiceImpl {
+
+    public LeakSensorService(LeakSensor leakSensor) {
+        this(leakSensor, leakSensor.getLabel());
+    }
+
+    public LeakSensorService(LeakSensor leakSensor, String serviceName) {
+        super("00000083-0000-1000-8000-0026BB765291", leakSensor, serviceName);
+        addCharacteristic(new LeakDetectedStateCharacteristic(leakSensor));
+    }
+}