io.github.hapjava.accessories.optionalcharacteristic.AccessoryWithStatusLowBattery 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.battery.StatusLowBatteryEnum;
import java.util.concurrent.CompletableFuture;

/** This characteristic describes an accessoryʼs battery status. */
public interface AccessoryWithStatusLowBattery {

  /**
   * A status of 1 indicates that the battery level of the accessory is low. Value should return to
   * 0 when the battery charges to a level thats above the low threshold.
   *
   * @return a future with the value
   */
  CompletableFuture getStatusLowBattery();

  /**
   * Subscribes to changes in status low battery.
   *
   * @param callback the function when the status low batter changes
   */
  void subscribeStatusLowBattery(HomekitCharacteristicChangeCallback callback);

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