make service characteristics complete

Author: yfre

src/main/java/io/github/hapjava/accessories/optionalcharacteristic/AccessoryWithAccessoryFlags.java

@@ -0,0 +1,30 @@
+package io.github.hapjava.accessories.optionalcharacteristic;
+
+import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
+import io.github.hapjava.characteristics.impl.accessoryinformation.AccessoryFlagsEnum;
+import java.util.concurrent.CompletableFuture;
+
+/**
+ * Accessory with accessory flags, which indicates that additional setup is required
+ *
+ * @author Eugen Freiter
+ */
+public interface AccessoryWithAccessoryFlags {
+
+  /**
+   * When set indicates accessory requires additional setup.
+   *
+   * @return a future that will contain the accessory flags
+   */
+  CompletableFuture<AccessoryFlagsEnum> getAccessoryFlags();
+
+  /**
+   * Subscribes to changes in accessory flags
+   *
+   * @param callback the function to call when the accessory flags changes.
+   */
+  void subscribeAccessoryFlags(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in the accessory flags . */
+  void unsubscribeAccessoryFlags();
+}

src/main/java/io/github/hapjava/accessories/optionalcharacteristic/AccessoryWithColorTemperature.java

@@ -0,0 +1,38 @@
+package io.github.hapjava.accessories.optionalcharacteristic;
+
+import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
+import java.util.concurrent.CompletableFuture;
+
+/**
+ * Accessory with color temperature.
+ *
+ * @author Eugen Freiter
+ */
+public interface AccessoryWithColorTemperature {
+
+  /**
+   * Retrieves the color temperature
+   *
+   * @return a future that will contain the brightness, expressed as an integer between 0 and 100.
+   */
+  CompletableFuture<Integer> getColorTemperature();
+
+  /**
+   * Sets the color temperature
+   *
+   * @param value the brightness, on a scale of 0 to 100, to set
+   * @return a future that completes when the brightness is changed
+   * @throws Exception when the brightness cannot be set
+   */
+  CompletableFuture<Void> setColorTemperature(Integer value) throws Exception;
+
+  /**
+   * Subscribes to changes in color temperature.
+   *
+   * @param callback the function to call when the color temperature changes.
+   */
+  void subscribeColorTemperature(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in the color temperature. */
+  void unsubscribeColorTemperature();
+}

…ssoryWithCoolingThresholdTemprature.java …soryWithCoolingThresholdTemperature.javasrc/main/java/io/github/hapjava/accessories/optionalcharacteristic/AccessoryWithCoolingThresholdTemprature.java renamed to src/main/java/io/github/hapjava/accessories/optionalcharacteristic/AccessoryWithCoolingThresholdTemperature.java src/main/java/io/github/hapjava/accessories/optionalcharacteristic/AccessoryWithCoolingThresholdTemprature.java renamed to src/main/java/io/github/hapjava/accessories/optionalcharacteristic/AccessoryWithCoolingThresholdTemperature.java

@@ -3,7 +3,12 @@
 import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
 import java.util.concurrent.CompletableFuture;
 
-public interface AccessoryWithCoolingThresholdTemprature {
+/**
+ * Accessory with cooling threshold temperature.
+ *
+ * @author Eugen Freiter
+ */
+public interface AccessoryWithCoolingThresholdTemperature {
 
   /**
    * Retrieves the temperature above which the thermostat should begin cooling.

src/main/java/io/github/hapjava/accessories/optionalcharacteristic/AccessoryWithCurrentHorizontalTilting.java

@@ -0,0 +1,29 @@
+package io.github.hapjava.accessories.optionalcharacteristic;
+
+import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
+import java.util.concurrent.CompletableFuture;
+
+/**
+ * Accessory with current horizontal tilting characteristic.
+ *
+ * @author Andy Lintner
+ */
+public interface AccessoryWithCurrentHorizontalTilting {
+
+  /**
+   * Retrieves the current horizontal tilt angle
+   *
+   * @return a future that will contain the position as a value between -90 and 90
+   */
+  CompletableFuture<Integer> getCurrentHorizontalTiltAngle();
+
+  /**
+   * Subscribes to changes in the current horizontal tilt angle.
+   *
+   * @param callback the function to call when the state changes.
+   */
+  void subscribeCurrentHorizontalTiltAngle(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in the current horizontal tilt angle */
+  void unsubscribeCurrentHorizontalTiltAngle();
+}

src/main/java/io/github/hapjava/accessories/optionalcharacteristic/AccessoryWithCurrentRelativeHumidity.java

@@ -0,0 +1,25 @@
+package io.github.hapjava.accessories.optionalcharacteristic;
+
+import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
+import java.util.concurrent.CompletableFuture;
+
+/** accessory with current relative humidity. */
+public interface AccessoryWithCurrentRelativeHumidity {
+
+  /**
+   * Retrieves the current relative humidity.
+   *
+   * @return a future that will contain the current relative humidity.
+   */
+  CompletableFuture<Double> getCurrentRelativeHumidity();
+
+  /**
+   * Subscribes to changes in current relative humidity.
+   *
+   * @param callback the function to call when the current relative humidity changes.
+   */
+  void subscribeCurrentRelativeHumidity(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in the current relative humidity. */
+  void unsubscribeCurrentRelativeHumidity();
+}

src/main/java/io/github/hapjava/accessories/optionalcharacteristic/AccessoryWithCurrentVerticalTilting.java

@@ -0,0 +1,24 @@
+package io.github.hapjava.accessories.optionalcharacteristic;
+
+import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
+import java.util.concurrent.CompletableFuture;
+
+/** Accessory with current vertical tilting characteristic. */
+public interface AccessoryWithCurrentVerticalTilting {
+  /**
+   * Retrieves the current vertical tilt angle
+   *
+   * @return a future that will contain the position as a value between -90 and 90
+   */
+  CompletableFuture<Integer> getCurrentVerticalTiltAngle();
+
+  /**
+   * Subscribes to changes in the current vertical tilt angle.
+   *
+   * @param callback the function to call when the state changes.
+   */
+  void subscribeCurrentVerticalTiltAngle(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in the current vertical tilt angle */
+  void unsubscribeCurrentVerticalTiltAngle();
+}

src/main/java/io/github/hapjava/accessories/optionalcharacteristic/AccessoryWithFanState.java

@@ -2,9 +2,6 @@
 
 import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
 import io.github.hapjava.characteristics.impl.fan.CurrentFanStateEnum;
-import io.github.hapjava.characteristics.impl.fan.LockPhysicalControlsEnum;
-import io.github.hapjava.characteristics.impl.fan.RotationDirectionEnum;
-import io.github.hapjava.characteristics.impl.fan.SwingModeEnum;
 import io.github.hapjava.characteristics.impl.fan.TargetFanStateEnum;
 import java.util.concurrent.CompletableFuture;
 
@@ -37,75 +34,6 @@ public interface AccessoryWithFanState {
    */
   CompletableFuture<Void> setTargetFanState(TargetFanStateEnum targetState);
 
-  /**
-   * Retrieves the swing mode of the fan.
-   *
-   * @return a future that will contain the swing mode
-   */
-  CompletableFuture<SwingModeEnum> getSwingMode();
-
-  /**
-   * Set the swing mode of the fan (DISABLED, ENABLED).
-   *
-   * @param swingMode swing mode
-   * @return a future that completes when the change is made
-   */
-  CompletableFuture<Void> setSwingMode(SwingModeEnum swingMode);
-
-  /**
-   * OPTIONAL: Retrieves the lock controls of the fan.
-   *
-   * @return a future that will contain the lock controls
-   */
-  CompletableFuture<LockPhysicalControlsEnum> getLockControls();
-
-  /**
-   * Set the lock controls of the fan (DISABLED, ENABLED).
-   *
-   * @param lockControls lock controls mode
-   * @return a future that completes when the change is made
-   */
-  CompletableFuture<Void> setLockControls(LockPhysicalControlsEnum lockControls);
-
-  /**
-   * Retrieves the current rotation direction of the fan.
-   *
-   * @return a future that will contain the direction
-   */
-  CompletableFuture<RotationDirectionEnum> 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 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(RotationDirectionEnum direction) throws Exception;
-
-  /**
-   * OPTIONAL: 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;
-
-  /**
-   * 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 current fan state.
    *
@@ -120,42 +48,9 @@ public interface AccessoryWithFanState {
    */
   void subscribeTargetFanState(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);
-
-  /**
-   * Subscribes to changes in the swing mode of the fan.
-   *
-   * @param callback the function to call when the swing mode changes.
-   */
-  void subscribeSwingMode(HomekitCharacteristicChangeCallback callback);
-
-  /**
-   * Subscribes to changes in the lock controls of the fan.
-   *
-   * @param callback the function to call when the lock controls changes.
-   */
-  void subscribeLockControls(HomekitCharacteristicChangeCallback callback);
-
-  /** Unsubscribes from changes in the rotation direction of the fan. */
-  void unsubscribeRotationDirection();
-
-  /** Unsubscribes from changes in the fan's rotation speed. */
-  void unsubscribeRotationSpeed();
-
   /** Unsubscribes from changes in the current state of the fan. */
   void unsubscribeCurrentFanState();
 
   /** Unsubscribes from changes in the target state of the fan. */
   void unsubscribeTargetFanState();
-
-  /** Unsubscribes from changes in the swing mode of the fan. */
-  void unsubscribeSwingMode();
-
-  /** Unsubscribes from changes in the lock controls of the fan. */
-  void unsubscribeLockControls();
 }

…ssoryWithHearingThresholdTemprature.java …ssoryWithHeatingThresholdTemprature.javasrc/main/java/io/github/hapjava/accessories/optionalcharacteristic/AccessoryWithHearingThresholdTemprature.java renamed to src/main/java/io/github/hapjava/accessories/optionalcharacteristic/AccessoryWithHeatingThresholdTemprature.java src/main/java/io/github/hapjava/accessories/optionalcharacteristic/AccessoryWithHearingThresholdTemprature.java renamed to src/main/java/io/github/hapjava/accessories/optionalcharacteristic/AccessoryWithHeatingThresholdTemprature.java

@@ -3,7 +3,7 @@
 import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
 import java.util.concurrent.CompletableFuture;
 
-public interface AccessoryWithHearingThresholdTemprature {
+public interface AccessoryWithHeatingThresholdTemprature {
 
   /**
    * Retrieves the temperature below which the thermostat should begin heating.

src/main/java/io/github/hapjava/accessories/optionalcharacteristic/AccessoryWithIsConfigured.java

@@ -0,0 +1,40 @@
+package io.github.hapjava.accessories.optionalcharacteristic;
+
+import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
+import io.github.hapjava.characteristics.impl.common.IsConfiguredEnum;
+import java.util.concurrent.CompletableFuture;
+
+/**
+ * Accessory with isConfigured characteristics. This characteristic describes if the service is
+ * configured for use. For example, all of the valves in an irrigation system may not be configured
+ * depending on physical wire connection.
+ *
+ * @author Eugen Freiter
+ */
+public interface AccessoryWithIsConfigured {
+
+  /**
+   * isConfigured state
+   *
+   * @return a future that will contain the isConfigured state
+   */
+  CompletableFuture<IsConfiguredEnum> getIsConfigured();
+
+  /**
+   * Set the isConfigured (NOT_CONFIGURED, CONFIGURED).
+   *
+   * @param isConfigured isConfigured state
+   * @return a future that completes when the change is made
+   */
+  CompletableFuture<Void> setIsConfigured(IsConfiguredEnum isConfigured);
+
+  /**
+   * Subscribes to changes in isConfigured state
+   *
+   * @param callback the function to call when the isConfigured state changes.
+   */
+  void subscribeIsConfigured(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in the isConfigured state. */
+  void unsubscribeIsConfigured();
+}

src/main/java/io/github/hapjava/accessories/optionalcharacteristic/AccessoryWithLockCurrentState.java

@@ -0,0 +1,30 @@
+package io.github.hapjava.accessories.optionalcharacteristic;
+
+import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
+import io.github.hapjava.characteristics.impl.lock.LockCurrentStateEnum;
+import java.util.concurrent.CompletableFuture;
+
+/**
+ * Accessory with current lock state.
+ *
+ * @author Eugen Freiter
+ */
+public interface AccessoryWithLockCurrentState {
+
+  /**
+   * Retrieves the lock states. The current state of the physical security mechanism (e.g. deadbolt)
+   *
+   * @return a future with the value
+   */
+  CompletableFuture<LockCurrentStateEnum> getLockCurrentState();
+
+  /**
+   * Subscribes to changes in lock current state.
+   *
+   * @param callback the function when the lock current state changes
+   */
+  void subscribeLockCurrentState(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes */
+  void unsubscribeLockCurrentState();
+}