ClosureControlTrait.MoveToCommand.Request

class ClosureControlTrait.MoveToCommand.Request : ClusterStruct


The request payload for the MoveTo command.

Summary

Nested types

Descriptor enum for this command's request fields.

Public constructors

Creates a request payload for the MoveTo 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 target latch state of the closure.

OptionalValue<ClosureControlTrait.TargetPositionEnum>

The target position of the closure.

OptionalValue<ClosureControlTrait.ThreeLevelAutoEnum>

The target speed of the closure.

Public constructors

Request

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

Creates a request payload for the MoveTo 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 latchOptionalValue<Boolean>

The target latch state of the closure.

position

val positionOptionalValue<ClosureControlTrait.TargetPositionEnum>

The target position of the closure.

speed

val speedOptionalValue<ClosureControlTrait.ThreeLevelAutoEnum>

The target speed of the closure.