Variable ColorTemperatureComponentConst

ColorTemperatureComponent: {
    attributes: {
        colorTemperatureMireds: Attribute<number, any>;
        colorTempPhysicalMaxMireds: Attribute<number, any>;
        colorTempPhysicalMinMireds: Attribute<number, any>;
        coupleColorTempToLevelMinMireds: OptionalAttribute<number, any>;
        startUpColorTemperatureMireds: OptionalWritableAttribute<number | null, any>;
    };
    commands: {
        moveColorTemperature: Command<TypeFromFields, void, any>;
        moveToColorTemperature: Command<TypeFromFields, void, any>;
        stepColorTemperature: Command<TypeFromFields, void, any>;
    };
}

A ColorControlCluster supports these elements if it supports feature ColorTemperature.

Type declaration

  • Readonlyattributes: {
        colorTemperatureMireds: Attribute<number, any>;
        colorTempPhysicalMaxMireds: Attribute<number, any>;
        colorTempPhysicalMinMireds: Attribute<number, any>;
        coupleColorTempToLevelMinMireds: OptionalAttribute<number, any>;
        startUpColorTemperatureMireds: OptionalWritableAttribute<number | null, any>;
    }
    • ReadonlycolorTemperatureMireds: Attribute<number, any>

      The ColorTemperatureMireds attribute contains 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.

      The color temperature value in kelvins shall be related to the ColorTemperatureMireds attribute in mireds by the relationship

      Color temperature in kelvins = 1,000,000 / ColorTemperatureMireds, where ColorTemperatureMireds is in the range 1 to 65279 mireds inclusive, giving a color temperature range from 1,000,000 kelvins to 15.32 kelvins.

      If this attribute is implemented then the ColorMode attribute shall also be implemented.

      See

      MatterSpecification.v13.Cluster § 3.2.7.9

    • ReadonlycolorTempPhysicalMaxMireds: Attribute<number, any>

      The ColorTempPhysicalMaxMireds attribute indicates the maximum mired value supported by the hardware. ColorTempPhysicalMaxMireds corresponds to the minimum color temperature in kelvins supported by the hardware. ColorTemperatureMireds <= ColorTempPhysicalMaxMireds.

      See

      MatterSpecification.v13.Cluster § 3.2.7.21

    • ReadonlycolorTempPhysicalMinMireds: Attribute<number, any>

      The ColorTempPhysicalMinMireds attribute indicates the minimum mired value supported by the hardware. ColorTempPhysicalMinMireds corresponds to the maximum color temperature in kelvins supported by the hardware. ColorTempPhysicalMinMireds <= ColorTemperatureMireds.

      See

      MatterSpecification.v13.Cluster § 3.2.7.20

    • ReadonlycoupleColorTempToLevelMinMireds: OptionalAttribute<number, any>

      The CoupleColorTempToLevelMinMireds attribute 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 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 0xFE (100%).

      This attribute shall be set such that the following relationship exists: ColorTempPhysicalMinMireds ≤ CoupleColorTempToLevelMinMireds ≤ ColorTemperatureMireds

      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.

      See

      MatterSpecification.v13.Cluster § 3.2.7.22

    • ReadonlystartUpColorTemperatureMireds: OptionalWritableAttribute<number | null, any>

      The StartUpColorTemperatureMireds attribute shall define the desired startup color temperature value a lamp 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 0x02 (color temperature). The values of the StartUpColorTemperatureMireds attribute are listed in the table below,

      Table 12. Values of the StartUpColorTemperatureMireds attribute

      See

      MatterSpecification.v13.Cluster § 3.2.7.23

  • Readonlycommands: {
        moveColorTemperature: Command<TypeFromFields, void, any>;
        moveToColorTemperature: Command<TypeFromFields, void, any>;
        stepColorTemperature: Command<TypeFromFields, void, any>;
    }
    • ReadonlymoveColorTemperature: Command<TypeFromFields, void, any>

      The MoveColorTemperature command allows the color temperature of a lamp to be moved at a specified rate.

      See

      MatterSpecification.v13.Cluster § 3.2.11.21

    • ReadonlymoveToColorTemperature: Command<TypeFromFields, void, any>

      See

      MatterSpecification.v13.Cluster § 3.2.11.14

    • ReadonlystepColorTemperature: Command<TypeFromFields, void, any>

      The StepColorTemperature command allows the color temperature of a lamp to be stepped with a specified step size.

      See

      MatterSpecification.v13.Cluster § 3.2.11.22

Settings

Member Visibility