Package io.github.hapjava.accessories.optionalcharacteristic

Interface AccessoryWithCarbonDioxideLevel

  • public interface AccessoryWithCarbonDioxideLevel
    Accessory with carbon dioxide level and peak level characteristic.

    • Method Detail

      • getCarbonDioxidePeakLevel

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

      • getCarbonDioxideLevel

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

      • getMinCarbonDioxideLevel

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

      • getMaxCarbonDioxideLevel

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

      • getMinStepCarbonDioxideLevel

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

      • getMinCarbonDioxidePeakLevel

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

      • getMaxCarbonDioxidePeakLevel

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

      • getMinStepCarbonDioxidePeakLevel

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

      • subscribeCarbonDioxideLevel

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

      • unsubscribeCarbonDioxideLevel

        void unsubscribeCarbonDioxideLevel()
        Unsubscribes from changes in the carbon dioxide level.

      • subscribeCarbonDioxidePeakLevel

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

      • unsubscribeCarbonDioxidePeakLevel

        void unsubscribeCarbonDioxidePeakLevel()
        Unsubscribes from changes in the carbon dioxide level.