WindowCoveringCommands
@Generated(value = ["GoogleHomePlatformCodegen"])
interface WindowCoveringCommands
WindowCovering |
API for the WindowCovering trait. |
Summary
Public functions |
|
|---|---|
suspend Unit |
Adjust the window covering position so the physical lift or slide and tilt is at the maximum closed or down position. |
BatchableCommand<Unit> |
The batchable version of |
suspend Unit |
goToLiftPercentage(liftPercent100thsValue: UShort)Adjust the window covering to the specified lift position. |
BatchableCommand<Unit> |
goToLiftPercentageBatchable(liftPercent100thsValue: UShort)The batchable version of |
suspend Unit |
goToLiftValue(liftValue: UShort)Adjust the window covering to the specified lift position. |
BatchableCommand<Unit> |
goToLiftValueBatchable(liftValue: UShort)The batchable version of |
suspend Unit |
goToTiltPercentage(tiltPercent100thsValue: UShort)Adjust the window covering to the specified tilt position. |
BatchableCommand<Unit> |
goToTiltPercentageBatchable(tiltPercent100thsValue: UShort)The batchable version of |
suspend Unit |
goToTiltValue(tiltValue: UShort)Adjust the window covering to the specified tilt position. |
BatchableCommand<Unit> |
goToTiltValueBatchable(tiltValue: UShort)The batchable version of |
suspend Unit |
Stop any adjustments to physical tilt and lift or slide that is currently underway. |
BatchableCommand<Unit> |
The batchable version of |
suspend Unit |
upOrOpen()Adjust the window covering position so the physical lift or slide and tilt is at the maximum open or up position. |
BatchableCommand<Unit> |
The batchable version of |
Public functions
downOrClose
suspend fun downOrClose(): Unit
Adjust the window covering position so the physical lift or slide and tilt is at the maximum closed or down position.
downOrCloseBatchable
fun downOrCloseBatchable(): BatchableCommand<Unit>
The batchable version of downOrClose command.
Adjust the window covering position so the physical lift or slide and tilt is at the maximum closed or down position.
| Returns | |
|---|---|
BatchableCommand<Unit> |
BatchableCommand |
goToLiftPercentage
suspend fun goToLiftPercentage(liftPercent100thsValue: UShort): Unit
Adjust the window covering to the specified lift position.
| Parameters | |
|---|---|
liftPercent100thsValue: UShort |
The lift position, as a percentage. |
goToLiftPercentageBatchable
fun goToLiftPercentageBatchable(liftPercent100thsValue: UShort): BatchableCommand<Unit>
The batchable version of goToLiftPercentage command.
Adjust the window covering to the specified lift position.
| Parameters | |
|---|---|
liftPercent100thsValue: UShort |
The lift position, as a percentage. |
| Returns | |
|---|---|
BatchableCommand<Unit> |
BatchableCommand |
goToLiftValue
suspend fun goToLiftValue(liftValue: UShort): Unit
Adjust the window covering to the specified lift position.
The specified lift position must be between installedClosedLimitLift and installedOpenLimitLift.
| Parameters | |
|---|---|
liftValue: UShort |
The lift position, in centimeters. |
goToLiftValueBatchable
fun goToLiftValueBatchable(liftValue: UShort): BatchableCommand<Unit>
The batchable version of goToLiftValue command.
Adjust the window covering to the specified lift position.
The specified lift position must be between installedClosedLimitLift and installedOpenLimitLift.
| Parameters | |
|---|---|
liftValue: UShort |
The lift position, in centimeters. |
| Returns | |
|---|---|
BatchableCommand<Unit> |
BatchableCommand |
goToTiltPercentage
suspend fun goToTiltPercentage(tiltPercent100thsValue: UShort): Unit
Adjust the window covering to the specified tilt position.
| Parameters | |
|---|---|
tiltPercent100thsValue: UShort |
The tilt position, in hundredths of a percent. |
goToTiltPercentageBatchable
fun goToTiltPercentageBatchable(tiltPercent100thsValue: UShort): BatchableCommand<Unit>
The batchable version of goToTiltPercentage command.
Adjust the window covering to the specified tilt position.
| Parameters | |
|---|---|
tiltPercent100thsValue: UShort |
The tilt position, in hundredths of a percent. |
| Returns | |
|---|---|
BatchableCommand<Unit> |
BatchableCommand |
goToTiltValue
suspend fun goToTiltValue(tiltValue: UShort): Unit
Adjust the window covering to the specified tilt position.
The specified tilt position must be between installedClosedLimitTilt and installedOpenLimitTilt.
| Parameters | |
|---|---|
tiltValue: UShort |
The tilt position, in degrees. |
goToTiltValueBatchable
fun goToTiltValueBatchable(tiltValue: UShort): BatchableCommand<Unit>
The batchable version of goToTiltValue command.
Adjust the window covering to the specified tilt position.
The specified tilt position must be between installedClosedLimitTilt and installedOpenLimitTilt.
| Parameters | |
|---|---|
tiltValue: UShort |
The tilt position, in degrees. |
| Returns | |
|---|---|
BatchableCommand<Unit> |
BatchableCommand |
stopMotion
suspend fun stopMotion(): Unit
Stop any adjustments to physical tilt and lift or slide that is currently underway.
stopMotionBatchable
fun stopMotionBatchable(): BatchableCommand<Unit>
The batchable version of stopMotion command.
Stop any adjustments to physical tilt and lift or slide that is currently underway.
| Returns | |
|---|---|
BatchableCommand<Unit> |
BatchableCommand |
upOrOpen
suspend fun upOrOpen(): Unit
Adjust the window covering position so the physical lift or slide and tilt is at the maximum open or up position.
upOrOpenBatchable
fun upOrOpenBatchable(): BatchableCommand<Unit>
The batchable version of upOrOpen command.
Adjust the window covering position so the physical lift or slide and tilt is at the maximum open or up position.
| Returns | |
|---|---|
BatchableCommand<Unit> |
BatchableCommand |