Add support for LeakSensor and Valve devices

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

@@ -1,15 +1,15 @@
 package com.beowulfe.hap.accessories;
 
-import com.beowulfe.hap.HomekitCharacteristicChangeCallback;
-
 import java.util.concurrent.CompletableFuture;
 
+import com.beowulfe.hap.HomekitCharacteristicChangeCallback;
+
 /**
- * An accessory that runs on batteries. Accessories that run on batteries are able to report
- * battery level.
+ * Do not use. Devices that have battery levels should implement LowBatteryStatusAccessory.
  *
  * @author Gaston Dombiak
  */
+@Deprecated
 public interface BatteryAccessory {
 
     /**

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

@@ -0,0 +1,34 @@
+package com.beowulfe.hap.accessories;
+
+import java.util.concurrent.CompletableFuture;
+
+import com.beowulfe.hap.HomekitCharacteristicChangeCallback;
+
+/**
+ * An accessory that runs on batteries. Accessories that run on batteries are able to report
+ * battery level.
+ *
+ * @author Tim Harper
+ */
+public interface BatteryStatusAccessory {
+
+    /**
+     * Queries if the device battery level is low; returning a value of true
+     * will cause a low-battery status to appear in Home for the device.
+     *
+     * @return a future that will contain the accessory's low battery state
+     */
+    CompletableFuture<Boolean> getLowBatteryState();
+
+    /**
+     * Subscribes to changes in the battery level.
+     *
+     * @param callback the function to call when low battery state changes.
+     */
+    void subscribeLowBatteryState(HomekitCharacteristicChangeCallback callback);
+
+    /**
+     * Unsubscribes from changes in the low battery state.
+     */
+    void unsubscribeLowBatteryState();
+}

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

@@ -14,7 +14,7 @@
  * <p>A carbon monoxide sensor reports whether carbon monoxide has been detected or not.</p>
  *
  * <p>Carbon monoxide sensors that run on batteries will need to implement this interface
- * and also implement {@link BatteryAccessory}.</p>
+ * and also implement {@link BatteryStatusAccessory}.</p>
  *
  * @author Gaston Dombiak
  */

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

@@ -16,7 +16,7 @@
  * that the door/window is closed.</p>
  *
  * <p>Contact sensors that run on batteries will need to implement this interface
- * and also implement {@link BatteryAccessory}.</p>
+ * and also implement {@link BatteryStatusAccessory}.</p>
  *
  * @author Gaston Dombiak
  */

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/LockMechanism.java

@@ -15,7 +15,7 @@
  * {@link LockableLockMechanism}.</p>
  *
  * <p>Locks that run on batteries will need to implement this interface and also
- * implement {@link BatteryAccessory}.</p>
+ * implement {@link BatteryStatusAccessory}.</p>
  *
  * @author Andy Lintner
  */

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

@@ -13,7 +13,7 @@
  * <p>A motion sensor that reports whether motion has been detected.</p>
  *
  * <p>Motion sensors that run on batteries will need to implement this interface
- * and also implement {@link BatteryAccessory}.</p>
+ * and also implement {@link BatteryStatusAccessory}.</p>
  *
  * @author Gaston Dombiak
  */

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

@@ -14,7 +14,7 @@
  * <p>A smoke sensor reports whether smoke has been detected or not.</p>
  *
  * <p>Smoke sensors that run on batteries will need to implement this interface
- * and also implement {@link BatteryAccessory}.</p>
+ * and also implement {@link BatteryStatusAccessory}.</p>
  *
  * @author Gaston Dombiak
  */

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;
+    }
+}