Package io.github.hapjava.accessories.optionalcharacteristic

Interface AccessoryWithCarbonMonoxideLevel

  • public interface AccessoryWithCarbonMonoxideLevel
    Accessory with carbon monoxide level and peak level characteristic.

    • Method Detail

      • getCarbonMonoxidePeakLevel

        java.util.concurrent.CompletableFuture<java.lang.Double> getCarbonMonoxidePeakLevel()
        Retrieves the carbon monoxide peak level
        Returns:
        a future that will contain the carbon monoxide level as a value between 0 and 100000

      • getCarbonMonoxideLevel

        java.util.concurrent.CompletableFuture<java.lang.Double> getCarbonMonoxideLevel()
        Retrieves the carbon monoxide level
        Returns:
        a future that will contain the carbon monoxide level as a value between 0 and 100000

      • getMinCarbonMonoxideLevel

        default double getMinCarbonMonoxideLevel()
        return the min value for carbon monoxide level. overwrite if you want to change the default value.
        Returns:
        min carbon monoxide level

      • getMaxCarbonMonoxideLevel

        default double getMaxCarbonMonoxideLevel()
        return the max value for carbon monoxide level. overwrite if you want to change the default value.
        Returns:
        max carbon monoxide level

      • getMinStepCarbonMonoxideLevel

        default double getMinStepCarbonMonoxideLevel()
        return the min step value for carbon monoxide level. overwrite if you want to change the default value.
        Returns:
        min step carbon monoxide level

      • getMinCarbonMonoxidePeakLevel

        default double getMinCarbonMonoxidePeakLevel()
        return the min value for carbon monoxide peak level. overwrite if you want to change the default value.
        Returns:
        min carbon monoxide peak level

      • getMaxCarbonMonoxidePeakLevel

        default double getMaxCarbonMonoxidePeakLevel()
        return the max value for carbon monoxide peak level. overwrite if you want to change the default value.
        Returns:
        max carbon monoxide peak level

      • getMinStepCarbonMonoxidePeakLevel

        default double getMinStepCarbonMonoxidePeakLevel()
        return the min step value for carbon monoxide peak level. overwrite if you want to change the default value.
        Returns:
        min step carbon monoxide peak level

      • subscribeCarbonMonoxideLevel

        void subscribeCarbonMonoxideLevel​(HomekitCharacteristicChangeCallback callback)
        Subscribes to changes in the carbon monoxide level.
        Parameters:
        callback - the function to call when the state changes.

      • unsubscribeCarbonMonoxideLevel

        void unsubscribeCarbonMonoxideLevel()
        Unsubscribes from changes in the carbon monoxide level.

      • subscribeCarbonMonoxidePeakLevel

        void subscribeCarbonMonoxidePeakLevel​(HomekitCharacteristicChangeCallback callback)
        Subscribes to changes in the carbon monoxide level.
        Parameters:
        callback - the function to call when the state changes.

      • unsubscribeCarbonMonoxidePeakLevel

        void unsubscribeCarbonMonoxidePeakLevel()
        Unsubscribes from changes in the carbon monoxide level.