5.2.6.3.3. ZCL Lighting Clusters

This section provides the lighting clusters implementations in ZCL of ESP Zigbee Core.

5.2.6.3.3.1. Color Control

5.2.6.3.3.1.1. Header File

5.2.6.3.3.1.2. Functions

ezb_err_t ezb_zcl_color_control_cluster_desc_add_attr(ezb_zcl_cluster_desc_t cluster_desc, uint16_t attr_id, const void *value)

Add an attribute to an color_control cluster descriptor.

Parameters:

  • cluster_desc -- [in] The color_control cluster descriptor.

  • attr_id -- [in] The identifier of the attribute to be added to cluster_desc.

  • value -- [in] The pointer to the initial value of the attribute.

Returns:

Error code.

ezb_zcl_cluster_desc_t ezb_zcl_color_control_create_cluster_desc(const void *cluster_cfg, uint8_t role_mask)

Create an color_control cluster descriptor.

Parameters:

  • cluster_cfg -- [in] The pointer to the color_control cluster configuration structure. Use ezb_zcl_color_control_cluster_server_config_t for EZB_ZCL_CLUSTER_SERVER, use ezb_zcl_color_control_cluster_client_config_t for EZB_ZCL_CLUSTER_CLIENT, or use NULL for default configuration of the stack based on the role_mask.

  • role_mask -- [in] The role of the cluster to create.

Returns:

Created cluster descriptor.

void ezb_zcl_color_control_cluster_client_init(uint8_t ep_id)

Initialize the ColorControl cluster client role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs initialization.

void ezb_zcl_color_control_cluster_server_init(uint8_t ep_id)

Initialize the ColorControl cluster server role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs de-initialization.

5.2.6.3.3.1.3. Structures

struct ezb_zcl_color_control_cluster_server_config_s

Configuration mandatory attributes for the ColorControl server cluster.

Public Members

uint16_t current_x

Configurable mandatory CurrentX attribute

uint16_t current_y

Configurable mandatory CurrentY attribute

uint8_t color_mode

Configurable mandatory ColorMode attribute

uint8_t options

Configurable mandatory Options attribute

uint8_t enhanced_color_mode

Configurable mandatory EnhancedColorMode attribute

uint16_t color_capabilities

Configurable mandatory ColorCapabilities attribute

uint8_t number_of_primaries

Configurable mandatory NumberOfPrimaries attribute

5.2.6.3.3.1.4. Macros

EZB_ZCL_COLOR_CONTROL_CLUSTER_REVISION

Cluster Revision of the color_control cluster implementation.

EZB_ZCL_COLOR_CONTROL_CURRENT_HUE_DEFAULT_VALUE

Default value of CurrentHue in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_CURRENT_HUE_MIN_VALUE

Minimum value of CurrentHue in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_CURRENT_HUE_MAX_VALUE

Maximum value of CurrentHue in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_CURRENT_SATURATION_DEFAULT_VALUE

Default value of CurrentSaturation in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_CURRENT_SATURATION_MIN_VALUE

Minimum value of CurrentSaturation in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_CURRENT_SATURATION_MAX_VALUE

Maximum value of CurrentSaturation in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_REMAINING_TIME_DEFAULT_VALUE

Default value of RemainingTime in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_REMAINING_TIME_MIN_VALUE

Minimum value of RemainingTime in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_REMAINING_TIME_MAX_VALUE

Maximum value of RemainingTime in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_CURRENT_X_DEFAULT_VALUE

Default value of CurrentX in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_CURRENT_X_MIN_VALUE

Minimum value of CurrentX in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_CURRENT_X_MAX_VALUE

Maximum value of CurrentX in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_CURRENT_Y_DEFAULT_VALUE

Default value of CurrentY in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_CURRENT_Y_MIN_VALUE

Minimum value of CurrentY in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_CURRENT_Y_MAX_VALUE

Maximum value of CurrentY in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_DRIFT_COMPENSATION_MIN_VALUE

Minimum value of DriftCompensation in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_DRIFT_COMPENSATION_MAX_VALUE

Maximum value of DriftCompensation in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_TEMPERATURE_MIREDS_DEFAULT_VALUE

Default value of ColorTemperatureMireds in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_TEMPERATURE_MIREDS_MIN_VALUE

Minimum value of ColorTemperatureMireds in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_TEMPERATURE_MIREDS_MAX_VALUE

Maximum value of ColorTemperatureMireds in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_MODE_DEFAULT_VALUE

Default value of ColorMode in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_MODE_MIN_VALUE

Minimum value of ColorMode in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_MODE_MAX_VALUE

Maximum value of ColorMode in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_OPTIONS_DEFAULT_VALUE

Default value of Options in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_ENHANCED_CURRENT_HUE_DEFAULT_VALUE

Default value of EnhancedCurrentHue in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_ENHANCED_CURRENT_HUE_MIN_VALUE

Minimum value of EnhancedCurrentHue in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_ENHANCED_CURRENT_HUE_MAX_VALUE

Maximum value of EnhancedCurrentHue in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_ENHANCED_COLOR_MODE_DEFAULT_VALUE

Default value of EnhancedColorMode in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_ENHANCED_COLOR_MODE_MIN_VALUE

Minimum value of EnhancedColorMode in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_ENHANCED_COLOR_MODE_MAX_VALUE

Maximum value of EnhancedColorMode in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_LOOP_ACTIVE_DEFAULT_VALUE

Default value of ColorLoopActive in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_LOOP_ACTIVE_MIN_VALUE

Minimum value of ColorLoopActive in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_LOOP_ACTIVE_MAX_VALUE

Maximum value of ColorLoopActive in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_LOOP_DIRECTION_DEFAULT_VALUE

Default value of ColorLoopDirection in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_LOOP_DIRECTION_MIN_VALUE

Minimum value of ColorLoopDirection in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_LOOP_DIRECTION_MAX_VALUE

Maximum value of ColorLoopDirection in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_LOOP_TIME_DEFAULT_VALUE

Default value of ColorLoopTime in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_LOOP_TIME_MIN_VALUE

Minimum value of ColorLoopTime in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_LOOP_TIME_MAX_VALUE

Maximum value of ColorLoopTime in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_LOOP_START_ENHANCED_HUE_DEFAULT_VALUE

Default value of ColorLoopStartEnhancedHue in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_LOOP_START_ENHANCED_HUE_MIN_VALUE

Minimum value of ColorLoopStartEnhancedHue in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_LOOP_START_ENHANCED_HUE_MAX_VALUE

Maximum value of ColorLoopStartEnhancedHue in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_LOOP_STORED_ENHANCED_HUE_DEFAULT_VALUE

Default value of ColorLoopStoredEnhancedHue in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_LOOP_STORED_ENHANCED_HUE_MIN_VALUE

Minimum value of ColorLoopStoredEnhancedHue in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_LOOP_STORED_ENHANCED_HUE_MAX_VALUE

Maximum value of ColorLoopStoredEnhancedHue in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_CAPABILITIES_DEFAULT_VALUE

Default value of ColorCapabilities in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_CAPABILITIES_MIN_VALUE

Minimum value of ColorCapabilities in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_CAPABILITIES_MAX_VALUE

Maximum value of ColorCapabilities in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_TEMP_PHYSICAL_MIN_MIREDS_DEFAULT_VALUE

Default value of ColorTempPhysicalMinMireds in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_TEMP_PHYSICAL_MIN_MIREDS_MIN_VALUE

Minimum value of ColorTempPhysicalMinMireds in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_TEMP_PHYSICAL_MIN_MIREDS_MAX_VALUE

Maximum value of ColorTempPhysicalMinMireds in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_TEMP_PHYSICAL_MAX_MIREDS_DEFAULT_VALUE

Default value of ColorTempPhysicalMaxMireds in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_TEMP_PHYSICAL_MAX_MIREDS_MIN_VALUE

Minimum value of ColorTempPhysicalMaxMireds in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_TEMP_PHYSICAL_MAX_MIREDS_MAX_VALUE

Maximum value of ColorTempPhysicalMaxMireds in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COUPLE_COLOR_TEMP_TO_LEVEL_MIN_MIREDS_MIN_VALUE

Minimum value of CoupleColorTempToLevelMinMireds in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COUPLE_COLOR_TEMP_TO_LEVEL_MIN_MIREDS_MAX_VALUE

Maximum value of CoupleColorTempToLevelMinMireds in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_START_UP_COLOR_TEMPERATURE_MIREDS_MIN_VALUE

Minimum value of StartUpColorTemperatureMireds in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_START_UP_COLOR_TEMPERATURE_MIREDS_MAX_VALUE

Maximum value of StartUpColorTemperatureMireds in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_NUMBER_OF_PRIMARIES_MIN_VALUE

Minimum value of NumberOfPrimaries in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_NUMBER_OF_PRIMARIES_MAX_VALUE

Maximum value of NumberOfPrimaries in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_PRIMARY1_X_MIN_VALUE

Minimum value of Primary1X in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_PRIMARY1_X_MAX_VALUE

Maximum value of Primary1X in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_PRIMARY1_Y_MIN_VALUE

Minimum value of Primary1Y in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_PRIMARY1_Y_MAX_VALUE

Maximum value of Primary1Y in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_PRIMARY1_INTENSITY_MIN_VALUE

Minimum value of Primary1Intensity in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_PRIMARY1_INTENSITY_MAX_VALUE

Maximum value of Primary1Intensity in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_PRIMARY2_X_MIN_VALUE

Minimum value of Primary2X in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_PRIMARY2_X_MAX_VALUE

Maximum value of Primary2X in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_PRIMARY2_Y_MIN_VALUE

Minimum value of Primary2Y in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_PRIMARY2_Y_MAX_VALUE

Maximum value of Primary2Y in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_PRIMARY2_INTENSITY_MIN_VALUE

Minimum value of Primary2Intensity in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_PRIMARY2_INTENSITY_MAX_VALUE

Maximum value of Primary2Intensity in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_PRIMARY3_X_MIN_VALUE

Minimum value of Primary3X in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_PRIMARY3_X_MAX_VALUE

Maximum value of Primary3X in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_PRIMARY3_Y_MIN_VALUE

Minimum value of Primary3Y in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_PRIMARY3_Y_MAX_VALUE

Maximum value of Primary3Y in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_PRIMARY3_INTENSITY_MIN_VALUE

Minimum value of Primary3Intensity in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_PRIMARY3_INTENSITY_MAX_VALUE

Maximum value of Primary3Intensity in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_PRIMARY4_X_MIN_VALUE

Minimum value of Primary4X in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_PRIMARY4_X_MAX_VALUE

Maximum value of Primary4X in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_PRIMARY4_Y_MIN_VALUE

Minimum value of Primary4Y in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_PRIMARY4_Y_MAX_VALUE

Maximum value of Primary4Y in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_PRIMARY4_INTENSITY_MIN_VALUE

Minimum value of Primary4Intensity in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_PRIMARY4_INTENSITY_MAX_VALUE

Maximum value of Primary4Intensity in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_PRIMARY5_X_MIN_VALUE

Minimum value of Primary5X in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_PRIMARY5_X_MAX_VALUE

Maximum value of Primary5X in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_PRIMARY5_Y_MIN_VALUE

Minimum value of Primary5Y in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_PRIMARY5_Y_MAX_VALUE

Maximum value of Primary5Y in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_PRIMARY5_INTENSITY_MIN_VALUE

Minimum value of Primary5Intensity in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_PRIMARY5_INTENSITY_MAX_VALUE

Maximum value of Primary5Intensity in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_PRIMARY6_X_MIN_VALUE

Minimum value of Primary6X in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_PRIMARY6_X_MAX_VALUE

Maximum value of Primary6X in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_PRIMARY6_Y_MIN_VALUE

Minimum value of Primary6Y in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_PRIMARY6_Y_MAX_VALUE

Maximum value of Primary6Y in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_PRIMARY6_INTENSITY_MIN_VALUE

Minimum value of Primary6Intensity in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_PRIMARY6_INTENSITY_MAX_VALUE

Maximum value of Primary6Intensity in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_WHITE_POINT_X_DEFAULT_VALUE

Default value of WhitePointX in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_WHITE_POINT_X_MIN_VALUE

Minimum value of WhitePointX in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_WHITE_POINT_X_MAX_VALUE

Maximum value of WhitePointX in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_WHITE_POINT_Y_MIN_VALUE

Minimum value of WhitePointY in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_WHITE_POINT_Y_MAX_VALUE

Maximum value of WhitePointY in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_POINT_RX_MIN_VALUE

Minimum value of ColorPointRX in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_POINT_RX_MAX_VALUE

Maximum value of ColorPointRX in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_POINT_RY_MIN_VALUE

Minimum value of ColorPointRY in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_POINT_RY_MAX_VALUE

Maximum value of ColorPointRY in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_POINT_R_INTENSITY_MIN_VALUE

Minimum value of ColorPointRIntensity in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_POINT_R_INTENSITY_MAX_VALUE

Maximum value of ColorPointRIntensity in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_POINT_GX_MIN_VALUE

Minimum value of ColorPointGX in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_POINT_GX_MAX_VALUE

Maximum value of ColorPointGX in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_POINT_GY_MIN_VALUE

Minimum value of ColorPointGY in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_POINT_GY_MAX_VALUE

Maximum value of ColorPointGY in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_POINT_G_INTENSITY_MIN_VALUE

Minimum value of ColorPointGIntensity in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_POINT_G_INTENSITY_MAX_VALUE

Maximum value of ColorPointGIntensity in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_POINT_BX_MIN_VALUE

Minimum value of ColorPointBX in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_POINT_BX_MAX_VALUE

Maximum value of ColorPointBX in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_POINT_BY_MIN_VALUE

Minimum value of ColorPointBY in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_POINT_BY_MAX_VALUE

Maximum value of ColorPointBY in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_POINT_B_INTENSITY_MIN_VALUE

Minimum value of ColorPointBIntensity in ColorControl cluster.

EZB_ZCL_COLOR_CONTROL_COLOR_POINT_B_INTENSITY_MAX_VALUE

Maximum value of ColorPointBIntensity in ColorControl cluster.

EZB_ZCL_CLUSTER_ID_COLOR_CONTROL_CLIENT_ROLE_INIT
EZB_ZCL_CLUSTER_ID_COLOR_CONTROL_SERVER_ROLE_INIT

5.2.6.3.3.1.5. Type Definitions

typedef struct ezb_zcl_color_control_cluster_server_config_s ezb_zcl_color_control_cluster_server_config_t

Configuration mandatory attributes for the ColorControl server cluster.

typedef ezb_zcl_color_control_cluster_server_config_t ezb_zcl_color_control_cluster_config_t

5.2.6.3.3.1.6. Enumerations

enum ezb_zcl_color_control_server_attr_t

Attribute identifiers for the color_control server cluster.

Values:

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_CURRENT_HUE_ID

CurrentHue attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_CURRENT_SATURATION_ID

CurrentSaturation attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_REMAINING_TIME_ID

RemainingTime attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_CURRENT_X_ID

CurrentX attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_CURRENT_Y_ID

CurrentY attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_DRIFT_COMPENSATION_ID

DriftCompensation attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_COMPENSATION_TEXT_ID

CompensationText attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_COLOR_TEMPERATURE_MIREDS_ID

ColorTemperatureMireds attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_COLOR_MODE_ID

ColorMode attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_OPTIONS_ID

Options attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_ENHANCED_CURRENT_HUE_ID

EnhancedCurrentHue attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_ENHANCED_COLOR_MODE_ID

EnhancedColorMode attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_COLOR_LOOP_ACTIVE_ID

ColorLoopActive attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_COLOR_LOOP_DIRECTION_ID

ColorLoopDirection attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_COLOR_LOOP_TIME_ID

ColorLoopTime attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_COLOR_LOOP_START_ENHANCED_HUE_ID

ColorLoopStartEnhancedHue attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_COLOR_LOOP_STORED_ENHANCED_HUE_ID

ColorLoopStoredEnhancedHue attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_COLOR_CAPABILITIES_ID

ColorCapabilities attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_COLOR_TEMP_PHYSICAL_MIN_MIREDS_ID

ColorTempPhysicalMinMireds attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_COLOR_TEMP_PHYSICAL_MAX_MIREDS_ID

ColorTempPhysicalMaxMireds attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_COUPLE_COLOR_TEMP_TO_LEVEL_MIN_MIREDS_ID

CoupleColorTempToLevelMinMireds attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_START_UP_COLOR_TEMPERATURE_MIREDS_ID

StartUpColorTemperatureMireds attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_NUMBER_OF_PRIMARIES_ID

NumberOfPrimaries attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_PRIMARY1_X_ID

Primary1X attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_PRIMARY1_Y_ID

Primary1Y attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_PRIMARY1_INTENSITY_ID

Primary1Intensity attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_PRIMARY2_X_ID

Primary2X attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_PRIMARY2_Y_ID

Primary2Y attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_PRIMARY2_INTENSITY_ID

Primary2Intensity attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_PRIMARY3_X_ID

Primary3X attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_PRIMARY3_Y_ID

Primary3Y attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_PRIMARY3_INTENSITY_ID

Primary3Intensity attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_PRIMARY4_X_ID

Primary4X attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_PRIMARY4_Y_ID

Primary4Y attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_PRIMARY4_INTENSITY_ID

Primary4Intensity attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_PRIMARY5_X_ID

Primary5X attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_PRIMARY5_Y_ID

Primary5Y attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_PRIMARY5_INTENSITY_ID

Primary5Intensity attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_PRIMARY6_X_ID

Primary6X attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_PRIMARY6_Y_ID

Primary6Y attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_PRIMARY6_INTENSITY_ID

Primary6Intensity attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_WHITE_POINT_X_ID

WhitePointX attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_WHITE_POINT_Y_ID

WhitePointY attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_COLOR_POINT_RX_ID

ColorPointRX attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_COLOR_POINT_RY_ID

ColorPointRY attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_COLOR_POINT_R_INTENSITY_ID

ColorPointRIntensity attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_COLOR_POINT_GX_ID

ColorPointGX attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_COLOR_POINT_GY_ID

ColorPointGY attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_COLOR_POINT_G_INTENSITY_ID

ColorPointGIntensity attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_COLOR_POINT_BX_ID

ColorPointBX attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_COLOR_POINT_BY_ID

ColorPointBY attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_COLOR_POINT_B_INTENSITY_ID

ColorPointBIntensity attribute.

enumerator EZB_ZCL_ATTR_COLOR_CONTROL_CVC_CONTEXT_ID

CVCContext attribute.

enum ezb_zcl_color_control_server_drift_compensation_t

Enumeration for ZCL DriftCompensation attribute of ColorControl.

Values:

enumerator EZB_ZCL_COLOR_CONTROL_DRIFT_COMPENSATION_NONE

None

enumerator EZB_ZCL_COLOR_CONTROL_DRIFT_COMPENSATION_OTHER_OR_UNKNOWN

OtherOrUnknown

enumerator EZB_ZCL_COLOR_CONTROL_DRIFT_COMPENSATION_TEMPERATURE_MONITORING

TemperatureMonitoring

enumerator EZB_ZCL_COLOR_CONTROL_DRIFT_COMPENSATION_OPTICAL_LUMINANCE_MONITORING_AND_FEEDBACK

OpticalLuminanceMonitoringAndFeedback

enumerator EZB_ZCL_COLOR_CONTROL_DRIFT_COMPENSATION_OPTICAL_COLOR_MONITORING_AND_FEEDBACK

OpticalColorMonitoringAndFeedback

enum ezb_zcl_color_control_server_color_mode_t

Enumeration for ZCL ColorMode attribute of ColorControl.

Values:

enumerator EZB_ZCL_COLOR_CONTROL_COLOR_MODE_CURRENT_HUE_AND_CURRENT_SATURATION

CurrentHueAndCurrentSaturation

enumerator EZB_ZCL_COLOR_CONTROL_COLOR_MODE_CURRENT_X_AND_CURRENT_Y

CurrentXAndCurrentY

enumerator EZB_ZCL_COLOR_CONTROL_COLOR_MODE_COLOR_TEMPERATURE_MIREDS

ColorTemperatureMireds

enum ezb_zcl_color_control_server_enhanced_color_mode_t

Enumeration for ZCL EnhancedColorMode attribute of ColorControl.

Values:

enumerator EZB_ZCL_COLOR_CONTROL_ENHANCED_COLOR_MODE_CURRENT_HUE_AND_CURRENT_SATURATION

CurrentHueAndCurrentSaturation

enumerator EZB_ZCL_COLOR_CONTROL_ENHANCED_COLOR_MODE_CURRENT_X_AND_CURRENT_Y

CurrentXAndCurrentY

enumerator EZB_ZCL_COLOR_CONTROL_ENHANCED_COLOR_MODE_COLOR_TEMPERATURE_MIREDS

ColorTemperatureMireds

enumerator EZB_ZCL_COLOR_CONTROL_ENHANCED_COLOR_MODE_ENHANCED_CURRENT_HUE_AND_CURRENT_SATURATION

EnhancedCurrentHueAndCurrentSaturation

enum ezb_zcl_color_control_server_color_loop_active_t

Enumeration for ZCL ColorLoopActive attribute of ColorControl.

Values:

enumerator EZB_ZCL_COLOR_CONTROL_COLOR_LOOP_ACTIVE_COLOR_LOOP_INACTIVE

ColorLoopInactive

enumerator EZB_ZCL_COLOR_CONTROL_COLOR_LOOP_ACTIVE_COLOR_LOOP_ACTIVE

ColorLoopActive

enum ezb_zcl_color_control_server_color_capabilities_t

Bitmap for ZCL ColorCapabilities attribute of ColorControl.

Values:

enumerator EZB_ZCL_COLOR_CONTROL_COLOR_CAPABILITIES_HUE_SATURATION_SUPPORTED

HueSaturationSupported

enumerator EZB_ZCL_COLOR_CONTROL_COLOR_CAPABILITIES_ENHANCED_HUE_SUPPORTED

EnhancedHueSupported

enumerator EZB_ZCL_COLOR_CONTROL_COLOR_CAPABILITIES_COLOR_LOOP_SUPPORTED

ColorLoopSupported

enumerator EZB_ZCL_COLOR_CONTROL_COLOR_CAPABILITIES_XY_SUPPORTED

XYSupported

enumerator EZB_ZCL_COLOR_CONTROL_COLOR_CAPABILITIES_COLOR_TEMPERATURE_SUPPORTED

ColorTemperatureSupported

enum ezb_zcl_color_control_server_cmd_id_t

Received Command identifiers for the ColorControl cluster.

Values:

enumerator EZB_ZCL_CMD_COLOR_CONTROL_MOVE_TO_HUE_ID

MoveToHue command.

enumerator EZB_ZCL_CMD_COLOR_CONTROL_MOVE_HUE_ID

MoveHue command.

enumerator EZB_ZCL_CMD_COLOR_CONTROL_STEP_HUE_ID

StepHue command.

enumerator EZB_ZCL_CMD_COLOR_CONTROL_MOVE_TO_SATURATION_ID

MoveToSaturation command.

enumerator EZB_ZCL_CMD_COLOR_CONTROL_MOVE_SATURATION_ID

MoveSaturation command.

enumerator EZB_ZCL_CMD_COLOR_CONTROL_STEP_SATURATION_ID

StepSaturation command.

enumerator EZB_ZCL_CMD_COLOR_CONTROL_MOVE_TO_HUE_AND_SATURATION_ID

MoveToHueAndSaturation command.

enumerator EZB_ZCL_CMD_COLOR_CONTROL_MOVE_TO_COLOR_ID

MoveToColor command.

enumerator EZB_ZCL_CMD_COLOR_CONTROL_MOVE_COLOR_ID

MoveColor command.

enumerator EZB_ZCL_CMD_COLOR_CONTROL_STEP_COLOR_ID

StepColor command.

enumerator EZB_ZCL_CMD_COLOR_CONTROL_MOVE_TO_COLOR_TEMPERATURE_ID

MoveToColorTemperature command.

enumerator EZB_ZCL_CMD_COLOR_CONTROL_ENHANCED_MOVE_TO_HUE_ID

EnhancedMoveToHue command.

enumerator EZB_ZCL_CMD_COLOR_CONTROL_ENHANCED_MOVE_HUE_ID

EnhancedMoveHue command.

enumerator EZB_ZCL_CMD_COLOR_CONTROL_ENHANCED_STEP_HUE_ID

EnhancedStepHue command.

enumerator EZB_ZCL_CMD_COLOR_CONTROL_ENHANCED_MOVE_TO_HUE_AND_SATURATION_ID

EnhancedMoveToHueAndSaturation command.

enumerator EZB_ZCL_CMD_COLOR_CONTROL_COLOR_LOOP_SET_ID

ColorLoopSet command.

enumerator EZB_ZCL_CMD_COLOR_CONTROL_STOP_MOVE_STEP_ID

StopMoveStep command.

enumerator EZB_ZCL_CMD_COLOR_CONTROL_MOVE_COLOR_TEMPERATURE_ID

MoveColorTemperature command.

enumerator EZB_ZCL_CMD_COLOR_CONTROL_STEP_COLOR_TEMPERATURE_ID

StepColorTemperature command.

5.2.6.3.3.1.7. Header File

5.2.6.3.3.1.8. Functions

ezb_err_t ezb_zcl_color_control_move_to_hue_cmd_req(const ezb_zcl_color_control_move_to_hue_cmd_t *cmd_req)

Send ZCL Color Control MoveToHue command request.

Parameters:

cmd_req -- Pointer to the MoveToHue command request structure, ezb_zcl_color_control_move_to_hue_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_color_control_enhanced_move_to_hue_cmd_req(const ezb_zcl_color_control_enhanced_move_to_hue_cmd_t *cmd_req)

Send ZCL Color Control EnhancedMoveToHue command request.

Parameters:

cmd_req -- Pointer to the EnhancedMoveToHue command request structure, ezb_zcl_color_control_enhanced_move_to_hue_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_color_control_move_hue_cmd_req(const ezb_zcl_color_control_move_hue_cmd_t *cmd_req)

Send ZCL Color Control MoveHue command request.

Parameters:

cmd_req -- Pointer to the MoveHue command request structure, ezb_zcl_color_control_move_hue_cmd_t.

Returns:

Error code.

ezb_err_t ezb_zcl_color_control_enhanced_move_hue_cmd_req(const ezb_zcl_color_control_enhanced_move_hue_cmd_t *cmd_req)

Send ZCL Color Control EnhancedMoveHue command request.

Parameters:

cmd_req -- Pointer to the EnhancedMoveHue command request structure, ezb_zcl_color_control_enhanced_move_hue_cmd_t.

Returns:

Error code.

ezb_err_t ezb_zcl_color_control_step_hue_cmd_req(const ezb_zcl_color_control_step_hue_cmd_t *cmd_req)

Send ZCL Color Control StepHue command request.

Parameters:

cmd_req -- Pointer to the StepHue command request structure, ezb_zcl_color_control_step_hue_cmd_t.

Returns:

Error code.

ezb_err_t ezb_zcl_color_control_enhanced_step_hue_cmd_req(const ezb_zcl_color_control_enhanced_step_hue_cmd_t *cmd_req)

Send ZCL Color Control EnhancedStepHue command request.

Parameters:

cmd_req -- Pointer to the EnhancedStepHue command request structure, ezb_zcl_color_control_enhanced_step_hue_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_color_control_move_to_saturation_cmd_req(const ezb_zcl_color_control_move_to_saturation_cmd_t *cmd_req)

Send ZCL Color Control MoveToSaturation command request.

Parameters:

cmd_req -- Pointer to the MoveToSaturation command request structure, ezb_zcl_color_control_move_to_saturation_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_color_control_move_saturation_cmd_req(const ezb_zcl_color_control_move_saturation_cmd_t *cmd_req)

Send ZCL Color Control MoveSaturation command request.

Parameters:

cmd_req -- Pointer to the MoveSaturation command request structure, ezb_zcl_color_control_move_saturation_cmd_t.

Returns:

Error code.

ezb_err_t ezb_zcl_color_control_step_saturation_cmd_req(const ezb_zcl_color_control_step_saturation_cmd_t *cmd_req)

Send ZCL Color Control StepSaturation command request.

Parameters:

cmd_req -- Pointer to the StepSaturation command request structure, ezb_zcl_color_control_step_saturation_cmd_t.

Returns:

Error code.

ezb_err_t ezb_zcl_color_control_move_to_hue_and_saturation_cmd_req(const ezb_zcl_color_control_move_to_hue_and_saturation_cmd_t *cmd_req)

Send ZCL Color Control MoveToHueAndSaturation command request.

Parameters:

cmd_req -- Pointer to the MoveToHueAndSaturation command request structure, ezb_zcl_color_control_move_to_hue_and_saturation_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_color_control_enhanced_move_to_hue_and_saturation_cmd_req(const ezb_zcl_color_control_enhanced_move_to_hue_and_saturation_cmd_t *cmd_req)

Send ZCL Color Control EnhancedMoveToHueAndSaturation command request.

Parameters:

cmd_req -- Pointer to the EnhancedMoveToHueAndSaturation command request structure, ezb_zcl_color_control_enhanced_move_to_hue_and_saturation_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_color_control_move_to_color_cmd_req(const ezb_zcl_color_control_move_to_color_cmd_t *cmd_req)

Send ZCL Color Control MoveToColor command request.

Parameters:

cmd_req -- Pointer to the MoveToColor command request structure, ezb_zcl_color_control_move_to_color_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_color_control_move_color_cmd_req(const ezb_zcl_color_control_move_color_cmd_t *cmd_req)

Send ZCL Color Control MoveColor command request.

Parameters:

cmd_req -- Pointer to the MoveColor command request structure, ezb_zcl_color_control_move_color_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_color_control_step_color_cmd_req(const ezb_zcl_color_control_step_color_cmd_t *cmd_req)

Send ZCL Color Control StepColor command request.

Parameters:

cmd_req -- Pointer to the StepColor command request structure, ezb_zcl_color_control_step_color_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_color_control_move_to_color_temperature_cmd_req(const ezb_zcl_color_control_move_to_color_temperature_cmd_t *cmd_req)

Send ZCL Color Control MoveToColorTemperature command request.

Parameters:

cmd_req -- Pointer to the MoveToColorTemperature command request structure, ezb_zcl_color_control_move_to_color_temperature_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_color_control_move_color_temperature_cmd_req(const ezb_zcl_color_control_move_color_temperature_cmd_t *cmd_req)

Send ZCL Color Control MoveColorTemperature command request.

Parameters:

cmd_req -- Pointer to the MoveColorTemperature command request structure, ezb_zcl_color_control_move_color_temperature_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_color_control_step_color_temperature_cmd_req(const ezb_zcl_color_control_step_color_temperature_cmd_t *cmd_req)

Send ZCL Color Control StepColorTemperature command request.

Parameters:

cmd_req -- Pointer to the StepColorTemperature command request structure, ezb_zcl_color_control_step_color_temperature_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_color_control_stop_move_step_cmd_req(const ezb_zcl_color_control_stop_move_step_cmd_t *cmd_req)

Send ZCL Color Control StopMoveStep command request.

Parameters:

cmd_req -- Pointer to the StopMoveStep command request structure, ezb_zcl_color_control_stop_move_step_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_color_control_color_loop_set_cmd_req(const ezb_zcl_color_control_color_loop_set_cmd_t *cmd_req)

Send ZCL Color Control ColorLoopSet command request.

Parameters:

cmd_req -- Pointer to the ColorLoopSet command request structure, ezb_zcl_color_control_color_loop_set_cmd_s.

Returns:

Error code.

5.2.6.3.3.1.9. Structures

struct ezb_zcl_color_control_move_to_hue_cmd_payload_t

Payload for the ZCL Color Control MoveToHue command.

Public Members

uint8_t hue

The Hue field specifies the hue to be moved to.

uint8_t direction

The Direction field, see ezb_zcl_color_control_move_to_hue_direction_t

uint16_t transition_time

The Transition Time field specifies, in 1/10ths of a second, the time that SHALL be taken to move to the new hue.

uint8_t options_mask

Bits of Options attribute to check.

uint8_t options_override

Values to override for those bits.

struct ezb_zcl_color_control_move_to_hue_cmd_s

Structure for the MovetoHue command request of ZCL ColorControl cluster.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

ezb_zcl_color_control_move_to_hue_cmd_payload_t payload

Payload of the command.

struct ezb_zcl_color_control_enhanced_move_to_hue_cmd_payload_t

Payload for the ZCL Color Control EnhancedMoveToHue command.

Public Members

uint16_t enhanced_hue

Target enhanced hue.

uint8_t direction

Direction. see ezb_zcl_color_control_move_to_hue_direction_t

uint16_t transition_time

Time to reach the new hue, in 1/10 s.

uint8_t options_mask

Bits of Options attribute to check.

uint8_t options_override

Values to override for those bits.

struct ezb_zcl_color_control_enhanced_move_to_hue_cmd_s

Structure for the ZCL Color Control EnhancedMoveToHue command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

ezb_zcl_color_control_enhanced_move_to_hue_cmd_payload_t payload

The payload field

struct ezb_zcl_color_control_move_to_hue_and_saturation_cmd_payload_t

Payload for the ZCL Color Control MoveToHueAndSaturation command.

Public Members

uint8_t hue

The Hue field specifies the hue to be moved to.

uint8_t saturation

The Saturation field specifies the saturation to be moved to.

uint16_t transition_time

The Transition Time field specifies, in 1/10ths of a second, the time that SHALL be taken to move to the new value.

uint8_t options_mask

Bits of Options attribute to check.

uint8_t options_override

Values to override for those bits.

struct ezb_zcl_color_control_move_to_hue_and_saturation_cmd_s

Structure for the MovetoHueSaturation command request of ZCL ColorControl cluster.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

ezb_zcl_color_control_move_to_hue_and_saturation_cmd_payload_t payload

The payload field

struct ezb_zcl_color_control_enhanced_move_to_hue_and_saturation_cmd_payload_t

Payload for the ZCL Color Control EnhancedMoveToHueAndSaturation command.

Public Members

uint16_t enhanced_hue

Target enhanced hue.

uint8_t saturation

Target saturation.

uint16_t transition_time

Time to reach the new value, in 1/10 s.

uint8_t options_mask

Bits of Options attribute to check.

uint8_t options_override

Values to override for those bits.

struct ezb_zcl_color_control_enhanced_move_to_hue_and_saturation_cmd_s

Structure for the EnhancedMovetoHueSaturation command request of ZCL ColorControl cluster.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

ezb_zcl_color_control_enhanced_move_to_hue_and_saturation_cmd_payload_t payload

Payload of the command.

struct ezb_zcl_color_control_move_hs_cmd_payload_t

Payload for the ZCL Color Control Move Hue/Saturation command.

Public Members

uint8_t move_mode

Direction of movement: up, down, or stop. see ezb_zcl_color_control_move_mode_t

uint8_t rate

The Rate field specifies the rate of movement in steps per second.

uint8_t options_mask

Bits of Options attribute to check.

uint8_t options_override

Values to override for those bits.

struct ezb_zcl_color_control_move_hs_cmd_t

Structure for the Move HueOrSaturation command request of ZCL ColorControl cluster.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

ezb_zcl_color_control_move_hs_cmd_payload_t payload

The payload field, see ezb_zcl_color_control_move_hs_cmd_payload_t

struct ezb_zcl_color_control_enhanced_move_hue_cmd_payload_t

Payload for the ZCL Color Control EnhancedMoveHue command.

Public Members

uint8_t move_mode

Move mode. see ezb_zcl_color_control_move_mode_t

uint16_t rate

Rate of movement in steps per second.

uint8_t options_mask

Bits of Options attribute to check.

uint8_t options_override

Values to override for those bits.

struct ezb_zcl_color_control_enhanced_move_hue_cmd_t

Structure for ZCL Color Control EnhancedMoveHue command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

ezb_zcl_color_control_enhanced_move_hue_cmd_payload_t payload

The payload field

struct ezb_zcl_color_control_step_hs_cmd_payload_t

Structure for the format of the Step HueOrSaturation Command Payload.

Public Members

uint8_t step_mode

The Step Mode field, see ezb_zcl_color_control_step_mode_t

uint8_t step_size

The change to be added to (or subtracted from) the current value of the device’s value.

uint16_t transition_time

The Transition Time field specifies, in 1/10ths of a second, the time that SHALL be taken to perform the step.

uint8_t options_mask

Bits of Options attribute to check.

uint8_t options_override

Values to override for those bits.

struct ezb_zcl_color_control_step_hs_cmd_s

Structure for the ZCL Color Control Step Hue/Saturation command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

ezb_zcl_color_control_step_hs_cmd_payload_t payload

The payload field, see ezb_zcl_color_control_step_hs_cmd_payload_t

struct ezb_zcl_color_control_enhanced_step_hue_cmd_payload_t

Payload for the ZCL Color Control EnhancedStepHue command.

Public Members

uint8_t step_mode

The Step Mode field, see ezb_zcl_color_control_step_mode_t

uint16_t step_size

The change to be added to (or subtracted from) the current value of the device’s enhanced hue.

uint16_t transition_time

The Transition Time field specifies, in 1/10ths of a second, the time that SHALL be taken to perform the step.

uint8_t options_mask

Bits of Options attribute to check.

uint8_t options_override

Values to override for those bits.

struct ezb_zcl_color_control_enhanced_step_hue_cmd_s

Structure for ZCL Color Control EnhancedStepHue command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

ezb_zcl_color_control_enhanced_step_hue_cmd_payload_t payload

The payload field

struct ezb_zcl_color_control_move_to_saturation_cmd_payload_t

Payload for the ZCL Color Control MoveToSaturation command.

Public Members

uint8_t saturation

The saturation field specifies the saturation to be moved to.

uint16_t transition_time

The Transition Time field specifies, in 1/10ths of a second, the time that SHALL be taken to move to the new hue.

uint8_t options_mask

Bits of Options attribute to check.

uint8_t options_override

Values to override for those bits.

struct ezb_zcl_color_control_move_to_saturation_cmd_s

Structure for ZCL Color Control MoveToSaturation command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

ezb_zcl_color_control_move_to_saturation_cmd_payload_t payload

The payload field

struct ezb_zcl_color_control_move_to_color_cmd_payload_t

Payload for the ZCL Color Control MoveToColor command.

Public Members

uint16_t color_x

The color x field specifies the color x to be moved to.

uint16_t color_y

The color y field specifies the color y to be moved to.

uint16_t transition_time

The Transition Time field specifies, in 1/10ths of a second, the time that SHALL be taken to move to the color space.

uint8_t options_mask

Bits of Options attribute to check.

uint8_t options_override

Values to override for those bits.

struct ezb_zcl_color_control_move_to_color_cmd_s

Structure for the MoveColor command request of ZCL ColorControl cluster.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

ezb_zcl_color_control_move_to_color_cmd_payload_t payload

The payload field

struct ezb_zcl_color_control_move_color_cmd_payload_t

Payload for the ZCL Color Control MoveColor command.

Public Members

uint16_t rate_x

The RateX field specifies the rate of movement in steps per second.

uint16_t rate_y

The RateY field specifies the rate of movement in steps per second.

uint8_t options_mask

The Options Mask field specifies which bits of the EZB_ZCL_ATTR_COLOR_CONTROL_OPTIONS_ID attribute on the server should be checked.

uint8_t options_override

The Options Override field specifies which bits indicated by options_mask should be overwritten in the EZB_ZCL_ATTR_COLOR_CONTROL_OPTIONS_ID attribute of the server.

struct ezb_zcl_color_control_move_color_cmd_s

Structure for the MoveColor command request of ZCL ColorControl cluster.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

ezb_zcl_color_control_move_color_cmd_payload_t payload

The payload field

struct ezb_zcl_color_control_step_color_cmd_payload_t

Payload for the ZCL Color Control StepColor command.

Public Members

uint8_t step_x

The StepX fields specify the change to be added to the device's CurrentX attribute.

uint8_t step_y

The StepY fields specify the change to be added to the device's CurrentYu attribute.

uint16_t transition_time

The Transition Time field specifies, in 1/10ths of a second, the time that SHALL be taken to perform the step.

uint8_t options_mask

Bits of Options attribute to check.

uint8_t options_override

Values to override for those bits.

struct ezb_zcl_color_control_step_color_cmd_s

Structure for the StepColor command request of ZCL ColorControl cluster.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

ezb_zcl_color_control_step_color_cmd_payload_t payload

The payload field

struct ezb_zcl_color_control_move_to_color_temperature_cmd_payload_t

Payload for the ZCL Color Control MoveToColorTemperature command.

Public Members

uint16_t color_temperature_mireds

The color temperature field specifies the color x to be moved to.

uint16_t transition_time

The Transition Time field specifies, in 1/10ths of a second, the time that SHALL be taken to move to the color space.

uint8_t options_mask

Bits of Options attribute to check.

uint8_t options_override

Values to override for those bits.

struct ezb_zcl_color_control_move_to_color_temperature_cmd_s

Structure for the MovetoColorTemperature command request of ZCL ColorControl cluster.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

ezb_zcl_color_control_move_to_color_temperature_cmd_payload_t payload

The payload field

struct ezb_zcl_color_control_move_color_temperature_cmd_payload_t

Payload for the ZCL Color Control MoveColorTemperature command.

Public Members

uint8_t move_mode

Up (increase mireds) or down (decrease). see ezb_zcl_color_control_move_mode_t

uint16_t rate

Rate of movement in steps per second.

uint16_t color_temperature_min_mireds

The Color Temperature Minimum Mireds field is 16-bits in length and specifies a lower bound on the ColorTemperatureMireds attribute.

uint16_t color_temperature_max_mireds

The Color Temperature Maximum Mireds field is 16-bits in length and specifies an upper bound on the ColorTemperatureMireds attribute.

uint8_t options_mask

Bits of Options attribute to check.

uint8_t options_override

Values to override for those bits.

struct ezb_zcl_color_control_move_color_temperature_cmd_s

Structure for the MoveColorTemperature command request of ZCL ColorControl cluster.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

ezb_zcl_color_control_move_color_temperature_cmd_payload_t payload

The payload field

struct ezb_zcl_color_control_step_color_temperature_cmd_payload_t

Payload for the ZCL Color Control StepColorTemperature command.

Public Members

uint8_t step_mode

Up or down. see ezb_zcl_color_control_step_mode_t

uint16_t step_size

Change in ColorTemperatureMireds to add or subtract.

uint16_t color_temperature_min_mireds

The Color Temperature Minimum Mireds field is 16-bits in length and specifies a lower bound on the ColorTemperatureMireds attribute.

uint16_t color_temperature_max_mireds

The Color Temperature Maximum Mireds field is 16-bits in length and specifies an upper bound on the ColorTemperatureMireds attribute.

uint16_t transition_time

The Transition Time field specifies, in 1/10ths of a second, the time that SHALL be taken to perform the step.

uint8_t options_mask

Bits of Options attribute to check.

uint8_t options_override

Values to override for those bits.

struct ezb_zcl_color_control_step_color_temperature_cmd_s

Structure for the StepColorTemperature command request of ZCL ColorControl cluster.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

ezb_zcl_color_control_step_color_temperature_cmd_payload_t payload

Payload of the command.

struct ezb_zcl_color_control_stop_move_step_cmd_payload_t

Payload for the ZCL Color Control StopMoveStep command.

Public Members

uint8_t options_mask

Bits of Options attribute to check.

uint8_t options_override

Values to override for those bits.

struct ezb_zcl_color_control_stop_move_step_cmd_s

Structure for the ZCL Color Control StopMoveStep command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

ezb_zcl_color_control_stop_move_step_cmd_payload_t payload

The payload field

struct ezb_zcl_color_control_color_loop_set_cmd_payload_t

Structure for the format of the ColorLoopSet Command Payload.

Public Members

uint8_t update_flags

The Update Flags field specifies which color loop attributes to update before the color loop is started.

uint8_t action

The Action field specifies the action to take for the color loop if the Update Action sub-field of the Update Flags field is set to 1.

uint8_t direction

The Direction field specifies the direction for the color loop if the Update Direction field of the Update Flags field is set to 1.

uint16_t time

The Time field specifies the number of seconds over which to perform a full color loop if the Update Time field of the Update Flags field is set to 1.

uint16_t start_hue

The Start Hue field is 16 bits in length and specifies the starting hue to use for the color loop if the Update Start Hue field of the Update Flags field is set to 1.

uint8_t options_mask

The Options Mask field specifies which bits of the EZB_ZCL_ATTR_COLOR_CONTROL_OPTIONS_ID attribute on the server should be checked.

uint8_t options_override

The Options Override field specifies which bits indicated by options_mask should be overwritten in the EZB_ZCL_ATTR_COLOR_CONTROL_OPTIONS_ID attribute of the server.

struct ezb_zcl_color_control_color_loop_set_cmd_s

Structure for the ZCL Color Control ColorLoopSet command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

ezb_zcl_color_control_color_loop_set_cmd_payload_t payload

The payload field

struct ezb_zcl_color_control_color_t

Color value used in Color Control cluster callbacks (e.g. mode change).

The active member depends on mode: Hue/Saturation, xy (CurrentX/CurrentY), or color temperature.

Public Members

uint8_t mode

Current color mode; determines which union member is valid.

uint16_t enhanced_hue

Enhanced hue

uint8_t hue

Hue

uint8_t saturation

Saturation

uint16_t x

Color X

uint16_t y

Color Y

uint16_t color_temperature

Color temperature

union ezb_zcl_color_control_color_t

Color field

struct ezb_zcl_color_control_color_mode_change_message_s

Application message when Color Control server color mode changes.

Application may set out.result and out.color to influence the final color.

Public Members

ezb_zcl_message_info_t info

Common information for Zigbee device callback.

const ezb_zcl_cmd_hdr_t *header

ZCL command header information. See ezb_zcl_cmd_hdr_s.

uint8_t old_mode

The original color mode

uint8_t new_mode

The new color mode

struct ezb_zcl_color_control_color_mode_change_message_s in

Input: old mode and new mode

ezb_zcl_status_t result

Status of processing in application.

ezb_zcl_color_control_color_t color

If the result is EZB_ZCL_STATUS_SUCCESS, the color will be used to set the related color attribute.

struct ezb_zcl_color_control_color_mode_change_message_s out

Output: result to send back.

5.2.6.3.3.1.10. Type Definitions

typedef struct ezb_zcl_color_control_move_to_hue_cmd_s ezb_zcl_color_control_move_to_hue_cmd_t

Structure for the MovetoHue command request of ZCL ColorControl cluster.

typedef struct ezb_zcl_color_control_enhanced_move_to_hue_cmd_s ezb_zcl_color_control_enhanced_move_to_hue_cmd_t

Structure for the ZCL Color Control EnhancedMoveToHue command request.

typedef struct ezb_zcl_color_control_move_to_hue_and_saturation_cmd_s ezb_zcl_color_control_move_to_hue_and_saturation_cmd_t

Structure for the MovetoHueSaturation command request of ZCL ColorControl cluster.

typedef struct ezb_zcl_color_control_enhanced_move_to_hue_and_saturation_cmd_s ezb_zcl_color_control_enhanced_move_to_hue_and_saturation_cmd_t

Structure for the EnhancedMovetoHueSaturation command request of ZCL ColorControl cluster.

typedef ezb_zcl_color_control_move_hs_cmd_payload_t ezb_zcl_color_control_move_hue_cmd_payload_t

Payload for the ZCL Color Control MoveHue command. .

typedef ezb_zcl_color_control_move_hs_cmd_t ezb_zcl_color_control_move_hue_cmd_t

Structure for ZCL Color Control MoveHue command request. .

typedef struct ezb_zcl_color_control_step_hs_cmd_s ezb_zcl_color_control_step_hs_cmd_t

Structure for the ZCL Color Control Step Hue/Saturation command request.

typedef ezb_zcl_color_control_step_hs_cmd_payload_t ezb_zcl_color_control_step_hue_cmd_payload_t

Structure for the format of the StepHue Command Payload.

typedef ezb_zcl_color_control_step_hs_cmd_t ezb_zcl_color_control_step_hue_cmd_t

Structure for the ZCL Color Control StepHue command request. .

typedef ezb_zcl_color_control_step_hs_cmd_payload_t ezb_zcl_color_control_step_saturation_cmd_payload_t

Structure for the format of the StepSaturation Command Payload .

typedef ezb_zcl_color_control_step_hs_cmd_t ezb_zcl_color_control_step_saturation_cmd_t

Structure for the ZCL Color Control StepSaturation command request. .

typedef struct ezb_zcl_color_control_enhanced_step_hue_cmd_s ezb_zcl_color_control_enhanced_step_hue_cmd_t

Structure for ZCL Color Control EnhancedStepHue command request.

typedef struct ezb_zcl_color_control_move_to_saturation_cmd_s ezb_zcl_color_control_move_to_saturation_cmd_t

Structure for ZCL Color Control MoveToSaturation command request.

typedef ezb_zcl_color_control_move_hs_cmd_payload_t ezb_zcl_color_control_move_saturation_cmd_payload_t

Payload for the ZCL Color Control MoveSaturation command. .

typedef ezb_zcl_color_control_move_hs_cmd_t ezb_zcl_color_control_move_saturation_cmd_t

Structure for ZCL Color Control MoveSaturation command request. .

typedef struct ezb_zcl_color_control_move_to_color_cmd_s ezb_zcl_color_control_move_to_color_cmd_t

Structure for the MoveColor command request of ZCL ColorControl cluster.

typedef struct ezb_zcl_color_control_move_color_cmd_s ezb_zcl_color_control_move_color_cmd_t

Structure for the MoveColor command request of ZCL ColorControl cluster.

typedef struct ezb_zcl_color_control_step_color_cmd_s ezb_zcl_color_control_step_color_cmd_t

Structure for the StepColor command request of ZCL ColorControl cluster.

typedef struct ezb_zcl_color_control_move_to_color_temperature_cmd_s ezb_zcl_color_control_move_to_color_temperature_cmd_t

Structure for the MovetoColorTemperature command request of ZCL ColorControl cluster.

typedef struct ezb_zcl_color_control_move_color_temperature_cmd_s ezb_zcl_color_control_move_color_temperature_cmd_t

Structure for the MoveColorTemperature command request of ZCL ColorControl cluster.

typedef struct ezb_zcl_color_control_step_color_temperature_cmd_s ezb_zcl_color_control_step_color_temperature_cmd_t

Structure for the StepColorTemperature command request of ZCL ColorControl cluster.

typedef struct ezb_zcl_color_control_stop_move_step_cmd_s ezb_zcl_color_control_stop_move_step_cmd_t

Structure for the ZCL Color Control StopMoveStep command request.

typedef struct ezb_zcl_color_control_color_loop_set_cmd_s ezb_zcl_color_control_color_loop_set_cmd_t

Structure for the ZCL Color Control ColorLoopSet command request.

typedef struct ezb_zcl_color_control_color_mode_change_message_s ezb_zcl_color_control_color_mode_change_message_t

Application message when Color Control server color mode changes.

Application may set out.result and out.color to influence the final color.

5.2.6.3.3.1.11. Enumerations

enum ezb_zcl_color_control_move_to_hue_direction_t

Direction for the MoveToHue command. .

Values:

enumerator EZB_ZCL_COLOR_CONTROL_MOVE_TO_HUE_SHORTEST_DISTANCE

Move to hue with shortest distance

enumerator EZB_ZCL_COLOR_CONTROL_MOVE_TO_HUE_LONGEST_DISTANCE

Move to hue with longest distance

enumerator EZB_ZCL_COLOR_CONTROL_MOVE_TO_HUE_UP

Move to hue up

enumerator EZB_ZCL_COLOR_CONTROL_MOVE_TO_HUE_DOWN

Move to hue down

enum ezb_zcl_color_control_options_t

Enumeration for the options attribute.

When set, color commands may be executed even if the OnOff cluster is off.

Values:

enumerator EZB_ZCL_COLOR_CONTROL_OPTIONS_EXECUTE_IF_OFF
enum ezb_zcl_color_control_move_mode_t

Moving mode for continuous color change (up/down or stop). .

Values:

enumerator EZB_ZCL_COLOR_CONTROL_MOVE_MODE_STOP

Stop the movement

enumerator EZB_ZCL_COLOR_CONTROL_MOVE_MODE_UP

Move up

enumerator EZB_ZCL_COLOR_CONTROL_MOVE_MODE_RESERVED

Reserved

enumerator EZB_ZCL_COLOR_CONTROL_MOVE_MODE_DOWN

Move down

enum ezb_zcl_color_control_step_mode_t

Enumeration for the step mode color control cluster .

Indicates whether to add (up) or subtract (down) the step from the current value.

Values:

enumerator EZB_ZCL_COLOR_CONTROL_STEP_MODE_RESERVED0

Reserved

enumerator EZB_ZCL_COLOR_CONTROL_STEP_MODE_UP

Move up

enumerator EZB_ZCL_COLOR_CONTROL_STEP_MODE_RESERVED2

Reserved

enumerator EZB_ZCL_COLOR_CONTROL_STEP_MODE_DOWN

Move down

enum ezb_zcl_color_control_color_loop_set_update_flags_t

Update flags for the ColorLoopSet command.

Values:

enumerator EZB_ZCL_COLOR_CONTROL_COLOR_LOOP_SET_UPDATE_ACTION

Update action

enumerator EZB_ZCL_COLOR_CONTROL_COLOR_LOOP_SET_UPDATE_DIRECTION

Update direction

enumerator EZB_ZCL_COLOR_CONTROL_COLOR_LOOP_SET_UPDATE_TIME

Update time

enumerator EZB_ZCL_COLOR_CONTROL_COLOR_LOOP_SET_UPDATE_START_HUE

Update start hue

enum ezb_zcl_color_control_color_loop_set_action_t

Enumeration for the action of ColorLoopSet.

Deactivate stops the loop; Activate options define the starting hue for the loop.

Values:

enumerator EZB_ZCL_COLOR_CONTROL_COLOR_LOOP_SET_ACTION_DEACTIVATE

Deactivate

enumerator EZB_ZCL_COLOR_CONTROL_COLOR_LOOP_SET_ACTION_ACTIVATE_FROM_START_ENHANCED_HUE

Activate from start enhanced hue

enumerator EZB_ZCL_COLOR_CONTROL_COLOR_LOOP_SET_ACTION_ACTIVATE_FROM_ENHANCED_CURRENT_HUE

Activate from enhanced current hue

enum ezb_zcl_color_control_color_loop_set_direction_t

Direction for the ColorLoopSet command.

Values:

enumerator EZB_ZCL_COLOR_CONTROL_COLOR_LOOP_SET_DIRECTION_UP

Up

enumerator EZB_ZCL_COLOR_CONTROL_COLOR_LOOP_SET_DIRECTION_DOWN

Down