add Faucet and HeaterCooler

Signed-off-by: Eugen Freiter <freiter@gmx.de>

Author: Eugen Freiter

CHANGES.md

@@ -1,12 +1,12 @@
 # HAP-Java 2.0.0
 * major refactoring to support optional characteristics
-* structure and names are adapted to HAP spec structure and naming.
+* structure and names adapted to HAP spec structure and naming.
 * structure is following
     * `accessory` package include basis accessory as the listed in HAP spec, plus interfaces for optional characteristics. clients should extend the accessory classes. e.g. `WindowCoveringAccessory` or `AccessoryWithBrightness`
     * `characteristics` package consists of all characteristics, optional and mandatory. e.g. `TargetHorizontalTiltAngleCharacteristic`. The naming is done in accordance to HAP spec.
-    *  `services` package consists of services, which grouping characteristics. e.g. `WindowCoveringService` defines mandatory and optional characteristics for a window covering service as it is defined in HAP spec.
-    * `server` package consists classes to run homekit server and handle communication
-* the process is following: client, e.g. Openhab bindings, extends accessory classes, e.g. `WindowCoveringAccessory` and implements all required methods. WindowCoveringAccessory is linked already to WindowCoveringService, that in turn is link to single characteristics. 
+    * `services` package consists of services, which grouping characteristics. e.g. `WindowCoveringService` defines mandatory and optional characteristics for a window covering service as it is defined in HAP spec.
+    * `server` package consists classes to run HomeKit server and handle communication
+* the process is following: client, e.g. openHAB bindings, extends accessory classes, e.g. `WindowCoveringAccessory` and implements all required methods. WindowCoveringAccessory is linked already to WindowCoveringService, that in turn is link to single characteristics. 
 
 # HAP-Java 1.1.5
 

README.md

@@ -24,7 +24,7 @@ Supported HomeKit Accessories
 =========
 
 Current implementation is based on HAP specification Release R2 (published 2019-07-26) and
-fully supports 33 out of 45 HomeKit accessory services defined there.
+fully supports 35 out of 45 HomeKit accessory services defined there.
 
 | HomeKit Accessory & Service type | Supported by Java-HAP |
 |--------------------|--------------------|
@@ -41,11 +41,11 @@ fully supports 33 out of 45 HomeKit accessory services defined there.
 |  Door                             |     :white_check_mark:    |
 |  Doorbell                         |     :white_check_mark:    |
 |  Fan                              |     :white_check_mark:    |
-|  Faucet                           |     :x:                   |
+|  Faucet                           |     :white_check_mark:    |
 |  Filter Maintenance               |     :x:                   |
 |  Garage Door Opener               |     :white_check_mark:    |
 |  HAP Protocol Information         |     :white_check_mark:    |
-|  Heater Cooler                    |     :x:                   |
+|  Heater Cooler                    |     :white_check_mark:    |
 |  Humidifier Dehumidifier          |     :x:                   |
 |  Humidity Sensor                  |     :white_check_mark:    |
 |  Irrigation System                |     :x:                   |

src/main/java/io/github/hapjava/accessories/FanAccessory.java

@@ -34,7 +34,7 @@ public interface FanAccessory extends HomekitAccessory {
   /**
    * Subscribes to changes in the active state of the fan.
    *
-   * @param callback the function to call when the direction changes.
+   * @param callback the function to call when the active state changes.
    */
   void subscribeActive(HomekitCharacteristicChangeCallback callback);
 

src/main/java/io/github/hapjava/accessories/FaucetAccessory.java

@@ -0,0 +1,48 @@
+package io.github.hapjava.accessories;
+
+import java.util.Collection;
+import java.util.Collections;
+import java.util.concurrent.CompletableFuture;
+import io.github.hapjava.accessories.optionalcharacteristic.AccessoryWithFanState;
+import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
+import io.github.hapjava.services.Service;
+import io.github.hapjava.services.impl.FanService;
+import io.github.hapjava.services.impl.FaucetService;
+
+/**
+ * This service describes accessories like faucets or shower heads.
+ *
+ * @author Eugen Freiter
+ */
+public interface FaucetAccessory extends HomekitAccessory {
+  /**
+   * Mandatory: Retrieves the current active state of the faucet.
+   *
+   * @return a future that will contain the binary state
+   */
+  CompletableFuture<Boolean> isActive();
+
+  /**
+   * Sets the active state of the faucet
+   *
+   * @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> setActive(boolean state) throws Exception;
+
+  /**
+   * Subscribes to changes in the active state of the faucet.
+   *
+   * @param callback the function to call when the active state changes.
+   */
+  void subscribeActive(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in the active state of the faucet. */
+  void unsubscribeActive();
+
+  @Override
+  default Collection<Service> getServices() {
+    return Collections.singleton(new FaucetService(this));
+  }
+}

src/main/java/io/github/hapjava/accessories/HeaterCoolerAccessory.java

@@ -0,0 +1,108 @@
+package io.github.hapjava.accessories;
+
+import java.util.Collection;
+import java.util.Collections;
+import java.util.concurrent.CompletableFuture;
+import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
+import io.github.hapjava.characteristics.impl.heatercooler.CurrentHeaterCoolerStateEnum;
+import io.github.hapjava.characteristics.impl.heatercooler.TargetHeaterCoolerStateEnum;
+import io.github.hapjava.services.Service;
+import io.github.hapjava.services.impl.HeaterCoolerService;
+
+/**
+ * Heater Cooler accessory
+ *
+ * @author Eugen Freiter
+ */
+public interface HeaterCoolerAccessory extends HomekitAccessory {
+  /**
+   * Retrieves the current temperature, in celsius degrees.
+   *
+   * @return a future that will contain the temperature.
+   */
+  CompletableFuture<Double> getCurrentTemperature();
+
+
+  /**
+   * Mandatory: Retrieves the current active state of the fan'.
+   *
+   * @return a future that will contain the binary state
+   */
+  CompletableFuture<Boolean> isActive();
+
+  /**
+   * Sets the active state of the fan
+   *
+   * @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> setActive(boolean state) throws Exception;
+
+  /**
+   * Retrieves the heater /cooler current state.
+   *
+   * @return a future that will contain the heater cooler current state .
+   */
+  CompletableFuture<CurrentHeaterCoolerStateEnum> getCurrentHeaterCoolerState();
+
+  /**
+   * Retrieves the heater cooler target state.
+   *
+   * @return a future that will contain the heater cooler target state .
+   */
+  CompletableFuture<TargetHeaterCoolerStateEnum> getTargetHeaterCoolerState();
+
+  /**
+   * set heater cooler target state the lock target state.
+   *
+   * @param state heater cooler target state
+   * @return a future that completes when the change is made
+   */
+  CompletableFuture<Void> setTargetHeaterCoolerState(TargetHeaterCoolerStateEnum state);
+
+  /**
+   * Subscribes to changes in the heater cooler current state.
+   *
+   * @param callback the function to call when the state changes.
+   */
+  void subscribeCurrentHeaterCoolerState(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in heater cooler current state. */
+  void unsubscribeCurrentHeaterCoolerState();
+
+  /**
+   * Subscribes to changes in the heater cooler target state.
+   *
+   * @param callback the function to call when the state changes.
+   */
+  void subscribeTargetHeaterCoolerState(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in heater cooler target state. */
+  void unsubscribeTargetHeaterCoolerState();
+
+  /**
+   * Subscribes to changes in the active state of the heater cooler .
+   *
+   * @param callback the function to call when the active state changes.
+   */
+  void subscribeActive(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in the active state of the heater cooler . */
+  void unsubscribeActive();
+
+  /**
+   * Subscribes to changes in the current temperature.
+   *
+   * @param callback the function to call when the state changes.
+   */
+  void subscribeCurrentTemperature(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in the current temperature. */
+  void unsubscribeCurrentTemperature();
+
+  @Override
+  default Collection<Service> getServices() {
+    return Collections.singleton(new HeaterCoolerService(this));
+  }
+}

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

@@ -0,0 +1,37 @@
+package io.github.hapjava.accessories.optionalcharacteristic;
+
+import java.util.concurrent.CompletableFuture;
+import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
+import io.github.hapjava.characteristics.impl.thermostat.TemperatureDisplayUnitEnum;
+
+/** Accessory with characteristic that describes units of temperature used for presentation purposes (e.g. the units of temperature displayed on the
+ screen). */
+public interface AccessoryWithTemperatureDisplayUnits {
+
+  /**
+   * Retrieves temperature display units
+   *
+   * @return a future that will contain temperature display units
+   */
+  CompletableFuture<TemperatureDisplayUnitEnum> getTemperatureDisplayUnits();
+
+
+  /**
+   * Sets the temperature display units
+   *
+   * @param units the target temperature display units
+   * @return a future that completes when the change is made
+   * @throws Exception when the change cannot be made
+   */
+  CompletableFuture<Void> setTemperatureDisplayUnits(TemperatureDisplayUnitEnum units) throws Exception;
+
+  /**
+   * Subscribes to changes in the temperature display units
+   *
+   * @param callback the function to call when temperature display units changes.
+   */
+  void subscribeTemperatureDisplayUnits(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in the temperature display units */
+  void unsubscribeTemperatureDisplayUnits();
+}

src/main/java/io/github/hapjava/characteristics/impl/airquality/AirQualityEnum.java

@@ -9,9 +9,9 @@
 public enum AirQualityEnum implements CharacteristicEnum {
   UNKNOWN(0),
   EXCELLENT(1),
-  GOOD(0),
-  FAIR(1),
-  INFERIOR(1),
+  GOOD(2),
+  FAIR(3),
+  INFERIOR(4),
   POOR(5);
 
   private static final Map<Integer, AirQualityEnum> reverse;

src/main/java/io/github/hapjava/characteristics/impl/heatercooler/CurrentHeaterCoolerStateCharacteristic.java

@@ -0,0 +1,31 @@
+package io.github.hapjava.characteristics.impl.heatercooler;
+
+import java.util.Optional;
+import java.util.concurrent.CompletableFuture;
+import java.util.function.Consumer;
+import java.util.function.Supplier;
+import io.github.hapjava.characteristics.EventableCharacteristic;
+import io.github.hapjava.characteristics.ExceptionalConsumer;
+import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
+import io.github.hapjava.characteristics.impl.base.EnumCharacteristic;
+
+/**
+ * This characteristic describes the current state of a heater cooler.
+ */
+public class CurrentHeaterCoolerStateCharacteristic extends EnumCharacteristic<CurrentHeaterCoolerStateEnum>
+    implements EventableCharacteristic {
+
+  public CurrentHeaterCoolerStateCharacteristic(
+      Supplier<CompletableFuture<CurrentHeaterCoolerStateEnum>> getter,
+      Consumer<HomekitCharacteristicChangeCallback> subscriber,
+      Runnable unsubscriber) {
+    super(
+        "000000B1-0000-1000-8000-0026BB765291",
+        "current heater cooler state",
+        3,
+        Optional.of(getter),
+        Optional.empty(),
+        Optional.of(subscriber),
+        Optional.of(unsubscriber));
+  }
+}

src/main/java/io/github/hapjava/characteristics/impl/heatercooler/CurrentHeaterCoolerStateEnum.java

@@ -0,0 +1,40 @@
+package io.github.hapjava.characteristics.impl.heatercooler;
+
+import java.util.Arrays;
+import java.util.Map;
+import java.util.stream.Collectors;
+import io.github.hapjava.characteristics.CharacteristicEnum;
+
+/** 0 ”Inactive”
+ 1 ”Idle”
+ 2 ”Heating”
+ 3 ”Cooling” */
+public enum CurrentHeaterCoolerStateEnum implements CharacteristicEnum {
+  INACTIVE(0),
+  IDLE(1),
+  HEATING(2),
+  COOLING(3);
+
+  private static final Map<Integer, CurrentHeaterCoolerStateEnum> reverse;
+
+  static {
+    reverse =
+        Arrays.stream(CurrentHeaterCoolerStateEnum.values())
+            .collect(Collectors.toMap(CurrentHeaterCoolerStateEnum::getCode, t -> t));
+  }
+
+  public static CurrentHeaterCoolerStateEnum fromCode(Integer code) {
+    return reverse.get(code);
+  }
+
+  private final int code;
+
+  CurrentHeaterCoolerStateEnum(int code) {
+    this.code = code;
+  }
+
+  @Override
+  public int getCode() {
+    return code;
+  }
+}

src/main/java/io/github/hapjava/characteristics/impl/heatercooler/TargetHeaterCoolerStateCharacteristic.java

@@ -0,0 +1,41 @@
+package io.github.hapjava.characteristics.impl.heatercooler;
+
+import java.util.Optional;
+import java.util.concurrent.CompletableFuture;
+import java.util.function.Consumer;
+import java.util.function.Supplier;
+import io.github.hapjava.characteristics.EventableCharacteristic;
+import io.github.hapjava.characteristics.ExceptionalConsumer;
+import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
+import io.github.hapjava.characteristics.impl.base.EnumCharacteristic;
+import io.github.hapjava.characteristics.impl.thermostat.TargetHeatingCoolingStateEnum;
+
+/**
+ * This characteristic describes the target state of heater cooler.
+ */
+public class TargetHeaterCoolerStateCharacteristic extends EnumCharacteristic<TargetHeaterCoolerStateEnum>
+    implements EventableCharacteristic {
+
+  public TargetHeaterCoolerStateCharacteristic(
+      Supplier<CompletableFuture<TargetHeaterCoolerStateEnum>> getter,
+      ExceptionalConsumer<TargetHeaterCoolerStateEnum> setter,
+      Consumer<HomekitCharacteristicChangeCallback> subscriber,
+      Runnable unsubscriber) {
+    super(
+        "000000B2-0000-1000-8000-0026BB765291",
+        "target heater cooler state",
+        2,
+        Optional.of(getter),
+        Optional.of(setter),
+        Optional.of(subscriber),
+        Optional.of(unsubscriber));
+  }
+
+  @Override
+  protected void setValue(Integer value) throws Exception {
+    if (!setter.isPresent()) {
+      return;
+    }
+    setter.get().accept(TargetHeaterCoolerStateEnum.fromCode(value));
+  }
+}