RelativeHumidityControlTrait.StepRelativeHumidityCommand.Request

class RelativeHumidityControlTrait.StepRelativeHumidityCommand.Request : ClusterStruct


The request payload for the StepRelativeHumidity command.

Summary

Nested types

Descriptor enum for this command's request fields.

Public constructors

Request(
    relativeHumidityPercent: UInt,
    relativeHumidityWeight: UInt,
    stepMode: RelativeHumidityControlTrait.StepMode
)

Creates a request payload for the StepRelativeHumidity command.

Public functions

open StructDescriptor

Returns the descriptor for the struct.

open Any?

Returns the value of the field for the given tag ID.

Public properties

UInt

The percentage value to adjust the humidity level.

UInt

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

RelativeHumidityControlTrait.StepMode

Indicates the direction of the change.

Public constructors

Request

Request(
    relativeHumidityPercent: UInt,
    relativeHumidityWeight: UInt,
    stepMode: RelativeHumidityControlTrait.StepMode = StepMode.Unspecified
)

Creates a request payload for the StepRelativeHumidity command.

Public functions

getDescriptor

@HomeExperimentalApi
open fun getDescriptor(): StructDescriptor

Returns the descriptor for the struct.

getFieldValueById

@HomeExperimentalApi
open fun getFieldValueById(tagId: UInt): Any?

Returns the value of the field for the given tag ID.

Public properties

relativeHumidityPercent

val relativeHumidityPercentUInt

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

val relativeHumidityWeightUInt

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

stepMode

val stepModeRelativeHumidityControlTrait.StepMode

Indicates the direction of the change.