ZCL Shade Configuration cluster

nRF5 SDK for Thread and Zigbee v4.2.0

Shade Configuration cluster attributes

enum  zb_zcl_shade_config_info_attr_e { ZB_ZCL_ATTR_SHADE_CONFIG_PHYSICAL_CLOSED_LIMIT_ID = 0x0000, ZB_ZCL_ATTR_SHADE_CONFIG_MOTOR_STEP_SIZE_ID = 0x0001, ZB_ZCL_ATTR_SHADE_CONFIG_STATUS_ID = 0x0002 }
 Shade Configuration cluster information attribute set identifiers. More...
 
enum  zb_zcl_shade_config_status_type_e {
  ZB_ZCL_ATTR_SHADE_CONFIG_STATUS_SHADE_OPERATIONAL = 0x00, ZB_ZCL_ATTR_SHADE_CONFIG_STATUS_SHADE_ADJUSTING = 0x01, ZB_ZCL_ATTR_SHADE_CONFIG_STATUS_SHADE_DIRECTION = 0x02, ZB_ZCL_ATTR_SHADE_CONFIG_STATUS_FORWARD_DIRECTION_OF_MOTOR = 0x03,
  ZB_ZCL_ATTR_SHADE_CONFIG_STATUS_RESERVED = 0x04
}
 Bit values for Status attribute. More...
 
enum  zb_zcl_shade_config_settings_attr_e { ZB_ZCL_ATTR_SHADE_CONFIG_CLOSED_LIMIT_ID = 0x0010, ZB_ZCL_ATTR_SHADE_CONFIG_MODE_ID = 0x0011 }
 Shade cluster settings attribute set identifiers. More...
 
enum  zb_zcl_shade_config_mode_e { ZB_ZCL_ATTR_SHADE_CONFIG_MODE_NORMAL = 0x00, ZB_ZCL_ATTR_SHADE_CONFIG_MODE_CONFIGURE = 0x01, ZB_ZCL_ATTR_SHADE_CONFIG_MODE_RESERVED = 0x02 }
 Permissible values for Mode attribute. More...
 
#define ZB_ZCL_ATTR_SHADE_CONFIG_STATUS_SET(conf_var, type_value)   ZB_ZCL_SET_BIT(conf_var, type_value)
 Sets bits of Status parameter. More...
 
#define ZB_ZCL_ATTR_SHADE_CONFIG_GET_STATUS_BIT_VAL(conf_var, type_value)   ZB_ZCL_GET_BIT(conf_var, type_value)
 Gets bit value of Status parameter. More...
 
#define ZB_ZCL_ATTR_SHADE_CONFIG_STATUS_CLEAR(conf_var, type_value)   ZB_ZCL_CLR_BIT(conf_var, type_value)
 Clear bit of Status parameter. More...
 
#define ZB_ZCL_SHADE_CONFIG_CLUSTER_REVISION_DEFAULT   ((zb_uint16_t)0x0001u)
 Default value for Shade Configuration cluster revision global attribute.
 
#define ZB_ZCL_SHADE_CONFIG_STATUS_DEFAULT_VALUE   0x00
 Shade Configuration Status attribute default value.
 
#define ZB_ZCL_SHADE_CONFIG_CLOSED_LIMIT_DEFAULT_VALUE   0x0001
 ClosedLimit attribute default value.
 
#define ZB_ZCL_SHADE_CONFIG_ZERO_POINT_DEFAULT_VALUE   0x0000
 Zero Point attribute default value.
 
#define ZB_ZCL_SHADE_CONFIG_MODE_DEFAULT_VALUE   ZB_ZCL_ATTR_SHADE_CONFIG_MODE_NORMAL
 Mode attribute default value.
 
#define ZB_ZCL_DECLARE_SHADE_CONFIG_ATTRIB_LIST(attr_list, status, closed_limit, mode)
 Declare attribute list for Shade Configuration cluster. More...
 

Detailed Description

Macro Definition Documentation

◆ ZB_ZCL_ATTR_SHADE_CONFIG_GET_STATUS_BIT_VAL

#define ZB_ZCL_ATTR_SHADE_CONFIG_GET_STATUS_BIT_VAL (   conf_var,
  type_value 
)    ZB_ZCL_GET_BIT(conf_var, type_value)

Gets bit value of Status parameter.

Parameters
type_value- bit value to check
conf_var- config variable

◆ ZB_ZCL_ATTR_SHADE_CONFIG_STATUS_CLEAR

#define ZB_ZCL_ATTR_SHADE_CONFIG_STATUS_CLEAR (   conf_var,
  type_value 
)    ZB_ZCL_CLR_BIT(conf_var, type_value)

Clear bit of Status parameter.

Parameters
type_value- bit to clear
conf_var- config variable

◆ ZB_ZCL_ATTR_SHADE_CONFIG_STATUS_SET

#define ZB_ZCL_ATTR_SHADE_CONFIG_STATUS_SET (   conf_var,
  type_value 
)    ZB_ZCL_SET_BIT(conf_var, type_value)

Sets bits of Status parameter.

Parameters
type_value- bit to set
conf_var- config variable

◆ ZB_ZCL_DECLARE_SHADE_CONFIG_ATTRIB_LIST

#define ZB_ZCL_DECLARE_SHADE_CONFIG_ATTRIB_LIST (   attr_list,
  status,
  closed_limit,
  mode 
)
Value:
ZB_ZCL_START_DECLARE_ATTRIB_LIST_CLUSTER_REVISION(attr_list, ZB_ZCL_SHADE_CONFIG)    \
  ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_SHADE_CONFIG_STATUS_ID, (status))                   \
  ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_SHADE_CONFIG_CLOSED_LIMIT_ID, (closed_limit))       \
  ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_SHADE_CONFIG_MODE_ID, (mode))                       \
  ZB_ZCL_FINISH_DECLARE_ATTRIB_LIST
ZB_ZCL_ATTR_SHADE_CONFIG_MODE_ID
Mode attribute. 
Definition: zb_zcl_shade_config.h:150


ZB_ZCL_ATTR_SHADE_CONFIG_CLOSED_LIMIT_ID
ClosedLimit attribute. 
Definition: zb_zcl_shade_config.h:148


ZB_ZCL_ATTR_SHADE_CONFIG_STATUS_ID
Status attribute. 
Definition: zb_zcl_shade_config.h:81

Declare attribute list for Shade Configuration cluster.

Parameters
attr_list- attribute list name
status- pointer to variable to store Status attribute value
closed_limit- pointer to variable to store ClosedLimit attribute value
mode- pointer to variable to store Mode attribute value

Enumeration Type Documentation

◆ zb_zcl_shade_config_info_attr_e

enum zb_zcl_shade_config_info_attr_e

Shade Configuration cluster information attribute set identifiers.

See also
ZCL spec, subclause 7.2.2.2.1
Enumerator
ZB_ZCL_ATTR_SHADE_CONFIG_PHYSICAL_CLOSED_LIMIT_ID 

The PhysicalClosedLimit attribute indicates the most closed (numerically lowest) position that the shade can physically move to.

ZB_ZCL_ATTR_SHADE_CONFIG_MOTOR_STEP_SIZE_ID 

The MotorStepSize attribute indicates the angle the shade motor moves for one step, measured in 1/10ths of a degree.

ZB_ZCL_ATTR_SHADE_CONFIG_STATUS_ID 

Status attribute.

◆ zb_zcl_shade_config_mode_e

enum zb_zcl_shade_config_mode_e

Permissible values for Mode attribute.

See also
ZCL spec, subclause 7.2.2.2.2.2
Enumerator
ZB_ZCL_ATTR_SHADE_CONFIG_MODE_NORMAL 

Normal value

ZB_ZCL_ATTR_SHADE_CONFIG_MODE_CONFIGURE 

Configure value

ZB_ZCL_ATTR_SHADE_CONFIG_MODE_RESERVED 

Reserved values

◆ zb_zcl_shade_config_settings_attr_e

enum zb_zcl_shade_config_settings_attr_e

Shade cluster settings attribute set identifiers.

See also
ZCL spec, subclause 7.2.2.2.2
Enumerator
ZB_ZCL_ATTR_SHADE_CONFIG_CLOSED_LIMIT_ID 

ClosedLimit attribute.

ZB_ZCL_ATTR_SHADE_CONFIG_MODE_ID 

Mode attribute.

◆ zb_zcl_shade_config_status_type_e

enum zb_zcl_shade_config_status_type_e

Bit values for Status attribute.

See also
ZCL spec, subclause 7.2.2.2.1.3
Enumerator
ZB_ZCL_ATTR_SHADE_CONFIG_STATUS_SHADE_OPERATIONAL 

Shade operational value

ZB_ZCL_ATTR_SHADE_CONFIG_STATUS_SHADE_ADJUSTING 

Shade Adjusting value

ZB_ZCL_ATTR_SHADE_CONFIG_STATUS_SHADE_DIRECTION 

Shade Direction value

ZB_ZCL_ATTR_SHADE_CONFIG_STATUS_FORWARD_DIRECTION_OF_MOTOR 

Forward Direction of Motor value

ZB_ZCL_ATTR_SHADE_CONFIG_STATUS_RESERVED 

Reserved values