add support for television service

Signed-off-by: Eugen Freiter <[email protected]>

Author: Eugen Freiter

CHANGES.md

@@ -2,6 +2,31 @@
 ## Fixes
 * Log accessory names instead of futures. [#150](https://github.com/hap-java/HAP-Java/issues/150)
 * Fix rotation speed data type (BREAKING API CHANGE). According to HAP specification it must be float
+* Fix UUID of HAP Version characteristic
+
+## New  
+* New characteristics:
+  * Identifier
+  * Input Device Type 
+  * Input Source Type 
+  * Configured Name 
+  * Current Visibility State 
+  * Target Visibility State 
+  * Sleep Discovery Mode 
+  * Active Identifier 
+  * Closed Captions 
+  * Current Media State 
+  * Target Media State 
+  * Picture Mode
+  * Power Mode  
+  * Remote Key
+  * Volume Control Type
+  * Volume Selector
+  
+* New services
+  * Input Source
+  * Television
+  * Television Speaker
 
 # HAP-Java 2.0.0
 * major refactoring to support optional characteristics

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

@@ -0,0 +1,104 @@
+package io.github.hapjava.accessories;
+
+import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
+import io.github.hapjava.characteristics.impl.common.IsConfiguredEnum;
+import io.github.hapjava.characteristics.impl.inputsource.CurrentVisibilityStateEnum;
+import io.github.hapjava.characteristics.impl.inputsource.InputSourceTypeEnum;
+import io.github.hapjava.services.Service;
+import io.github.hapjava.services.impl.InputSourceService;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.concurrent.CompletableFuture;
+
+/** Input Source accessory. */
+public interface InputSourceAccessory extends HomekitAccessory {
+
+  /**
+   * Retrieves configured name of input source.
+   *
+   * @return configured name of input source
+   */
+  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 configured name changes.
+   */
+  void subscribeConfiguredName(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in the configured name. */
+  void unsubscribeConfiguredName();
+
+  /**
+   * Retrieves the flag whether input source is configured.
+   *
+   * @return a future that will contain the flag .
+   */
+  CompletableFuture<IsConfiguredEnum> isConfigured();
+  /**
+   * set the flag whether input source is configured.
+   *
+   * @param state is configured state
+   * @return a future that completes when the change is made
+   */
+  CompletableFuture<Void> setIsConfigured(IsConfiguredEnum state);
+
+  /**
+   * Subscribes to changes in isConfigured.
+   *
+   * @param callback the function to call when the state changes.
+   */
+  void subscribeIsConfigured(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in isConfigured. */
+  void unsubscribeIsConfigured();
+
+  /**
+   * Retrieves the input source type.
+   *
+   * @return a future that will contain the input source type.
+   */
+  CompletableFuture<InputSourceTypeEnum> getInputSourceType();
+
+  /**
+   * Subscribes to changes in input source type.
+   *
+   * @param callback the function to call when the type changes.
+   */
+  void subscribeInputSourceType(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in the input source type. */
+  void unsubscribeInputSourceType();
+
+  /**
+   * Retrieves the current visibility state.
+   *
+   * @return a future that will contain the current visibility state.
+   */
+  CompletableFuture<CurrentVisibilityStateEnum> getCurrentVisibilityState();
+
+  /**
+   * Subscribes to changes in current visibility state.
+   *
+   * @param callback the function to call when the state changes.
+   */
+  void subscribeCurrentVisibilityState(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in the current visibility state. */
+  void unsubscribeCurrentVisibilityState();
+
+  @Override
+  default Collection<Service> getServices() {
+    return Collections.singleton(new InputSourceService(this));
+  }
+}

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

@@ -0,0 +1,123 @@
+package io.github.hapjava.accessories;
+
+import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
+import io.github.hapjava.characteristics.impl.television.RemoteKeyEnum;
+import io.github.hapjava.characteristics.impl.television.SleepDiscoveryModeEnum;
+import io.github.hapjava.services.Service;
+import io.github.hapjava.services.impl.TelevisionService;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.concurrent.CompletableFuture;
+
+/** Television accessory. */
+public interface TelevisionAccessory extends HomekitAccessory {
+
+  /**
+   * Retrieves the current active state of the TV.
+   *
+   * @return a future that will contain the state
+   */
+  CompletableFuture<Boolean> isActive();
+
+  /**
+   * Sets the active state of the TV
+   *
+   * @param state the 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 TV .
+   *
+   * @param callback the function to call when the active state changes.
+   */
+  void subscribeActive(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in the active state of the TV. */
+  void unsubscribeActive();
+
+  /**
+   * Retrieves the active identifier
+   *
+   * @return a future that will contain the active identifier.
+   */
+  CompletableFuture<Integer> getActiveIdentifier();
+
+  /**
+   * Sets the active identifier
+   *
+   * @param identifier the active identifier
+   * @return a future that completes when the active identifier is changed
+   * @throws Exception when the active identifier cannot be set
+   */
+  CompletableFuture<Void> setActiveIdentifier(Integer identifier) throws Exception;
+
+  /**
+   * Subscribes to changes in the active identifier.
+   *
+   * @param callback the function to call when the active identifier changes.
+   */
+  void subscribeActiveIdentifier(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in the active identifier. */
+  void unsubscribeActiveIdentifier();
+
+  /**
+   * Retrieves configured name.
+   *
+   * @return configured name
+   */
+  CompletableFuture<String> getConfiguredName();
+
+  /**
+   * Sets the mute status
+   *
+   * @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 mute state.
+   *
+   * @param callback the function to call when the state changes.
+   */
+  void subscribeConfiguredName(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in the mute state. */
+  void unsubscribeConfiguredName();
+
+  /**
+   * Sends the remote key.
+   *
+   * @param key remote key
+   * @return a future that completes when the change is made
+   * @throws Exception when the change cannot be made
+   */
+  CompletableFuture<Void> setRemoteKey(RemoteKeyEnum key) throws Exception;
+
+  /**
+   * Retrieves the sleep discovery mode.
+   *
+   * @return a future that will contain the sleep discovery mode .
+   */
+  CompletableFuture<SleepDiscoveryModeEnum> getSleepDiscoveryMode();
+
+  /**
+   * Subscribes to changes in sleep discovery mode.
+   *
+   * @param callback the function to call when the sleep discovery mode changes.
+   */
+  void subscribeSleepDiscoveryMode(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in the sleep discovery mode. */
+  void unsubscribeSleepDiscoveryMode();
+
+  @Override
+  default Collection<Service> getServices() {
+    return Collections.singleton(new TelevisionService(this));
+  }
+}

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

@@ -0,0 +1,43 @@
+package io.github.hapjava.accessories;
+
+import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
+import io.github.hapjava.services.Service;
+import io.github.hapjava.services.impl.TelevisionSpeakerService;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.concurrent.CompletableFuture;
+
+/** Television speaker accessory. */
+public interface TelevisionSpeakerAccessory 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 TelevisionSpeakerService(this));
+  }
+}

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

@@ -0,0 +1,38 @@
+package io.github.hapjava.accessories.optionalcharacteristic;
+
+import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
+import io.github.hapjava.characteristics.impl.common.ActiveEnum;
+import java.util.concurrent.CompletableFuture;
+
+/**
+ * Accessory with active characteristic {@link
+ * io.github.hapjava.characteristics.impl.common.ActiveCharacteristic}.
+ */
+public interface AccessoryWithActive {
+
+  /**
+   * Retrieves the active state (see {@link
+   * io.github.hapjava.characteristics.impl.common.ActiveEnum} for supported values).
+   *
+   * @return a future that will contain the active state
+   */
+  CompletableFuture<ActiveEnum> getActive();
+
+  /**
+   * Set the active state (see {@link ActiveEnum} for supported values).
+   *
+   * @param active active state
+   * @return a future that completes when the change is made
+   */
+  CompletableFuture<Void> setActive(ActiveEnum active);
+
+  /**
+   * Subscribes to changes in the active state.
+   *
+   * @param callback the function to call when the active state changes.
+   */
+  void subscribeActive(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in the active state. */
+  void unsubscribeActive();
+}

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

@@ -0,0 +1,37 @@
+package io.github.hapjava.accessories.optionalcharacteristic;
+
+import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
+import io.github.hapjava.characteristics.impl.television.ClosedCaptionsEnum;
+import java.util.concurrent.CompletableFuture;
+
+/**
+ * Accessory with closed captions characteristic {@link
+ * io.github.hapjava.characteristics.impl.television.ClosedCaptionsCharacteristic}.
+ */
+public interface AccessoryWithClosedCaptions {
+
+  /**
+   * Retrieves the closed captions state (see {@link ClosedCaptionsEnum} for supported values).
+   *
+   * @return a future that will contain the closed captions
+   */
+  CompletableFuture<ClosedCaptionsEnum> getClosedCaptions();
+
+  /**
+   * Set the closed captions state (see {@link ClosedCaptionsEnum} for supported values).
+   *
+   * @param closedCaptions closed captions
+   * @return a future that completes when the change is made
+   */
+  CompletableFuture<Void> setClosedCaptions(ClosedCaptionsEnum closedCaptions);
+
+  /**
+   * Subscribes to changes in the closed captions.
+   *
+   * @param callback the function to call when the closed captions changes.
+   */
+  void subscribeClosedCaptions(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in the closed captions. */
+  void unsubscribeClosedCaptions();
+}