ExtendedColorControlTrait.MoveToColorHsvCommand.Request

class ExtendedColorControlTrait.MoveToColorHsvCommand.Request : ClusterStruct

The request payload for the MoveToColorHSV command.

Summary

Nested types

Descriptor enum for this command's request fields.

Public constructors
Request(hue: Float, saturation: Float, value: Float)

Creates a request payload for the MoveToColorHSV command.

Public functions
open StructDescriptor

Returns the descriptor for the struct.
open Any?

Returns the value of the field for the given tag ID.

Public properties
Float

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

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

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

Public constructors

Request

Request(hue: Float = 0.0f, saturation: Float = 0.0f, value: Float = 0.0f)

Creates a request payload for the MoveToColorHSV command.

Public functions

getDescriptor

@HomeExperimentalApi
open fun getDescriptor(): StructDescriptor

Returns the descriptor for the struct.

getFieldValueById

@HomeExperimentalApi
open fun getFieldValueById(tagId: UInt): Any?

Returns the value of the field for the given tag ID.

Public properties

hue

val hue: Float

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

saturation

val saturation: Float

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

value

val value: Float

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