ColorControlTrait.Attributes

@Generated(value = ["GoogleHomePlatformCodegen"])
interface ColorControlTrait.Attributes : ClusterStruct

Known direct subclasses
ColorControl

API for the ColorControl trait.

Attributes for the ColorControl cluster.

Summary

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
List<UInt>

A list of client-generated commands which are supported by this cluster server instance.
List<UInt>

A list of the attribute IDs of the attributes supported by the cluster instance.
UShort

The revision of the server cluster specification supported by the cluster instance.
ColorControlTrait.ColorCapabilitiesBitmap?

The color capabilities that the device supports.
UByte?

The current active status of the color loop.
UByte?

The current direction of the color loop.
UShort?

The value of the enhancedCurrentHue attribute from which to start the color loop.
UShort?

The value of the enhancedCurrentHue attribute before the color loop was started.
UShort?

The number of seconds it takes to perform a full color loop.
ColorControlTrait.ColorModeEnum?

The attributes that are currently determining the color of the device.
UByte?

A representation of the relative intensity of the blue color point as defined in the Dimming Light Curve in the BallastConfiguration cluster, normalized such that the color point with the highest relative intensity contains the value 0xfe.
UShort?

The normalized chromaticity value x for this primary, as defined in the CIE xyY Color Space, of the current blue color point of the device.
UShort?

The normalized chromaticity value y for this primary, as defined in the CIE xyY Color Space, of the current blue color point of the device.
UByte?

A representation of the relative intensity of the green color point as defined in the Dimming Light Curve in the BallastConfiguration cluster, normalized such that the color point with the highest relative intensity contains the value 0xfe.
UShort?

The normalized chromaticity value x for this primary, as defined in the CIE xyY Color Space, of the current green color point of the device.
UShort?

The normalized chromaticity value y for this primary, as defined in the CIE xyY Color Space, of the current green color point of the device.
UByte?

A representation of the relative intensity of the red color point as defined in the Dimming Light Curve in the BallastConfiguration cluster, normalized such that the color point with the highest relative intensity contains the value 0xfe.
UShort?

The normalized chromaticity value x for this primary, as defined in the CIE xyY Color Space, of the current red color point of the device.
UShort?

The normalized chromaticity value y for this primary, as defined in the CIE xyY Color Space, of the current red color point of the device.
UShort?

The maximum mired value supported by the device.
UShort?

The minimum mired value supported by the device.
UShort?

A scaled inverse of the current value of the color temperature, in mireds.
String?

A textual indication of what mechanism, if any, is in use to compensate for color or intensity drift over time.
UShort?

Specifies a lower bound on the value of the colorTemperatureMireds attribute for the purposes of coupling the colorTemperatureMireds attribute to the currentLevel attribute when the coupleColorTempToLevel bit of the options attribute of the LevelControl cluster is equal to 1.
UByte?

The current hue value of the light.
UByte?

The current saturation value of the light.
UShort?

The current value of the normalized chromaticity value x, as defined in the CIE xyY Color Space.
UShort?

The current value of the normalized chromaticity value y, as defined in the CIE xyY Color Space.
ColorControlTrait.DriftCompensationEnum?

The mechanism that is in use for compensation for color/intensity drift over time.
ColorControlTrait.EnhancedColorModeEnum?

The attributes that are currently determining the color of the device.
UShort?

Represents non-equidistant steps along the CIE 1931 color triangle.
ColorControlTrait.Feature

Whether the server supports zero or more optional cluster features.
List<UInt>

A list of server-generated commands (server to client) which are supported by this cluster server instance.
UByte?

The number of color primaries implemented on the device.
ColorControlTrait.OptionsBitmap?

A bitmap that determines the default behavior of some cluster commands.
UByte?

A representation of the maximum intensity of this primary as defined in the Dimming Light Curve in the BallastConfiguration cluster, normalized such that the primary with the highest maximum intensity contains the value 0xfe.
UShort?

The normalized chromaticity value x for this primary, as defined in the CIE xyY Color Space.
UShort?

The normalized chromaticity value y for this primary, as defined in the CIE xyY Color Space.
UByte?

A representation of the maximum intensity of this primary as defined in the Dimming Light Curve in the BallastConfiguration cluster, normalized such that the primary with the highest maximum intensity contains the value 0xfe.
UShort?

The normalized chromaticity value x for this primary, as defined in the CIE xyY Color Space.
UShort?

The normalized chromaticity value y for this primary, as defined in the CIE xyY Color Space.
UByte?

A representation of the maximum intensity of this primary as defined in the Dimming Light Curve in the BallastConfiguration cluster, normalized such that the primary with the highest maximum intensity contains the value 0xfe.
UShort?

The normalized chromaticity value x for this primary, as defined in the CIE xyY Color Space.
UShort?

The normalized chromaticity value y for this primary, as defined in the CIE xyY Color Space.
UByte?

A representation of the maximum intensity of this primary as defined in the Dimming Light Curve in the BallastConfiguration cluster, normalized such that the primary with the highest maximum intensity contains the value 0xfe.
UShort?

The normalized chromaticity value x for this primary, as defined in the CIE xyY Color Space.
UShort?

The normalized chromaticity value y for this primary, as defined in the CIE xyY Color Space.
UByte?

A representation of the maximum intensity of this primary as defined in the Dimming Light Curve in the BallastConfiguration cluster, normalized such that the primary with the highest maximum intensity contains the value 0xfe.
UShort?

The normalized chromaticity value x for this primary, as defined in the CIE xyY Color Space.
UShort?

The normalized chromaticity value y for this primary, as defined in the CIE xyY Color Space.
UByte?

A representation of the maximum intensity of this primary as defined in the Dimming Light Curve in the BallastConfiguration cluster, normalized such that the primary with the highest maximum intensity contains the value 0xfe.
UShort?

The normalized chromaticity value x for this primary, as defined in the CIE xyY Color Space.
UShort?

The normalized chromaticity value y for this primary, as defined in the CIE xyY Color Space.
UShort?

The time remaining (in 0.1 seconds) until the current command is complete.
UShort?

The desired startup color temperature value when a device is supplied with power.
UShort?

The normalized chromaticity value x for this primary, as defined in the CIE xyY Color Space, of the current white point of the device.
UShort?

The normalized chromaticity value y for this primary, as defined in the CIE xyY Color Space, of the current white point of the device.

Public functions

getDescriptor

@HomeExperimentalGenericApi
open fun getDescriptor(): StructDescriptor

Returns the descriptor for the struct.

getFieldValueById

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

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

Public properties

acceptedCommandList

val acceptedCommandList: List<UInt>

A list of client-generated commands which are supported by this cluster server instance.

attributeList

val attributeList: List<UInt>

A list of the attribute IDs of the attributes supported by the cluster instance.

clusterRevision

val clusterRevision: UShort

The revision of the server cluster specification supported by the cluster instance.

colorCapabilities

val colorCapabilities: ColorControlTrait.ColorCapabilitiesBitmap?

The color capabilities that the device supports. This is a bitmap that corresponds to the values in ColorControlTrait.ColorCapabilities.

Access type: Read

colorLoopActive

val colorLoopActive: UByte?

The current active status of the color loop. A value of 1 indicates an active color loop. A value of 0 indicates an inactive color loop.

Access type: Read

colorLoopDirection

val colorLoopDirection: UByte?

The current direction of the color loop. If the value is 1, the enhancedCurrentHue attribute is incremented. If the value is 0, the enhancedCurrentHue attribute is decremented.

Access type: Read

colorLoopStartEnhancedHue

val colorLoopStartEnhancedHue: UShort?

The value of the enhancedCurrentHue attribute from which to start the color loop.

Access type: Read

colorLoopStoredEnhancedHue

val colorLoopStoredEnhancedHue: UShort?

The value of the enhancedCurrentHue attribute before the color loop was started. enhancedCurrentHue is changed back to this value once the color loop is complete.

Access type: Read

colorLoopTime

val colorLoopTime: UShort?

The number of seconds it takes to perform a full color loop.

Access type: Read

colorMode

val colorMode: ColorControlTrait.ColorModeEnum?

The attributes that are currently determining the color of the device. Must be one of the values in the ColorControlTrait.ColorMode enum.

Access type: Read

colorPointBIntensity

val colorPointBIntensity: UByte?

A representation of the relative intensity of the blue color point as defined in the Dimming Light Curve in the BallastConfiguration cluster, normalized such that the color point with the highest relative intensity contains the value 0xfe. If null, this value is invalid.

Access type: Read

colorPointBx

val colorPointBx: UShort?

The normalized chromaticity value x for this primary, as defined in the CIE xyY Color Space, of the current blue color point of the device.

Access type: Read

colorPointBy

val colorPointBy: UShort?

The normalized chromaticity value y for this primary, as defined in the CIE xyY Color Space, of the current blue color point of the device.

Access type: Read

colorPointGIntensity

val colorPointGIntensity: UByte?

A representation of the relative intensity of the green color point as defined in the Dimming Light Curve in the BallastConfiguration cluster, normalized such that the color point with the highest relative intensity contains the value 0xfe. If null, this value is invalid.

Access type: Read

colorPointGx

val colorPointGx: UShort?

The normalized chromaticity value x for this primary, as defined in the CIE xyY Color Space, of the current green color point of the device.

Access type: Read

colorPointGy

val colorPointGy: UShort?

The normalized chromaticity value y for this primary, as defined in the CIE xyY Color Space, of the current green color point of the device.

Access type: Read

colorPointRIntensity

val colorPointRIntensity: UByte?

A representation of the relative intensity of the red color point as defined in the Dimming Light Curve in the BallastConfiguration cluster, normalized such that the color point with the highest relative intensity contains the value 0xfe. If null, this value is invalid.

Access type: Read

colorPointRx

val colorPointRx: UShort?

The normalized chromaticity value x for this primary, as defined in the CIE xyY Color Space, of the current red color point of the device.

Access type: Read

colorPointRy

val colorPointRy: UShort?

The normalized chromaticity value y for this primary, as defined in the CIE xyY Color Space, of the current red color point of the device.

Access type: Read

colorTempPhysicalMaxMireds

val colorTempPhysicalMaxMireds: UShort?

The maximum mired value supported by the device. This value must be greater than or equal to colorTemperatureMireds.

Access type: Read

colorTempPhysicalMinMireds

val colorTempPhysicalMinMireds: UShort?

The minimum mired value supported by the device. This value must be less than or equal to colorTemperatureMireds.

Access type: Read

colorTemperatureMireds

val colorTemperatureMireds: UShort?

A scaled inverse of the current value of the color temperature, in mireds.

Access type: Read

compensationText

val compensationText: String?

A textual indication of what mechanism, if any, is in use to compensate for color or intensity drift over time.

Access type: Read

coupleColorTempToLevelMinMireds

val coupleColorTempToLevelMinMireds: UShort?

Specifies a lower bound on the value of the colorTemperatureMireds attribute for the purposes of coupling the colorTemperatureMireds attribute to the currentLevel attribute when the coupleColorTempToLevel bit of the options attribute of the LevelControl cluster is equal to 1.

Access type: Read

currentHue

val currentHue: UByte?

The current hue value of the light. The valid range of values is 0 to 254.

Access type: Read

currentSaturation

val currentSaturation: UByte?

The current saturation value of the light. The valid range of values is 0 to 254.

Access type: Read

currentX

val currentX: UShort?

The current value of the normalized chromaticity value x, as defined in the CIE xyY Color Space.

Access type: Read

currentY

val currentY: UShort?

The current value of the normalized chromaticity value y, as defined in the CIE xyY Color Space.

Access type: Read

driftCompensation

val driftCompensation: ColorControlTrait.DriftCompensationEnum?

The mechanism that is in use for compensation for color/intensity drift over time.

Access type: Read

enhancedColorMode

val enhancedColorMode: ColorControlTrait.EnhancedColorModeEnum?

The attributes that are currently determining the color of the device.

Access type: Read

enhancedCurrentHue

val enhancedCurrentHue: UShort?

Represents non-equidistant steps along the CIE 1931 color triangle.

Access type: Read

featureMap

val featureMap: ColorControlTrait.Feature

Whether the server supports zero or more optional cluster features. A cluster feature is a set of cluster elements that are mandatory or optional for a defined feature of the cluster. If a cluster feature is supported by the cluster instance, then the corresponding bit is set to 1, otherwise the bit is set to 0 (zero).

generatedCommandList

val generatedCommandList: List<UInt>

A list of server-generated commands (server to client) which are supported by this cluster server instance.

numberOfPrimaries

val numberOfPrimaries: UByte?

The number of color primaries implemented on the device. If null, the number of primaries is unknown.

Access type: Read

options

val options: ColorControlTrait.OptionsBitmap?

A bitmap that determines the default behavior of some cluster commands. This should only be changed during commissioning. A ColorControl command does not continue beyond options processing if all of the following are true:

  • The OnOff cluster exists on the same endpoint as this cluster.
  • The onOff attribute of the OnOff cluster on this endpoint is false.
  • The value of the executeIfOff bit is 0.
This bitmap has the following valid bits:
  • Bit 0 — ExecuteIfOff

Access type: Write

primary1Intensity

val primary1Intensity: UByte?

A representation of the maximum intensity of this primary as defined in the Dimming Light Curve in the BallastConfiguration cluster, normalized such that the primary with the highest maximum intensity contains the value 0xfe. If null, this primary is not available.

Access type: Read

primary1X

val primary1X: UShort?

The normalized chromaticity value x for this primary, as defined in the CIE xyY Color Space.

Access type: Read

primary1Y

val primary1Y: UShort?

The normalized chromaticity value y for this primary, as defined in the CIE xyY Color Space.

Access type: Read

primary2Intensity

val primary2Intensity: UByte?

A representation of the maximum intensity of this primary as defined in the Dimming Light Curve in the BallastConfiguration cluster, normalized such that the primary with the highest maximum intensity contains the value 0xfe. If null, this primary is not available.

Access type: Read

primary2X

val primary2X: UShort?

The normalized chromaticity value x for this primary, as defined in the CIE xyY Color Space.

Access type: Read

primary2Y

val primary2Y: UShort?

The normalized chromaticity value y for this primary, as defined in the CIE xyY Color Space.

Access type: Read

primary3Intensity

val primary3Intensity: UByte?

A representation of the maximum intensity of this primary as defined in the Dimming Light Curve in the BallastConfiguration cluster, normalized such that the primary with the highest maximum intensity contains the value 0xfe. If null, this primary is not available.

Access type: Read

primary3X

val primary3X: UShort?

The normalized chromaticity value x for this primary, as defined in the CIE xyY Color Space.

Access type: Read

primary3Y

val primary3Y: UShort?

The normalized chromaticity value y for this primary, as defined in the CIE xyY Color Space.

Access type: Read

primary4Intensity

val primary4Intensity: UByte?

A representation of the maximum intensity of this primary as defined in the Dimming Light Curve in the BallastConfiguration cluster, normalized such that the primary with the highest maximum intensity contains the value 0xfe. If null, this primary is not available.

Access type: Read

primary4X

val primary4X: UShort?

The normalized chromaticity value x for this primary, as defined in the CIE xyY Color Space.

Access type: Read

primary4Y

val primary4Y: UShort?

The normalized chromaticity value y for this primary, as defined in the CIE xyY Color Space.

Access type: Read

primary5Intensity

val primary5Intensity: UByte?

A representation of the maximum intensity of this primary as defined in the Dimming Light Curve in the BallastConfiguration cluster, normalized such that the primary with the highest maximum intensity contains the value 0xfe. If null, this primary is not available.

Access type: Read

primary5X

val primary5X: UShort?

The normalized chromaticity value x for this primary, as defined in the CIE xyY Color Space.

Access type: Read

primary5Y

val primary5Y: UShort?

The normalized chromaticity value y for this primary, as defined in the CIE xyY Color Space.

Access type: Read

primary6Intensity

val primary6Intensity: UByte?

A representation of the maximum intensity of this primary as defined in the Dimming Light Curve in the BallastConfiguration cluster, normalized such that the primary with the highest maximum intensity contains the value 0xfe. If null, this primary is not available.

Access type: Read

primary6X

val primary6X: UShort?

The normalized chromaticity value x for this primary, as defined in the CIE xyY Color Space.

Access type: Read

primary6Y

val primary6Y: UShort?

The normalized chromaticity value y for this primary, as defined in the CIE xyY Color Space.

Access type: Read

remainingTime

val remainingTime: UShort?

The time remaining (in 0.1 seconds) until the current command is complete.

Access type: Read

startUpColorTemperatureMireds

val startUpColorTemperatureMireds: UShort?

The desired startup color temperature value when a device is supplied with power. The colorTemperatureMireds attribute is updated to this value. Setting this value to null sets colorTemperatureMireds to its previous value.

Access type: Write

whitePointX

val whitePointX: UShort?

The normalized chromaticity value x for this primary, as defined in the CIE xyY Color Space, of the current white point of the device.

Access type: Read

whitePointY

val whitePointY: UShort?

The normalized chromaticity value y for this primary, as defined in the CIE xyY Color Space, of the current white point of the device.

Access type: Read