Developing with ZBOSS for Zigbee
ZCL color control add-ons

Data Structures

struct  zb_zcl_color_ctrl_attrs_set_color_inf_t
 Color information set for Color cluster attributes according to ZCL Spec 5.2.2.2.1. More...
 
struct  zb_zcl_color_ctrl_attrs_set_color_inf_ext_t
 Color information extended set for Color cluster attributes according to ZCL Spec 5.2.2.2.1. More...
 
struct  zb_zcl_color_ctrl_attrs_set_defined_primaries_inf_t
 Defined primaries information attribute set for Color cluster attributes according to ZCL Spec 5.2.2.2.2. More...
 
struct  zb_zcl_color_ctrl_attrs_set_defined_primaries_inf_ext_t
 Defined primaries information extended attribute set for Color cluster attributes according to ZCL Spec 5.2.2.2.2. More...
 
struct  zb_zcl_color_ctrl_attrs_set_add_prim_inf_ext_t
 Color cluster extended attributes according to ZCL Spec 5.2.2.2.3. More...
 
struct  zb_zcl_color_control_attrs_t
 Color cluster attributes according to ZCL Spec 5.2.2.2. More...
 
struct  zb_zcl_color_control_attrs_ext_t
 Color cluster extended attributes according to ZCL Spec 5.2.2.2. More...
 

Macros

#define ZB_ZCL_COLOR_CONTROL_SEND_MOVE_TO_HUE_SATURATION_REQ_NO_APS_ACK(buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, def_resp, cb, hue, saturation, transition_time)
 Macro equivalent to ZB_ZCL_COLOR_CONTROL_SEND_MOVE_TO_HUE_SATURATION_REQ, but command is sent without APS ACK. More...
 
#define ZB_ZCL_DECLARE_COLOR_CONTROL_CLIENT_ATTRIB_LIST(attr_list)
 Declare attribute list for Color control cluster (client). More...
 
#define ZB_ZCL_DECLARE_COLOR_CONTROL_ATTRIB_LIST_HS(attr_list, current_hue, current_saturation, color_mode, options, number_primaries, enhanced_color_mode, color_capabilities)
 Declare attribute list for Color Control cluster (extended with hue and saturation attributes) More...
 

Detailed Description

Macro Definition Documentation

◆ ZB_ZCL_COLOR_CONTROL_SEND_MOVE_TO_HUE_SATURATION_REQ_NO_APS_ACK

#define ZB_ZCL_COLOR_CONTROL_SEND_MOVE_TO_HUE_SATURATION_REQ_NO_APS_ACK (   buffer,
  addr,
  dst_addr_mode,
  dst_ep,
  ep,
  prfl_id,
  def_resp,
  cb,
  hue,
  saturation,
  transition_time 
)
Value:
{ \
zb_uint8_t* ptr = ZB_ZCL_START_PACKET_REQ(buffer) \
ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_REQ_FRAME_CONTROL(ptr, (def_resp)) \
ZB_ZCL_CONSTRUCT_COMMAND_HEADER_REQ(ptr, ZB_ZCL_GET_SEQ_NUM(), ZB_ZCL_CMD_COLOR_CONTROL_MOVE_TO_HUE_SATURATION); \
ZB_ZCL_PACKET_PUT_DATA8(ptr, (hue)); \
ZB_ZCL_PACKET_PUT_DATA8(ptr, (saturation)); \
ZB_ZCL_PACKET_PUT_DATA16_VAL(ptr, (transition_time)); \
ZB_ZCL_SEND_COMMAND_SHORT_WITHOUT_ACK((buffer), ptr, addr, dst_addr_mode, \
dst_ep, ep, prfl_id, ZB_ZCL_CLUSTER_ID_COLOR_CONTROL, cb, 0); \
}

Macro equivalent to ZB_ZCL_COLOR_CONTROL_SEND_MOVE_TO_HUE_SATURATION_REQ, but command is sent without APS ACK.

◆ ZB_ZCL_DECLARE_COLOR_CONTROL_ATTRIB_LIST_HS

#define ZB_ZCL_DECLARE_COLOR_CONTROL_ATTRIB_LIST_HS (   attr_list,
  current_hue,
  current_saturation,
  color_mode,
  options,
  number_primaries,
  enhanced_color_mode,
  color_capabilities 
)
Value:
ZB_ZCL_START_DECLARE_ATTRIB_LIST_CLUSTER_REVISION(attr_list, ZB_ZCL_COLOR_CONTROL) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_COLOR_CONTROL_CURRENT_HUE_ID, (current_hue)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_COLOR_CONTROL_CURRENT_SATURATION_ID, (current_saturation)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_COLOR_CONTROL_COLOR_MODE_ID, (color_mode)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_COLOR_CONTROL_OPTIONS_ID, (options)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_COLOR_CONTROL_NUMBER_OF_PRIMARIES_ID, (number_primaries)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_COLOR_CONTROL_ENHANCED_COLOR_MODE_ID, (enhanced_color_mode)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_COLOR_CONTROL_COLOR_CAPABILITIES_ID, (color_capabilities)) \
ZB_ZCL_FINISH_DECLARE_ATTRIB_LIST

Declare attribute list for Color Control cluster (extended with hue and saturation attributes)

Parameters
attr_list- attribute list name
current_hue- pointer to variable to store current_hue attribute value
current_saturation- pointer to variable to store current_saturation attribute value
color_mode- pointer to variable to store color_mode attribute value
options- pointer to variable to store options attribute value
number_primaries- pointer to variable to store number_primaries attribute value
enhanced_color_mode- pointer to variable to store Enhanced Color Mode attribute value
color_capabilities- pointer to variable to store Color Capabilities attribute value

◆ ZB_ZCL_DECLARE_COLOR_CONTROL_CLIENT_ATTRIB_LIST

#define ZB_ZCL_DECLARE_COLOR_CONTROL_CLIENT_ATTRIB_LIST (   attr_list)
Value:
ZB_ZCL_START_DECLARE_ATTRIB_LIST_CLUSTER_REVISION(attr_list, ZB_ZCL_COLOR_CONTROL) \
ZB_ZCL_FINISH_DECLARE_ATTRIB_LIST

Declare attribute list for Color control cluster (client).

Parameters
attr_list- attribute list name.
ZB_ZCL_ATTR_COLOR_CONTROL_OPTIONS_ID
@ ZB_ZCL_ATTR_COLOR_CONTROL_OPTIONS_ID
Definition: zb_zcl_color_control.h:74
ZB_ZCL_GET_SEQ_NUM
#define ZB_ZCL_GET_SEQ_NUM()
Return next sequence number for ZCL frame.
Definition: zb_zcl_common.h:1468
ZB_ZCL_ATTR_COLOR_CONTROL_COLOR_CAPABILITIES_ID
@ ZB_ZCL_ATTR_COLOR_CONTROL_COLOR_CAPABILITIES_ID
Definition: zb_zcl_color_control.h:99
ZB_ZCL_CMD_COLOR_CONTROL_MOVE_TO_HUE_SATURATION
@ ZB_ZCL_CMD_COLOR_CONTROL_MOVE_TO_HUE_SATURATION
Definition: zb_zcl_color_control.h:1073
ZB_ZCL_CLUSTER_ID_COLOR_CONTROL
#define ZB_ZCL_CLUSTER_ID_COLOR_CONTROL
Definition: zb_zcl_common.h:250
ZB_ZCL_ATTR_COLOR_CONTROL_ENHANCED_COLOR_MODE_ID
@ ZB_ZCL_ATTR_COLOR_CONTROL_ENHANCED_COLOR_MODE_ID
Definition: zb_zcl_color_control.h:80