# ColorControlCommands
```
@Generated(value = ["GoogleHomePlatformCodegen"])
interface ColorControlCommands
```
Known direct subclasses [ColorControl](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControl)
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControl` | API for the ColorControl trait. |
*** ** * ** ***
Commands for the ColorControl trait.
## Summary
| ### Public functions |
|---|---|
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#colorLoopSet(com.google.home.matter.standard.ColorControlTrait.UpdateFlagsBitmap,com.google.home.matter.standard.ColorControlTrait.ColorLoopActionEnum,com.google.home.matter.standard.ColorControlTrait.ColorLoopDirectionEnum,kotlin.UShort,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)( updateFlags: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.UpdateFlagsBitmap, action: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.ColorLoopActionEnum, direction: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.ColorLoopDirectionEnum, time: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, startHue: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap, optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap )` Cycles the device through its range of hues. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#colorLoopSetBatchable(com.google.home.matter.standard.ColorControlTrait.UpdateFlagsBitmap,com.google.home.matter.standard.ColorControlTrait.ColorLoopActionEnum,com.google.home.matter.standard.ColorControlTrait.ColorLoopDirectionEnum,kotlin.UShort,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)( updateFlags: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.UpdateFlagsBitmap, action: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.ColorLoopActionEnum, direction: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.ColorLoopDirectionEnum, time: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, startHue: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap, optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#colorLoopSet(com.google.home.matter.standard.ColorControlTrait.UpdateFlagsBitmap,com.google.home.matter.standard.ColorControlTrait.ColorLoopActionEnum,com.google.home.matter.standard.ColorControlTrait.ColorLoopDirectionEnum,kotlin.UShort,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)` command. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#enhancedMoveHue(com.google.home.matter.standard.ColorControlTrait.MoveModeEnum,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)( moveMode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.MoveModeEnum, rate: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap, optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap )` Change a device's enhanced hue based on a rate of movement. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#enhancedMoveHueBatchable(com.google.home.matter.standard.ColorControlTrait.MoveModeEnum,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)( moveMode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.MoveModeEnum, rate: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap, optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#enhancedMoveHue(com.google.home.matter.standard.ColorControlTrait.MoveModeEnum,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)` command. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#enhancedMoveToHue(kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.DirectionEnum,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)( enhancedHue: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, direction: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.DirectionEnum, transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap, optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap )` Move a device from its current hue to the provided enhanced hue. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#enhancedMoveToHueAndSaturation(kotlin.UShort,kotlin.UByte,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)( enhancedHue: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, saturation: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap, optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap )` Move a device from its current enhanced hue and saturation to the provided enhanced hue and saturation. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#enhancedMoveToHueAndSaturationBatchable(kotlin.UShort,kotlin.UByte,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)( enhancedHue: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, saturation: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap, optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#enhancedMoveToHueAndSaturation(kotlin.UShort,kotlin.UByte,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)` command. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#enhancedMoveToHueBatchable(kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.DirectionEnum,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)( enhancedHue: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, direction: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.DirectionEnum, transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap, optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#enhancedMoveToHue(kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.DirectionEnum,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)` command. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#enhancedStepHue(com.google.home.matter.standard.ColorControlTrait.StepModeEnum,kotlin.UShort,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)( stepMode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.StepModeEnum, stepSize: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap, optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap )` Move a device's enhanced hue a specific amount over a period of time. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#enhancedStepHueBatchable(com.google.home.matter.standard.ColorControlTrait.StepModeEnum,kotlin.UShort,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)( stepMode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.StepModeEnum, stepSize: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap, optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#enhancedStepHue(com.google.home.matter.standard.ColorControlTrait.StepModeEnum,kotlin.UShort,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)` command. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#moveColor(kotlin.Short,kotlin.Short,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)( rateX: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html, rateY: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html, optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap, optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap )` Move a device from its current color in a continuous fashion according to the rates specified. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#moveColorBatchable(kotlin.Short,kotlin.Short,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)( rateX: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html, rateY: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html, optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap, optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#moveColor(kotlin.Short,kotlin.Short,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)` command. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#moveColorTemperature(com.google.home.matter.standard.ColorControlTrait.MoveModeEnum,kotlin.UShort,kotlin.UShort,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)( moveMode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.MoveModeEnum, rate: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, colorTemperatureMinimumMireds: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, colorTemperatureMaximumMireds: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap, optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap )` Change a device's color temperature based on a rate of movement. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#moveColorTemperatureBatchable(com.google.home.matter.standard.ColorControlTrait.MoveModeEnum,kotlin.UShort,kotlin.UShort,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)( moveMode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.MoveModeEnum, rate: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, colorTemperatureMinimumMireds: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, colorTemperatureMaximumMireds: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap, optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#moveColorTemperature(com.google.home.matter.standard.ColorControlTrait.MoveModeEnum,kotlin.UShort,kotlin.UShort,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)` command. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#moveHue(com.google.home.matter.standard.ColorControlTrait.MoveModeEnum,kotlin.UByte,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)( moveMode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.MoveModeEnum, rate: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap, optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap )` Change a device's hue based on a rate of movement. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#moveHueBatchable(com.google.home.matter.standard.ColorControlTrait.MoveModeEnum,kotlin.UByte,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)( moveMode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.MoveModeEnum, rate: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap, optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#moveHue(com.google.home.matter.standard.ColorControlTrait.MoveModeEnum,kotlin.UByte,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)` command. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#moveSaturation(com.google.home.matter.standard.ColorControlTrait.MoveModeEnum,kotlin.UByte,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)( moveMode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.MoveModeEnum, rate: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap, optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap )` Change a device's saturation based on a rate of movement. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#moveSaturationBatchable(com.google.home.matter.standard.ColorControlTrait.MoveModeEnum,kotlin.UByte,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)( moveMode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.MoveModeEnum, rate: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap, optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#moveSaturation(com.google.home.matter.standard.ColorControlTrait.MoveModeEnum,kotlin.UByte,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)` command. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#moveToColor(kotlin.UShort,kotlin.UShort,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)( colorX: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, colorY: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap, optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap )` Move a device from its current color to the color given in the `colorX` and `colorY` parameters. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#moveToColorBatchable(kotlin.UShort,kotlin.UShort,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)( colorX: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, colorY: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap, optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#moveToColor(kotlin.UShort,kotlin.UShort,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)` command. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#moveToColorTemperature(kotlin.UShort,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)( colorTemperatureMireds: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap, optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap )` Move a device from its current color to a new color, using the scaled inverse of the color temperature, in mireds. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#moveToColorTemperatureBatchable(kotlin.UShort,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)( colorTemperatureMireds: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap, optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#moveToColorTemperature(kotlin.UShort,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)` command. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#moveToHue(kotlin.UByte,com.google.home.matter.standard.ColorControlTrait.DirectionEnum,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)( hue: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, direction: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.DirectionEnum, transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap, optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap )` Move a device from its current hue to the provided hue. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#moveToHueAndSaturation(kotlin.UByte,kotlin.UByte,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)( hue: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, saturation: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap, optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap )` Move a device from its current hue and saturation to the provided hue and saturation. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#moveToHueAndSaturationBatchable(kotlin.UByte,kotlin.UByte,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)( hue: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, saturation: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap, optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#moveToHueAndSaturation(kotlin.UByte,kotlin.UByte,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)` command. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#moveToHueBatchable(kotlin.UByte,com.google.home.matter.standard.ColorControlTrait.DirectionEnum,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)( hue: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, direction: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.DirectionEnum, transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap, optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#moveToHue(kotlin.UByte,com.google.home.matter.standard.ColorControlTrait.DirectionEnum,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)` command. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#moveToSaturation(kotlin.UByte,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)( saturation: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap, optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap )` Move a device from its current saturation to the provided saturation. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#moveToSaturationBatchable(kotlin.UByte,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)( saturation: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap, optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#moveToSaturation(kotlin.UByte,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)` command. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#stepColor(kotlin.Short,kotlin.Short,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)( stepX: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html, stepY: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html, transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap, optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap )` Move a device from its current color by the specified color step. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#stepColorBatchable(kotlin.Short,kotlin.Short,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)( stepX: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html, stepY: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html, transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap, optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#stepColor(kotlin.Short,kotlin.Short,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)` command. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#stepColorTemperature(com.google.home.matter.standard.ColorControlTrait.StepModeEnum,kotlin.UShort,kotlin.UShort,kotlin.UShort,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)( stepMode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.StepModeEnum, stepSize: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, colorTemperatureMinimumMireds: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, colorTemperatureMaximumMireds: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap, optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap )` Change a device's color temperature a specific amount over a period of time. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#stepColorTemperatureBatchable(com.google.home.matter.standard.ColorControlTrait.StepModeEnum,kotlin.UShort,kotlin.UShort,kotlin.UShort,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)( stepMode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.StepModeEnum, stepSize: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, colorTemperatureMinimumMireds: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, colorTemperatureMaximumMireds: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap, optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#stepColorTemperature(com.google.home.matter.standard.ColorControlTrait.StepModeEnum,kotlin.UShort,kotlin.UShort,kotlin.UShort,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)` command. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#stepHue(com.google.home.matter.standard.ColorControlTrait.StepModeEnum,kotlin.UByte,kotlin.UByte,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)( stepMode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.StepModeEnum, stepSize: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap, optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap )` Move a device's hue a specific amount over a period of time. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#stepHueBatchable(com.google.home.matter.standard.ColorControlTrait.StepModeEnum,kotlin.UByte,kotlin.UByte,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)( stepMode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.StepModeEnum, stepSize: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap, optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#stepHue(com.google.home.matter.standard.ColorControlTrait.StepModeEnum,kotlin.UByte,kotlin.UByte,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)` command. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#stepSaturation(com.google.home.matter.standard.ColorControlTrait.StepModeEnum,kotlin.UByte,kotlin.UByte,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)( stepMode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.StepModeEnum, stepSize: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap, optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap )` Move a device's saturation a specific amount over a period of time. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#stepSaturationBatchable(com.google.home.matter.standard.ColorControlTrait.StepModeEnum,kotlin.UByte,kotlin.UByte,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)( stepMode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.StepModeEnum, stepSize: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap, optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#stepSaturation(com.google.home.matter.standard.ColorControlTrait.StepModeEnum,kotlin.UByte,kotlin.UByte,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)` command. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#stopMoveStep(com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)( optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap, optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap )` Stop a `MoveTo`, Move, or Step command that is currently in process. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#stopMoveStepBatchable(com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)( optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap, optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#stopMoveStep(com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)` command. |
## Public functions
### colorLoopSet
```
suspend fun colorLoopSet(
updateFlags: ColorControlTrait.UpdateFlagsBitmap,
action: ColorControlTrait.ColorLoopActionEnum,
direction: ColorControlTrait.ColorLoopDirectionEnum,
time: UShort,
startHue: UShort,
optionsMask: ColorControlTrait.OptionsBitmap,
optionsOverride: ColorControlTrait.OptionsBitmap
): Unit
```
Cycles the device through its range of hues.
| Parameters |
|---|---|
| `updateFlags: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.UpdateFlagsBitmap` | The attributes to update before the color loop starts. See ColorControlTrait.ColorLoopUpdateFlags for the list of flags to use. |
| `action: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.ColorLoopActionEnum` | The action to take if ColorControlTrait.ColorLoopUpdateFlags.updateAction is set in `updateFlags`. Must be a value from `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.ColorLoopActionEnum`. |
| `direction: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.ColorLoopDirectionEnum` | The direction of the color loop if ColorControlTrait.ColorLoopUpdateFlags.updateDirection is set in `updateFlags`. Must be a value from `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.ColorLoopDirectionEnum`. |
| `time: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The number of seconds over which to perform the full color loop if ColorControlTrait.ColorLoopUpdateFlags.updateTime is set in `updateFlags`. |
| `startHue: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The starting hue to use if ColorControlTrait.ColorLoopUpdateFlags.updateStartHue is set in `updateFlags`. |
| `optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`. |
| `optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute. |
### colorLoopSetBatchable
```
fun colorLoopSetBatchable(
updateFlags: ColorControlTrait.UpdateFlagsBitmap,
action: ColorControlTrait.ColorLoopActionEnum,
direction: ColorControlTrait.ColorLoopDirectionEnum,
time: UShort,
startHue: UShort,
optionsMask: ColorControlTrait.OptionsBitmap,
optionsOverride: ColorControlTrait.OptionsBitmap
): BatchableCommand
```
The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#colorLoopSet(com.google.home.matter.standard.ColorControlTrait.UpdateFlagsBitmap,com.google.home.matter.standard.ColorControlTrait.ColorLoopActionEnum,com.google.home.matter.standard.ColorControlTrait.ColorLoopDirectionEnum,kotlin.UShort,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)` command.
Cycles the device through its range of hues.
| Parameters |
|---|---|
| `updateFlags: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.UpdateFlagsBitmap` | The attributes to update before the color loop starts. See ColorControlTrait.ColorLoopUpdateFlags for the list of flags to use. |
| `action: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.ColorLoopActionEnum` | The action to take if ColorControlTrait.ColorLoopUpdateFlags.updateAction is set in `updateFlags`. Must be a value from `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.ColorLoopActionEnum`. |
| `direction: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.ColorLoopDirectionEnum` | The direction of the color loop if ColorControlTrait.ColorLoopUpdateFlags.updateDirection is set in `updateFlags`. Must be a value from `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.ColorLoopDirectionEnum`. |
| `time: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The number of seconds over which to perform the full color loop if ColorControlTrait.ColorLoopUpdateFlags.updateTime is set in `updateFlags`. |
| `startHue: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The starting hue to use if ColorControlTrait.ColorLoopUpdateFlags.updateStartHue is set in `updateFlags`. |
| `optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`. |
| `optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute. |
| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand` | BatchableCommand |
### enhancedMoveHue
```
suspend fun enhancedMoveHue(
moveMode: ColorControlTrait.MoveModeEnum,
rate: UShort,
optionsMask: ColorControlTrait.OptionsBitmap,
optionsOverride: ColorControlTrait.OptionsBitmap
): Unit
```
Change a device's enhanced hue based on a rate of movement.
| Parameters |
|---|---|
| `moveMode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.MoveModeEnum` | The direction in which to move the enhanced hue. This must be one of the values in ColorControlTrait.HueMoveMode. |
| `rate: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The rate (in steps per seconds) used to change the device's `enhancedCurrentHue`. |
| `optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`. |
| `optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute. |
### enhancedMoveHueBatchable
```
fun enhancedMoveHueBatchable(
moveMode: ColorControlTrait.MoveModeEnum,
rate: UShort,
optionsMask: ColorControlTrait.OptionsBitmap,
optionsOverride: ColorControlTrait.OptionsBitmap
): BatchableCommand
```
The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#enhancedMoveHue(com.google.home.matter.standard.ColorControlTrait.MoveModeEnum,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)` command.
Change a device's enhanced hue based on a rate of movement.
| Parameters |
|---|---|
| `moveMode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.MoveModeEnum` | The direction in which to move the enhanced hue. This must be one of the values in ColorControlTrait.HueMoveMode. |
| `rate: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The rate (in steps per seconds) used to change the device's `enhancedCurrentHue`. |
| `optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`. |
| `optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute. |
| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand` | BatchableCommand |
### enhancedMoveToHue
```
suspend fun enhancedMoveToHue(
enhancedHue: UShort,
direction: ColorControlTrait.DirectionEnum,
transitionTime: UShort,
optionsMask: ColorControlTrait.OptionsBitmap,
optionsOverride: ColorControlTrait.OptionsBitmap
): Unit
```
Move a device from its current hue to the provided enhanced hue.
| Parameters |
|---|---|
| `enhancedHue: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The enhanced hue to be moved to. The valid range of values is `0` to `65534`. |
| `direction: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.DirectionEnum` | The direction in which to move the enhanced hue. This must be one of the values in ColorControlTrait.HueDirection. |
| `transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The time (in 0.1 seconds) taken to move the device to the new hue. |
| `optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`. |
| `optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute. |
### enhancedMoveToHueAndSaturation
```
suspend fun enhancedMoveToHueAndSaturation(
enhancedHue: UShort,
saturation: UByte,
transitionTime: UShort,
optionsMask: ColorControlTrait.OptionsBitmap,
optionsOverride: ColorControlTrait.OptionsBitmap
): Unit
```
Move a device from its current enhanced hue and saturation to the provided enhanced hue and saturation.
| Parameters |
|---|---|
| `enhancedHue: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The enhanced hue to be moved to. The valid range of values is `0` to `65534`. |
| `saturation: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The saturation to be moved to. The valid range of values is `0` to `254`. |
| `transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The time (in 0.1 seconds) taken to move the device to the new enhanced hue and saturation. |
| `optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`. |
| `optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute. |
### enhancedMoveToHueAndSaturationBatchable
```
fun enhancedMoveToHueAndSaturationBatchable(
enhancedHue: UShort,
saturation: UByte,
transitionTime: UShort,
optionsMask: ColorControlTrait.OptionsBitmap,
optionsOverride: ColorControlTrait.OptionsBitmap
): BatchableCommand
```
The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#enhancedMoveToHueAndSaturation(kotlin.UShort,kotlin.UByte,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)` command.
Move a device from its current enhanced hue and saturation to the provided enhanced hue and saturation.
| Parameters |
|---|---|
| `enhancedHue: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The enhanced hue to be moved to. The valid range of values is `0` to `65534`. |
| `saturation: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The saturation to be moved to. The valid range of values is `0` to `254`. |
| `transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The time (in 0.1 seconds) taken to move the device to the new enhanced hue and saturation. |
| `optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`. |
| `optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute. |
| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand` | BatchableCommand |
### enhancedMoveToHueBatchable
```
fun enhancedMoveToHueBatchable(
enhancedHue: UShort,
direction: ColorControlTrait.DirectionEnum,
transitionTime: UShort,
optionsMask: ColorControlTrait.OptionsBitmap,
optionsOverride: ColorControlTrait.OptionsBitmap
): BatchableCommand
```
The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#enhancedMoveToHue(kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.DirectionEnum,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)` command.
Move a device from its current hue to the provided enhanced hue.
| Parameters |
|---|---|
| `enhancedHue: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The enhanced hue to be moved to. The valid range of values is `0` to `65534`. |
| `direction: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.DirectionEnum` | The direction in which to move the enhanced hue. This must be one of the values in ColorControlTrait.HueDirection. |
| `transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The time (in 0.1 seconds) taken to move the device to the new hue. |
| `optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`. |
| `optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute. |
| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand` | BatchableCommand |
### enhancedStepHue
```
suspend fun enhancedStepHue(
stepMode: ColorControlTrait.StepModeEnum,
stepSize: UShort,
transitionTime: UShort,
optionsMask: ColorControlTrait.OptionsBitmap,
optionsOverride: ColorControlTrait.OptionsBitmap
): Unit
```
Move a device's enhanced hue a specific amount over a period of time.
| Parameters |
|---|---|
| `stepMode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.StepModeEnum` | The direction in which to move the enhanced hue. This must be one of the values in ColorControlTrait.HueStepMode. |
| `stepSize: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The amount of units to move the device's `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#enhancedCurrentHue()` to. |
| `transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The time (in 0.1 seconds) taken to move the device to the new enhanced hue. |
| `optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`. |
| `optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute. |
### enhancedStepHueBatchable
```
fun enhancedStepHueBatchable(
stepMode: ColorControlTrait.StepModeEnum,
stepSize: UShort,
transitionTime: UShort,
optionsMask: ColorControlTrait.OptionsBitmap,
optionsOverride: ColorControlTrait.OptionsBitmap
): BatchableCommand
```
The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#enhancedStepHue(com.google.home.matter.standard.ColorControlTrait.StepModeEnum,kotlin.UShort,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)` command.
Move a device's enhanced hue a specific amount over a period of time.
| Parameters |
|---|---|
| `stepMode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.StepModeEnum` | The direction in which to move the enhanced hue. This must be one of the values in ColorControlTrait.HueStepMode. |
| `stepSize: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The amount of units to move the device's `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#enhancedCurrentHue()` to. |
| `transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The time (in 0.1 seconds) taken to move the device to the new enhanced hue. |
| `optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`. |
| `optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute. |
| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand` | BatchableCommand |
### moveColor
```
suspend fun moveColor(
rateX: Short,
rateY: Short,
optionsMask: ColorControlTrait.OptionsBitmap,
optionsOverride: ColorControlTrait.OptionsBitmap
): Unit
```
Move a device from its current color in a continuous fashion according to the rates specified.
This command will continue to process until the target color for the next step cannot be implemented on the device.
Setting both `rateX` and `rateY` to `0` stops any previously received command of the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControl` cluster.
| Parameters |
|---|---|
| `rateX: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html` | The rate of movement in steps per second. A step is a change of one unit to the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#currentX()` attribute. |
| `rateY: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html` | The rate of movement in steps per second. A step is a change of one unit to the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#currentY()` attribute. |
| `optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`. |
| `optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute. |
### moveColorBatchable
```
fun moveColorBatchable(
rateX: Short,
rateY: Short,
optionsMask: ColorControlTrait.OptionsBitmap,
optionsOverride: ColorControlTrait.OptionsBitmap
): BatchableCommand
```
The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#moveColor(kotlin.Short,kotlin.Short,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)` command.
Move a device from its current color in a continuous fashion according to the rates specified.
This command will continue to process until the target color for the next step cannot be implemented on the device.
Setting both `rateX` and `rateY` to `0` stops any previously received command of the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControl` cluster.
| Parameters |
|---|---|
| `rateX: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html` | The rate of movement in steps per second. A step is a change of one unit to the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#currentX()` attribute. |
| `rateY: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html` | The rate of movement in steps per second. A step is a change of one unit to the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#currentY()` attribute. |
| `optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`. |
| `optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute. |
| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand` | BatchableCommand |
### moveColorTemperature
```
suspend fun moveColorTemperature(
moveMode: ColorControlTrait.MoveModeEnum,
rate: UShort,
colorTemperatureMinimumMireds: UShort,
colorTemperatureMaximumMireds: UShort,
optionsMask: ColorControlTrait.OptionsBitmap,
optionsOverride: ColorControlTrait.OptionsBitmap
): Unit
```
Change a device's color temperature based on a rate of movement.
| Parameters |
|---|---|
| `moveMode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.MoveModeEnum` | The direction in which to move the color temperature. This must be one of the values in ColorControlTrait.HueMoveMode. |
| `rate: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The rate (in steps per seconds) used to change the device's `colorTemperatureMireds`. |
| `colorTemperatureMinimumMireds: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The lower bound of the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#colorTemperatureMireds()` attribute for the command. This value must be between the `colorTempPhysicalMinMireds` and `colorTemperatureMireds` attributes. If this value is set to `0`, `colorTempPhysicalMinMireds` is used as the lower bound. |
| `colorTemperatureMaximumMireds: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The upper bound of the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#colorTemperatureMireds()` attribute for the command. This value must be between the `colorTemperatureMireds` and `colorTempPhysicalMaxMireds` attributes. If this value is set to `0`, `colorTempPhysicalMaxMireds` is used as the upper bound. |
| `optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`. |
| `optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute. |
### moveColorTemperatureBatchable
```
fun moveColorTemperatureBatchable(
moveMode: ColorControlTrait.MoveModeEnum,
rate: UShort,
colorTemperatureMinimumMireds: UShort,
colorTemperatureMaximumMireds: UShort,
optionsMask: ColorControlTrait.OptionsBitmap,
optionsOverride: ColorControlTrait.OptionsBitmap
): BatchableCommand
```
The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#moveColorTemperature(com.google.home.matter.standard.ColorControlTrait.MoveModeEnum,kotlin.UShort,kotlin.UShort,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)` command.
Change a device's color temperature based on a rate of movement.
| Parameters |
|---|---|
| `moveMode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.MoveModeEnum` | The direction in which to move the color temperature. This must be one of the values in ColorControlTrait.HueMoveMode. |
| `rate: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The rate (in steps per seconds) used to change the device's `colorTemperatureMireds`. |
| `colorTemperatureMinimumMireds: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The lower bound of the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#colorTemperatureMireds()` attribute for the command. This value must be between the `colorTempPhysicalMinMireds` and `colorTemperatureMireds` attributes. If this value is set to `0`, `colorTempPhysicalMinMireds` is used as the lower bound. |
| `colorTemperatureMaximumMireds: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The upper bound of the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#colorTemperatureMireds()` attribute for the command. This value must be between the `colorTemperatureMireds` and `colorTempPhysicalMaxMireds` attributes. If this value is set to `0`, `colorTempPhysicalMaxMireds` is used as the upper bound. |
| `optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`. |
| `optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute. |
| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand` | BatchableCommand |
### moveHue
```
suspend fun moveHue(
moveMode: ColorControlTrait.MoveModeEnum,
rate: UByte,
optionsMask: ColorControlTrait.OptionsBitmap,
optionsOverride: ColorControlTrait.OptionsBitmap
): Unit
```
Change a device's hue based on a rate of movement.
| Parameters |
|---|---|
| `moveMode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.MoveModeEnum` | The direction in which to move the hue. This must be one of the values in ColorControlTrait.HueMoveMode. |
| `rate: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The rate (in steps per seconds) used to change the device's `currentHue`. |
| `optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`. |
| `optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute. |
### moveHueBatchable
```
fun moveHueBatchable(
moveMode: ColorControlTrait.MoveModeEnum,
rate: UByte,
optionsMask: ColorControlTrait.OptionsBitmap,
optionsOverride: ColorControlTrait.OptionsBitmap
): BatchableCommand
```
The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#moveHue(com.google.home.matter.standard.ColorControlTrait.MoveModeEnum,kotlin.UByte,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)` command.
Change a device's hue based on a rate of movement.
| Parameters |
|---|---|
| `moveMode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.MoveModeEnum` | The direction in which to move the hue. This must be one of the values in ColorControlTrait.HueMoveMode. |
| `rate: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The rate (in steps per seconds) used to change the device's `currentHue`. |
| `optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`. |
| `optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute. |
| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand` | BatchableCommand |
### moveSaturation
```
suspend fun moveSaturation(
moveMode: ColorControlTrait.MoveModeEnum,
rate: UByte,
optionsMask: ColorControlTrait.OptionsBitmap,
optionsOverride: ColorControlTrait.OptionsBitmap
): Unit
```
Change a device's saturation based on a rate of movement.
| Parameters |
|---|---|
| `moveMode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.MoveModeEnum` | The direction in which to move the saturation. This must be one of the values in ColorControlTrait.SaturationMoveMode. |
| `rate: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The rate (in steps per seconds) used to change the device's `currentSaturation`. |
| `optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`. |
| `optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute. |
### moveSaturationBatchable
```
fun moveSaturationBatchable(
moveMode: ColorControlTrait.MoveModeEnum,
rate: UByte,
optionsMask: ColorControlTrait.OptionsBitmap,
optionsOverride: ColorControlTrait.OptionsBitmap
): BatchableCommand
```
The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#moveSaturation(com.google.home.matter.standard.ColorControlTrait.MoveModeEnum,kotlin.UByte,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)` command.
Change a device's saturation based on a rate of movement.
| Parameters |
|---|---|
| `moveMode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.MoveModeEnum` | The direction in which to move the saturation. This must be one of the values in ColorControlTrait.SaturationMoveMode. |
| `rate: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The rate (in steps per seconds) used to change the device's `currentSaturation`. |
| `optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`. |
| `optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute. |
| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand` | BatchableCommand |
### moveToColor
```
suspend fun moveToColor(
colorX: UShort,
colorY: UShort,
transitionTime: UShort,
optionsMask: ColorControlTrait.OptionsBitmap,
optionsOverride: ColorControlTrait.OptionsBitmap
): Unit
```
Move a device from its current color to the color given in the `colorX` and `colorY` parameters.
| Parameters |
|---|---|
| `colorX: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The normalized chromaticity value `x`, as defined in the CIE xyY Color Space, to move the device's color to. |
| `colorY: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The normalized chromaticity value `y`, as defined in the CIE xyY Color Space, to move the device's color to. |
| `transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The time (in 0.1 seconds) taken to move the device to the new color. |
| `optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`. |
| `optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute. |
### moveToColorBatchable
```
fun moveToColorBatchable(
colorX: UShort,
colorY: UShort,
transitionTime: UShort,
optionsMask: ColorControlTrait.OptionsBitmap,
optionsOverride: ColorControlTrait.OptionsBitmap
): BatchableCommand
```
The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#moveToColor(kotlin.UShort,kotlin.UShort,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)` command.
Move a device from its current color to the color given in the `colorX` and `colorY` parameters.
| Parameters |
|---|---|
| `colorX: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The normalized chromaticity value `x`, as defined in the CIE xyY Color Space, to move the device's color to. |
| `colorY: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The normalized chromaticity value `y`, as defined in the CIE xyY Color Space, to move the device's color to. |
| `transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The time (in 0.1 seconds) taken to move the device to the new color. |
| `optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`. |
| `optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute. |
| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand` | BatchableCommand |
### moveToColorTemperature
```
suspend fun moveToColorTemperature(
colorTemperatureMireds: UShort,
transitionTime: UShort,
optionsMask: ColorControlTrait.OptionsBitmap,
optionsOverride: ColorControlTrait.OptionsBitmap
): Unit
```
Move a device from its current color to a new color, using the scaled inverse of the color temperature, in mireds.
| Parameters |
|---|---|
| `colorTemperatureMireds: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The color temperature, in mireds, to move the device to. |
| `transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The time (in 0.1 seconds) taken to move the device to the new color temperature. |
| `optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`. |
| `optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute. |
### moveToColorTemperatureBatchable
```
fun moveToColorTemperatureBatchable(
colorTemperatureMireds: UShort,
transitionTime: UShort,
optionsMask: ColorControlTrait.OptionsBitmap,
optionsOverride: ColorControlTrait.OptionsBitmap
): BatchableCommand
```
The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#moveToColorTemperature(kotlin.UShort,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)` command.
Move a device from its current color to a new color, using the scaled inverse of the color temperature, in mireds.
| Parameters |
|---|---|
| `colorTemperatureMireds: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The color temperature, in mireds, to move the device to. |
| `transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The time (in 0.1 seconds) taken to move the device to the new color temperature. |
| `optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`. |
| `optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute. |
| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand` | BatchableCommand |
### moveToHue
```
suspend fun moveToHue(
hue: UByte,
direction: ColorControlTrait.DirectionEnum,
transitionTime: UShort,
optionsMask: ColorControlTrait.OptionsBitmap,
optionsOverride: ColorControlTrait.OptionsBitmap
): Unit
```
Move a device from its current hue to the provided hue.
| Parameters |
|---|---|
| `hue: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The hue to be moved to. The valid range of values is `0` to `254`. |
| `direction: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.DirectionEnum` | The direction in which to move the hue. This must be one of the values in ColorControlTrait.HueDirection. |
| `transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The time (in 0.1 seconds) taken to move the device to the new hue. |
| `optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`. |
| `optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute. |
### moveToHueAndSaturation
```
suspend fun moveToHueAndSaturation(
hue: UByte,
saturation: UByte,
transitionTime: UShort,
optionsMask: ColorControlTrait.OptionsBitmap,
optionsOverride: ColorControlTrait.OptionsBitmap
): Unit
```
Move a device from its current hue and saturation to the provided hue and saturation.
| Parameters |
|---|---|
| `hue: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The hue to be moved to. The valid range of values is `0` to `254`. |
| `saturation: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The saturation to be moved to. The valid range of values is `0` to `254`. |
| `transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The time (in 0.1 seconds) taken to move the device to the new hue and saturation. |
| `optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`. |
| `optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute. |
### moveToHueAndSaturationBatchable
```
fun moveToHueAndSaturationBatchable(
hue: UByte,
saturation: UByte,
transitionTime: UShort,
optionsMask: ColorControlTrait.OptionsBitmap,
optionsOverride: ColorControlTrait.OptionsBitmap
): BatchableCommand
```
The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#moveToHueAndSaturation(kotlin.UByte,kotlin.UByte,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)` command.
Move a device from its current hue and saturation to the provided hue and saturation.
| Parameters |
|---|---|
| `hue: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The hue to be moved to. The valid range of values is `0` to `254`. |
| `saturation: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The saturation to be moved to. The valid range of values is `0` to `254`. |
| `transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The time (in 0.1 seconds) taken to move the device to the new hue and saturation. |
| `optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`. |
| `optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute. |
| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand` | BatchableCommand |
### moveToHueBatchable
```
fun moveToHueBatchable(
hue: UByte,
direction: ColorControlTrait.DirectionEnum,
transitionTime: UShort,
optionsMask: ColorControlTrait.OptionsBitmap,
optionsOverride: ColorControlTrait.OptionsBitmap
): BatchableCommand
```
The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#moveToHue(kotlin.UByte,com.google.home.matter.standard.ColorControlTrait.DirectionEnum,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)` command.
Move a device from its current hue to the provided hue.
| Parameters |
|---|---|
| `hue: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The hue to be moved to. The valid range of values is `0` to `254`. |
| `direction: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.DirectionEnum` | The direction in which to move the hue. This must be one of the values in ColorControlTrait.HueDirection. |
| `transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The time (in 0.1 seconds) taken to move the device to the new hue. |
| `optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`. |
| `optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute. |
| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand` | BatchableCommand |
### moveToSaturation
```
suspend fun moveToSaturation(
saturation: UByte,
transitionTime: UShort,
optionsMask: ColorControlTrait.OptionsBitmap,
optionsOverride: ColorControlTrait.OptionsBitmap
): Unit
```
Move a device from its current saturation to the provided saturation.
| Parameters |
|---|---|
| `saturation: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The saturation to be moved to. The valid range of values is `0` to `254`. |
| `transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The time (in 0.1 seconds) taken to move the device to the new saturation. |
| `optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`. |
| `optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute. |
### moveToSaturationBatchable
```
fun moveToSaturationBatchable(
saturation: UByte,
transitionTime: UShort,
optionsMask: ColorControlTrait.OptionsBitmap,
optionsOverride: ColorControlTrait.OptionsBitmap
): BatchableCommand
```
The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#moveToSaturation(kotlin.UByte,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)` command.
Move a device from its current saturation to the provided saturation.
| Parameters |
|---|---|
| `saturation: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The saturation to be moved to. The valid range of values is `0` to `254`. |
| `transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The time (in 0.1 seconds) taken to move the device to the new saturation. |
| `optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`. |
| `optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute. |
| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand` | BatchableCommand |
### stepColor
```
suspend fun stepColor(
stepX: Short,
stepY: Short,
transitionTime: UShort,
optionsMask: ColorControlTrait.OptionsBitmap,
optionsOverride: ColorControlTrait.OptionsBitmap
): Unit
```
Move a device from its current color by the specified color step.
If the required step is larger than supported by the `stepX` and `stepY` parameters, use this command multiple times.
| Parameters |
|---|---|
| `stepX: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html` | The change to be added to the device's `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#currentX()` attribute. |
| `stepY: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html` | The change to be added to the device's `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#currentY()` attribute. |
| `transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The time (in 0.1 seconds) taken to move the device to the new color. |
| `optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`. |
| `optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute. |
### stepColorBatchable
```
fun stepColorBatchable(
stepX: Short,
stepY: Short,
transitionTime: UShort,
optionsMask: ColorControlTrait.OptionsBitmap,
optionsOverride: ColorControlTrait.OptionsBitmap
): BatchableCommand
```
The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#stepColor(kotlin.Short,kotlin.Short,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)` command.
Move a device from its current color by the specified color step.
If the required step is larger than supported by the `stepX` and `stepY` parameters, use this command multiple times.
| Parameters |
|---|---|
| `stepX: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html` | The change to be added to the device's `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#currentX()` attribute. |
| `stepY: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html` | The change to be added to the device's `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#currentY()` attribute. |
| `transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The time (in 0.1 seconds) taken to move the device to the new color. |
| `optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`. |
| `optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute. |
| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand` | BatchableCommand |
### stepColorTemperature
```
suspend fun stepColorTemperature(
stepMode: ColorControlTrait.StepModeEnum,
stepSize: UShort,
transitionTime: UShort,
colorTemperatureMinimumMireds: UShort,
colorTemperatureMaximumMireds: UShort,
optionsMask: ColorControlTrait.OptionsBitmap,
optionsOverride: ColorControlTrait.OptionsBitmap
): Unit
```
Change a device's color temperature a specific amount over a period of time.
| Parameters |
|---|---|
| `stepMode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.StepModeEnum` | The direction in which to move the color temperature. This must be one of the values in ColorControlTrait.HueStepMode. |
| `stepSize: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The amount of units to move the device's `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#colorTemperatureMireds()` to. |
| `transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The time (in 0.1 seconds) taken to move the device to the new color temperature. |
| `colorTemperatureMinimumMireds: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The lower bound of the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#colorTemperatureMireds()` attribute for the command. This value must be between the `colorTempPhysicalMinMireds` and `colorTemperatureMireds` attributes. If this value is set to `0`, `colorTempPhysicalMinMireds` is used as the lower bound. |
| `colorTemperatureMaximumMireds: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The upper bound of the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#colorTemperatureMireds()` attribute for the command. This value must be between the `colorTemperatureMireds` and `colorTempPhysicalMaxMireds` attributes. If this value is set to `0`, `colorTempPhysicalMaxMireds` is used as the upper bound. |
| `optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`. |
| `optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute. |
### stepColorTemperatureBatchable
```
fun stepColorTemperatureBatchable(
stepMode: ColorControlTrait.StepModeEnum,
stepSize: UShort,
transitionTime: UShort,
colorTemperatureMinimumMireds: UShort,
colorTemperatureMaximumMireds: UShort,
optionsMask: ColorControlTrait.OptionsBitmap,
optionsOverride: ColorControlTrait.OptionsBitmap
): BatchableCommand
```
The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#stepColorTemperature(com.google.home.matter.standard.ColorControlTrait.StepModeEnum,kotlin.UShort,kotlin.UShort,kotlin.UShort,kotlin.UShort,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)` command.
Change a device's color temperature a specific amount over a period of time.
| Parameters |
|---|---|
| `stepMode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.StepModeEnum` | The direction in which to move the color temperature. This must be one of the values in ColorControlTrait.HueStepMode. |
| `stepSize: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The amount of units to move the device's `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#colorTemperatureMireds()` to. |
| `transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The time (in 0.1 seconds) taken to move the device to the new color temperature. |
| `colorTemperatureMinimumMireds: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The lower bound of the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#colorTemperatureMireds()` attribute for the command. This value must be between the `colorTempPhysicalMinMireds` and `colorTemperatureMireds` attributes. If this value is set to `0`, `colorTempPhysicalMinMireds` is used as the lower bound. |
| `colorTemperatureMaximumMireds: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The upper bound of the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#colorTemperatureMireds()` attribute for the command. This value must be between the `colorTemperatureMireds` and `colorTempPhysicalMaxMireds` attributes. If this value is set to `0`, `colorTempPhysicalMaxMireds` is used as the upper bound. |
| `optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`. |
| `optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute. |
| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand` | BatchableCommand |
### stepHue
```
suspend fun stepHue(
stepMode: ColorControlTrait.StepModeEnum,
stepSize: UByte,
transitionTime: UByte,
optionsMask: ColorControlTrait.OptionsBitmap,
optionsOverride: ColorControlTrait.OptionsBitmap
): Unit
```
Move a device's hue a specific amount over a period of time.
| Parameters |
|---|---|
| `stepMode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.StepModeEnum` | The direction in which to move the hue. This must be one of the values in ColorControlTrait.HueStepMode. |
| `stepSize: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The amount of units to move the device's `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#currentHue()` to. |
| `transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The time (in 0.1 seconds) taken to move the device to the new hue. |
| `optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`. |
| `optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute. |
### stepHueBatchable
```
fun stepHueBatchable(
stepMode: ColorControlTrait.StepModeEnum,
stepSize: UByte,
transitionTime: UByte,
optionsMask: ColorControlTrait.OptionsBitmap,
optionsOverride: ColorControlTrait.OptionsBitmap
): BatchableCommand
```
The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#stepHue(com.google.home.matter.standard.ColorControlTrait.StepModeEnum,kotlin.UByte,kotlin.UByte,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)` command.
Move a device's hue a specific amount over a period of time.
| Parameters |
|---|---|
| `stepMode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.StepModeEnum` | The direction in which to move the hue. This must be one of the values in ColorControlTrait.HueStepMode. |
| `stepSize: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The amount of units to move the device's `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#currentHue()` to. |
| `transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The time (in 0.1 seconds) taken to move the device to the new hue. |
| `optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`. |
| `optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute. |
| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand` | BatchableCommand |
### stepSaturation
```
suspend fun stepSaturation(
stepMode: ColorControlTrait.StepModeEnum,
stepSize: UByte,
transitionTime: UByte,
optionsMask: ColorControlTrait.OptionsBitmap,
optionsOverride: ColorControlTrait.OptionsBitmap
): Unit
```
Move a device's saturation a specific amount over a period of time.
| Parameters |
|---|---|
| `stepMode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.StepModeEnum` | The direction in which to move the saturation. This must be one of the values in ColorControlTrait.SaturationStepMode. |
| `stepSize: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The amount of units to move the device's `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#currentSaturation()` to. |
| `transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The time (in 0.1 seconds) taken to move the device to the new saturation. |
| `optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`. |
| `optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute. |
### stepSaturationBatchable
```
fun stepSaturationBatchable(
stepMode: ColorControlTrait.StepModeEnum,
stepSize: UByte,
transitionTime: UByte,
optionsMask: ColorControlTrait.OptionsBitmap,
optionsOverride: ColorControlTrait.OptionsBitmap
): BatchableCommand
```
The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#stepSaturation(com.google.home.matter.standard.ColorControlTrait.StepModeEnum,kotlin.UByte,kotlin.UByte,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)` command.
Move a device's saturation a specific amount over a period of time.
| Parameters |
|---|---|
| `stepMode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.StepModeEnum` | The direction in which to move the saturation. This must be one of the values in ColorControlTrait.SaturationStepMode. |
| `stepSize: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The amount of units to move the device's `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#currentSaturation()` to. |
| `transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The time (in 0.1 seconds) taken to move the device to the new saturation. |
| `optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`. |
| `optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute. |
| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand` | BatchableCommand |
### stopMoveStep
```
suspend fun stopMoveStep(
optionsMask: ColorControlTrait.OptionsBitmap,
optionsOverride: ColorControlTrait.OptionsBitmap
): Unit
```
Stop a `MoveTo`, Move, or Step command that is currently in process.
The `currentHue`, `enhancedCurrentHue`, and `currentSaturation` attributes are left at their present value upon receipt of this command, and the `remainingTime` attribute is set to `0`.
| Parameters |
|---|---|
| `optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`. |
| `optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute. |
### stopMoveStepBatchable
```
fun stopMoveStepBatchable(
optionsMask: ColorControlTrait.OptionsBitmap,
optionsOverride: ColorControlTrait.OptionsBitmap
): BatchableCommand
```
The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlCommands#stopMoveStep(com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)` command.
Stop a `MoveTo`, Move, or Step command that is currently in process.
The `currentHue`, `enhancedCurrentHue`, and `currentSaturation` attributes are left at their present value upon receipt of this command, and the `remainingTime` attribute is set to `0`.
| Parameters |
|---|---|
| `optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`. |
| `optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute. |
| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand` | BatchableCommand |