add smart speaker

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

Author: Eugen Freiter

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

@@ -0,0 +1,62 @@
+package io.github.hapjava.accessories;
+
+import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
+import io.github.hapjava.characteristics.impl.television.CurrentMediaStateEnum;
+import io.github.hapjava.characteristics.impl.television.TargetMediaStateEnum;
+import io.github.hapjava.services.Service;
+import io.github.hapjava.services.impl.SmartSpeakerService;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.concurrent.CompletableFuture;
+
+/** Smart Speaker accessory. */
+public interface SmartSpeakerAccessory extends HomekitAccessory {
+
+  /**
+   * Retrieves the current media state (see {@link
+   * io.github.hapjava.characteristics.impl.television.CurrentMediaStateEnum} for supported values).
+   *
+   * @return a future that will contain the current media state
+   */
+  CompletableFuture<CurrentMediaStateEnum> getCurrentMediaState();
+
+  /**
+   * Subscribes to changes in the current media state.
+   *
+   * @param callback the function to call when the current media state changes.
+   */
+  void subscribeCurrentMediaState(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in the current media state. */
+  void unsubscribeCurrentMediaState();
+
+  /**
+   * Retrieves the target media state (see {@link TargetMediaStateEnum} for supported values).
+   *
+   * @return a future that will contain the target media state
+   */
+  CompletableFuture<TargetMediaStateEnum> getTargetMediaState();
+
+  /**
+   * Set the target media state (see {@link TargetMediaStateEnum} for supported values).
+   *
+   * @param targetMediaState target media state
+   * @return a future that completes when the change is made
+   */
+  CompletableFuture<Void> setTargetMediaState(TargetMediaStateEnum targetMediaState);
+
+  /**
+   * Subscribes to changes in the target media state.
+   *
+   * @param callback the function to call when the target media state changes.
+   */
+  void subscribeTargetMediaState(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in the target media state. */
+  void unsubscribeTargetMediaState();
+
+  @Override
+  default Collection<Service> getServices() {
+    return Collections.singleton(new SmartSpeakerService(this));
+  }
+}

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

@@ -72,7 +72,7 @@ public interface TelevisionAccessory extends HomekitAccessory {
   CompletableFuture<String> getConfiguredName();
 
   /**
-   * Sets the mute status
+   * Sets the configured name
    *
    * @param name configured name
    * @return a future that completes when the change is made
@@ -81,13 +81,13 @@ public interface TelevisionAccessory extends HomekitAccessory {
   CompletableFuture<Void> setConfiguredName(String name) throws Exception;
 
   /**
-   * Subscribes to changes in mute state.
+   * Subscribes to changes in configured name.
    *
-   * @param callback the function to call when the state changes.
+   * @param callback the function to call when the configureed name changes.
    */
   void subscribeConfiguredName(HomekitCharacteristicChangeCallback callback);
 
-  /** Unsubscribes from changes in the mute state. */
+  /** Unsubscribes from changes in the configured name state. */
   void unsubscribeConfiguredName();
 
   /**

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

@@ -0,0 +1,37 @@
+package io.github.hapjava.accessories.optionalcharacteristic;
+
+import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
+import java.util.concurrent.CompletableFuture;
+
+/**
+ * Accessory with AirPlay enable characteristic {@link
+ * io.github.hapjava.characteristics.impl.common.AirPlayEnableCharacteristic}.
+ */
+public interface AccessoryWithAirPlayEnable {
+
+  /**
+   * Retrieves the AirPlay enable state
+   *
+   * @return a future that will contain the AirPlay enable state.
+   */
+  CompletableFuture<Integer> getAirPlayEnable();
+
+  /**
+   * Sets the AirPlay enable state
+   *
+   * @param state AirPlay enable state
+   * @return a future that completes when the AirPlay enable is changed
+   * @throws Exception when the AirPlay enable cannot be set
+   */
+  CompletableFuture<Void> setAirPlayEnable(Integer state) throws Exception;
+
+  /**
+   * Subscribes to changes in the AirPlay enable state.
+   *
+   * @param callback the function to call when the AirPlay enable state changes.
+   */
+  void subscribeAirPlayEnable(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in the AirPlay enable state. */
+  void unsubscribeAirPlayEnable();
+}

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

@@ -0,0 +1,34 @@
+package io.github.hapjava.accessories.optionalcharacteristic;
+
+import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
+import java.util.concurrent.CompletableFuture;
+
+/** Accessory with configured name. */
+public interface AccessoryWithConfiguredName {
+
+  /**
+   * Retrieves configured name.
+   *
+   * @return configured name
+   */
+  CompletableFuture<String> getConfiguredName();
+
+  /**
+   * Sets the configured name
+   *
+   * @param name configured name
+   * @return a future that completes when the change is made
+   * @throws Exception when the change cannot be made
+   */
+  CompletableFuture<Void> setConfiguredName(String name) throws Exception;
+
+  /**
+   * Subscribes to changes in configured name.
+   *
+   * @param callback the function to call when the configureed name changes.
+   */
+  void subscribeConfiguredName(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in the configured name state. */
+  void unsubscribeConfiguredName();
+}

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

@@ -0,0 +1,37 @@
+package io.github.hapjava.accessories.optionalcharacteristic;
+
+import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
+import java.util.concurrent.CompletableFuture;
+
+/**
+ * Accessory with mute characteristic {@link
+ * io.github.hapjava.characteristics.impl.audio.MuteCharacteristic}.
+ */
+public interface AccessoryWithMute {
+
+  /**
+   * 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();
+}

src/main/java/io/github/hapjava/characteristics/impl/common/AirPlayEnableCharacteristic.java

@@ -0,0 +1,32 @@
+package io.github.hapjava.characteristics.impl.common;
+
+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.IntegerCharacteristic;
+import java.util.Optional;
+import java.util.concurrent.CompletableFuture;
+import java.util.function.Consumer;
+import java.util.function.Supplier;
+
+/** characteristic to control air play. */
+public class AirPlayEnableCharacteristic extends IntegerCharacteristic
+    implements EventableCharacteristic {
+
+  public AirPlayEnableCharacteristic(
+      Supplier<CompletableFuture<Integer>> getter,
+      ExceptionalConsumer<Integer> setter,
+      Consumer<HomekitCharacteristicChangeCallback> subscriber,
+      Runnable unsubscriber) {
+    super(
+        "0000025B-0000-1000-8000-0026BB765291",
+        "AirPlay enable",
+        0,
+        1,
+        "",
+        Optional.of(getter),
+        Optional.of(setter),
+        Optional.of(subscriber),
+        Optional.of(unsubscriber));
+  }
+}

src/main/java/io/github/hapjava/services/impl/DoorService.java

@@ -2,8 +2,10 @@
 
 import io.github.hapjava.accessories.DoorAccessory;
 import io.github.hapjava.accessories.optionalcharacteristic.AccessoryWithHoldPosition;
+import io.github.hapjava.accessories.optionalcharacteristic.AccessoryWithMute;
 import io.github.hapjava.accessories.optionalcharacteristic.AccessoryWithName;
 import io.github.hapjava.accessories.optionalcharacteristic.AccessoryWithObstructionDetection;
+import io.github.hapjava.characteristics.impl.audio.MuteCharacteristic;
 import io.github.hapjava.characteristics.impl.common.NameCharacteristic;
 import io.github.hapjava.characteristics.impl.common.ObstructionDetectedCharacteristic;
 import io.github.hapjava.characteristics.impl.windowcovering.CurrentPositionCharacteristic;
@@ -53,6 +55,14 @@ public DoorService(DoorAccessory accessory) {
               ((AccessoryWithObstructionDetection) accessory)::subscribeObstructionDetected,
               ((AccessoryWithObstructionDetection) accessory)::unsubscribeObstructionDetected));
     }
+    if (accessory instanceof AccessoryWithMute) {
+      addOptionalCharacteristic(
+          new MuteCharacteristic(
+              ((AccessoryWithMute) accessory)::isMuted,
+              ((AccessoryWithMute) accessory)::setMute,
+              ((AccessoryWithMute) accessory)::subscribeMuteState,
+              ((AccessoryWithMute) accessory)::unsubscribeMuteState));
+    }
   }
 
   public void addOptionalCharacteristic(NameCharacteristic name) {
@@ -67,4 +77,8 @@ public void addOptionalCharacteristic(
       ObstructionDetectedCharacteristic obstructionDetectedCharacteristic) {
     addCharacteristic(obstructionDetectedCharacteristic);
   }
+
+  public void addOptionalCharacteristic(MuteCharacteristic muteCharacteristic) {
+    addCharacteristic(muteCharacteristic);
+  }
 }

src/main/java/io/github/hapjava/services/impl/SmartSpeakerService.java

@@ -0,0 +1,95 @@
+package io.github.hapjava.services.impl;
+
+import io.github.hapjava.accessories.SmartSpeakerAccessory;
+import io.github.hapjava.accessories.optionalcharacteristic.AccessoryWithAirPlayEnable;
+import io.github.hapjava.accessories.optionalcharacteristic.AccessoryWithConfiguredName;
+import io.github.hapjava.accessories.optionalcharacteristic.AccessoryWithMute;
+import io.github.hapjava.accessories.optionalcharacteristic.AccessoryWithName;
+import io.github.hapjava.accessories.optionalcharacteristic.AccessoryWithVolume;
+import io.github.hapjava.characteristics.impl.audio.MuteCharacteristic;
+import io.github.hapjava.characteristics.impl.audio.VolumeCharacteristic;
+import io.github.hapjava.characteristics.impl.common.AirPlayEnableCharacteristic;
+import io.github.hapjava.characteristics.impl.common.ConfiguredNameCharacteristic;
+import io.github.hapjava.characteristics.impl.common.NameCharacteristic;
+import io.github.hapjava.characteristics.impl.television.CurrentMediaStateCharacteristic;
+import io.github.hapjava.characteristics.impl.television.TargetMediaStateCharacteristic;
+
+/** A smart speaker service can be used to control the audio output settings on a speaker device. */
+public class SmartSpeakerService extends AbstractServiceImpl {
+
+  public SmartSpeakerService(
+      CurrentMediaStateCharacteristic currentMediaStateCharacteristic,
+      TargetMediaStateCharacteristic targetMediaStateCharacteristic) {
+    super("00000228-0000-1000-8000-0026BB765291");
+    addCharacteristic(currentMediaStateCharacteristic);
+    addCharacteristic(targetMediaStateCharacteristic);
+  }
+
+  public SmartSpeakerService(SmartSpeakerAccessory accessory) {
+    this(
+        new CurrentMediaStateCharacteristic(
+            accessory::getCurrentMediaState,
+            accessory::subscribeCurrentMediaState,
+            accessory::unsubscribeCurrentMediaState),
+        new TargetMediaStateCharacteristic(
+            accessory::getTargetMediaState,
+            accessory::setTargetMediaState,
+            accessory::subscribeTargetMediaState,
+            accessory::unsubscribeTargetMediaState));
+    if (accessory instanceof AccessoryWithName) {
+      addOptionalCharacteristic(new NameCharacteristic(((AccessoryWithName) accessory)::getName));
+    }
+    if (accessory instanceof AccessoryWithVolume) {
+      addOptionalCharacteristic(
+          new VolumeCharacteristic(
+              ((AccessoryWithVolume) accessory)::getVolume,
+              ((AccessoryWithVolume) accessory)::setVolume,
+              ((AccessoryWithVolume) accessory)::subscribeVolume,
+              ((AccessoryWithVolume) accessory)::unsubscribeVolume));
+    }
+    if (accessory instanceof AccessoryWithConfiguredName) {
+      addOptionalCharacteristic(
+          new ConfiguredNameCharacteristic(
+              ((AccessoryWithConfiguredName) accessory)::getConfiguredName,
+              ((AccessoryWithConfiguredName) accessory)::setConfiguredName,
+              ((AccessoryWithConfiguredName) accessory)::subscribeConfiguredName,
+              ((AccessoryWithConfiguredName) accessory)::unsubscribeConfiguredName));
+    }
+    if (accessory instanceof AccessoryWithMute) {
+      addOptionalCharacteristic(
+          new MuteCharacteristic(
+              ((AccessoryWithMute) accessory)::isMuted,
+              ((AccessoryWithMute) accessory)::setMute,
+              ((AccessoryWithMute) accessory)::subscribeMuteState,
+              ((AccessoryWithMute) accessory)::unsubscribeMuteState));
+    }
+    if (accessory instanceof AccessoryWithAirPlayEnable) {
+      addOptionalCharacteristic(
+          new AirPlayEnableCharacteristic(
+              ((AccessoryWithAirPlayEnable) accessory)::getAirPlayEnable,
+              ((AccessoryWithAirPlayEnable) accessory)::setAirPlayEnable,
+              ((AccessoryWithAirPlayEnable) accessory)::subscribeAirPlayEnable,
+              ((AccessoryWithAirPlayEnable) accessory)::unsubscribeAirPlayEnable));
+    }
+  }
+
+  public void addOptionalCharacteristic(NameCharacteristic name) {
+    addCharacteristic(name);
+  }
+
+  public void addOptionalCharacteristic(VolumeCharacteristic volume) {
+    addCharacteristic(volume);
+  }
+
+  public void addOptionalCharacteristic(ConfiguredNameCharacteristic configuredNameCharacteristic) {
+    addCharacteristic(configuredNameCharacteristic);
+  }
+
+  public void addOptionalCharacteristic(MuteCharacteristic muteCharacteristic) {
+    addCharacteristic(muteCharacteristic);
+  }
+
+  public void addOptionalCharacteristic(AirPlayEnableCharacteristic airPlayEnableCharacteristic) {
+    addCharacteristic(airPlayEnableCharacteristic);
+  }
+}