Added new accessory types

Added Fan, GarageDoor, Outlet, and Switch accessories

Author: andylintner

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

@@ -0,0 +1,100 @@
+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.RotationDirection;
+import com.beowulfe.hap.impl.services.FanService;
+
+/**
+ * A fan, with power and rotational characteristics.
+ *
+ * @author Andy Lintner
+ */
+public interface Fan extends HomekitAccessory {
+
+	/**
+	 * Retrieves the current binary state of the fan's power.
+	 * @return a future that will contain the binary state
+	 */
+	CompletableFuture<Boolean> getFanPower();
+	
+	/**
+	 * Retrieves the current rotation direction of the fan.
+	 * @return a future that will contain the direction
+	 */
+	CompletableFuture<RotationDirection> getRotationDirection();
+	
+	/**
+	 * Retrieves the current speed of the fan's rotation
+	 * @return a future that will contain the speed, expressed as an integer between 0 and 100.
+	 */
+	CompletableFuture<Integer> getRotationSpeed();
+	
+	/**
+	 * Sets the binary state of the fan's power
+	 * @param state 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> setFanPower(boolean state) throws Exception;
+	
+	/**
+	 * Sets the rotation direction of the fan
+	 * @param direction the direction to set
+	 * @return a future that completes when the change is made
+	 * @throws Exception when the change cannot be made
+	 */
+	CompletableFuture<Void> setRotationDirection(RotationDirection direction) throws Exception;
+	
+	
+	/**
+	 * Sets the speed of the fan's rotation
+	 * @param speed the speed to set, expressed as an integer between 0 and 100.
+	 * @return a future that completes when the change is made
+	 * @throws Exception when the change cannot be made
+	 */
+	CompletableFuture<Void> setRotationSpeed(Integer speed) throws Exception;
+	
+	@Override
+	default public Collection<Service> getServices() {
+		return Collections.singleton(new FanService(this));
+	}
+	
+	/**
+	 * Subscribes to changes in the binary state of the fan's power.
+	 * @param callback the function to call when the state changes.
+	 */
+	void subscribeFanPower(HomekitCharacteristicChangeCallback callback);
+	
+	/**
+	 * Subscribes to changes in the rotation direction of the fan.
+	 * @param callback the function to call when the direction changes.
+	 */
+	void subscribeRotationDirection(HomekitCharacteristicChangeCallback callback);
+	
+	/**
+	 * Subscribes to changes in the rotation speed of the fan.
+	 * @param callback the function to call when the speed changes.
+	 */
+	void subscribeRotationSpeed(HomekitCharacteristicChangeCallback callback);
+	
+	/**
+	 * Unsubscribes from changes in the binary state of the fan's power.
+	 */
+	void unsubscribeFanPower();
+	
+	/**
+	 * Unsubscribes from changes in the rotation direction of the fan.
+	 */
+	void unsubscribeRotationDirection();
+	
+	/**
+	 * Unsubscribes from changes in the fan's rotation speed.
+	 */
+	void unsubscribeRotationSpeed();
+}

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

@@ -0,0 +1,84 @@
+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.DoorState;
+import com.beowulfe.hap.impl.services.GarageDoorService;
+
+/**
+ * A garage door opener, with control and status of a garage door
+ *
+ * @author Andy Lintner
+ */
+public interface GarageDoor extends HomekitAccessory {
+
+	/**
+	 * Retrieves the current state of the door
+	 * @return a future which will contain the door's state
+	 */
+	CompletableFuture<DoorState> getCurrentDoorState();
+	
+	/**
+	 * Retrieves the targeted state of the door
+	 * @return a future which will contain the door's targeted state
+	 */
+	CompletableFuture<DoorState> getTargetDoorState();
+	
+	/**
+	 * Retrieves an indicator of an obstruction detected by the door
+	 * @return a future which will contain the indicator
+	 */
+	CompletableFuture<Boolean> getObstructionDetected();
+	
+	/**
+	 * Sets the targeted state of the door.
+	 * @param state the targeted state
+	 * @return a future that completes when the change is made
+	 * @throws Exception when the change cannot be made
+	 */
+	CompletableFuture<Void> setTargetDoorState(DoorState state) throws Exception;
+
+	/**
+	 * Subscribes to changes in the door's state
+	 * @param callback the function to call when the state changes
+	 */
+	void subscribeCurrentDoorState(HomekitCharacteristicChangeCallback callback);
+	
+	/**
+	 * Subscribes to changes in the door's targeted state
+	 * @param callback the function to call when the targeted state changes
+	 */
+	void subscribeTargetDoorState(HomekitCharacteristicChangeCallback callback);
+	
+	/**
+	 * Subscribes to changes in the obstruction detected indicator
+	 * @param callback the function to call when the indicator chnages
+	 */
+	void subscribeObstructionDetected(HomekitCharacteristicChangeCallback callback);
+
+	/**
+	 * Unsubscribes from changes in the door's state
+	 */
+	void unsubscribeCurrentDoorState();
+	
+	/**
+	 * Unsubscribes from changes in the door's targeted state
+	 */
+	void unsubscribeTargetDoorState();
+	
+	/**
+	 * Unsubscribes from changes in the door's obstruction detected indicator
+	 */
+	void unsubscribeObstructionDetected();
+
+
+	@Override
+	default public Collection<Service> getServices() {
+		return Collections.singleton(new GarageDoorService(this));
+	}
+}

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

@@ -0,0 +1,66 @@
+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.OutletService;
+
+/**
+ * A power outlet with boolean power and usage states.
+ *
+ * @author Andy Lintner
+ */
+public interface Outlet extends HomekitAccessory {
+
+	@Override
+	default public Collection<Service> getServices() {
+		return Collections.singleton(new OutletService(this));
+	}
+
+	/**
+	 * Retrieves the current binary state of the outlet's power.
+	 * @return a future that will contain the binary state
+	 */
+	public CompletableFuture<Boolean> getPowerState();
+	
+	/**
+	 * Retrieves the current binary state indicating whether the outlet is in use.
+	 * @return a future that will contain the binary state
+	 */
+	public CompletableFuture<Boolean> getOutletInUse();
+	
+	/**
+	 * Sets the binary state of the outlet's power.
+	 * @param state the binary state to set
+	 * @return a future that completes when the change is made
+	 * @throws Exception when the change cannot be made
+	 */
+	public CompletableFuture<Void> setPowerState(boolean state);
+	
+	/**
+	 * Subscribes to changes in the binary state of the outlet's power.
+	 * @param callback the function to call when the state changes.
+	 */
+	public void subscribePowerState(HomekitCharacteristicChangeCallback callback);
+
+	/**
+	 * Subscribes to changes in the binary state indicating whether the outlet is in use.
+	 * @param callback the function to call when the state changes.
+	 */
+	public void subscribeOutletInUse(HomekitCharacteristicChangeCallback callback);
+	
+	/**
+	 * Unsubscribes from changes in the binary state of the outlet's power.
+	 */
+	public void unsubscribePowerState();
+
+	/**
+	 * Unsubscribes from changes in the binary state indicating whether hte outlet is in use.
+	 */
+	public void unsubscribeOutletInUse();
+
+}

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

@@ -0,0 +1,48 @@
+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.SwitchService;
+
+/**
+ * A simple switch with a binary state.
+ *
+ * @author Andy Lintner
+ */
+public interface Switch extends HomekitAccessory {
+
+	/**
+	 * Retrieves the current binary state of the switch.
+	 * @return a future that will contain the binary state
+	 */
+	CompletableFuture<Boolean> getSwitchState();
+	
+	/**
+	 * Sets the binary state of the switch
+	 * @param state 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> setSwitchState(boolean state) throws Exception;
+	
+	@Override
+	default public Collection<Service> getServices() {
+		return Collections.singleton(new SwitchService(this));
+	}
+	
+	/**
+	 * Subscribes to changes in the binary state of the switch.
+	 * @param callback the function to call when the state changes.
+	 */
+	void subscribeSwitchState(HomekitCharacteristicChangeCallback callback);
+	
+	/**
+	 * Unsubscribes from changes in the binary state of the switch.
+	 */
+	void unsubscribeSwitchState();
+}

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

@@ -0,0 +1,34 @@
+package com.beowulfe.hap.accessories.properties;
+
+import java.util.Arrays;
+import java.util.Map;
+import java.util.stream.Collectors;
+
+public enum DoorState {
+
+	OPEN(0),
+	CLOSED(1),
+	OPENING(2),
+	CLOSING(3),
+	STOPPED(4);
+	
+
+	private final static Map<Integer, DoorState> reverse;
+	static {
+		reverse = Arrays.stream(DoorState.values()).collect(Collectors.toMap(t -> t.getCode(), t -> t));
+	}
+	
+	public static DoorState fromCode(Integer code) {
+		return reverse.get(code);
+	}
+	
+	private final int code;
+	
+	private DoorState(int code) {
+		this.code = code;
+	}
+	
+	public int getCode() {
+		return code;
+	}
+}

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

@@ -0,0 +1,30 @@
+package com.beowulfe.hap.accessories.properties;
+
+import java.util.Arrays;
+import java.util.Map;
+import java.util.stream.Collectors;
+
+public enum RotationDirection {
+	CLOCKWISE(0),
+	COUNTER_CLOCKWISE(1)
+	;
+	
+	private final static Map<Integer, RotationDirection> reverse;
+	static {
+		reverse = Arrays.stream(RotationDirection.values()).collect(Collectors.toMap(t -> t.getCode(), t -> t));
+	}
+	
+	public static RotationDirection fromCode(Integer code) {
+		return reverse.get(code);
+	}
+	
+	private final int code;
+	
+	private RotationDirection(int code) {
+		this.code = code;
+	}
+	
+	public int getCode() {
+		return code;
+	}
+}

src/main/java/com/beowulfe/hap/impl/ExceptionalConsumer.java

@@ -0,0 +1,5 @@
+package com.beowulfe.hap.impl;
+
+public interface ExceptionalConsumer<T> {
+	void accept(T t) throws Exception;
+}