Cluster Commands: Color Control#

This group describes the CLI commands for the Color Control cluster. Listed below is a description of the cluster:

Attributes and commands for controlling the color properties of a color-capable light.

Macros#

#define

zcl color-control movetohue [hue:1] [direction:1] [transitionTime:2] [optionsMask:1] [optionsOverride:1]

#define

zcl color-control movehue [moveMode:1] [rate:1] [optionsMask:1] [optionsOverride:1]

#define

zcl color-control stephue [stepMode:1] [stepSize:1] [transitionTime:1] [optionsMask:1] [optionsOverride:1]

#define

zcl color-control movetosat [saturation:1] [transitionTime:2] [optionsMask:1] [optionsOverride:1]

#define

zcl color-control movesat [moveMode:1] [rate:1] [optionsMask:1] [optionsOverride:1]

#define

zcl color-control stepsat [stepMode:1] [stepSize:1] [transitionTime:1] [optionsMask:1] [optionsOverride:1]

#define

zcl color-control movetohueandsat [hue:1] [saturation:1] [transitionTime:2] [optionsMask:1] [optionsOverride:1]

#define

zcl color-control movetocolor [colorX:2] [colorY:2] [transitionTime:2] [optionsMask:1] [optionsOverride:1]

#define

zcl color-control movecolor [rateX:2] [rateY:2] [optionsMask:1] [optionsOverride:1]

#define

zcl color-control stepcolor [stepX:2] [stepY:2] [transitionTime:2] [optionsMask:1] [optionsOverride:1]

#define

zcl color-control movetocolortemp [colorTemperature:2] [transitionTime:2] [optionsMask:1] [optionsOverride:1]

#define

zcl color-control emovetohue [enhancedHue:2] [direction:1] [transitionTime:2] [optionsMask:1] [optionsOverride:1]

#define

zcl color-control emovehue [moveMode:1] [rate:2] [optionsMask:1] [optionsOverride:1]

#define

zcl color-control estephue [stepMode:1] [stepSize:2] [transitionTime:2] [optionsMask:1] [optionsOverride:1]

#define

zcl color-control emovetohueandsat [enhancedHue:2] [saturation:1] [transitionTime:2] [optionsMask:1] [optionsOverride:1]

#define

zcl color-control loop [updateFlags:1] [action:1] [direction:1] [time:2] [startHue:2] [optionsMask:1] [optionsOverride:1]

#define

zcl color-control stopmovestep [optionsMask:1] [optionsOverride:1]

#define

zcl color-control movecolortemp [moveMode:1] [rate:2] [colorTemperatureMinimum:2] [colorTemperatureMaximum:2] [optionsMask:1] [optionsOverride:1]

#define

zcl color-control stepcolortemp [stepMode:1] [stepSize:2] [transitionTime:2] [colorTemperatureMinimum:2] [colorTemperatureMaximum:2] [optionsMask:1] [optionsOverride:1]

Macro Definition Documentation#

EMBER_AF_DOXYGEN_CLI_COMMAND_COLOR_CONTROL_MOVETOHUE#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_COLOR_CONTROL_MOVETOHUE

zcl color-control movetohue [hue:1] [direction:1] [transitionTime:2] [optionsMask:1] [optionsOverride:1]

  • Move to specified hue.

    • hue - INT8U

    • direction - HueDirection [ENUM8]

    • transitionTime - INT16U

    • optionsMask - BITMAP8

    • optionsOverride - BITMAP8 See Also


Definition at line 444 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_COLOR_CONTROL_MOVEHUE#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_COLOR_CONTROL_MOVEHUE

zcl color-control movehue [moveMode:1] [rate:1] [optionsMask:1] [optionsOverride:1]

  • Move hue up or down at specified rate.

    • moveMode - HueMoveMode [ENUM8]

    • rate - INT8U

    • optionsMask - BITMAP8

    • optionsOverride - BITMAP8 See Also


Definition at line 455 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_COLOR_CONTROL_STEPHUE#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_COLOR_CONTROL_STEPHUE

zcl color-control stephue [stepMode:1] [stepSize:1] [transitionTime:1] [optionsMask:1] [optionsOverride:1]

  • Step hue up or down by specified size at specified rate.

    • stepMode - HueStepMode [ENUM8]

    • stepSize - INT8U

    • transitionTime - INT8U

    • optionsMask - BITMAP8

    • optionsOverride - BITMAP8 See Also


Definition at line 467 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_COLOR_CONTROL_MOVETOSAT#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_COLOR_CONTROL_MOVETOSAT

zcl color-control movetosat [saturation:1] [transitionTime:2] [optionsMask:1] [optionsOverride:1]

  • Move to specified saturation.

    • saturation - INT8U

    • transitionTime - INT16U

    • optionsMask - BITMAP8

    • optionsOverride - BITMAP8


Definition at line 476 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_COLOR_CONTROL_MOVESAT#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_COLOR_CONTROL_MOVESAT

zcl color-control movesat [moveMode:1] [rate:1] [optionsMask:1] [optionsOverride:1]

  • Move saturation up or down at specified rate.

    • moveMode - SaturationMoveMode [ENUM8]

    • rate - INT8U

    • optionsMask - BITMAP8

    • optionsOverride - BITMAP8 See Also


Definition at line 487 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_COLOR_CONTROL_STEPSAT#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_COLOR_CONTROL_STEPSAT

zcl color-control stepsat [stepMode:1] [stepSize:1] [transitionTime:1] [optionsMask:1] [optionsOverride:1]

  • Step saturation up or down by specified size at specified rate.

    • stepMode - SaturationStepMode [ENUM8]

    • stepSize - INT8U

    • transitionTime - INT8U

    • optionsMask - BITMAP8

    • optionsOverride - BITMAP8 See Also


Definition at line 499 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_COLOR_CONTROL_MOVETOHUEANDSAT#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_COLOR_CONTROL_MOVETOHUEANDSAT

zcl color-control movetohueandsat [hue:1] [saturation:1] [transitionTime:2] [optionsMask:1] [optionsOverride:1]

  • Move to hue and saturation.

    • hue - INT8U

    • saturation - INT8U

    • transitionTime - INT16U

    • optionsMask - BITMAP8

    • optionsOverride - BITMAP8


Definition at line 509 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_COLOR_CONTROL_MOVETOCOLOR#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_COLOR_CONTROL_MOVETOCOLOR

zcl color-control movetocolor [colorX:2] [colorY:2] [transitionTime:2] [optionsMask:1] [optionsOverride:1]

  • Move to specified color.

    • colorX - INT16U

    • colorY - INT16U

    • transitionTime - INT16U

    • optionsMask - BITMAP8

    • optionsOverride - BITMAP8


Definition at line 519 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_COLOR_CONTROL_MOVECOLOR#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_COLOR_CONTROL_MOVECOLOR

zcl color-control movecolor [rateX:2] [rateY:2] [optionsMask:1] [optionsOverride:1]

  • Moves the color.

    • rateX - INT16S

    • rateY - INT16S

    • optionsMask - BITMAP8

    • optionsOverride - BITMAP8


Definition at line 528 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_COLOR_CONTROL_STEPCOLOR#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_COLOR_CONTROL_STEPCOLOR

zcl color-control stepcolor [stepX:2] [stepY:2] [transitionTime:2] [optionsMask:1] [optionsOverride:1]

  • Steps the lighting to a specific color.

    • stepX - INT16S

    • stepY - INT16S

    • transitionTime - INT16U

    • optionsMask - BITMAP8

    • optionsOverride - BITMAP8


Definition at line 538 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_COLOR_CONTROL_MOVETOCOLORTEMP#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_COLOR_CONTROL_MOVETOCOLORTEMP

zcl color-control movetocolortemp [colorTemperature:2] [transitionTime:2] [optionsMask:1] [optionsOverride:1]

  • Move to a specific color temperature.

    • colorTemperature - INT16U

    • transitionTime - INT16U

    • optionsMask - BITMAP8

    • optionsOverride - BITMAP8


Definition at line 547 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_COLOR_CONTROL_EMOVETOHUE#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_COLOR_CONTROL_EMOVETOHUE

zcl color-control emovetohue [enhancedHue:2] [direction:1] [transitionTime:2] [optionsMask:1] [optionsOverride:1]

  • Command description for EnhancedMoveToHue

    • enhancedHue - INT16U

    • direction - HueDirection [ENUM8]

    • transitionTime - INT16U

    • optionsMask - BITMAP8

    • optionsOverride - BITMAP8 See Also


Definition at line 559 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_COLOR_CONTROL_EMOVEHUE#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_COLOR_CONTROL_EMOVEHUE

zcl color-control emovehue [moveMode:1] [rate:2] [optionsMask:1] [optionsOverride:1]

  • Command description for EnhancedMoveHue

    • moveMode - HueMoveMode [ENUM8]

    • rate - INT16U

    • optionsMask - BITMAP8

    • optionsOverride - BITMAP8 See Also


Definition at line 570 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_COLOR_CONTROL_ESTEPHUE#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_COLOR_CONTROL_ESTEPHUE

zcl color-control estephue [stepMode:1] [stepSize:2] [transitionTime:2] [optionsMask:1] [optionsOverride:1]

  • Command description for EnhancedStepHue

    • stepMode - HueStepMode [ENUM8]

    • stepSize - INT16U

    • transitionTime - INT16U

    • optionsMask - BITMAP8

    • optionsOverride - BITMAP8 See Also


Definition at line 582 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_COLOR_CONTROL_EMOVETOHUEANDSAT#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_COLOR_CONTROL_EMOVETOHUEANDSAT

zcl color-control emovetohueandsat [enhancedHue:2] [saturation:1] [transitionTime:2] [optionsMask:1] [optionsOverride:1]

  • Command description for EnhancedMoveToHueAndSaturation

    • enhancedHue - INT16U

    • saturation - INT8U

    • transitionTime - INT16U

    • optionsMask - BITMAP8

    • optionsOverride - BITMAP8


Definition at line 592 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_COLOR_CONTROL_LOOP#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_COLOR_CONTROL_LOOP

zcl color-control loop [updateFlags:1] [action:1] [direction:1] [time:2] [startHue:2] [optionsMask:1] [optionsOverride:1]

  • Command description for ColorLoopSet

    • updateFlags - ColorLoopUpdateFlags [BITMAP8]

    • action - ColorLoopAction [ENUM8]

    • direction - ColorLoopDirection [ENUM8]

    • time - INT16U

    • startHue - INT16U

    • optionsMask - BITMAP8

    • optionsOverride - BITMAP8 See Also


Definition at line 607 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_COLOR_CONTROL_STOPMOVESTEP#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_COLOR_CONTROL_STOPMOVESTEP

zcl color-control stopmovestep [optionsMask:1] [optionsOverride:1]

  • Command description for StopMoveStep

    • optionsMask - BITMAP8

    • optionsOverride - BITMAP8


Definition at line 614 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_COLOR_CONTROL_MOVECOLORTEMP#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_COLOR_CONTROL_MOVECOLORTEMP

zcl color-control movecolortemp [moveMode:1] [rate:2] [colorTemperatureMinimum:2] [colorTemperatureMaximum:2] [optionsMask:1] [optionsOverride:1]

  • Command description for MoveColorTemperature

    • moveMode - HueMoveMode [ENUM8]

    • rate - INT16U

    • colorTemperatureMinimum - INT16U

    • colorTemperatureMaximum - INT16U

    • optionsMask - BITMAP8

    • optionsOverride - BITMAP8 See Also


Definition at line 627 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_COLOR_CONTROL_STEPCOLORTEMP#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_COLOR_CONTROL_STEPCOLORTEMP

zcl color-control stepcolortemp [stepMode:1] [stepSize:2] [transitionTime:2] [colorTemperatureMinimum:2] [colorTemperatureMaximum:2] [optionsMask:1] [optionsOverride:1]

  • Command description for StepColorTemperature

    • stepMode - HueStepMode [ENUM8]

    • stepSize - INT16U

    • transitionTime - INT16U

    • colorTemperatureMinimum - INT16U

    • colorTemperatureMaximum - INT16U

    • optionsMask - BITMAP8

    • optionsOverride - BITMAP8 See Also


Definition at line 641 of file app/framework/test/headers/cli.doc