RelativeHumidityControlCommands

interface RelativeHumidityControlCommands

Known direct subclasses
RelativeHumidityControl

API for the RelativeHumidityControl trait.


Summary

Public functions

suspend Unit

Set the relative humidity level to a specific value.

suspend Unit
stepRelativeHumidity(
    relativeHumidityPercent: UInt,
    relativeHumidityWeight: UInt,
    stepMode: RelativeHumidityControlTrait.StepMode
)

Increase or decrease the relative humidity.

Public functions

setRelativeHumidity

suspend fun setRelativeHumidity(humidity: UInt): Unit

Set the relative humidity level to a specific value.

Parameters
humidity: UInt

Setpoint humidity percentage. Must fall between minRelativeHumidity maxRelativeHumidity.

stepRelativeHumidity

suspend fun stepRelativeHumidity(
    relativeHumidityPercent: UInt,
    relativeHumidityWeight: UInt,
    stepMode: RelativeHumidityControlTrait.StepMode
): Unit

Increase or decrease the relative humidity.

Parameters
relativeHumidityPercent: UInt

The percentage value to adjust the humidity level. For example, if the current level of relative humidity is set to 50%, then StepRelativeHumidity with a relativeHumidityPercent of 10 sets relative humidity to 55%.

relativeHumidityWeight: UInt

The amount of ambiguous humidity change from a small amount to a large amount.

stepMode: RelativeHumidityControlTrait.StepMode

Indicates the direction of the change.