Interface AccessoryWithTemperatureDisplayUnits
-
public interface AccessoryWithTemperatureDisplayUnitsAccessory with characteristic that describes units of temperature used for presentation purposes (e.g. the units of temperature displayed on the screen).
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CompletableFuture<TemperatureDisplayUnitEnum>getTemperatureDisplayUnits()Retrieves temperature display unitsCompletableFuture<Void>setTemperatureDisplayUnits(TemperatureDisplayUnitEnum units)Sets the temperature display unitsvoidsubscribeTemperatureDisplayUnits(HomekitCharacteristicChangeCallback callback)Subscribes to changes in the temperature display unitsvoidunsubscribeTemperatureDisplayUnits()Unsubscribes from changes in the temperature display units
-
-
-
Method Detail
-
getTemperatureDisplayUnits
CompletableFuture<TemperatureDisplayUnitEnum> getTemperatureDisplayUnits()
Retrieves temperature display units- Returns:
- a future that will contain temperature display units
-
setTemperatureDisplayUnits
CompletableFuture<Void> setTemperatureDisplayUnits(TemperatureDisplayUnitEnum units) throws Exception
Sets the temperature display units- Parameters:
units- the target temperature display units- Returns:
- a future that completes when the change is made
- Throws:
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
-
-