WindowCoveringCommands
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. |
suspend Unit |
goToLiftPercentage(liftPercent100thsValue: UShort)Adjust the window covering to the specified lift position. |
suspend Unit |
goToLiftValue(liftValue: UShort)Adjust the window covering to the specified lift position. |
suspend Unit |
goToTiltPercentage(tiltPercent100thsValue: UShort)Adjust the window covering to the specified tilt position. |
suspend Unit |
goToTiltValue(tiltValue: UShort)Adjust the window covering to the specified tilt position. |
suspend Unit |
Stop any adjustments to physical tilt and lift or slide that is currently underway. |
suspend Unit |
upOrOpen()Adjust the window covering position so the physical lift or slide and tilt is at the maximum open or up position. |
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.
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. |
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. |
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. |
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. |
stopMotion
suspend fun stopMotion(): Unit
Stop any adjustments to physical tilt and lift or slide that is currently underway.