/** * @license * Copyright 2022-2026 Matter.js Authors * SPDX-License-Identifier: Apache-2.0 */ /*** THIS FILE IS GENERATED, DO NOT EDIT ***/ import { Resource } from "#models/Resource.js"; Resource.add( { tag: "cluster", name: "ColorControl", pics: "CC", xref: "cluster§3.2", details: "This cluster provides an interface for changing the color of a light. Color is specified according " + "to the CIE 1931 Color space. Color control is carried out in terms of x,y values, as defined by this " + "specification." + "\n" + "Additionally, color may optionally be controlled in terms of color temperature, or as hue and " + "saturation values based on optionally variable RGB and W color points. It is recommended that the " + "hue and saturation are interpreted according to the HSV (a.k.a. HSB) color model." + "\n" + "Control over luminance is not included, as this is provided by means of the Level Control for " + "Lighting cluster. It is recommended that the level provided by this cluster be interpreted as " + "representing a proportion of the maximum intensity achievable at the current color.", children: [ { tag: "attribute", name: "FeatureMap", xref: "cluster§3.2.4", children: [ { tag: "field", name: "HS", details: "Supports color specification via hue/saturation." }, { tag: "field", name: "EHUE", details: "Enhanced hue is supported." }, { tag: "field", name: "CL", details: "Color loop is supported." }, { tag: "field", name: "XY", details: "Supports color specification via XY." }, { tag: "field", name: "CT", details: "Supports specification of color temperature." } ] }, { tag: "attribute", name: "CurrentHue", xref: "cluster§3.2.7.2", details: "The CurrentHue attribute contains the current hue value of the light. It is updated as fast as " + "practical during commands that change the hue." + "\n" + "The hue in degrees shall be related to the CurrentHue attribute by the relationship:" + "\n" + "where CurrentHue is in the range from 0 to 254 inclusive." + "\n" + "Changes to this attribute shall only be marked as reportable in the following cases:" + "\n" + " - At most once per second or" + "\n" + " - At the end of the movement/transition." }, { tag: "attribute", name: "CurrentSaturation", xref: "cluster§3.2.7.3", details: "Indicates the current saturation value of the light. It is updated as fast as practical during " + "commands that change the saturation." + "\n" + "The saturation (on a scale from 0.0 to 1.0) shall be related to the CurrentSaturation attribute by " + "the relationship:" + "\n" + "where CurrentSaturation is in the range from 0 to 254 inclusive." + "\n" + "Changes to this attribute shall only be marked as reportable in the following cases:" + "\n" + " - At most once per second or" + "\n" + " - At the end of the movement/transition." }, { tag: "attribute", name: "RemainingTime", xref: "cluster§3.2.7.4", details: "Indicates the time remaining, in 1/10ths of a second, until transitions due to the currently active " + "command will be complete." + "\n" + "Changes to this attribute shall only be marked as reportable in the following cases:" + "\n" + " - When it changes from 0 to any value higher than 10, or" + "\n" + " - When it changes, with a delta larger than 10, caused by the invoke of a command, or" + "\n" + " - When it changes to 0." + "\n" + "For commands with a transition time or changes to the transition time less than 1 second, changes to " + "this attribute shall NOT be reported." + "\n" + "As this attribute is not being reported during a regular countdown, clients SHOULD NOT rely on the " + "reporting of this attribute in order to keep track of the remaining duration." }, { tag: "attribute", name: "CurrentX", xref: "cluster§3.2.7.5", details: "Indicates the current value of the normalized chromaticity value x, as defined in the CIE xyY Color " + "Space. It is updated as fast as practical during commands that change the color." + "\n" + "The value of x shall be related to the CurrentX attribute by the relationship where CurrentX is in " + "the range from 0 to 65279 inclusive." + "\n" + "Changes to this attribute shall only be marked as reportable in the following cases:" + "\n" + " - At most once per second or" + "\n" + " - At the end of the movement/transition." }, { tag: "attribute", name: "CurrentY", xref: "cluster§3.2.7.6", details: "Indicates the current value of the normalized chromaticity value y, as defined in the CIE xyY Color " + "Space. It is updated as fast as practical during commands that change the color." + "\n" + "The value of y shall be related to the CurrentY attribute by the relationship where CurrentY is in " + "the range from 0 to 65279 inclusive." + "\n" + "Changes to this attribute shall only be marked as reportable in the following cases:" + "\n" + " - At most once per second or" + "\n" + " - At the end of the movement/transition." }, { tag: "attribute", name: "DriftCompensation", xref: "cluster§3.2.7.7", details: "Indicates what mechanism, if any, is in use for compensation for color/intensity drift over time." }, { tag: "attribute", name: "CompensationText", xref: "cluster§3.2.7.8", details: "This attribute shall contain a textual indication of what mechanism, if any, is in use to compensate " + "for color/intensity drift over time." }, { tag: "attribute", name: "ColorTemperatureMireds", xref: "cluster§3.2.7.9", details: "Indicates a scaled inverse of the current value of the color temperature. The unit of " + "ColorTemperatureMireds is the mired (micro reciprocal degree), a.k.a. mirek (micro reciprocal " + "kelvin). It is updated as fast as practical during commands that change the color." + "\n" + "Changes to this attribute shall only be marked as reportable in the following cases:" + "\n" + " - At most once per second or" + "\n" + " - At the end of the movement/transition." + "\n" + "The color temperature value in kelvins shall be related to the ColorTemperatureMireds attribute in " + "mired by the relationship where ColorTemperatureMireds is in the range from 1 to 65279 inclusive, " + "giving a color temperature range from 1,000,000 K to 15.32 K." + "\n" + "If this attribute is implemented then the ColorMode attribute shall also be implemented." }, { tag: "attribute", name: "ColorMode", xref: "cluster§3.2.7.10", details: "Indicates which attributes are currently determining the color of the device." + "\n" + "The value of the ColorMode attribute cannot be written directly - it is set upon reception of any " + "command in section Commands to the appropriate mode for that command." }, { tag: "attribute", name: "Options", xref: "cluster§3.2.7.11", details: "Indicates a bitmap that determines the default behavior of some cluster commands. Each command that " + "is dependent on the Options attribute shall first construct a temporary Options bitmap that is in " + "effect during the command processing. The temporary Options bitmap has the same format and meaning " + "as the Options attribute, but includes any bits that may be overridden by command fields." + "\n" + "This attribute is meant to be changed only during commissioning." + "\n" + "Below is the format and description of the Options attribute and temporary Options bitmap and the " + "effect on dependent commands." + "\n" + "Command execution shall NOT continue beyond the Options processing if all of these criteria are " + "true:" + "\n" + " - The On/Off cluster exists on the same endpoint as this cluster." + "\n" + " - The OnOff attribute of the On/Off cluster, on this endpoint, is FALSE." + "\n" + " - The value of the ExecuteIfOff bit is 0." }, { tag: "attribute", name: "NumberOfPrimaries", xref: "cluster§3.2.7.24", details: "Indicates the number of color primaries implemented on this device. A value of null shall indicate " + "that the number of primaries is unknown." + "\n" + "Where this attribute is implemented, the attributes below for indicating the “x” and “y” color " + "values of the primaries shall also be implemented for each of the primaries from 1 to " + "NumberOfPrimaries, without leaving gaps. Implementation of the Primary1Intensity attribute and " + "subsequent intensity attributes is optional." }, { tag: "attribute", name: "Primary1X", xref: "cluster§3.2.7.25", details: "Indicates the normalized chromaticity value x for this primary, as defined in the CIE xyY Color " + "Space." + "\n" + "The value of x shall be related to the Primary1X attribute by the relationship" + "\n" + "x = Primary1X / 65536 (Primary1X in the range 0 to 65279 inclusive)" }, { tag: "attribute", name: "Primary1Y", xref: "cluster§3.2.7.26", details: "Indicates the normalized chromaticity value y for this primary, as defined in the CIE xyY Color " + "Space." + "\n" + "The value of y shall be related to the Primary1Y attribute by the relationship" + "\n" + "y = Primary1Y / 65536 (Primary1Y in the range 0 to 65279 inclusive)" }, { tag: "attribute", name: "Primary1Intensity", xref: "cluster§3.2.7.27", details: "Indicates a representation of the maximum intensity of this primary as defined in Section 3.1.3, " + "\"The Dimming Light Curve\", normalized such that the primary with the highest maximum intensity " + "contains the value 254." + "\n" + "A value of null shall indicate that this primary is not available." }, { tag: "attribute", name: "Primary2X", xref: "cluster§3.2.7" }, { tag: "attribute", name: "Primary2Y", xref: "cluster§3.2.7" }, { tag: "attribute", name: "Primary2Intensity", xref: "cluster§3.2.7" }, { tag: "attribute", name: "Primary3X", xref: "cluster§3.2.7" }, { tag: "attribute", name: "Primary3Y", xref: "cluster§3.2.7" }, { tag: "attribute", name: "Primary3Intensity", xref: "cluster§3.2.7" }, { tag: "attribute", name: "Primary4X", xref: "cluster§3.2.7" }, { tag: "attribute", name: "Primary4Y", xref: "cluster§3.2.7" }, { tag: "attribute", name: "Primary4Intensity", xref: "cluster§3.2.7" }, { tag: "attribute", name: "Primary5X", xref: "cluster§3.2.7" }, { tag: "attribute", name: "Primary5Y", xref: "cluster§3.2.7" }, { tag: "attribute", name: "Primary5Intensity", xref: "cluster§3.2.7" }, { tag: "attribute", name: "Primary6X", xref: "cluster§3.2.7" }, { tag: "attribute", name: "Primary6Y", xref: "cluster§3.2.7" }, { tag: "attribute", name: "Primary6Intensity", xref: "cluster§3.2.7" }, { tag: "attribute", name: "WhitePointX", xref: "cluster§3.2.7.29", details: "Indicates the normalized chromaticity value x, as defined in the CIE xyY Color Space, of the current " + "white point of the device." + "\n" + "The value of x shall be related to the WhitePointX attribute by the relationship" + "\n" + "x = WhitePointX / 65536 (WhitePointX in the range 0 to 65279 inclusive)" }, { tag: "attribute", name: "WhitePointY", xref: "cluster§3.2.7.30", details: "Indicates the normalized chromaticity value y, as defined in the CIE xyY Color Space, of the current " + "white point of the device." + "\n" + "The value of y shall be related to the WhitePointY attribute by the relationship" + "\n" + "y = WhitePointY / 65536 (WhitePointY in the range 0 to 65279 inclusive)" }, { tag: "attribute", name: "ColorPointRx", xref: "cluster§3.2.7.31", details: "Indicates the normalized chromaticity value x, as defined in the CIE xyY Color Space, of the red " + "color point of the device." + "\n" + "The value of x shall be related to the ColorPointRX attribute by the relationship" + "\n" + "x = ColorPointRX / 65536 (ColorPointRX in the range 0 to 65279 inclusive)" }, { tag: "attribute", name: "ColorPointRy", xref: "cluster§3.2.7.32", details: "Indicates the normalized chromaticity value y, as defined in the CIE xyY Color Space, of the red " + "color point of the device." + "\n" + "The value of y shall be related to the ColorPointRY attribute by the relationship" + "\n" + "y = ColorPointRY / 65536 (ColorPointRY in the range 0 to 65279 inclusive)" }, { tag: "attribute", name: "ColorPointRIntensity", xref: "cluster§3.2.7.33", details: "Indicates a representation of the relative intensity of the red color point as defined in Section " + "3.1.3, \"The Dimming Light Curve\", normalized such that the color point with the highest relative " + "intensity contains the value 254." + "\n" + "A value of null shall indicate an invalid value." }, { tag: "attribute", name: "ColorPointGx", xref: "cluster§3.2.7" }, { tag: "attribute", name: "ColorPointGy", xref: "cluster§3.2.7" }, { tag: "attribute", name: "ColorPointGIntensity", xref: "cluster§3.2.7" }, { tag: "attribute", name: "ColorPointBx", xref: "cluster§3.2.7" }, { tag: "attribute", name: "ColorPointBy", xref: "cluster§3.2.7" }, { tag: "attribute", name: "ColorPointBIntensity", xref: "cluster§3.2.7" }, { tag: "attribute", name: "EnhancedCurrentHue", xref: "cluster§3.2.7.12", details: "Indicates the non-equidistant steps along the CIE 1931 color triangle, and it provides 16-bits " + "precision." + "\n" + "The upper 8 bits of this attribute shall be used as an index in the implementation specific XY " + "lookup table to provide the non-equidistant steps. The lower 8 bits shall be used to interpolate " + "between these steps in a linear way in order to provide color zoom for the user." + "\n" + "To provide compatibility with clients not supporting EHUE, the CurrentHue attribute shall contain a " + "hue value in the range 0 to 254, calculated from the EnhancedCurrentHue attribute." + "\n" + "Changes to this attribute shall only be marked as reportable in the following cases:" + "\n" + " - At most once per second or" + "\n" + " - At the end of the movement/transition." }, { tag: "attribute", name: "EnhancedColorMode", xref: "cluster§3.2.7.13", details: "Indicates which attributes are currently determining the color of the device." + "\n" + "To provide compatibility with clients not supporting EHUE, the ColorMode attribute shall indicate " + "CurrentHueAndCurrentSaturation when the EnhancedCurrentHue attribute indicates " + "EnhancedCurrentHueAndCurrentSaturation. For other values of the EnhancedCurrentHue attribute, the " + "value of the ColorMode attribute shall be the same as the value of the EnhancedCurrentHue attribute. " + "If the ColorMode attribute is changed, its new value shall be copied to the EnhancedColorMode " + "attribute." }, { tag: "attribute", name: "ColorLoopActive", xref: "cluster§3.2.7.14", details: "Indicates the current active status of the color loop. If this attribute has the value 0, the color " + "loop shall NOT be active. If this attribute has the value 1, the color loop shall be active." }, { tag: "attribute", name: "ColorLoopDirection", xref: "cluster§3.2.7.15", details: "Indicates the current direction of the color loop. If this attribute has the value Decrement, the " + "EnhancedCurrentHue attribute shall be decremented. If this attribute has the value Increment, the " + "EnhancedCurrentHue attribute shall be incremented." }, { tag: "attribute", name: "ColorLoopTime", xref: "cluster§3.2.7.16", details: "Indicates the number of seconds it shall take to perform a full color loop, i.e., to cycle all " + "values of the EnhancedCurrentHue attribute (between 0 and 65534)." }, { tag: "attribute", name: "ColorLoopStartEnhancedHue", xref: "cluster§3.2.7.17", details: "Indicates the value of the EnhancedCurrentHue attribute from which the color loop shall be started." }, { tag: "attribute", name: "ColorLoopStoredEnhancedHue", xref: "cluster§3.2.7.18", details: "Indicates the value of the EnhancedCurrentHue attribute before the color loop was started. Once the " + "color loop is complete, the EnhancedCurrentHue attribute shall be restored to this value." }, { tag: "attribute", name: "ColorCapabilities", xref: "cluster§3.2.7.19", details: "Indicates the color control capabilities of the device." + "\n" + "Bits 0-4 of the ColorCapabilities attribute shall have the same values as the corresponding bits of " + "the FeatureMap attribute. All other bits in ColorCapabilities shall be 0." }, { tag: "attribute", name: "ColorTempPhysicalMinMireds", xref: "cluster§3.2.7.20", details: "Indicates the minimum mired value supported by the hardware. ColorTempPhysicalMinMireds corresponds " + "to the maximum color temperature in kelvins supported by the hardware. ColorTempPhysicalMinMireds " + "$<=$ ColorTemperatureMireds." }, { tag: "attribute", name: "ColorTempPhysicalMaxMireds", xref: "cluster§3.2.7.21", details: "Indicates the maximum mired value supported by the hardware. ColorTempPhysicalMaxMireds corresponds " + "to the minimum color temperature in kelvins supported by the hardware. ColorTemperatureMireds $<=$ " + "ColorTempPhysicalMaxMireds." }, { tag: "attribute", name: "CoupleColorTempToLevelMinMireds", xref: "cluster§3.2.7.22", details: "Indicates 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 Level Control cluster is equal to 1. When " + "coupling the ColorTemperatureMireds attribute to the CurrentLevel attribute, this value shall " + "correspond to a CurrentLevel value of 254 (100%)." + "\n" + "This attribute shall be set such that the following relationship exists: ColorTempPhysicalMinMireds " + "$<=$ CoupleColorTempToLevelMinMireds $<=$ ColorTemperatureMireds" + "\n" + "Note that since this attribute is stored as a micro reciprocal degree (mired) value (i.e. color " + "temperature in kelvins = 1,000,000 / CoupleColorTempToLevelMinMireds), the " + "CoupleColorTempToLevelMinMireds attribute corresponds to an upper bound on the value of the color " + "temperature in kelvins supported by the device." }, { tag: "attribute", name: "StartUpColorTemperatureMireds", xref: "cluster§3.2.7.23", details: "Indicates the desired startup color temperature value the light shall use when it is supplied with " + "power and this value shall be reflected in the ColorTemperatureMireds attribute. In addition, the " + "ColorMode and EnhancedColorMode attributes shall be set to 2 (ColorTemperatureMireds). The values of " + "the StartUpColorTemperatureMireds attribute are listed in the table below," }, { tag: "command", name: "MoveToHue", xref: "cluster§3.2.8.4", details: "This command will move the device to the requested hue using a transition.", children: [ { tag: "field", name: "Hue", xref: "cluster§3.2.8.4.1", details: "This field shall indicate the hue to be moved to." }, { tag: "field", name: "Direction", xref: "cluster§3.2.8.4.2", details: "This field shall indicate the movement direction." }, { tag: "field", name: "TransitionTime", xref: "cluster§3.2.8.4.3", details: "This field shall indicate, in 1/10ths of a second, the time that shall be taken to move to the new " + "hue." } ] }, { tag: "command", name: "MoveHue", xref: "cluster§3.2.8.5", details: "This command will change the hue of the device with a requested rate.", children: [ { tag: "field", name: "MoveMode", xref: "cluster§3.2.8.5.1", details: "This field shall indicate the mode of movement." }, { tag: "field", name: "Rate", xref: "cluster§3.2.8.5.2", details: "This field shall indicate the rate of movement in steps per second. A step is a change in the " + "device’s hue of one unit." } ] }, { tag: "command", name: "StepHue", xref: "cluster§3.2.8.6", details: "This command will change the hue of the device using a step and transition.", children: [ { tag: "field", name: "StepMode", xref: "cluster§3.2.8.6.1", details: "This field shall indicate the mode of the step to be performed." }, { tag: "field", name: "StepSize", xref: "cluster§3.2.8.6.2", details: "This field shall indicate the change to be added to (or subtracted from) the current value of the " + "device’s hue." }, { tag: "field", name: "TransitionTime", xref: "cluster§3.2.8.6.3", details: "This field shall indicate, in 1/10ths of a second, the time that shall be taken to perform the step. " + "A step is a change in the device’s hue of Step size units." + "\n" + "> [!NOTE]" + "\n" + "> NOTE: Here the TransitionTime data field is of data type uint8, where uint16 is more common for " + "TransitionTime data fields in other clusters / commands." } ] }, { tag: "command", name: "MoveToSaturation", xref: "cluster§3.2.8.7", details: "This command will move the device to the requested saturation using a transition." }, { tag: "command", name: "MoveSaturation", xref: "cluster§3.2.8.8", details: "This command will change the saturation of the device with a requested rate.", children: [ { tag: "field", name: "MoveMode", xref: "cluster§3.2.8.8.1", details: "This field shall indicate the mode of movement, as described in the MoveHue command." }, { tag: "field", name: "Rate", xref: "cluster§3.2.8.8.2", details: "This field shall indicate the rate of movement in steps per second. A step is a change in the " + "device’s saturation of one unit." } ] }, { tag: "command", name: "StepSaturation", xref: "cluster§3.2.8.9", details: "This command will change the saturation of the device using a step and transition.", children: [ { tag: "field", name: "StepMode", xref: "cluster§3.2.8.9.1", details: "This field shall indicate the mode of the step to be performed, as described in the StepHue command." }, { tag: "field", name: "StepSize", xref: "cluster§3.2.8.9.2", details: "This field shall indicate the change to be added to (or subtracted from) the current value of the " + "device’s saturation." }, { tag: "field", name: "TransitionTime", xref: "cluster§3.2.8.9.3", details: "This field shall indicate, in 1/10ths of a second, the time that shall be taken to perform the step. " + "A step is a change in the device’s saturation of Step size units." + "\n" + "> [!NOTE]" + "\n" + "> NOTE: Here the TransitionTime data field is of data type uint8, where uint16 is more common for " + "TransitionTime data fields in other clusters / commands." } ] }, { tag: "command", name: "MoveToHueAndSaturation", xref: "cluster§3.2.8.10", details: "This command will move the device to the requested hue and saturation using a transition." }, { tag: "command", name: "MoveToColor", xref: "cluster§3.2.8.11", details: "This command will move the device to the requested color using a transition." }, { tag: "command", name: "MoveColor", xref: "cluster§3.2.8.12", details: "This command will change the color of the device with a requested rate.", children: [ { tag: "field", name: "RateX", xref: "cluster§3.2.8.12.1", details: "This field shall indicate the rate of movement in steps per second. A step is a change in the " + "device’s CurrentX attribute of one unit." }, { tag: "field", name: "RateY", xref: "cluster§3.2.8.12.2", details: "This field shall indicate the rate of movement in steps per second. A step is a change in the " + "device’s CurrentY attribute of one unit." } ] }, { tag: "command", name: "StepColor", xref: "cluster§3.2.8.13", details: "This command will change the color of the device using a step and transition.", children: [{ tag: "field", name: "TransitionTime", xref: "cluster§3.2.8.13.2", details: "The field shall indicate, in 1/10ths of a second, the time that shall be taken to perform the color " + "change." }] }, { tag: "command", name: "MoveToColorTemperature", xref: "cluster§3.2.8.14", details: "This command will move the device to the requested color temperature using a transition." }, { tag: "command", name: "EnhancedMoveToHue", xref: "cluster§3.2.8.15", details: "This command allows the light to be moved in a smooth continuous transition from their current hue " + "to a target hue.", children: [ { tag: "field", name: "EnhancedHue", xref: "cluster§3.2.8.15.1", details: "This field shall indicate the target enhanced hue for the light." }, { tag: "field", name: "Direction", xref: "cluster§3.2.8.15.2", details: "This field shall indicate the movement direction." }, { tag: "field", name: "TransitionTime", xref: "cluster§3.2.8.15.3", details: "This field shall indicate the transition time, as described in the MoveToHue command." } ] }, { tag: "command", name: "EnhancedMoveHue", xref: "cluster§3.2.8.16", details: "This command allows the light to start a continuous transition starting from their current hue.", children: [ { tag: "field", name: "MoveMode", xref: "cluster§3.2.8.16.1", details: "This field shall indicate the mode of movement, as described in the MoveHue command." }, { tag: "field", name: "Rate", xref: "cluster§3.2.8.16.2", details: "This field shall indicate the rate of movement in steps per second. A step is a change in the " + "enhanced hue of a device by one unit." } ] }, { tag: "command", name: "EnhancedStepHue", xref: "cluster§3.2.8.17", details: "This command allows the device to be moved in a stepped transition from their current hue.", children: [ { tag: "field", name: "StepMode", xref: "cluster§3.2.8.17.1", details: "This field shall indicate the mode of the step to be performed, as described in the StepHue command." }, { tag: "field", name: "StepSize", xref: "cluster§3.2.8.17.2", details: "This field shall indicate the change to be added to (or subtracted from) the current value of the " + "device’s enhanced hue." }, { tag: "field", name: "TransitionTime", xref: "cluster§3.2.8.17.3", details: "The field shall indicate, in units of 1/10ths of a second, the time that shall be taken to perform " + "the step. A step is a change to the device’s enhanced hue of a magnitude corresponding to the " + "StepSize field." + "\n" + "> [!NOTE]" + "\n" + "> NOTE: Here TransitionTime data field is of data type uint16, while the TransitionTime data field " + "of the StepHue command is of data type uint8." } ] }, { tag: "command", name: "EnhancedMoveToHueAndSaturation", xref: "cluster§3.2.8.18", details: "This command allows the light to be moved in a smooth continuous transition from their current hue " + "to a target hue and from their current saturation to a target saturation.", children: [ { tag: "field", name: "EnhancedHue", xref: "cluster§3.2.8.18.1", details: "This field shall indicate the target enhanced hue for the light." }, { tag: "field", name: "Saturation", xref: "cluster§3.2.8.18.2", details: "This field shall indicate the saturation, as described in the MoveToHueAndSaturation command." }, { tag: "field", name: "TransitionTime", xref: "cluster§3.2.8.18.3", details: "This field shall indicate the transition time, as described in the MoveToHue command." } ] }, { tag: "command", name: "ColorLoopSet", xref: "cluster§3.2.8.19", details: "This command allows a color loop to be activated such that the color light cycles through its range " + "of hues.", children: [ { tag: "field", name: "UpdateFlags", xref: "cluster§3.2.8.19.1", details: "This field shall indicate which color loop attributes to update (from the values supplied in the " + "other fields, see field descriptions below) before the color loop is started." }, { tag: "field", name: "Action", xref: "cluster§3.2.8.19.2", details: "This field shall indicate the action to take for the color loop." }, { tag: "field", name: "Direction", xref: "cluster§3.2.8.19.3", details: "This field shall indicate the direction for the color loop." }, { tag: "field", name: "Time", xref: "cluster§3.2.8.19.4", details: "This field shall indicate the number of seconds over which to perform a full color loop." } ] }, { tag: "command", name: "StopMoveStep", xref: "cluster§3.2.8.20", details: "This command is provided to allow MoveTo and Step commands to be stopped." + "\n" + "> [!NOTE]" + "\n" + "> NOTE: This automatically provides symmetry to the Level Control cluster." + "\n" + "> [!NOTE]" + "\n" + "> NOTE: The StopMoveStep command has no effect on an active color loop." }, { tag: "command", name: "MoveColorTemperature", xref: "cluster§3.2.8.21", details: "This command allows the color temperature of the light to be moved at a specified rate.", children: [ { tag: "field", name: "MoveMode", xref: "cluster§3.2.8.21.1", details: "This field shall indicate the mode of movement, as described in the MoveHue command." }, { tag: "field", name: "Rate", xref: "cluster§3.2.8.21.2", details: "This field shall indicate the rate of movement in steps per second. A step is a change in the color " + "temperature of a device by one unit." }, { tag: "field", name: "ColorTemperatureMinimumMireds", xref: "cluster§3.2.8.21.3", details: "This field shall indicate a lower bound on the ColorTemperatureMireds attribute (≡ an upper bound on " + "the color temperature in kelvins) for the current move operation" + "\n" + "ColorTempPhysicalMinMireds $<=$ ColorTemperatureMinimumMireds field $<=$ ColorTemperatureMireds As " + "such if the move operation takes the ColorTemperatureMireds attribute towards the value of the " + "ColorTemperatureMinimumMireds field it shall be clipped so that the above invariant is satisfied. If " + "the ColorTemperatureMinimumMireds field is set to 0, ColorTempPhysicalMinMireds shall be used as the " + "lower bound for the ColorTemperatureMireds attribute." }, { tag: "field", name: "ColorTemperatureMaximumMireds", xref: "cluster§3.2.8.21.4", details: "This field shall indicate an upper bound on the ColorTemperatureMireds attribute (≡ a lower bound on " + "the color temperature in kelvins) for the current move operation" + "\n" + "ColorTemperatureMireds $<=$ ColorTemperatureMaximumMireds field $<=$ ColorTempPhysicalMaxMireds As " + "such if the move operation takes the ColorTemperatureMireds attribute towards the value of the " + "ColorTemperatureMaximumMireds field it shall be clipped so that the above invariant is satisfied. If " + "the ColorTemperatureMaximumMireds field is set to 0, ColorTempPhysicalMaxMireds shall be used as the " + "upper bound for the ColorTemperatureMireds attribute." } ] }, { tag: "command", name: "StepColorTemperature", xref: "cluster§3.2.8.22", details: "This command allows the color temperature of the light to be stepped with a specified step size.", children: [ { tag: "field", name: "StepMode", xref: "cluster§3.2.8.22.1", details: "This field shall indicate the mode of the step to be performed, as described in the StepHue command." }, { tag: "field", name: "StepSize", xref: "cluster§3.2.8.22.2", details: "This field shall indicate the change to be added to (or subtracted from) the current value of the " + "device’s color temperature." }, { tag: "field", name: "TransitionTime", xref: "cluster§3.2.8.22.3", details: "This field shall indicate, in units of 1/10ths of a second, the time that shall be taken to perform " + "the step. A step is a change to the device’s color temperature of a magnitude corresponding to the " + "StepSize field." }, { tag: "field", name: "ColorTemperatureMinimumMireds", xref: "cluster§3.2.8.22.4", details: "This field shall indicate a lower bound on the ColorTemperatureMireds attribute (≡ an upper bound on " + "the color temperature in kelvins) for the current step operation" + "\n" + "ColorTempPhysicalMinMireds $<=$ ColorTemperatureMinimumMireds field $<=$ ColorTemperatureMireds As " + "such if the step operation takes the ColorTemperatureMireds attribute towards the value of the " + "ColorTemperatureMinimumMireds field it shall be clipped so that the above invariant is satisfied. If " + "the ColorTemperatureMinimumMireds field is set to 0, ColorTempPhysicalMinMireds shall be used as the " + "lower bound for the ColorTemperatureMireds attribute." }, { tag: "field", name: "ColorTemperatureMaximumMireds", xref: "cluster§3.2.8.22.5", details: "This field shall indicate an upper bound on the ColorTemperatureMireds attribute (≡ a lower bound on " + "the color temperature in kelvins) for the current step operation" + "\n" + "ColorTemperatureMireds ≤ ColorTemperatureMaximumMireds field ≤ ColorTempPhysicalMaxMireds As such if " + "the step operation takes the ColorTemperatureMireds attribute towards the value of the " + "ColorTemperatureMaximumMireds field it shall be clipped so that the above invariant is satisfied. If " + "the ColorTemperatureMaximumMireds field is set to 0, ColorTempPhysicalMaxMireds shall be used as the " + "upper bound for the ColorTemperatureMireds attribute." } ] }, { tag: "datatype", name: "ColorCapabilitiesBitmap", xref: "cluster§3.2.6.1", children: [ { tag: "field", name: "HueSaturation", description: "Supports color specification via hue/saturation." }, { tag: "field", name: "EnhancedHue", description: "Enhanced hue is supported." }, { tag: "field", name: "ColorLoop", description: "Color loop is supported." }, { tag: "field", name: "Xy", description: "Supports color specification via XY." }, { tag: "field", name: "ColorTemperature", description: "Supports color specification via color temperature." } ] }, { tag: "datatype", name: "OptionsBitmap", xref: "cluster§3.2.6.2", children: [{ tag: "field", name: "ExecuteIfOff", description: "Dependency on On/Off cluster", xref: "cluster§3.2.6.2.1", details: "This bit shall indicate if this cluster server instance has a dependency with the On/Off cluster." }] }, { tag: "datatype", name: "UpdateFlagsBitmap", xref: "cluster§3.2.6.3", details: "This data type is derived from map8 and is used in the ColorLoopSet command.", children: [ { tag: "field", name: "UpdateAction", description: "Device adheres to the associated action field.", xref: "cluster§3.2.6.3.1", details: "This bit shall indicate whether the server adheres to the Action field in order to process the " + "command." + "\n" + " - 0 = Device shall ignore the Action field." + "\n" + " - 1 = Device shall adhere to the Action field." }, { tag: "field", name: "UpdateDirection", description: "Device updates the associated direction attribute.", xref: "cluster§3.2.6.3.2", details: "This bit shall indicate whether the device updates the ColorLoopDirection attribute with the " + "Direction field." + "\n" + " - 0 = Device shall ignore the Direction field." + "\n" + " - 1 = Device shall update the ColorLoopDirection attribute with the value of the Direction field." }, { tag: "field", name: "UpdateTime", description: "Device updates the associated time attribute.", xref: "cluster§3.2.6.3.3", details: "This bit shall indicate whether the device updates the ColorLoopTime attribute with the Time field." + "\n" + " - 0 = Device shall ignore the Time field." + "\n" + " - 1 = Device shall update the value of the ColorLoopTime attribute with the value of the Time " + "field." }, { tag: "field", name: "UpdateStartHue", description: "Device updates the associated start hue attribute.", xref: "cluster§3.2.6.3.4", details: "This bit shall indicate whether the device updates the ColorLoopStartEnhancedHue attribute with the " + "value of the StartHue field." + "\n" + " - 0 = Device shall ignore the StartHue field." + "\n" + " - 1 = Device shall update the value of the ColorLoopStartEnhancedHue attribute with the value of " + "the StartHue field." } ] }, { tag: "datatype", name: "DriftCompensationEnum", xref: "cluster§3.2.6.4", children: [ { tag: "field", name: "None", description: "There is no compensation." }, { tag: "field", name: "OtherOrUnknown", description: "The compensation is based on other or unknown mechanism." }, { tag: "field", name: "TemperatureMonitoring", description: "The compensation is based on temperature monitoring." }, { tag: "field", name: "OpticalLuminanceMonitoringAndFeedback", description: "The compensation is based on optical luminance monitoring and feedback." }, { tag: "field", name: "OpticalColorMonitoringAndFeedback", description: "The compensation is based on optical color monitoring and feedback." } ] }, { tag: "datatype", name: "ColorModeEnum", xref: "cluster§3.2.6.5", children: [ { tag: "field", name: "CurrentHueAndCurrentSaturation", description: "The current hue and saturation attributes determine the color." }, { tag: "field", name: "CurrentXAndCurrentY", description: "The current X and Y attributes determine the color." }, { tag: "field", name: "ColorTemperatureMireds", description: "The color temperature attribute determines the color." } ] }, { tag: "datatype", name: "EnhancedColorModeEnum", xref: "cluster§3.2.6.6", children: [ { tag: "field", name: "CurrentHueAndCurrentSaturation", description: "The current hue and saturation attributes determine the color." }, { tag: "field", name: "CurrentXAndCurrentY", description: "The current X and Y attributes determine the color." }, { tag: "field", name: "ColorTemperatureMireds", description: "The color temperature attribute determines the color." }, { tag: "field", name: "EnhancedCurrentHueAndCurrentSaturation", description: "The enhanced current hue and saturation attributes determine the color." } ] }, { tag: "datatype", name: "DirectionEnum", xref: "cluster§3.2.6.7", children: [ { tag: "field", name: "Shortest", description: "Shortest distance" }, { tag: "field", name: "Longest", description: "Longest distance" }, { tag: "field", name: "Up", description: "Up" }, { tag: "field", name: "Down", description: "Down" } ] }, { tag: "datatype", name: "MoveModeEnum", xref: "cluster§3.2.6.8", children: [ { tag: "field", name: "Stop", description: "Stop the movement" }, { tag: "field", name: "Up", description: "Move in an upwards direction" }, { tag: "field", name: "Down", description: "Move in a downwards direction" } ] }, { tag: "datatype", name: "StepModeEnum", xref: "cluster§3.2.6.9", children: [ { tag: "field", name: "Up", description: "Step in an upwards direction" }, { tag: "field", name: "Down", description: "Step in a downwards direction" } ] }, { tag: "datatype", name: "ColorLoopActionEnum", xref: "cluster§3.2.6.10", children: [ { tag: "field", name: "Deactivate", description: "De-activate the color loop." }, { tag: "field", name: "ActivateFromColorLoopStartEnhancedHue", description: "Activate the color loop from the value in the ColorLoopStartEnhancedHue field." }, { tag: "field", name: "ActivateFromEnhancedCurrentHue", description: "Activate the color loop from the value of the EnhancedCurrentHue attribute." } ] }, { tag: "datatype", name: "ColorLoopDirectionEnum", xref: "cluster§3.2.6.11", children: [ { tag: "field", name: "Decrement", description: "Decrement the hue in the color loop." }, { tag: "field", name: "Increment", description: "Increment the hue in the color loop." } ] } ] } );