Add Doorbell, Microphone, Slat, Speaker, StatelessProgrammableSwitch accessories

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

Author: Eugen Freiter

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

@@ -0,0 +1,40 @@
+package io.github.hapjava.accessories;
+
+import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
+import io.github.hapjava.characteristics.impl.common.ProgrammableSwitchEnum;
+import io.github.hapjava.services.Service;
+import io.github.hapjava.services.impl.DoorbellService;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.concurrent.CompletableFuture;
+
+/**
+ * The Doorbell accessory describes a doorbell.
+ *
+ * @author Eugen Freiter
+ */
+public interface DoorbellAccessory extends HomekitAccessory {
+
+  /**
+   * Retrieves the last states of the doorbell. Bluetooth device should return the last event, the
+   * IP device should always return null
+   *
+   * @return state of the door bell event
+   */
+  CompletableFuture<ProgrammableSwitchEnum> getSwitchEvent();
+
+  /**
+   * Subscribes to changes in doorbell switch event, i.e. pressing on the door bell button.
+   *
+   * @param callback the function to call when the state changes.
+   */
+  void subscribeSwitchEvent(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in doorbell switch event. */
+  void unsubscribeSwitchEvent();
+
+  @Override
+  default Collection<Service> getServices() {
+    return Collections.singleton(new DoorbellService(this));
+  }
+}

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

@@ -0,0 +1,47 @@
+package io.github.hapjava.accessories;
+
+import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
+import io.github.hapjava.services.Service;
+import io.github.hapjava.services.impl.MicrophoneService;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.concurrent.CompletableFuture;
+
+/**
+ * Microphone accessory.
+ *
+ * @author Eugen Freiter
+ */
+public interface MicrophoneAccessory extends HomekitAccessory {
+
+  /**
+   * Retrieves mute status.
+   *
+   * @return true if accessory is muted
+   */
+  CompletableFuture<Boolean> isMuted();
+
+  /**
+   * Sets the mute status
+   *
+   * @param mute true if accessory should be muted
+   * @return a future that completes when the change is made
+   * @throws Exception when the change cannot be made
+   */
+  CompletableFuture<Void> setMute(boolean mute) throws Exception;
+
+  /**
+   * Subscribes to changes in mute state.
+   *
+   * @param callback the function to call when the state changes.
+   */
+  void subscribeMuteState(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in the mute state. */
+  void unsubscribeMuteState();
+
+  @Override
+  default Collection<Service> getServices() {
+    return Collections.singleton(new MicrophoneService(this));
+  }
+}

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

@@ -0,0 +1,47 @@
+package io.github.hapjava.accessories;
+
+import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
+import io.github.hapjava.characteristics.impl.slat.CurrentSlatStateEnum;
+import io.github.hapjava.characteristics.impl.slat.SlatTypeEnum;
+import io.github.hapjava.services.Service;
+import io.github.hapjava.services.impl.SlatService;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.concurrent.CompletableFuture;
+
+/**
+ * A slat which tilts on a vertical or a horizontal axis.
+ *
+ * @author Eugen Freiter
+ */
+public interface SlatAccessory extends HomekitAccessory {
+
+  /**
+   * Retrieves the current state of the slat
+   *
+   * @return a future that will contain the state
+   */
+  CompletableFuture<CurrentSlatStateEnum> getSlatState();
+
+  /**
+   * Subscribes to changes in the state of the slat.
+   *
+   * @param callback the function to call when the state changes.
+   */
+  void subscribeSlatState(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in the state of the slat. */
+  void unsubscribeSlatState();
+
+  /**
+   * Retrieves the slat type.
+   *
+   * @return a future that will slat type.
+   */
+  CompletableFuture<SlatTypeEnum> getSlatType();
+
+  @Override
+  default Collection<Service> getServices() {
+    return Collections.singleton(new SlatService(this));
+  }
+}

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

@@ -0,0 +1,47 @@
+package io.github.hapjava.accessories;
+
+import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
+import io.github.hapjava.services.Service;
+import io.github.hapjava.services.impl.SpeakerService;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.concurrent.CompletableFuture;
+
+/**
+ * Speaker accessory.
+ *
+ * @author Eugen Freiter
+ */
+public interface SpeakerAccessory extends HomekitAccessory {
+
+  /**
+   * Retrieves mute status.
+   *
+   * @return true if accessory is muted
+   */
+  CompletableFuture<Boolean> isMuted();
+
+  /**
+   * Sets the mute status
+   *
+   * @param mute true if accessory should be muted
+   * @return a future that completes when the change is made
+   * @throws Exception when the change cannot be made
+   */
+  CompletableFuture<Void> setMute(boolean mute) throws Exception;
+
+  /**
+   * Subscribes to changes in mute state.
+   *
+   * @param callback the function to call when the state changes.
+   */
+  void subscribeMuteState(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in the mute state. */
+  void unsubscribeMuteState();
+
+  @Override
+  default Collection<Service> getServices() {
+    return Collections.singleton(new SpeakerService(this));
+  }
+}

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

@@ -0,0 +1,40 @@
+package io.github.hapjava.accessories;
+
+import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
+import io.github.hapjava.characteristics.impl.common.ProgrammableSwitchEnum;
+import io.github.hapjava.services.Service;
+import io.github.hapjava.services.impl.StatelessProgrammableSwitchService;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.concurrent.CompletableFuture;
+
+/**
+ * The Stateless Programmable Switch accessory describes a stateless programmable switch..
+ *
+ * @author Eugen Freiter
+ */
+public interface StatelessProgrammableSwitchAccessory extends HomekitAccessory {
+
+  /**
+   * Retrieves the last states of the switch. Bluetooth device should return the last event, the IP
+   * device should always return null
+   *
+   * @return state of the switch event
+   */
+  CompletableFuture<ProgrammableSwitchEnum> getSwitchEvent();
+
+  /**
+   * Subscribes to changes in switch event, i.e. pressing on the button.
+   *
+   * @param callback the function to call when the state changes.
+   */
+  void subscribeSwitchEvent(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in switch event. */
+  void unsubscribeSwitchEvent();
+
+  @Override
+  default Collection<Service> getServices() {
+    return Collections.singleton(new StatelessProgrammableSwitchService(this));
+  }
+}

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

@@ -70,9 +70,7 @@ public interface ValveAccessory extends HomekitAccessory {
   /**
    * Retrieves the valve type.
    *
-   * <p>To communicate water is flowing through a valve, inUse should be used.
-   *
-   * @return a future that will contain the binary state
+   * @return a future that will contain the valve type.
    */
   CompletableFuture<ValveTypeEnum> getValveType();
 

src/main/java/io/github/hapjava/accessories/optionalcharacteristic/AccessoryWithCurrentTilting.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 tilting characteristic.
+ *
+ * @author Eugen Freiter
+ */
+public interface AccessoryWithCurrentTilting {
+
+  /**
+   * Retrieves the current tilt angle
+   *
+   * @return a future that will contain the position as a value between -90 and 90
+   */
+  CompletableFuture<Integer> getCurrentTiltAngle();
+
+  /**
+   * Subscribes to changes in the current tilt angle.
+   *
+   * @param callback the function to call when the state changes.
+   */
+  void subscribeCurrentTiltAngle(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in the current tilt angle */
+  void unsubscribeCurrentTiltAngle();
+}

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

@@ -0,0 +1,38 @@
+package io.github.hapjava.accessories.optionalcharacteristic;
+
+import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
+import java.util.concurrent.CompletableFuture;
+
+/**
+ * Accessory with target tilting characteristic.
+ *
+ * @author Eugen Freiter
+ */
+public interface AccessoryWithTargetTilting {
+
+  /**
+   * Retrieves the target tilt angle
+   *
+   * @return a future that will contain the target position as a value between -90 and 90
+   */
+  CompletableFuture<Integer> getTargetTiltAngle();
+
+  /**
+   * Sets the target tilt angle
+   *
+   * @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
+   */
+  CompletableFuture<Void> setTargetTiltAngle(int angle) throws Exception;
+
+  /**
+   * Subscribes to changes in the target tilt angle.
+   *
+   * @param callback the function to call when the state changes.
+   */
+  void subscribeTargetTiltAngle(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in the target tilt angle */
+  void unsubscribeTargetTiltAngle();
+}

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

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

src/main/java/io/github/hapjava/characteristics/impl/audio/MuteCharacteristic.java

@@ -0,0 +1,27 @@
+package io.github.hapjava.characteristics.impl.audio;
+
+import io.github.hapjava.characteristics.ExceptionalConsumer;
+import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
+import io.github.hapjava.characteristics.impl.base.EnumCharacteristic;
+import java.util.Optional;
+import java.util.concurrent.CompletableFuture;
+import java.util.function.Consumer;
+import java.util.function.Supplier;
+
+/** A Mute characteristic allows the control of audio input or output accessory respectively. */
+public class MuteCharacteristic extends EnumCharacteristic<MuteEnum> {
+  public MuteCharacteristic(
+      Supplier<CompletableFuture<MuteEnum>> getter,
+      ExceptionalConsumer<MuteEnum> setter,
+      Consumer<HomekitCharacteristicChangeCallback> subscriber,
+      Runnable unsubscriber) {
+    super(
+        "0000011A-0000-1000-8000-0026BB765291",
+        "Mute",
+        1,
+        Optional.of(getter),
+        Optional.of(setter),
+        Optional.of(subscriber),
+        Optional.of(unsubscriber));
+  }
+}