ClosureDimensionTrait.SetTargetCommand.Request

class ClosureDimensionTrait.SetTargetCommand.Request : ClusterStruct

The request payload for the SetTarget command.

Summary

Nested types

Descriptor enum for this command's request fields.

Public constructors

Creates a request payload for the SetTarget 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
OptionalValue<Boolean>

The desired latching state of the closure, as defined in the OverallCurrentStateStruct Latch field.
OptionalValue<UShort>

The target position in hundredths of a percent of the closure.
OptionalValue<ClosureDimensionTrait.ThreeLevelAutoEnum>

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

Public constructors

Request

Request(
    position: OptionalValue<UShort> = OptionalValue.absent(),
    latch: OptionalValue<Boolean> = OptionalValue.absent(),
    speed: OptionalValue<ClosureDimensionTrait.ThreeLevelAutoEnum> = OptionalValue.absent()
)

Creates a request payload for the SetTarget 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

latch

val latch: OptionalValue<Boolean>

The desired latching state of the closure, as defined in the OverallCurrentStateStruct Latch field.

position

val position: OptionalValue<UShort>

The target position in hundredths of a percent of the closure.

speed

val speed: OptionalValue<ClosureDimensionTrait.ThreeLevelAutoEnum>

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