ExtendedColorControlCommands

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

Known direct subclasses
ExtendedColorControl

API for the ExtendedColorControl trait.

Summary

Public functions
suspend Unit
moveToColorHsv(hue: Float, saturation: Float, value: Float)

Moves a device to the color specified in HSV semantics.
BatchableCommand<Unit>
moveToColorHsvBatchable(hue: Float, saturation: Float, value: Float)

The batchable version of moveToColorHsv command.
suspend Unit
moveToColorName(colorName: String)

Moves the device to the color named.
BatchableCommand<Unit>

The batchable version of moveToColorName command.
suspend Unit
moveToColorRgb(red: UByte, green: UByte, blue: UByte)

Moves a device to the color specified in RGB semantics.
BatchableCommand<Unit>
moveToColorRgbBatchable(red: UByte, green: UByte, blue: UByte)

The batchable version of moveToColorRgb command.

Public functions

moveToColorHsv

suspend fun moveToColorHsv(hue: Float, saturation: Float, value: Float): Unit

Moves a device to the color specified in HSV semantics.

Parameters
hue: Float

Moves a device to the provided hue, whose range is 0 to 360.
saturation: Float

Moves a device to the provided saturation, whose range is 0 to 1.
value: Float

Moves a device to the provided value, whose range is 0 to 1.

moveToColorHsvBatchable

fun moveToColorHsvBatchable(hue: Float, saturation: Float, value: Float): BatchableCommand<Unit>

The batchable version of moveToColorHsv command.

Moves a device to the color specified in HSV semantics.

Parameters
hue: Float

Moves a device to the provided hue, whose range is 0 to 360.
saturation: Float

Moves a device to the provided saturation, whose range is 0 to 1.
value: Float

Moves a device to the provided value, whose range is 0 to 1.
Returns
BatchableCommand<Unit>

BatchableCommand

moveToColorName

suspend fun moveToColorName(colorName: String): Unit

Moves the device to the color named.

Parameters
colorName: String

Name of the color.

moveToColorNameBatchable

fun moveToColorNameBatchable(colorName: String): BatchableCommand<Unit>

The batchable version of moveToColorName command.

Moves the device to the color named.

Parameters
colorName: String

Name of the color.
Returns
BatchableCommand<Unit>

BatchableCommand

moveToColorRgb

suspend fun moveToColorRgb(red: UByte, green: UByte, blue: UByte): Unit

Moves a device to the color specified in RGB semantics. The device may move to a color that approximates the requested color, depending on the capabilities of the device.

Parameters
red: UByte

Moves a device to the provided color of red, whose range is 0 to 155.
green: UByte

Moves a device to the provided color of green, whose range is 0 to 155.
blue: UByte

Moves a device to the provided color of blue, whose range is 0 to 155.

moveToColorRgbBatchable

fun moveToColorRgbBatchable(red: UByte, green: UByte, blue: UByte): BatchableCommand<Unit>

The batchable version of moveToColorRgb command.

Moves a device to the color specified in RGB semantics. The device may move to a color that approximates the requested color, depending on the capabilities of the device.

Parameters
red: UByte

Moves a device to the provided color of red, whose range is 0 to 155.
green: UByte

Moves a device to the provided color of green, whose range is 0 to 155.
blue: UByte

Moves a device to the provided color of blue, whose range is 0 to 155.
Returns
BatchableCommand<Unit>

BatchableCommand