io.github.hapjava.accessories.optionalcharacteristic.AccessoryWithRotationSpeed Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hap Show documentation

Homekit Accessory Protocol for Java

There is a newer version: 2.0.7

package io.github.hapjava.accessories.optionalcharacteristic;

import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
import java.util.concurrent.CompletableFuture;

/** accessory with rotation speed characteristics. */
public interface AccessoryWithRotationSpeed {

  /**
   * Retrieves the current speed of the rotation
   *
   * @return a future that will contain the speed, expressed as an integer between 0 and 100.
   */
  CompletableFuture getRotationSpeed();

  /**
   * Sets the speed of the 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 setRotationSpeed(Integer speed) throws Exception;

  /**
   * Subscribes to changes in the rotation speed.
   *
   * @param callback the function to call when the speed changes.
   */
  void subscribeRotationSpeed(HomekitCharacteristicChangeCallback callback);

  /** Unsubscribes from changes in the rotation speed. */
  void unsubscribeRotationSpeed();
}