ZCL Window Covering cluster

Data Structures
struct	zb_zcl_go_to_lift_value_req_s
	Structured representation of GO_TO_LIFT_VALUE command payload. More...
struct	zb_zcl_go_to_lift_percentage_req_s
	Structured representation of GO_TO_LIFT_PERCENTAGE command payload. More...
struct	zb_zcl_go_to_tilt_value_req_s
	Structured representation of GO_TO_TILT_VALUE command payload. More...
struct	zb_zcl_go_to_tilt_percentage_req_s
	Structured representation of GO_TO_TILT_PERCENTAGE command payload. More...

Window Covering cluster attributes
enum	zb_zcl_window_covering_info_attr_e {   ZB_ZCL_ATTR_WINDOW_COVERING_WINDOW_COVERING_TYPE_ID = 0x0000, ZB_ZCL_ATTR_WINDOW_COVERING_PHYSICAL_CLOSED_LIMIT_LIFT_ID = 0x0001, ZB_ZCL_ATTR_WINDOW_COVERING_PHY_CLOSED_LIMIT_TILT_ID = 0x0002, ZB_ZCL_ATTR_WINDOW_COVERING_CURRENT_POSITION_LIFT_ID = 0x0003,   ZB_ZCL_ATTR_WINDOW_COVERING_CURRENT_POSITION_TILT_ID = 0x0004, ZB_ZCL_ATTR_WINDOW_COVERING_NUMBER_OF_ACTUATIONS_LIFT_ID = 0x0005, ZB_ZCL_ATTR_WINDOW_COVERING_NUMBER_OF_ACTUATIONS_TILT_ID = 0x0006, ZB_ZCL_ATTR_WINDOW_COVERING_CONFIG_STATUS_ID = 0x0007,   ZB_ZCL_ATTR_WINDOW_COVERING_CURRENT_POSITION_LIFT_PERCENTAGE_ID = 0x0008, ZB_ZCL_ATTR_WINDOW_COVERING_CURRENT_POSITION_TILT_PERCENTAGE_ID = 0x0009 }
	Window Covering cluster information attribute set identifiers. More...
enum	zb_zcl_window_covering_window_covering_type_e {   ZB_ZCL_ATTR_WINDOW_COVERING_TYPE_ROLLERSHADE = 0x00, ZB_ZCL_ATTR_WINDOW_COVERING_TYPE_ROLLERSHADE_2_MOTOR = 0x01, ZB_ZCL_ATTR_WINDOW_COVERING_TYPE_ROLLERSHADE_EXTERIOR = 0x02, ZB_ZCL_ATTR_WINDOW_COVERING_TYPE_ROLLERSHADE_EXTERIOR_2_MOTOR = 0x03,   ZB_ZCL_ATTR_WINDOW_COVERING_TYPE_DRAPERY = 0x04, ZB_ZCL_ATTR_WINDOW_COVERING_TYPE_AWNING = 0x05, ZB_ZCL_ATTR_WINDOW_COVERING_TYPE_SHUTTER = 0x06, ZB_ZCL_ATTR_WINDOW_COVERING_TYPE_TILT_BLIND_TILT_ONLY = 0x07,   ZB_ZCL_ATTR_WINDOW_COVERING_TYPE_TILT_BLIND_LIFT_AND_TILT = 0x08, ZB_ZCL_ATTR_WINDOW_COVERING_TYPE_PROJECTOR_SCREEN = 0x09 }
	Permissible values for Type attribute. More...
enum	zb_zcl_window_covering_config_status_e {   ZB_ZCL_ATTR_WINDOW_COVERING_CONFIG_OPERATIONAL = 0x01, ZB_ZCL_ATTR_WINDOW_COVERING_CONFIG_ONLINE = 0x02, ZB_ZCL_ATTR_WINDOW_COVERING_CONFIG_REVERSE_COMMANDS = 0x04, ZB_ZCL_ATTR_WINDOW_COVERING_CONFIG_LIFT_CONTROL_IS_CLOSED_LOOP = 0x08,   ZB_ZCL_ATTR_WINDOW_COVERING_CONFIG_TILT_CONTROL_IS_CLOSED_LOOP = 0x10, ZB_ZCL_ATTR_WINDOW_COVERING_CONFIG_LIFT_ENCODER_CONTROLLED = 0x20, ZB_ZCL_ATTR_WINDOW_COVERING_CONFIG_TILT_ENCODER_CONTROLLED = 0x40 }
	Permissible values for Config/Status attribute. More...
enum	zb_zcl_window_covering_settings_attr_e {   ZB_ZCL_ATTR_WINDOW_COVERING_INSTALLED_OPEN_LIMIT_LIFT_ID = 0x0010, ZB_ZCL_ATTR_WINDOW_COVERING_INSTALLED_CLOSED_LIMIT_LIFT_ID = 0x0011, ZB_ZCL_ATTR_WINDOW_COVERING_INSTALLED_OPEN_LIMIT_TILT_ID = 0x0012, ZB_ZCL_ATTR_WINDOW_COVERING_INSTALLED_CLOSED_LIMIT_TILT_ID = 0x0013,   ZB_ZCL_ATTR_WINDOW_COVERING_VELOCITY_ID = 0x0014, ZB_ZCL_ATTR_WINDOW_COVERING_ACCELERATION_TIME_ID = 0x0015, ZB_ZCL_ATTR_WINDOW_COVERING_DECELERATION_TIME_ID = 0x0016, ZB_ZCL_ATTR_WINDOW_COVERING_MODE_ID = 0x0017,   ZB_ZCL_ATTR_WINDOW_COVERING_INTERMEDIATE_SETPOINTS_LIFT_ID = 0x0018, ZB_ZCL_ATTR_WINDOW_COVERING_INTERMEDIATE_SETPOINTS_TILT_ID = 0x0019 }
	Window covering cluster settings attribute set identifiers. More...
enum	zb_zcl_window_covering_mode_e { ZB_ZCL_ATTR_WINDOW_COVERING_TYPE_REVERSED_MOTOR_DIRECTION = 0x01, ZB_ZCL_ATTR_WINDOW_COVERING_TYPE_RUN_IN_CALIBRATION_MODE = 0x02, ZB_ZCL_ATTR_WINDOW_COVERING_TYPE_MOTOR_IS_RUNNING_IN_MAINTENANCE_MODE = 0x04, ZB_ZCL_ATTR_WINDOW_COVERING_TYPE_LEDS_WILL_DISPLAY_FEEDBACK = 0x08 }
	Permissible values for Mode attribute. More...
#define	ZB_ZCL_WINDOW_COVERING_PHYSICAL_CLOSED_LIMIT_LIFT_DEFAULT_VALUE   ((zb_uint16_t)0x0000)
	Default value for PhysicalClosedLimitLift attribute.
#define	ZB_ZCL_WINDOW_COVERING_PHY_CLOSED_LIMIT_TILT_DEFAULT_VALUE   ((zb_uint16_t)0x0000)
	Default value for PhyClosedLimitTilt attribute.
#define	ZB_ZCL_WINDOW_COVERING_CURRENT_POSITION_LIFT_DEFAULT_VALUE   ((zb_uint16_t)0x0000)
	Default value for CurrentPositionLift attribute.
#define	ZB_ZCL_WINDOW_COVERING_CURRENT_POSITION_TILT_DEFAULT_VALUE   ((zb_uint16_t)0x0000)
	Default value for CurrentPositionTilt attribute.
#define	ZB_ZCL_WINDOW_COVERING_NUMBER_OF_ACTUATIONS_LIFT_DEFAULT_VALUE   ((zb_uint16_t)0x0000)
	Default value for NumberOfActuationsLift attribute.
#define	ZB_ZCL_WINDOW_COVERING_NUMBER_OF_ACTUATIONS_TILT_DEFAULT_VALUE   ((zb_uint16_t)0x0000)
	Default value for NumberOfActuationsTilt attribute.
#define	ZB_ZCL_WINDOW_COVERING_WINDOW_COVERING_TYPE_DEFAULT_VALUE   0x00
	Window covering type attribute default value.
#define	ZB_ZCL_WINDOW_COVERING_CONFIG_STATUS_DEFAULT_VALUE
	Config/status attribute default value. More...
#define	ZB_ZCL_WINDOW_COVERING_CURRENT_POSITION_LIFT_PERCENTAGE_DEFAULT_VALUE   0x00
	Current position lift percentage attribute default value.
#define	ZB_ZCL_WINDOW_COVERING_CURRENT_POSITION_TILT_PERCENTAGE_DEFAULT_VALUE   0x00
	Current position tilt percentage attribute default value.
#define	ZB_ZCL_WINDOW_COVERING_INSTALLED_OPEN_LIMIT_LIFT_DEFAULT_VALUE   0x0000
	Installed open limit lift attribute default value.
#define	ZB_ZCL_WINDOW_COVERING_INSTALLED_CLOSED_LIMIT_LIFT_DEFAULT_VALUE   0xffff
	Installed closed limit lift attribute default value.
#define	ZB_ZCL_WINDOW_COVERING_INSTALLED_OPEN_LIMIT_TILT_DEFAULT_VALUE   0x0000
	Installed open limit tilt attribute default value.
#define	ZB_ZCL_WINDOW_COVERING_INSTALLED_CLOSED_LIMIT_TILT_DEFAULT_VALUE   0xffff
	Installed closed limit tilt attribute default value.
#define	ZB_ZCL_WINDOW_COVERING_VELOCITY_DEFAULT_VALUE   ((zb_uint16_t)0x0000)
	Default value for Velocity attribute.
#define	ZB_ZCL_WINDOW_COVERING_ACCELERATION_TIME_DEFAULT_VALUE   ((zb_uint16_t)0x0000)
	Default value for AccelerationTime attribute.
#define	ZB_ZCL_WINDOW_COVERING_DECELERATION_TIME_DEFAULT_VALUE   ((zb_uint16_t)0x0000)
	Default value for DecelerationTime attribute.
#define	ZB_ZCL_WINDOW_COVERING_MODE_DEFAULT_VALUE   ZB_ZCL_ATTR_WINDOW_COVERING_TYPE_MOTOR_IS_RUNNING_IN_MAINTENANCE_MODE
	Mode attribute default value.
#define	ZB_ZCL_WINDOW_COVERING_INTERMEDIATE_SETPOINTS_LIFT_DEFAULT_VALUE   {0x31, 0x2C, 0x30, 0x78, 0x30, 0x30, 0x30, 0x30, 0x00}
	Default value for IntermediateSetpointsLift attribute.
#define	ZB_ZCL_WINDOW_COVERING_INTERMEDIATE_SETPOINTS_TILT_DEFAULT_VALUE   {0x31, 0x2C, 0x30, 0x78, 0x30, 0x30, 0x30, 0x30, 0x00}
	Default value for IntermediateSetpointsTilt attribute.
#define	ZB_ZCL_DECLARE_WINDOW_COVERING_CLUSTER_ATTRIB_LIST(attr_list, window_covering_type, config_status, current_position_lift_percentage, current_position_tilt_percentage, installed_open_limit_lift, installed_closed_limit_lift, installed_open_limit_tilt, installed_closed_limit_tilt, mode)
	Declare attribute list for Window Covering cluster. More...

Attribute value manipulation API
#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_WINDOW_COVERING_CONFIG_STATUS_SET(conf_var, type_value)
	Sets bits of Config/Status parameter. More...
#define	ZB_ZCL_ATTR_WINDOW_COVERING_GET_CONFIG_STATUS_BIT_VAL(conf_var, type_value)
	Gets bit value of Config/Status parameter. More...
#define	ZB_ZCL_ATTR_WINDOW_COVERING_CONFIG_STATUS_CLEAR(conf_var, type_value)
	Clear bit of Config/Status parameter. More...
#define	ZB_ZCL_ATTR_WINDOW_COVERING_MODE_SET(mode_var, type_value)
	Sets bits of Mode parameter. More...
#define	ZB_ZCL_ATTR_WINDOW_COVERING_MODE_GET(mode_var, type_value)
	Gets bits of Mode parameter. More...
#define	ZB_ZCL_ATTR_WINDOW_COVERING_MODE_CLEAR(mode_var, type_value)   ZB_ZCL_CLR_BIT(mode_var, type_value)
	Clear bytes of Mode parameter. More...

Window Covering cluster commands
enum	zb_zcl_window_covering_cmd_e {   ZB_ZCL_CMD_WINDOW_COVERING_UP_OPEN = 0x00, ZB_ZCL_CMD_WINDOW_COVERING_DOWN_CLOSE = 0x01, ZB_ZCL_CMD_WINDOW_COVERING_STOP = 0x02, ZB_ZCL_CMD_WINDOW_COVERING_GO_TO_LIFT_VALUE = 0x04,   ZB_ZCL_CMD_WINDOW_COVERING_GO_TO_LIFT_PERCENTAGE = 0x05, ZB_ZCL_CMD_WINDOW_COVERING_GO_TO_TILT_VALUE = 0x07, ZB_ZCL_CMD_WINDOW_COVERING_GO_TO_TILT_PERCENTAGE = 0x08 }
	Window Covering cluster command identifiers. More...
typedef struct zb_zcl_go_to_lift_value_req_s	zb_zcl_go_to_lift_value_req_t
	Structured representation of GO_TO_LIFT_VALUE command payload. More...
typedef struct zb_zcl_go_to_lift_percentage_req_s	zb_zcl_go_to_lift_percentage_req_t
	Structured representation of GO_TO_LIFT_PERCENTAGE command payload. More...
typedef struct zb_zcl_go_to_tilt_value_req_s	zb_zcl_go_to_tilt_value_req_t
	Structured representation of GO_TO_TILT_VALUE command payload.
typedef struct zb_zcl_go_to_tilt_percentage_req_s	zb_zcl_go_to_tilt_percentage_req_t
	Structured representation of GO_TO_TILT_PERCENTAGE command payload. More...
#define	ZB_ZCL_WINDOW_COVERING_SEND_UP_OPEN_REQ( buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, def_resp, cb)
	Send Up/Open command. More...
#define	ZB_ZCL_WINDOW_COVERING_SEND_DOWN_CLOSE_REQ( buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, def_resp, cb)
	Send Down/Close command. More...
#define	ZB_ZCL_WINDOW_COVERING_SEND_STOP_REQ( buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, def_resp, cb)
	Send Stop command. More...
#define	ZB_ZCL_WINDOW_COVERING_SEND_GO_TO_LIFT_PERCENTAGE_REQ( buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, def_resp, cb, percentage_lift_value)
	Send Go to Lift Percentage command. More...
#define	ZB_ZCL_WINDOW_COVERING_GET_GO_TO_LIFT_PERCENTAGE_REQ( data_buf, lift_percentage_req, status)
	Parses Get Go to Lift Percentage command and fills data request structure. If request contains invalid data, status parameter is ZB_FALSE. More...
#define	ZB_ZCL_WINDOW_COVERING_SEND_GO_TO_TILT_PERCENTAGE_REQ( buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, def_resp, cb, percentage_tilt_value)
	Send Go to Tilt Percentage command. More...
#define	ZB_ZCL_WINDOW_COVERING_GET_GO_TO_TILT_PERCENTAGE_REQ( data_buf, tilt_percentage_req, status)
	Parses Get Go to Tilt Percentage command and fills to data request structure. If request contains invalid data, -1 is returned as Percentage Tilt Value. More...

Detailed Description

All commands in the cluster have request form only, and could be responded with Default Response command, if not disabled explicitly.

Macro Definition Documentation

ZB_ZCL_ATTR_WINDOW_COVERING_CONFIG_STATUS_CLEAR

#define ZB_ZCL_ATTR_WINDOW_COVERING_CONFIG_STATUS_CLEAR	(		conf_var,
			type_value
	)

Clear bit of Config/Status parameter.

Parameters

type_value	- bit to clear
conf_var	- config variable

ZB_ZCL_ATTR_WINDOW_COVERING_CONFIG_STATUS_SET

#define ZB_ZCL_ATTR_WINDOW_COVERING_CONFIG_STATUS_SET	(		conf_var,
			type_value
	)

Sets bits of Config/Status parameter.

Parameters

type_value	- bit to set.
conf_var	- config variable.

ZB_ZCL_ATTR_WINDOW_COVERING_GET_CONFIG_STATUS_BIT_VAL

#define ZB_ZCL_ATTR_WINDOW_COVERING_GET_CONFIG_STATUS_BIT_VAL	(		conf_var,
			type_value
	)

Gets bit value of Config/Status parameter.

Parameters

type_value	- bit value to check
conf_var	- config variable

ZB_ZCL_ATTR_WINDOW_COVERING_MODE_CLEAR

#define ZB_ZCL_ATTR_WINDOW_COVERING_MODE_CLEAR	(		mode_var,
			type_value
	)		ZB_ZCL_CLR_BIT(mode_var, type_value)

Clear bytes of Mode parameter.

Parameters

type_value	- type which need to set
mode_var	- mode variable

ZB_ZCL_ATTR_WINDOW_COVERING_MODE_GET

#define ZB_ZCL_ATTR_WINDOW_COVERING_MODE_GET	(		mode_var,
			type_value
	)

Gets bits of Mode parameter.

Parameters

type_value	- type which need to set
mode_var	- mode variable

ZB_ZCL_ATTR_WINDOW_COVERING_MODE_SET

#define ZB_ZCL_ATTR_WINDOW_COVERING_MODE_SET	(		mode_var,
			type_value
	)

Sets bits of Mode parameter.

Parameters

type_value	- type which need to set
mode_var	- mode variable

ZB_ZCL_CLR_BIT

#define ZB_ZCL_CLR_BIT	(		conf_var,
			type_value
	)

Value:

{ \
 (conf_var) = (conf_var) & ~(type_value); \
}

ZB_ZCL_DECLARE_WINDOW_COVERING_CLUSTER_ATTRIB_LIST

#define ZB_ZCL_DECLARE_WINDOW_COVERING_CLUSTER_ATTRIB_LIST	(		attr_list,
			window_covering_type,
			config_status,
			current_position_lift_percentage,
			current_position_tilt_percentage,
			installed_open_limit_lift,
			installed_closed_limit_lift,
			installed_open_limit_tilt,
			installed_closed_limit_tilt,
			mode
	)

Value:

 ZB_ZCL_START_DECLARE_ATTRIB_LIST(attr_list) \
 ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_WINDOW_COVERING_WINDOW_COVERING_TYPE_ID, \
 (window_covering_type)) \
 ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_WINDOW_COVERING_CONFIG_STATUS_ID, \
 (config_status)) \
 ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_WINDOW_COVERING_CURRENT_POSITION_LIFT_PERCENTAGE_ID, \
 (current_position_lift_percentage)) \
 ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_WINDOW_COVERING_CURRENT_POSITION_TILT_PERCENTAGE_ID, \
 (current_position_tilt_percentage)) \
 ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_WINDOW_COVERING_INSTALLED_OPEN_LIMIT_LIFT_ID, \
 (installed_open_limit_lift)) \
 ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_WINDOW_COVERING_INSTALLED_CLOSED_LIMIT_LIFT_ID, \
 (installed_closed_limit_lift)) \
 ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_WINDOW_COVERING_INSTALLED_OPEN_LIMIT_TILT_ID, \
 (installed_open_limit_tilt)) \
 ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_WINDOW_COVERING_INSTALLED_CLOSED_LIMIT_TILT_ID, \
 (installed_closed_limit_tilt)) \
 ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_WINDOW_COVERING_MODE_ID, (mode)) \
 ZB_ZCL_FINISH_DECLARE_ATTRIB_LIST

Declare attribute list for Window Covering cluster.

Parameters

attr_list	- attribute list name
window_covering_type	- pointer to variable to store Window Covering Type attribute value
config_status	- pointer to variable to store Config/Status attribute value
current_position_lift_percentage	- pointer to variable to store Current Position Lift Percentage attribute value
current_position_tilt_percentage	- pointer to variable to store Current Position Tilt Percentage attribute value
installed_open_limit_lift	- pointer to variable to store Installed Open Limit Lift attribute value
installed_closed_limit_lift	- pointer to variable to store Installed Closed Limit Lift attribute value
installed_open_limit_tilt	- pointer to variable to store Installed Open Limit Tilt attribute value
installed_closed_limit_tilt	- pointer to variable to store Installed Closed Limit Tilt attribute value
mode	- pointer to variable to store Mode attribute value

ZB_ZCL_SET_BIT

#define ZB_ZCL_SET_BIT	(		conf_var,
			type_value
	)

Value:

{ \
 (conf_var) = (conf_var) | (type_value); \
}

ZB_ZCL_WINDOW_COVERING_CONFIG_STATUS_DEFAULT_VALUE

#define ZB_ZCL_WINDOW_COVERING_CONFIG_STATUS_DEFAULT_VALUE

Value:

 ZB_ZCL_ATTR_WINDOW_COVERING_CONFIG_OPERATIONAL \
 | ZB_ZCL_ATTR_WINDOW_COVERING_CONFIG_ONLINE

Config/status attribute default value.

ZB_ZCL_WINDOW_COVERING_GET_GO_TO_LIFT_PERCENTAGE_REQ

#define ZB_ZCL_WINDOW_COVERING_GET_GO_TO_LIFT_PERCENTAGE_REQ	(		data_buf,
			lift_percentage_req,
			status
	)

Value:

{ \
 zb_zcl_go_to_lift_percentage_req_t *lift_percentage_req_ptr; \
 (lift_percentage_req_ptr) = zb_buf_len(data_buf) == \
 sizeof(zb_zcl_go_to_lift_percentage_req_t) ? \
 (zb_zcl_go_to_lift_percentage_req_t*)zb_buf_begin(data_buf) : NULL; \
 if (lift_percentage_req_ptr != NULL) \
 { \
 (lift_percentage_req)->percentage_lift_value = \
 lift_percentage_req_ptr->percentage_lift_value; \
 (status) = ZB_ZCL_PARSE_STATUS_SUCCESS; \
 } \
 else \
 { \
 (status) = ZB_ZCL_PARSE_STATUS_FAILURE; \
 } \
}

Parses Get Go to Lift Percentage command and fills data request structure. If request contains invalid data, status parameter is ZB_FALSE.

Parameters

data_buf	- pointer to zb_buf_t buffer containing command request data
lift_percentage_req	- pointer to a variable to save command request to
status	- return ZB_ZCL_PARSE_STATUS_SUCCESS if request contains valid data, else ZB_ZCL_PARSE_STATUS_FAILURE

Note

data_buf buffer should contain command request payload without ZCL header.

ZB_ZCL_WINDOW_COVERING_GET_GO_TO_TILT_PERCENTAGE_REQ

#define ZB_ZCL_WINDOW_COVERING_GET_GO_TO_TILT_PERCENTAGE_REQ	(		data_buf,
			tilt_percentage_req,
			status
	)

Value:

{ \
 zb_zcl_go_to_tilt_percentage_req_t *tilt_percentage_req_ptr; \
 (tilt_percentage_req_ptr) = zb_buf_len(data_buf) == \
 sizeof(zb_zcl_go_to_tilt_percentage_req_t) ? \
 (zb_zcl_go_to_tilt_percentage_req_t*)zb_buf_begin(data_buf) : NULL; \
 if (tilt_percentage_req_ptr != NULL) \
 { \
 (tilt_percentage_req)->percentage_tilt_value = \
 tilt_percentage_req_ptr->percentage_tilt_value; \
 (status) = ZB_ZCL_PARSE_STATUS_SUCCESS; \
 } \
 else \
 { \
 (status) = ZB_ZCL_PARSE_STATUS_FAILURE; \
 } \
}

Parses Get Go to Tilt Percentage command and fills to data request structure. If request contains invalid data, -1 is returned as Percentage Tilt Value.

Parameters

data_buf	- pointer to zb_buf_t buffer containing command request data
tilt_percentage_req	- variable to save command request
status	- return ZB_ZCL_PARSE_STATUS_SUCCESS if request contains valid data, else ZB_ZCL_PARSE_STATUS_FAILURE

Note

data_buf buffer should contain command request payload without ZCL header.

ZB_ZCL_WINDOW_COVERING_SEND_DOWN_CLOSE_REQ

#define ZB_ZCL_WINDOW_COVERING_SEND_DOWN_CLOSE_REQ	(		buffer,
			addr,
			dst_addr_mode,
			dst_ep,
			ep,
			prfl_id,
			def_resp,
			cb
	)

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_WINDOW_COVERING_DOWN_CLOSE); \
 ZB_ZCL_FINISH_PACKET(buffer, ptr) \
 ZB_ZCL_SEND_COMMAND_SHORT(buffer, addr, dst_addr_mode, dst_ep, ep, \
 prfl_id, ZB_ZCL_CLUSTER_ID_WINDOW_COVERING, cb); \
}

Send Down/Close command.

Parameters

buffer	- to put packet to
addr	- address to send packet to
dst_addr_mode	- addressing mode
dst_ep	- destination endpoint
ep	- sending endpoint
prfl_id	- profile identifier
def_resp	- enable/disable default response
cb	- callback for getting command send status

ZB_ZCL_WINDOW_COVERING_SEND_GO_TO_LIFT_PERCENTAGE_REQ

#define ZB_ZCL_WINDOW_COVERING_SEND_GO_TO_LIFT_PERCENTAGE_REQ	(		buffer,
			addr,
			dst_addr_mode,
			dst_ep,
			ep,
			prfl_id,
			def_resp,
			cb,
			percentage_lift_value
	)

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_WINDOW_COVERING_GO_TO_LIFT_PERCENTAGE); \
 ZB_ZCL_PACKET_PUT_DATA8(ptr, percentage_lift_value); \
 ZB_ZCL_FINISH_PACKET(buffer, ptr) \
 ZB_ZCL_SEND_COMMAND_SHORT(buffer, addr, dst_addr_mode, dst_ep, ep, \
 prfl_id, ZB_ZCL_CLUSTER_ID_WINDOW_COVERING, cb); \
}

Send Go to Lift Percentage command.

Parameters

buffer	- to put packet to
addr	- address to send packet to
dst_addr_mode	- addressing mode
dst_ep	- destination endpoint
ep	- sending endpoint
prfl_id	- profile identifier
def_resp	- enable/disable default response
cb	- callback for getting command send status
percentage_lift_value	- Percentage Lift value

ZB_ZCL_WINDOW_COVERING_SEND_GO_TO_TILT_PERCENTAGE_REQ

#define ZB_ZCL_WINDOW_COVERING_SEND_GO_TO_TILT_PERCENTAGE_REQ	(		buffer,
			addr,
			dst_addr_mode,
			dst_ep,
			ep,
			prfl_id,
			def_resp,
			cb,
			percentage_tilt_value
	)

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_WINDOW_COVERING_GO_TO_TILT_PERCENTAGE); \
 ZB_ZCL_PACKET_PUT_DATA8(ptr, percentage_tilt_value); \
 ZB_ZCL_FINISH_PACKET(buffer, ptr) \
 ZB_ZCL_SEND_COMMAND_SHORT(buffer, addr, dst_addr_mode, dst_ep, ep, \
 prfl_id, ZB_ZCL_CLUSTER_ID_WINDOW_COVERING, cb); \
}

Send Go to Tilt Percentage command.

Parameters

buffer	- to put packet to
addr	- address to send packet to
dst_addr_mode	- addressing mode
dst_ep	- destination endpoint
ep	- sending endpoint
prfl_id	- profile identifier
def_resp	- enable/disable default response
cb	- callback for getting command send status
percentage_tilt_value	- Percentage Tilt value

ZB_ZCL_WINDOW_COVERING_SEND_STOP_REQ

#define ZB_ZCL_WINDOW_COVERING_SEND_STOP_REQ	(		buffer,
			addr,
			dst_addr_mode,
			dst_ep,
			ep,
			prfl_id,
			def_resp,
			cb
	)

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_WINDOW_COVERING_STOP); \
 ZB_ZCL_FINISH_PACKET(buffer, ptr) \
 ZB_ZCL_SEND_COMMAND_SHORT(buffer, addr, dst_addr_mode, dst_ep, ep, \
 prfl_id, ZB_ZCL_CLUSTER_ID_WINDOW_COVERING, cb); \
}

Send Stop command.

Parameters

buffer	- to put packet to
addr	- address to send packet to
dst_addr_mode	- addressing mode
dst_ep	- destination endpoint
ep	- sending endpoint
prfl_id	- profile identifier
def_resp	- enable/disable default response
cb	- callback for getting command send status

ZB_ZCL_WINDOW_COVERING_SEND_UP_OPEN_REQ

#define ZB_ZCL_WINDOW_COVERING_SEND_UP_OPEN_REQ	(		buffer,
			addr,
			dst_addr_mode,
			dst_ep,
			ep,
			prfl_id,
			def_resp,
			cb
	)

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_WINDOW_COVERING_UP_OPEN); \
 ZB_ZCL_FINISH_PACKET(buffer, ptr) \
 ZB_ZCL_SEND_COMMAND_SHORT(buffer, addr, dst_addr_mode, dst_ep, ep, \
 prfl_id, ZB_ZCL_CLUSTER_ID_WINDOW_COVERING, cb); \
}

Send Up/Open command.

Parameters

buffer	- to put packet to
addr	- address to send packet to
dst_addr_mode	- addressing mode
dst_ep	- destination endpoint
ep	- sending endpoint
prfl_id	- profile identifier
def_resp	- enable/disable default response
cb	- callback for getting command send status

Typedef Documentation

zb_zcl_go_to_lift_percentage_req_t

typedef struct zb_zcl_go_to_lift_percentage_req_s zb_zcl_go_to_lift_percentage_req_t

Structured representation of GO_TO_LIFT_PERCENTAGE command payload.

See also

ZCL spec, subclause 9.4.2.2.5.2.1

zb_zcl_go_to_lift_value_req_t

typedef struct zb_zcl_go_to_lift_value_req_s zb_zcl_go_to_lift_value_req_t

Structured representation of GO_TO_LIFT_VALUE command payload.

Mandatory commands defines

zb_zcl_go_to_tilt_percentage_req_t

typedef struct zb_zcl_go_to_tilt_percentage_req_s zb_zcl_go_to_tilt_percentage_req_t

Structured representation of GO_TO_TILT_PERCENTAGE command payload.

See also

ZCL spec, subclause 9.4.2.2.5.5.1

Enumeration Type Documentation

zb_zcl_window_covering_cmd_e

enum zb_zcl_window_covering_cmd_e

Window Covering cluster command identifiers.

See also

ZCL spec, subclause 9.4.2.2

Enumerator
ZB_ZCL_CMD_WINDOW_COVERING_UP_OPEN	Up/Open command
ZB_ZCL_CMD_WINDOW_COVERING_DOWN_CLOSE	Down/Close command
ZB_ZCL_CMD_WINDOW_COVERING_STOP	Stop command
ZB_ZCL_CMD_WINDOW_COVERING_GO_TO_LIFT_VALUE	Go to Lift Value command
ZB_ZCL_CMD_WINDOW_COVERING_GO_TO_LIFT_PERCENTAGE	Go to Lift Percentage command
ZB_ZCL_CMD_WINDOW_COVERING_GO_TO_TILT_VALUE	Go to Tilt Value command
ZB_ZCL_CMD_WINDOW_COVERING_GO_TO_TILT_PERCENTAGE	Go to Tilt Percentage command

zb_zcl_window_covering_config_status_e

enum zb_zcl_window_covering_config_status_e

Permissible values for Config/Status attribute.

See also

ZCL spec, subclause 9.4.2.1.2.7

Enumerator
ZB_ZCL_ATTR_WINDOW_COVERING_CONFIG_OPERATIONAL	Operational value
ZB_ZCL_ATTR_WINDOW_COVERING_CONFIG_ONLINE	Online value
ZB_ZCL_ATTR_WINDOW_COVERING_CONFIG_REVERSE_COMMANDS	Open/Up Commands have been reversed value
ZB_ZCL_ATTR_WINDOW_COVERING_CONFIG_LIFT_CONTROL_IS_CLOSED_LOOP	Lift control is Closed Loop value
ZB_ZCL_ATTR_WINDOW_COVERING_CONFIG_TILT_CONTROL_IS_CLOSED_LOOP	Tilt control is Closed Loop value
ZB_ZCL_ATTR_WINDOW_COVERING_CONFIG_LIFT_ENCODER_CONTROLLED	Lift Encoder Controlled value
ZB_ZCL_ATTR_WINDOW_COVERING_CONFIG_TILT_ENCODER_CONTROLLED	Tilt Encoder Controlled value

zb_zcl_window_covering_info_attr_e

enum zb_zcl_window_covering_info_attr_e

Window Covering cluster information attribute set identifiers.

See also

ZCL spec, subclause 9.4.2.1.1 - 9.4.2.1.4

Enumerator
ZB_ZCL_ATTR_WINDOW_COVERING_WINDOW_COVERING_TYPE_ID	Window Covering Type attribute.
ZB_ZCL_ATTR_WINDOW_COVERING_PHYSICAL_CLOSED_LIMIT_LIFT_ID	PhysicalClosedLimit Lift attribute.
ZB_ZCL_ATTR_WINDOW_COVERING_PHY_CLOSED_LIMIT_TILT_ID	PhysicalClosedLimit Tilt attribute.
ZB_ZCL_ATTR_WINDOW_COVERING_CURRENT_POSITION_LIFT_ID	CurrentPosition Lift attribute.
ZB_ZCL_ATTR_WINDOW_COVERING_CURRENT_POSITION_TILT_ID	CurrentPosition Tilt attribute.
ZB_ZCL_ATTR_WINDOW_COVERING_NUMBER_OF_ACTUATIONS_LIFT_ID	Number of Actuations Lift attribute.
ZB_ZCL_ATTR_WINDOW_COVERING_NUMBER_OF_ACTUATIONS_TILT_ID	Number of Actuations Tilt attribute.
ZB_ZCL_ATTR_WINDOW_COVERING_CONFIG_STATUS_ID	Config/Status attribute.
ZB_ZCL_ATTR_WINDOW_COVERING_CURRENT_POSITION_LIFT_PERCENTAGE_ID	Current Position Lift Percentage attribute.
ZB_ZCL_ATTR_WINDOW_COVERING_CURRENT_POSITION_TILT_PERCENTAGE_ID	Current Position Tilt Percentage attribute.

zb_zcl_window_covering_mode_e

enum zb_zcl_window_covering_mode_e

Permissible values for Mode attribute.

See also

ZCL spec, subclause 9.4.2.1.5.7.1

Enumerator
ZB_ZCL_ATTR_WINDOW_COVERING_TYPE_REVERSED_MOTOR_DIRECTION	Reversed motor direction value
ZB_ZCL_ATTR_WINDOW_COVERING_TYPE_RUN_IN_CALIBRATION_MODE	Run in calibration mode value
ZB_ZCL_ATTR_WINDOW_COVERING_TYPE_MOTOR_IS_RUNNING_IN_MAINTENANCE_MODE	Motor is running in maintenance mode value
ZB_ZCL_ATTR_WINDOW_COVERING_TYPE_LEDS_WILL_DISPLAY_FEEDBACK	LEDs will display feedback value

zb_zcl_window_covering_settings_attr_e

enum zb_zcl_window_covering_settings_attr_e

Window covering cluster settings attribute set identifiers.

See also

ZCL spec, subclause 9.4.2.1.5

Enumerator
ZB_ZCL_ATTR_WINDOW_COVERING_INSTALLED_OPEN_LIMIT_LIFT_ID	InstalledOpenLimit - Lift attribute.
ZB_ZCL_ATTR_WINDOW_COVERING_INSTALLED_CLOSED_LIMIT_LIFT_ID	InstalledClosedLimit - Lift attribute.
ZB_ZCL_ATTR_WINDOW_COVERING_INSTALLED_OPEN_LIMIT_TILT_ID	InstalledOpenLimit - Tilt attribute.
ZB_ZCL_ATTR_WINDOW_COVERING_INSTALLED_CLOSED_LIMIT_TILT_ID	InstalledClosedLimit - Tilt attribute.
ZB_ZCL_ATTR_WINDOW_COVERING_VELOCITY_ID	Velocity - Lift attribute.
ZB_ZCL_ATTR_WINDOW_COVERING_ACCELERATION_TIME_ID	Acceleration Time - Lift attribute.
ZB_ZCL_ATTR_WINDOW_COVERING_DECELERATION_TIME_ID	Deceleration Time - Lift attribute.
ZB_ZCL_ATTR_WINDOW_COVERING_MODE_ID	Mode attribute.
ZB_ZCL_ATTR_WINDOW_COVERING_INTERMEDIATE_SETPOINTS_LIFT_ID	Intermediate Setpoints - Lift attribute.
ZB_ZCL_ATTR_WINDOW_COVERING_INTERMEDIATE_SETPOINTS_TILT_ID	Intermediate Setpoints - Tilt attribute.

zb_zcl_window_covering_window_covering_type_e

enum zb_zcl_window_covering_window_covering_type_e

Permissible values for Type attribute.

See also

ZCL spec, subclause 9.4.2.1.2

Enumerator
ZB_ZCL_ATTR_WINDOW_COVERING_TYPE_ROLLERSHADE	Rollershade value
ZB_ZCL_ATTR_WINDOW_COVERING_TYPE_ROLLERSHADE_2_MOTOR	Rollershade - 2 Motor value
ZB_ZCL_ATTR_WINDOW_COVERING_TYPE_ROLLERSHADE_EXTERIOR	Rollershade - Exterior value
ZB_ZCL_ATTR_WINDOW_COVERING_TYPE_ROLLERSHADE_EXTERIOR_2_MOTOR	Rollershade - Exterior - 2 Motor value
ZB_ZCL_ATTR_WINDOW_COVERING_TYPE_DRAPERY	Drapery value
ZB_ZCL_ATTR_WINDOW_COVERING_TYPE_AWNING	Awning value
ZB_ZCL_ATTR_WINDOW_COVERING_TYPE_SHUTTER	Shutter value
ZB_ZCL_ATTR_WINDOW_COVERING_TYPE_TILT_BLIND_TILT_ONLY	Tilt Blind - Tilt Only value
ZB_ZCL_ATTR_WINDOW_COVERING_TYPE_TILT_BLIND_LIFT_AND_TILT	Tilt Blind - Lift and Tilt value
ZB_ZCL_ATTR_WINDOW_COVERING_TYPE_PROJECTOR_SCREEN	Projector screen value