Merge pull request #52 from timcharper/tharper/leak-sensor

Add support for LeakSensor and Valve devices

Author: andylintner

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/accessories/Valve.java

@@ -0,0 +1,99 @@
+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.accessories.properties.ValveType;
+import com.beowulfe.hap.impl.services.ValveService;
+
+/**
+ * A Valve (sprinkler head, faucet, etc.)
+ *
+ * @author Tim Harper
+ */
+public interface Valve extends HomekitAccessory {
+
+    @Override
+    default Collection<Service> getServices() {
+        return Collections.singleton(new ValveService(this));
+    }
+
+    /**
+     * Retrieves the current active state of the valve; Active could mean the valve is open (but not necessarily
+     * running),
+     * or that the valve is associated with an active watering program (like a watering program) but is not currently
+     * running.
+     *
+     * To communicate water is flowing through a valve, inUse should be used.
+     *
+     * @return a future that will contain the binary state
+     */
+    CompletableFuture<Boolean> getValveActive();
+
+    /**
+     * Sets the valve active state
+     *
+     * @param active the binary state to set
+     * @return a future that completes when the change is made
+     * @throws Exception when the change cannot be made
+     */
+    CompletableFuture<Void> setValveActive(boolean active) throws Exception;
+
+    /**
+     * Subscribes to changes in the active state of the valve.
+     *
+     * @param callback the function to call when the state changes.
+     */
+    void subscribeValveActive(HomekitCharacteristicChangeCallback callback);
+
+    /**
+     * Unsubscribes from changes in the valve active state.
+     */
+    void unsubscribeValveActive();
+
+    /**
+     * Retrieves the current inUse state of the valve; InUse usually means water is flowing through the valve.
+     *
+     * To communicate water is flowing through a valve, inUse should be used.
+     *
+     * @return a future that will contain the binary state
+     */
+    CompletableFuture<Boolean> getValveInUse();
+
+    /**
+     * Subscribes to changes in the inUse state of the valve.
+     *
+     * @param callback the function to call when the state changes.
+     */
+    void subscribeValveInUse(HomekitCharacteristicChangeCallback callback);
+
+    /**
+     * Unsubscribes from changes in the valve inUse state.
+     */
+    void unsubscribeValveInUse();
+
+    /**
+     * Retrieves the valve type.
+     *
+     * To communicate water is flowing through a valve, inUse should be used.
+     *
+     * @return a future that will contain the binary state
+     */
+    CompletableFuture<ValveType> getValveType();
+
+    /**
+     * Subscribes to changes in the valveType state of the valve.
+     *
+     * @param callback the function to call when the state changes.
+     */
+    void subscribeValveType(HomekitCharacteristicChangeCallback callback);
+
+    /**
+     * Unsubscribes from changes in the valveType state light.
+     */
+    void unsubscribeValveType();
+}

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

@@ -0,0 +1,66 @@
+package com.beowulfe.hap.accessories;
+
+import java.util.concurrent.CompletableFuture;
+
+import com.beowulfe.hap.HomekitCharacteristicChangeCallback;
+
+/**
+ * Extends {@link Valve} with timer values.
+ *
+ * @author Tim Harper
+ */
+public interface ValveWithTimer extends Valve {
+
+    /**
+     * Retrieves the current duration for which the valve will run
+     *
+     * @return a future with the value
+     */
+    CompletableFuture<Integer> getRemainingDuration();
+
+    /**
+     * Subscribes to changes in the duration; note it is not necessary to emit a
+     * change every second, homekit infers the countdown progress clientside.
+     *
+     * @param callback the function when the existing duration has been replaced with a new one.
+     */
+    void subscribeRemainingDuration(HomekitCharacteristicChangeCallback callback);
+
+    /**
+     * Unsubscribes from changes
+     */
+    void unsubscribeRemainingDuration();
+
+    /**
+     * Retrieves the current set duration for which the valve will be scheduled
+     * to run; this is usually used as the duration to use when the valve is set
+     * to active.
+     *
+     * @return a future with the value
+     */
+    CompletableFuture<Integer> getSetDuration();
+
+    /**
+     * Sets the duration for which the valve will be scheduled to run; this is
+     * usually used as the duration to use when the valve is set to active.
+     *
+     * If the valve is currently running, then Homekit assumes that changing
+     * this value affects the current remaining duration.
+     *
+     * @return a future with the value
+     */
+    CompletableFuture<Void> setSetDuration(int value);
+
+    /**
+     * Subscribes to changes in the set duration
+     *
+     * @param callback the function when the value has changed
+     */
+    void subscribeSetDuration(HomekitCharacteristicChangeCallback callback);
+
+    /**
+     * Unsubscribes from changes
+     */
+    void unsubscribeSetDuration();
+
+}

src/main/java/com/beowulfe/hap/accessories/properties/ValveType.java

@@ -0,0 +1,39 @@
+package com.beowulfe.hap.accessories.properties;
+
+import java.util.Arrays;
+import java.util.Map;
+import java.util.stream.Collectors;
+
+import com.beowulfe.hap.accessories.Valve;
+
+/**
+ * The mode used by a {@link Valve}
+ *
+ * @author Tim Harper
+ */
+public enum ValveType {
+
+    GENERIC(0),
+    IRRIGATION(1),
+    SHOWER(2),
+    WATER_FAUCET(3);
+
+    private final static Map<Integer, ValveType> reverse;
+    static {
+        reverse = Arrays.stream(ValveType.values()).collect(Collectors.toMap(t -> t.getCode(), t -> t));
+    }
+
+    public static ValveType fromCode(Integer code) {
+        return reverse.get(code);
+    }
+
+    private final int code;
+
+    private ValveType(int code) {
+        this.code = code;
+    }
+
+    public int getCode() {
+        return code;
+    }
+}

src/main/java/com/beowulfe/hap/impl/characteristics/common/ActiveCharacteristic.java

@@ -0,0 +1,47 @@
+package com.beowulfe.hap.impl.characteristics.common;
+
+import java.util.concurrent.CompletableFuture;
+import java.util.function.Consumer;
+import java.util.function.Supplier;
+
+import com.beowulfe.hap.HomekitCharacteristicChangeCallback;
+import com.beowulfe.hap.characteristics.BooleanCharacteristic;
+import com.beowulfe.hap.characteristics.EventableCharacteristic;
+import com.beowulfe.hap.impl.ExceptionalConsumer;
+
+public class ActiveCharacteristic extends BooleanCharacteristic implements EventableCharacteristic {
+
+    private final Supplier<CompletableFuture<Boolean>> getter;
+    private final ExceptionalConsumer<Boolean> setter;
+    private final Consumer<HomekitCharacteristicChangeCallback> subscriber;
+    private final Runnable unsubscriber;
+
+    public ActiveCharacteristic(Supplier<CompletableFuture<Boolean>> getter, ExceptionalConsumer<Boolean> setter,
+            Consumer<HomekitCharacteristicChangeCallback> subscriber, Runnable unsubscriber) {
+        super("000000B0-0000-1000-8000-0026BB765291", true, true, "Active");
+        this.getter = getter;
+        this.setter = setter;
+        this.subscriber = subscriber;
+        this.unsubscriber = unsubscriber;
+    }
+
+    @Override
+    protected CompletableFuture<Boolean> getValue() {
+        return getter.get();
+    }
+
+    @Override
+    protected void setValue(Boolean value) throws Exception {
+        setter.accept(value);
+    }
+
+    @Override
+    public void subscribe(HomekitCharacteristicChangeCallback callback) {
+        subscriber.accept(callback);
+    }
+
+    @Override
+    public void unsubscribe() {
+        unsubscriber.run();
+    }
+}

src/main/java/com/beowulfe/hap/impl/characteristics/common/InUseCharacteristic.java

@@ -0,0 +1,44 @@
+package com.beowulfe.hap.impl.characteristics.common;
+
+import java.util.concurrent.CompletableFuture;
+import java.util.function.Consumer;
+import java.util.function.Supplier;
+
+import com.beowulfe.hap.HomekitCharacteristicChangeCallback;
+import com.beowulfe.hap.characteristics.BooleanCharacteristic;
+import com.beowulfe.hap.characteristics.EventableCharacteristic;
+
+public class InUseCharacteristic extends BooleanCharacteristic implements EventableCharacteristic {
+
+    private final Supplier<CompletableFuture<Boolean>> getter;
+    private final Consumer<HomekitCharacteristicChangeCallback> subscriber;
+    private final Runnable unsubscriber;
+
+    public InUseCharacteristic(Supplier<CompletableFuture<Boolean>> getter,
+            Consumer<HomekitCharacteristicChangeCallback> subscriber, Runnable unsubscriber) {
+        super("000000D2-0000-1000-8000-0026BB765291", false, true, "InUse");
+        this.getter = getter;
+        this.subscriber = subscriber;
+        this.unsubscriber = unsubscriber;
+    }
+
+    @Override
+    protected CompletableFuture<Boolean> getValue() {
+        return getter.get();
+    }
+
+    @Override
+    protected void setValue(Boolean value) throws Exception {
+        // Read Only
+    }
+
+    @Override
+    public void subscribe(HomekitCharacteristicChangeCallback callback) {
+        subscriber.accept(callback);
+    }
+
+    @Override
+    public void unsubscribe() {
+        unsubscriber.run();
+    }
+}

src/main/java/com/beowulfe/hap/impl/characteristics/common/RemainingDurationCharacteristic.java

@@ -0,0 +1,44 @@
+package com.beowulfe.hap.impl.characteristics.common;
+
+import java.util.concurrent.CompletableFuture;
+import java.util.function.Consumer;
+import java.util.function.Supplier;
+
+import com.beowulfe.hap.HomekitCharacteristicChangeCallback;
+import com.beowulfe.hap.characteristics.EventableCharacteristic;
+import com.beowulfe.hap.characteristics.IntegerCharacteristic;
+
+public class RemainingDurationCharacteristic extends IntegerCharacteristic implements EventableCharacteristic {
+
+    private final Supplier<CompletableFuture<Integer>> getter;
+    private final Consumer<HomekitCharacteristicChangeCallback> subscriber;
+    private final Runnable unsubscriber;
+
+    public RemainingDurationCharacteristic(Supplier<CompletableFuture<Integer>> getter,
+            Consumer<HomekitCharacteristicChangeCallback> subscriber, Runnable unsubscriber) {
+        super("000000D4-0000-1000-8000-0026BB765291", false, true, "Remaining Duration", 0, 3600, "seconds");
+        this.getter = getter;
+        this.subscriber = subscriber;
+        this.unsubscriber = unsubscriber;
+    }
+
+    @Override
+    protected CompletableFuture<Integer> getValue() {
+        return getter.get();
+    }
+
+    @Override
+    protected void setValue(Integer value) throws Exception {
+        // Read Only
+    }
+
+    @Override
+    public void subscribe(HomekitCharacteristicChangeCallback callback) {
+        subscriber.accept(callback);
+    }
+
+    @Override
+    public void unsubscribe() {
+        unsubscriber.run();
+    }
+}