ClosureControlCommands

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

Known direct subclasses
ClosureControl

API for the ClosureControl trait.

Commands for the ClosureControl trait.

Summary

Public functions
suspend Unit

Initiates a calibration of the closure.
BatchableCommand<Unit>

The batchable version of calibrate command.
suspend Unit

The closure updates its position, latch state and motion speed.
BatchableCommand<Unit>

The batchable version of moveTo command.
suspend Unit

Stops the closure.
BatchableCommand<Unit>

The batchable version of stop command.

Public functions

calibrate

suspend fun calibrate(): Unit

Initiates a calibration of the closure. Procedures of how to achieve the calibration are manufacturer-specific.

calibrateBatchable

fun calibrateBatchable(): BatchableCommand<Unit>

The batchable version of calibrate command.

Initiates a calibration of the closure. Procedures of how to achieve the calibration are manufacturer-specific.

Returns
BatchableCommand<Unit>

BatchableCommand

moveTo

suspend fun moveTo(optionalArgs: ClosureControlTrait.MoveToCommand.OptionalArgs.() -> Unit = {}): Unit

The closure updates its position, latch state and motion speed.

Parameters
optionalArgs: ClosureControlTrait.MoveToCommand.OptionalArgs.() -> Unit = {}

Receiver for the optional arguments of this command

moveToBatchable

fun moveToBatchable(optionalArgs: ClosureControlTrait.MoveToCommand.OptionalArgs.() -> Unit = {}): BatchableCommand<Unit>

The batchable version of moveTo command.

The closure updates its position, latch state and motion speed.

Parameters
optionalArgs: ClosureControlTrait.MoveToCommand.OptionalArgs.() -> Unit = {}

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

BatchableCommand

stop

suspend fun stop(): Unit

Stops the closure.

stopBatchable

fun stopBatchable(): BatchableCommand<Unit>

The batchable version of stop command.

Stops the closure.

Returns
BatchableCommand<Unit>

BatchableCommand