io.github.hapjava.accessories.optionalcharacteristic.AccessoryWithStatusFault 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 io.github.hapjava.characteristics.impl.common.StatusFaultEnum;
import java.util.concurrent.CompletableFuture;

/** Accessory with characteristic that describes an accessory which has a fault. */
public interface AccessoryWithStatusFault {

  /**
   * Retrieves the status fault. A non-zero value indicates that the accessory has experienced a
   * fault that may be interfering with its intended functionality. A value of 0 indicates that
   * there is no fault.
   *
   * @return a future with the value
   */
  CompletableFuture getStatusFault();

  /**
   * Subscribes to changes in status fault.
   *
   * @param callback the function when the status fault changes
   */
  void subscribeStatusFault(HomekitCharacteristicChangeCallback callback);

  /** Unsubscribes from changes */
  void unsubscribeStatusFault();
}