Package io.github.hapjava.accessories.optionalcharacteristic

Interface AccessoryWithTemperatureDisplayUnits

  • public interface AccessoryWithTemperatureDisplayUnits
    Accessory with characteristic that describes units of temperature used for presentation purposes (e.g. the units of temperature displayed on the screen).

    • Method Detail

      • getTemperatureDisplayUnits

        java.util.concurrent.CompletableFuture<TemperatureDisplayUnitEnum> getTemperatureDisplayUnits()
        Retrieves temperature display units
        Returns:
        a future that will contain temperature display units

      • setTemperatureDisplayUnits

        java.util.concurrent.CompletableFuture<java.lang.Void> setTemperatureDisplayUnits​(TemperatureDisplayUnitEnum units)
                                                                           throws java.lang.Exception
        Sets the temperature display units
        Parameters:
        units - the target temperature display units
        Returns:
        a future that completes when the change is made
        Throws:
        java.lang.Exception - when the change cannot be made

      • subscribeTemperatureDisplayUnits

        void subscribeTemperatureDisplayUnits​(HomekitCharacteristicChangeCallback callback)
        Subscribes to changes in the temperature display units
        Parameters:
        callback - the function to call when temperature display units changes.

      • unsubscribeTemperatureDisplayUnits

        void unsubscribeTemperatureDisplayUnits()
        Unsubscribes from changes in the temperature display units