ClosureDimensionCommands

@Generated(value = ["GoogleHomePlatformCodegen"])
interface ClosureDimensionCommands

Known direct subclasses
ClosureDimension

API for the ClosureDimension trait.

Commands for the ClosureDimension trait.

Summary

Public functions
suspend Unit

Moves a dimension of the closure to a target position.
BatchableCommand<Unit>

The batchable version of setTarget command.
suspend Unit
step(
    direction: ClosureDimensionTrait.StepDirectionEnum,
    numberOfSteps: UShort,
    optionalArgs: ClosureDimensionTrait.StepCommand.OptionalArgs.() -> Unit
)

Moves a dimension of the closure by a specified number of steps to a target position.
BatchableCommand<Unit>
stepBatchable(
    direction: ClosureDimensionTrait.StepDirectionEnum,
    numberOfSteps: UShort,
    optionalArgs: ClosureDimensionTrait.StepCommand.OptionalArgs.() -> Unit
)

The batchable version of step command.

Public functions

setTarget

suspend fun setTarget(optionalArgs: ClosureDimensionTrait.SetTargetCommand.OptionalArgs.() -> Unit = {}): Unit

Moves a dimension of the closure to a target position.

Parameters
optionalArgs: ClosureDimensionTrait.SetTargetCommand.OptionalArgs.() -> Unit = {}

Receiver for the optional arguments of this command

setTargetBatchable

fun setTargetBatchable(optionalArgs: ClosureDimensionTrait.SetTargetCommand.OptionalArgs.() -> Unit = {}): BatchableCommand<Unit>

The batchable version of setTarget command.

Moves a dimension of the closure to a target position.

Parameters
optionalArgs: ClosureDimensionTrait.SetTargetCommand.OptionalArgs.() -> Unit = {}

Receiver for the optional arguments of this command
Returns
BatchableCommand<Unit>

BatchableCommand

step

suspend fun step(
    direction: ClosureDimensionTrait.StepDirectionEnum,
    numberOfSteps: UShort,
    optionalArgs: ClosureDimensionTrait.StepCommand.OptionalArgs.() -> Unit = {}
): Unit

Moves a dimension of the closure by a specified number of steps to a target position.

Parameters
direction: ClosureDimensionTrait.StepDirectionEnum

Indicates whether the Position field of the TargetState attribute must be increased toward 100.00% or decreased toward 0.00%.
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.
optionalArgs: ClosureDimensionTrait.StepCommand.OptionalArgs.() -> Unit = {}

Receiver for the optional arguments of this command

stepBatchable

fun stepBatchable(
    direction: ClosureDimensionTrait.StepDirectionEnum,
    numberOfSteps: UShort,
    optionalArgs: ClosureDimensionTrait.StepCommand.OptionalArgs.() -> Unit = {}
): BatchableCommand<Unit>

The batchable version of step command.

Moves a dimension of the closure by a specified number of steps to a target position.

Parameters
direction: ClosureDimensionTrait.StepDirectionEnum

Indicates whether the Position field of the TargetState attribute must be increased toward 100.00% or decreased toward 0.00%.
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.
optionalArgs: ClosureDimensionTrait.StepCommand.OptionalArgs.() -> Unit = {}

Receiver for the optional arguments of this command
Returns
BatchableCommand<Unit>

BatchableCommand