Added window covering accessory type

Author: andylintner

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

@@ -0,0 +1,55 @@
+package com.beowulfe.hap.accessories;
+
+import java.util.concurrent.CompletableFuture;
+
+import com.beowulfe.hap.HomekitCharacteristicChangeCallback;
+
+/**
+ * Extends WindowCovering with the ability to control horizontal tilt angles
+ *
+ * @author Andy Lintner
+ */
+public interface HorizontalTiltingWindowCovering extends WindowCovering {
+
+	/**
+	 * Retrieves the current horizontal tilt angle
+	 * @return a future that will contain the position as a value between -90 and 90
+	 */
+	CompletableFuture<Integer> getCurrentHorizontalTiltAngle();
+	
+	/**
+	 * Retrieves the target horizontal tilt angle
+	 * @return a future that will contain the target position as a value between -90 and 90
+	 */
+	CompletableFuture<Integer> getTargetHorizontalTiltAngle();
+	
+	/**
+	 * Sets the target position
+	 * @param angle the target angle to set, as a value between -90 and 90
+	 * @return a future that completes when the change is made
+	 * @throws Exception when the change cannot be made
+	 */
+	public CompletableFuture<Void> setTargetHorizontalTiltAngle(int angle) throws Exception;
+	
+	/**
+	 * Subscribes to changes in the current horizontal tilt angle.
+	 * @param callback the function to call when the state changes.
+	 */
+	void subscribeCurrentHorizontalTiltAngle(HomekitCharacteristicChangeCallback callback);
+	
+	/**
+	 * Subscribes to changes in the target horizontal tilt angle.
+	 * @param callback the function to call when the state changes.
+	 */
+	void subscribeTargetHorizontalTiltAngle(HomekitCharacteristicChangeCallback callback);
+	
+	/**
+	 * Unsubscribes from changes in the current horizontal tilt angle
+	 */
+	void unsubscribeCurrentHorizontalTiltAngle();
+	
+	/**
+	 * Unsubscribes from changes in the target horizontal tilt angle
+	 */
+	void unsubscribeTargetHorizontalTiltAngle();
+}

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

@@ -0,0 +1,55 @@
+package com.beowulfe.hap.accessories;
+
+import java.util.concurrent.CompletableFuture;
+
+import com.beowulfe.hap.HomekitCharacteristicChangeCallback;
+
+/**
+ * Extends WindowCovering with the ability to control vertical tilt angles
+ *
+ * @author Andy Lintner
+ */
+public interface VerticalTiltingWindowCovering extends WindowCovering {
+
+	/**
+	 * Retrieves the current vertical tilt angle
+	 * @return a future that will contain the position as a value between -90 and 90
+	 */
+	CompletableFuture<Integer> getCurrentVerticalTiltAngle();
+	
+	/**
+	 * Retrieves the target vertical tilt angle
+	 * @return a future that will contain the target position as a value between -90 and 90
+	 */
+	CompletableFuture<Integer> getTargetVerticalTiltAngle();
+	
+	/**
+	 * Sets the target position
+	 * @param angle the target angle to set, as a value between -90 and 90
+	 * @return a future that completes when the change is made
+	 * @throws Exception when the change cannot be made
+	 */
+	public CompletableFuture<Void> setTargetVerticalTiltAngle(int angle) throws Exception;
+	
+	/**
+	 * Subscribes to changes in the current vertical tilt angle.
+	 * @param callback the function to call when the state changes.
+	 */
+	void subscribeCurrentVerticalTiltAngle(HomekitCharacteristicChangeCallback callback);
+	
+	/**
+	 * Subscribes to changes in the target vertical tilt angle.
+	 * @param callback the function to call when the state changes.
+	 */
+	void subscribeTargetVerticalTiltAngle(HomekitCharacteristicChangeCallback callback);
+	
+	/**
+	 * Unsubscribes from changes in the current vertical tilt angle
+	 */
+	void unsubscribeCurrentVerticalTiltAngle();
+	
+	/**
+	 * Unsubscribes from changes in the target vertical tilt angle
+	 */
+	void unsubscribeTargetVerticalTiltAngle();
+}

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

@@ -0,0 +1,106 @@
+package com.beowulfe.hap.accessories;
+
+import java.util.Collection;
+import java.util.Collections;
+import java.util.concurrent.CompletableFuture;
+
+import com.beowulfe.hap.*;
+import com.beowulfe.hap.accessories.properties.WindowCoveringPositionState;
+import com.beowulfe.hap.impl.services.WindowCoveringService;
+
+/**
+ * A window covering, like blinds, which can be remotely controlled.
+ *
+ * @author Andy Lintner
+ */
+public interface WindowCovering extends HomekitAccessory {
+
+	/**
+	 * Retrieves the current position
+	 * @return a future that will contain the position as a value between 0 and 100
+	 */
+	CompletableFuture<Integer> getCurrentPosition();
+	
+	/**
+	 * Retrieves the target position
+	 * @return a future that will contain the target position as a value between 0 and 100
+	 */
+	CompletableFuture<Integer> getTargetPosition();
+	
+	/**
+	 * Retrieves the state of the position: increasing, decreasing, or stopped
+	 * @return a future that will contain the current state
+	 */
+	CompletableFuture<WindowCoveringPositionState> getPositionState();
+	
+	/**
+	 * Retrieves an indication that the window covering is obstructed from moving
+	 * @return a future that will contain a boolean indicating whether an obstruction is present
+	 */
+	CompletableFuture<Boolean> getObstructionDetected();
+	
+	@Override
+	default public Collection<Service> getServices() {
+		return Collections.singleton(new WindowCoveringService(this));
+	}
+	
+	/**
+	 * Sets the target position
+	 * @param position the target position to set, as a value between 1 and 100
+	 * @return a future that completes when the change is made
+	 * @throws Exception when the change cannot be made
+	 */
+	public CompletableFuture<Void> setTargetPosition(int position) throws Exception;
+	
+	/**
+	 * Sets the hold position state
+	 * @param hold whether or not to hold the current position state
+	 * @return a future that completes when the change is made
+	 * @throws Exception when the change cannot be made
+	 */
+	public CompletableFuture<Void> setHoldPosition(boolean hold) throws Exception;
+	
+	/**
+	 * Subscribes to changes in the current position.
+	 * @param callback the function to call when the state changes.
+	 */
+	void subscribeCurrentPosition(HomekitCharacteristicChangeCallback callback);
+	
+	/**
+	 * Subscribes to changes in the target position.
+	 * @param callback the function to call when the state changes.
+	 */
+	void subscribeTargetPosition(HomekitCharacteristicChangeCallback callback);
+	
+	/**
+	 * Subscribes to changes in the position state: increasing, decreasing, or stopped
+	 * @param callback the function to call when the state changes.
+	 */
+	void subscribePositionState(HomekitCharacteristicChangeCallback callback);
+	
+	/**
+	 * Subscribes to changes in the obstruction detected state
+	 * @param callback the function to call when the state changes.
+	 */
+	void subscribeObstructionDetected(HomekitCharacteristicChangeCallback callback);
+
+	/**
+	 * Unsubscribes from changes in the current position.
+	 */
+	void unsubscribeCurrentPosition();
+	
+	/**
+	 * Unsubscribes from changes in the target position.
+	 */
+	void unsubscribeTargetPosition();
+	
+	/**
+	 * Unsubscribes from changes in the position state
+	 */
+	void unsubscribePositionState();
+	
+	/**
+	 * Unsubscribes from changes in the obstruction detected state
+	 */
+	void unsubscribeObstructionDetected();
+}

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

@@ -0,0 +1,38 @@
+package com.beowulfe.hap.accessories.properties;
+
+import java.util.Arrays;
+import java.util.Map;
+import java.util.stream.Collectors;
+
+import com.beowulfe.hap.accessories.WindowCovering;
+
+/**
+ * The position state used by a {@link WindowCovering}
+ *
+ * @author Andy Lintner
+ */
+public enum WindowCoveringPositionState {
+	DECREASING(0),
+	INCREASING(1),
+	STOPPED(2)
+	;
+	
+	private final static Map<Integer, WindowCoveringPositionState> reverse;
+	static {
+		reverse = Arrays.stream(WindowCoveringPositionState.values()).collect(Collectors.toMap(t -> t.getCode(), t -> t));
+	}
+	
+	public static WindowCoveringPositionState fromCode(Integer code) {
+		return reverse.get(code);
+	}
+	
+	private final int code;
+	
+	private WindowCoveringPositionState(int code) {
+		this.code = code;
+	}
+	
+	public int getCode() {
+		return code;
+	}
+}

…e/ObstructionDetectedCharacteristic.java …n/ObstructionDetectedCharacteristic.javasrc/main/java/com/beowulfe/hap/impl/characteristics/garage/ObstructionDetectedCharacteristic.java renamed to src/main/java/com/beowulfe/hap/impl/characteristics/common/ObstructionDetectedCharacteristic.java src/main/java/com/beowulfe/hap/impl/characteristics/garage/ObstructionDetectedCharacteristic.java renamed to src/main/java/com/beowulfe/hap/impl/characteristics/common/ObstructionDetectedCharacteristic.java

@@ -1,19 +1,25 @@
-package com.beowulfe.hap.impl.characteristics.garage;
+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.accessories.GarageDoor;
 import com.beowulfe.hap.characteristics.BooleanCharacteristic;
 import com.beowulfe.hap.characteristics.EventableCharacteristic;
 
 public class ObstructionDetectedCharacteristic extends BooleanCharacteristic implements EventableCharacteristic {
 
-	private final GarageDoor door;
+	private final Supplier<CompletableFuture<Boolean>> getter;
+	private final Consumer<HomekitCharacteristicChangeCallback> subscriber;
+	private final Runnable unsubscriber;
 
-	public ObstructionDetectedCharacteristic(GarageDoor door) {
-		super("00000024-0000-1000-8000-0026BB765291", false, true, "An obstruction to the door has been detected");
-		this.door = door;
+	public ObstructionDetectedCharacteristic(Supplier<CompletableFuture<Boolean>> getter, 
+			Consumer<HomekitCharacteristicChangeCallback> subscriber, Runnable unsubscriber) {
+		super("00000024-0000-1000-8000-0026BB765291", false, true, "An obstruction has been detected");
+		this.getter = getter;
+		this.subscriber = subscriber;
+		this.unsubscriber = unsubscriber;
 	}
 
 	@Override
@@ -23,17 +29,17 @@ protected void setValue(Boolean value) throws Exception {
 
 	@Override
 	protected CompletableFuture<Boolean> getValue() {
-		return door.getObstructionDetected();
+		return getter.get();
 	}
 
 	@Override
 	public void subscribe(HomekitCharacteristicChangeCallback callback) {
-		door.subscribeObstructionDetected(callback);
+		subscriber.accept(callback);
 	}
 
 	@Override
 	public void unsubscribe() {
-		door.unsubscribeObstructionDetected();
+		unsubscriber.run();
 	}
 
 

src/main/java/com/beowulfe/hap/impl/characteristics/windowcovering/CurrentHorizontalTiltAngleCharacteristic.java

@@ -0,0 +1,39 @@
+package com.beowulfe.hap.impl.characteristics.windowcovering;
+
+import java.util.concurrent.CompletableFuture;
+
+import com.beowulfe.hap.HomekitCharacteristicChangeCallback;
+import com.beowulfe.hap.accessories.HorizontalTiltingWindowCovering;
+import com.beowulfe.hap.characteristics.EventableCharacteristic;
+import com.beowulfe.hap.characteristics.IntegerCharacteristic;
+
+public class CurrentHorizontalTiltAngleCharacteristic extends IntegerCharacteristic implements EventableCharacteristic {
+
+	private final HorizontalTiltingWindowCovering windowCovering;
+	
+	public CurrentHorizontalTiltAngleCharacteristic(HorizontalTiltingWindowCovering windowCovering) {
+		super("0000006C-0000-1000-8000-0026BB765291", false, true, "The current horizontal tilt angle", -90, 90, "Arc Degree");
+		this.windowCovering = windowCovering;
+	}
+
+	@Override
+	protected void setValue(Integer value) throws Exception {
+		//Read Only
+	}
+
+	@Override
+	protected CompletableFuture<Integer> getValue() {
+		return windowCovering.getCurrentHorizontalTiltAngle();
+	}
+
+	@Override
+	public void subscribe(HomekitCharacteristicChangeCallback callback) {
+		windowCovering.subscribeCurrentHorizontalTiltAngle(callback);
+	}
+
+	@Override
+	public void unsubscribe() {
+		windowCovering.unsubscribeCurrentHorizontalTiltAngle();
+	}
+
+}

src/main/java/com/beowulfe/hap/impl/characteristics/windowcovering/CurrentPositionCharacteristic.java

@@ -0,0 +1,39 @@
+package com.beowulfe.hap.impl.characteristics.windowcovering;
+
+import java.util.concurrent.CompletableFuture;
+
+import com.beowulfe.hap.HomekitCharacteristicChangeCallback;
+import com.beowulfe.hap.accessories.WindowCovering;
+import com.beowulfe.hap.characteristics.EventableCharacteristic;
+import com.beowulfe.hap.characteristics.IntegerCharacteristic;
+
+public class CurrentPositionCharacteristic extends IntegerCharacteristic implements EventableCharacteristic {
+
+	private final WindowCovering windowCovering;
+	
+	public CurrentPositionCharacteristic(WindowCovering windowCovering) {
+		super("0000006D-0000-1000-8000-0026BB765291", false, true, "The current position", 0, 100, "%");
+		this.windowCovering = windowCovering;
+	}
+
+	@Override
+	protected void setValue(Integer value) throws Exception {
+		//Read Only
+	}
+
+	@Override
+	protected CompletableFuture<Integer> getValue() {
+		return windowCovering.getCurrentPosition();
+	}
+
+	@Override
+	public void subscribe(HomekitCharacteristicChangeCallback callback) {
+		windowCovering.subscribeCurrentPosition(callback);
+	}
+
+	@Override
+	public void unsubscribe() {
+		windowCovering.unsubscribeCurrentPosition();
+	}
+
+}