io.github.hapjava.accessories.SlatAccessory 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;

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 accessory which tilts on a vertical or a horizontal axis. */
public interface SlatAccessory extends HomekitAccessory {

  /**
   * Retrieves the current state of the slat
   *
   * @return a future that will contain the state
   */
  CompletableFuture 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 getSlatType();

  @Override
  default Collection getServices() {
    return Collections.singleton(new SlatService(this));
  }
}