ZCL color_control

Zigbee Cluster Library (ZCL) color_control cluster usage definition for ESP Zigbee SDK.

Header File

• components/esp-zigbee-lib/include/zcl/esp_zigbee_zcl_color_control.h

Macros

ESP_ZB_ZCL_COLOR_CONTROL_CURRENT_HUE_DEFAULT_VALUE

Default value for CurrentHue attribute.

ESP_ZB_ZCL_COLOR_CONTROL_CURRENT_SATURATION_DEFAULT_VALUE

Default value for CurrentSaturation attribute.

ESP_ZB_ZCL_COLOR_CONTROL_REMAINING_TIME_DEFAULT_VALUE

Default value for RemainingTime attribute.

ESP_ZB_ZCL_COLOR_CONTROL_CURRENT_X_DEF_VALUE

Current X attribute default value.

ESP_ZB_ZCL_COLOR_CONTROL_CURRENT_Y_DEF_VALUE

Current Y attribute default value.

ESP_ZB_ZCL_COLOR_CONTROL_COLOR_TEMPERATURE_DEF_VALUE

Color Temperature default value (4000K)

ESP_ZB_ZCL_COLOR_CONTROL_COLOR_MODE_DEFAULT_VALUE

Default value for ColorMode attribute.

ESP_ZB_ZCL_COLOR_CONTROL_OPTIONS_DEFAULT_VALUE

Default value for Options attribute.

ESP_ZB_ZCL_COLOR_CONTROL_ENHANCED_CURRENT_HUE_DEFAULT_VALUE

Default value for EnhancedCurrentHue attribute.

ESP_ZB_ZCL_COLOR_CONTROL_ENHANCED_COLOR_MODE_DEFAULT_VALUE

Default value for EnhancedColorMode attribute.

ESP_ZB_ZCL_COLOR_CONTROL_COLOR_LOOP_ACTIVE_DEFAULT_VALUE

Default value for ColorLoopActive attribute.

ESP_ZB_ZCL_COLOR_CONTROL_COLOR_LOOP_DIRECTION_DEFAULT_VALUE

Default value for ColorLoopDirection attribute.

ESP_ZB_ZCL_COLOR_CONTROL_COLOR_LOOP_TIME_DEF_VALUE

Color Loop Time attribute default value.

ESP_ZB_ZCL_COLOR_CONTROL_COLOR_LOOP_START_DEF_VALUE

Color Loop Start Enhanced Hue attribute default value.

ESP_ZB_ZCL_COLOR_CONTROL_COLOR_LOOP_STORED_ENHANCED_HUE_DEFAULT_VALUE

Default value for ColorLoopStoredEnhancedHue attribute.

ESP_ZB_ZCL_COLOR_CONTROL_COLOR_CAPABILITIES_DEFAULT_VALUE

Default value for ColorCapabilities attribute.

ESP_ZB_ZCL_COLOR_CONTROL_COLOR_TEMP_PHYSICAL_MIN_MIREDS_DEFAULT_VALUE

Default value for ColorTempPhysicalMinMireds attribute.

ESP_ZB_ZCL_COLOR_CONTROL_COLOR_TEMP_PHYSICAL_MAX_MIREDS_DEFAULT_VALUE

Default value for ColorTempPhysicalMaxMireds attribute.

Enumerations

enum esp_zb_zcl_color_control_attr_t

Color control attribute list.

Values:

enumerator ESP_ZB_ZCL_ATTR_COLOR_CONTROL_CURRENT_HUE_ID

Current_HUE attribute

enumerator ESP_ZB_ZCL_ATTR_COLOR_CONTROL_CURRENT_SATURATION_ID

Current Saturation attribute

enumerator ESP_ZB_ZCL_ATTR_COLOR_CONTROL_REMAINING_TIME_ID

Remaining Time attribute

enumerator ESP_ZB_ZCL_ATTR_COLOR_CONTROL_CURRENT_X_ID

CurrentX attribute

enumerator ESP_ZB_ZCL_ATTR_COLOR_CONTROL_CURRENT_Y_ID

CurrentY attribute

enumerator ESP_ZB_ZCL_ATTR_COLOR_CONTROL_DRIFT_COMPENSATION_ID

The DriftCompensation attribute indicates what mechanism

enumerator ESP_ZB_ZCL_ATTR_COLOR_CONTROL_COMPENSATION_TEXT_ID

The CompensationText attribute holds a textual indication of what mechanism

enumerator ESP_ZB_ZCL_ATTR_COLOR_CONTROL_COLOR_TEMPERATURE_ID

Color Temperature Mireds attribute

enumerator ESP_ZB_ZCL_ATTR_COLOR_CONTROL_COLOR_MODE_ID

Color Mode attribute

enumerator ESP_ZB_ZCL_ATTR_COLOR_CONTROL_OPTIONS_ID

The Options attribute is a bitmap that determines the default behavior of some cluster commands.

enumerator ESP_ZB_ZCL_ATTR_COLOR_CONTROL_ENHANCED_CURRENT_HUE_ID

The EnhancedCurrentHue attribute represents non-equidistant steps along the CIE 1931 color triangle.

enumerator ESP_ZB_ZCL_ATTR_COLOR_CONTROL_ENHANCED_COLOR_MODE_ID

The EnhancedColorMode attribute specifies which attributes are currently determining the color of the device.

enumerator ESP_ZB_ZCL_ATTR_COLOR_CONTROL_COLOR_LOOP_ACTIVE_ID

The ColorLoopActive attribute specifies the current active status of the color loop.

enumerator ESP_ZB_ZCL_ATTR_COLOR_CONTROL_COLOR_LOOP_DIRECTION_ID

The ColorLoopDirection attribute specifies the current direction of the color loop.

enumerator ESP_ZB_ZCL_ATTR_COLOR_CONTROL_COLOR_LOOP_TIME_ID

The ColorLoopTime attribute specifies the number of seconds it SHALL take to perform a full color loop.

enumerator ESP_ZB_ZCL_ATTR_COLOR_CONTROL_COLOR_LOOP_START_ENHANCED_HUE_ID

The ColorLoopStartEnhancedHue attribute specifies the value of the EnhancedCurrentHue attribute from which the color loop SHALL be started.

enumerator ESP_ZB_ZCL_ATTR_COLOR_CONTROL_COLOR_LOOP_STORED_ENHANCED_HUE_ID

The ColorLoopStoredEnhancedHue attribute specifies the value of the EnhancedCurrentHue attribute before the color loop was stored.

enumerator ESP_ZB_ZCL_ATTR_COLOR_CONTROL_COLOR_CAPABILITIES_ID

The ColorCapabilities attribute specifies the color capabilities of the device

enumerator ESP_ZB_ZCL_ATTR_COLOR_CONTROL_COLOR_TEMP_PHYSICAL_MIN_MIREDS_ID

The ColorTempPhysicalMinMireds attribute indicates the minimum mired value supported by the hardware.

enumerator ESP_ZB_ZCL_ATTR_COLOR_CONTROL_COLOR_TEMP_PHYSICAL_MAX_MIREDS_ID

The ColorTempPhysicalMaxMireds attribute indicates the maximum mired value supported by the hardware.

enumerator ESP_ZB_ZCL_ATTR_COLOR_CONTROL_COUPLE_COLOR_TEMP_TO_LEVEL_MIN_MIREDS_ID

The CoupleColorTempToLevelMinMireds attribute specifies a lower bound on the value of the ColorTemperatureMireds attribute

enumerator ESP_ZB_ZCL_ATTR_COLOR_CONTROL_START_UP_COLOR_TEMPERATURE_MIREDS_ID

The StartUpColorTemperatureMireds attribute SHALL define the desired startup color temperature value a lamp SHALL use when it is supplied with power.

enum esp_zb_zcl_color_control_cmd_id_t

Color control cluster command identifiers.

Values:

enumerator ESP_ZB_ZCL_CMD_COLOR_CONTROL_MOVE_TO_HUE

Move To Hue command

enumerator ESP_ZB_ZCL_CMD_COLOR_CONTROL_MOVE_HUE

Move Hue command

enumerator ESP_ZB_ZCL_CMD_COLOR_CONTROL_STEP_HUE

Step Hue command

enumerator ESP_ZB_ZCL_CMD_COLOR_CONTROL_MOVE_TO_SATURATION

Move To Saturation command

enumerator ESP_ZB_ZCL_CMD_COLOR_CONTROL_MOVE_SATURATION

Move Saturation command

enumerator ESP_ZB_ZCL_CMD_COLOR_CONTROL_STEP_SATURATION

Step Saturation command

enumerator ESP_ZB_ZCL_CMD_COLOR_CONTROL_MOVE_TO_HUE_SATURATION

Move To Hue and Saturation command

enumerator ESP_ZB_ZCL_CMD_COLOR_CONTROL_MOVE_TO_COLOR

Move To Color command

enumerator ESP_ZB_ZCL_CMD_COLOR_CONTROL_MOVE_COLOR

Move Color command

enumerator ESP_ZB_ZCL_CMD_COLOR_CONTROL_STEP_COLOR

Step Color command

enumerator ESP_ZB_ZCL_CMD_COLOR_CONTROL_MOVE_TO_COLOR_TEMPERATURE

Move to color temperature command

enumerator ESP_ZB_ZCL_CMD_COLOR_CONTROL_ENHANCED_MOVE_TO_HUE

Enhanced move to hue command

enumerator ESP_ZB_ZCL_CMD_COLOR_CONTROL_ENHANCED_MOVE_HUE

Enhanced move hue command

enumerator ESP_ZB_ZCL_CMD_COLOR_CONTROL_ENHANCED_STEP_HUE

Enhanced step hue command

enumerator ESP_ZB_ZCL_CMD_COLOR_CONTROL_ENHANCED_MOVE_TO_HUE_SATURATION

Enhanced move to hue and saturation command

enumerator ESP_ZB_ZCL_CMD_COLOR_CONTROL_COLOR_LOOP_SET

Color loop set command

enumerator ESP_ZB_ZCL_CMD_COLOR_CONTROL_STOP_MOVE_STEP

Stop move step command

enumerator ESP_ZB_ZCL_CMD_COLOR_CONTROL_MOVE_COLOR_TEMPERATURE

Move color temperature command

enumerator ESP_ZB_ZCL_CMD_COLOR_CONTROL_STEP_COLOR_TEMPERATURE

Step color temperature command

enum esp_zb_zcl_color_control_move_to_hue_direction_t

Direction of Move to Hue defines.

Values:

enumerator ESP_ZB_ZCL_CMD_COLOR_CONTROL_MOVE_TO_HUE_SHORTEST

Shortest distance

enumerator ESP_ZB_ZCL_CMD_COLOR_CONTROL_MOVE_TO_HUE_LONGEST

Longest distance

enumerator ESP_ZB_ZCL_CMD_COLOR_CONTROL_MOVE_TO_HUE_UP

Up

enumerator ESP_ZB_ZCL_CMD_COLOR_CONTROL_MOVE_TO_HUE_DOWN

Down

enum esp_zb_zcl_color_control_move_mode_t

Direction of Move mode defines.

Values:

enumerator ESP_ZB_ZCL_CMD_COLOR_CONTROL_MOVE_STOP

Stop

enumerator ESP_ZB_ZCL_CMD_COLOR_CONTROL_MOVE_UP

Up

enumerator ESP_ZB_ZCL_CMD_COLOR_CONTROL_MOVE_DOWN

Down

enum esp_zb_zcl_color_control_step_mode_t

Direction of Step mode defines.

Values:

enumerator ESP_ZB_ZCL_CMD_COLOR_CONTROL_STEP_UP

Up

enumerator ESP_ZB_ZCL_CMD_COLOR_CONTROL_STEP_DOWN

Down