nRF5 SDK for Thread and Zigbee v2.0.0
Data Structures
ZCL Shade Configuration cluster
ZCL clusters

Data Structures

struct  zb_zcl_shade_set_value_param_s
 
struct  zb_zcl_shade_get_value_param_s
 

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...
 
typedef struct
zb_zcl_shade_set_value_param_s 		zb_zcl_shade_set_value_param_t
 
typedef struct
zb_zcl_shade_get_value_param_s 		zb_zcl_shade_get_value_param_t
 
#define ZB_ZCL_SET_BIT(conf_var, type_value)
 
#define ZB_ZCL_GET_BIT(conf_var, type_value)   ((conf_var) & (type_value))
 
#define ZB_ZCL_CLR_BIT(conf_var, type_value)
 
#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_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.
 

Shade Configuration cluster internals

Internal structures for Shade Configuration cluster

#define ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_SHADE_CONFIG_STATUS_ID(data_ptr)
 
#define ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_SHADE_CONFIG_CLOSED_LIMIT_ID(data_ptr)
 
#define ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_SHADE_CONFIG_MODE_ID(data_ptr)
 
#define ZB_ZCL_DECLARE_SHADE_CONFIG_ATTRIB_LIST(attr_list, status, closed_limit, mode)
 
#define ZB_ZCL_SHADE_CONFIG_REPORT_ATTR_COUNT   0
 
#define ZB_ZCL_SHADE_SET_MODE(ep, mode_val)
 Shade Configuration cluster command identifiers. More...
 

Detailed Description

Macro Definition Documentation

#define ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_SHADE_CONFIG_CLOSED_LIMIT_ID (   data_ptr)
Value:
{ \
ZB_ZCL_ATTR_SHADE_CONFIG_CLOSED_LIMIT_ID, \
ZB_ZCL_ATTR_TYPE_U16, \
ZB_ZCL_ATTR_ACCESS_READ_WRITE, \
(zb_voidp_t) data_ptr \
}
ZB_ZCL_ATTR_TYPE_U16
Definition: zb_zcl_common.h:456
ZB_ZCL_ATTR_SHADE_CONFIG_CLOSED_LIMIT_ID
ClosedLimit attribute.
Definition: zb_zcl_shade_config.h:144
zb_voidp_t
void * zb_voidp_t
Project-local "pointer to void" type.
Definition: zb_types.h:294
ZB_ZCL_ATTR_ACCESS_READ_WRITE
Definition: zb_zcl_common.h:491
#define ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_SHADE_CONFIG_MODE_ID (   data_ptr)
Value:
{ \
ZB_ZCL_ATTR_SHADE_CONFIG_MODE_ID, \
ZB_ZCL_ATTR_TYPE_8BIT_ENUM, \
ZB_ZCL_ATTR_ACCESS_READ_WRITE, \
(zb_voidp_t) data_ptr \
}
ZB_ZCL_ATTR_TYPE_8BIT_ENUM
Definition: zb_zcl_common.h:470
ZB_ZCL_ATTR_SHADE_CONFIG_MODE_ID
Mode attribute.
Definition: zb_zcl_shade_config.h:146
zb_voidp_t
void * zb_voidp_t
Project-local "pointer to void" type.
Definition: zb_types.h:294
ZB_ZCL_ATTR_ACCESS_READ_WRITE
Definition: zb_zcl_common.h:491
#define ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_SHADE_CONFIG_STATUS_ID (   data_ptr)
Value:
{ \
ZB_ZCL_ATTR_SHADE_CONFIG_STATUS_ID, \
ZB_ZCL_ATTR_TYPE_8BITMAP, \
ZB_ZCL_ATTR_ACCESS_READ_WRITE, \
(zb_voidp_t) data_ptr \
}
zb_voidp_t
void * zb_voidp_t
Project-local "pointer to void" type.
Definition: zb_types.h:294
ZB_ZCL_ATTR_ACCESS_READ_WRITE
Definition: zb_zcl_common.h:491
ZB_ZCL_ATTR_TYPE_8BITMAP
Definition: zb_zcl_common.h:447
ZB_ZCL_ATTR_SHADE_CONFIG_STATUS_ID
Status attribute.
Definition: zb_zcl_shade_config.h:79
#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
#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
#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
#define ZB_ZCL_CLR_BIT (   conf_var,
  type_value 
)
Value:
{ \
(conf_var) = (conf_var) & ~(type_value); \
}
#define ZB_ZCL_DECLARE_SHADE_CONFIG_ATTRIB_LIST (   attr_list,
  status,
  closed_limit,
  mode 
)
Value:
ZB_ZCL_START_DECLARE_ATTRIB_LIST(attr_list) \
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:146
ZB_ZCL_ATTR_SHADE_CONFIG_CLOSED_LIMIT_ID
ClosedLimit attribute.
Definition: zb_zcl_shade_config.h:144
ZB_ZCL_ATTR_SHADE_CONFIG_STATUS_ID
Status attribute.
Definition: zb_zcl_shade_config.h:79

Declare attribute list for Shade Configuration cluster

Parameters
attr_list- attribure 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
#define ZB_ZCL_SET_BIT (   conf_var,
  type_value 
)
Value:
{ \
(conf_var) = (conf_var) | (type_value); \
}
#define ZB_ZCL_SHADE_CONFIG_REPORT_ATTR_COUNT   0

Number of attributes mandatory for reporting in Shade Configuration cluster

#define ZB_ZCL_SHADE_SET_MODE (   ep,
  mode_val 
)
Value:
{ \
zb_uint8_t mode = (mode_val); \
ZB_ZCL_SET_ATTRIBUTE((ep), \
ZB_ZCL_CLUSTER_ID_SHADE_CONFIG, \
ZB_ZCL_ATTR_SHADE_CONFIG_MODE_ID, \
&mode, \
ZB_FALSE); \
}
ZB_ZCL_ATTR_SHADE_CONFIG_MODE_ID
Mode attribute.
Definition: zb_zcl_shade_config.h:146
zb_uint8_t
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type.
Definition: zb_types.h:116
ZB_ZCL_SET_ATTRIBUTE
#define ZB_ZCL_SET_ATTRIBUTE(ep, cluster_id, cluster_role, attr_id, value_ptr, check_access)
Sets attribute value, perform all needed checks before and after setting new value, including read-only check and marking for reporting.
Definition: zb_zcl_common.h:662
ZB_ZCL_CLUSTER_ID_SHADE_CONFIG
Definition: zb_zcl_common.h:173
ZB_FALSE
Definition: zb_types.h:100

Shade Configuration cluster command identifiers.

Macro for setting Mode attribute

Parameters
ep- endpoint id
mode_val- mode value
See also
ZCL spec, subclause ?Mandatory commands defines

Enumeration Type Documentation

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.

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

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.

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

Documentation feedback | Developer Zone | Subscribe | Updated