ClosureDimensionTrait.StepCommand.Request

class ClosureDimensionTrait.StepCommand.Request : ClusterStruct

The request payload for the Step command.

Summary

Nested types

Descriptor enum for this command's request fields.

Public constructors

Creates a request payload for the Step 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
ClosureDimensionTrait.StepDirectionEnum

Indicates whether the Position field of the TargetState attribute must be increased toward 100.00% or decreased toward 0.00%.
UShort

The number of steps by which the position should be changed.
OptionalValue<ClosureDimensionTrait.ThreeLevelAutoEnum>

The desired speed of the closure, as defined in ThreeLevelAutoEnum enum.

Public constructors

Request

Request(
    direction: ClosureDimensionTrait.StepDirectionEnum = StepDirectionEnum.Decrease,
    numberOfSteps: UShort,
    speed: OptionalValue<ClosureDimensionTrait.ThreeLevelAutoEnum> = OptionalValue.absent()
)

Creates a request payload for the Step command.

Public functions

getDescriptor

@HomeExperimentalGenericApi
open fun getDescriptor(): StructDescriptor

Returns the descriptor for the struct.

getFieldValueById

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

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

Public properties

direction

val direction: ClosureDimensionTrait.StepDirectionEnum

Indicates whether the Position field of the TargetState attribute must be increased toward 100.00% or decreased toward 0.00%.

numberOfSteps

val numberOfSteps: UShort

The number of steps by which the position should be changed. The size of one step, given in hundredths of a percent, is determined by the stepValue attribute.

speed

val speed: OptionalValue<ClosureDimensionTrait.ThreeLevelAutoEnum>

The desired speed of the closure, as defined in ThreeLevelAutoEnum enum.