Z-Stack API Reference  8.31.00.00
ZCL Closure Window Covering Cluster Macros

This group provides ZCL Closure Windo Covering Cluster macros defined in the ZCL v7 specification. More...

Macros

#define ATTRSET_WINDOW_COVERING_INFO   0x0000
 
#define ATTRSET_WINDOW_COVERING_SETTINGS   0x0010
 
#define ATTRID_WINDOW_COVERING_WINDOW_COVERING_TYPE   0x0000
 
#define ATTRID_WINDOW_COVERING_PHYSICAL_CLOSED_LIMIT_LIFT   0x0001
 
#define ATTRID_WINDOW_COVERING_PHYSICAL_CLOSED_LIMIT_TILT   0x0002
 
#define ATTRID_WINDOW_COVERING_CURRENT_POSITION_LIFT   0x0003
 
#define ATTRID_WINDOW_COVERING_CURRENT_POSITION_TILT   0x0004
 
#define ATTRID_WINDOW_COVERING_NUMBER_OF_ACTUATIONS_LIFT   0x0005
 
#define ATTRID_WINDOW_COVERING_NUMBER_OF_ACTUATIONS_TILT   0x0006
 
#define ATTRID_WINDOW_COVERING_CONFIG_OR_STATUS   0x0007
 The ConfigStatus attribute makes configuration and status information available.
 
#define ATTRID_WINDOW_COVERING_CURRENT_POSITION_LIFT_PERCENTAGE   0x0008
 
#define ATTRID_WINDOW_COVERING_CURRENT_POSITION_TILT_PERCENTAGE   0x0009
 
#define ATTRID_WINDOW_COVERING_INSTALLED_OPEN_LIMIT_LIFT   0x0010
 
#define ATTRID_WINDOW_COVERING_INSTALLED_CLOSED_LIMIT_LIFT   0x0011
 
#define ATTRID_WINDOW_COVERING_INSTALLED_OPEN_LIMIT_TILT   0x0012
 
#define ATTRID_WINDOW_COVERING_INSTALLED_CLOSED_LIMIT_TILT   0x0013
 
#define ATTRID_WINDOW_COVERING_VELOCITY_LIFT   0x0014
 
#define ATTRID_WINDOW_COVERING_ACCELERATION_TIME_LIFT   0x0015
 
#define ATTRID_WINDOW_COVERING_DECELERATION_TIME_LIFT   0x0016
 
#define ATTRID_WINDOW_COVERING_MODE   0x0017
 The Mode attribute allows configuration of the Window Covering.
 
#define ATTRID_WINDOW_COVERING_INTERMEDIATE_SETPOINTS_LIFT   0x0018
 
#define ATTRID_WINDOW_COVERING_INTERMEDIATE_SETPOINTS_TILT   0x0019
 
#define CLOSURES_WINDOW_COVERING_TYPE_ROLLERSHADE   0x00
 Window Covering Type enum.
 
#define CLOSURES_WINDOW_COVERING_TYPE_ROLLERSHADE_2_MOTOR   0x01
 
#define CLOSURES_WINDOW_COVERING_TYPE_ROLLERSHADE_EXTERIOR   0x02
 
#define CLOSURES_WINDOW_COVERING_TYPE_ROLLERSHADE_EXTERIOR_2_MOTOR   0x03
 
#define CLOSURES_WINDOW_COVERING_TYPE_DRAPERY   0x04
 
#define CLOSURES_WINDOW_COVERING_TYPE_AWNING   0x05
 
#define CLOSURES_WINDOW_COVERING_TYPE_SHUTTER   0x06
 
#define CLOSURES_WINDOW_COVERING_TYPE_TILT_BLIND_TILT_ONLY   0x07
 
#define CLOSURES_WINDOW_COVERING_TYPE_TILT_BLIND_LIFT_AND_TILT   0x08
 
#define CLOSURES_WINDOW_COVERING_TYPE_PROJECTOR_SCREEN   0x09
 
#define COMMAND_WINDOW_COVERING_UP_OR_OPEN   ( 0x00 )
 
#define COMMAND_WINDOW_COVERING_DOWN_OR_CLOSE   ( 0x01 )
 
#define COMMAND_WINDOW_COVERING_STOP   ( 0x02 )
 
#define COMMAND_WINDOW_COVERING_GO_TO_LIFT_VALUE   ( 0x04 )
 
#define COMMAND_WINDOW_COVERING_GO_TO_LIFT_PERCENTAGE   ( 0x05 )
 
#define COMMAND_WINDOW_COVERING_GO_TO_TILT_VALUE   ( 0x07 )
 
#define COMMAND_WINDOW_COVERING_GO_TO_TILT_PERCENTAGE   ( 0x08 )
 
#define ZCL_WC_GOTOVALUEREQ_PAYLOADLEN   ( 2 )
 
#define ZCL_WC_GOTOPERCENTAGEREQ_PAYLOADLEN   ( 1 )
 

Detailed Description

This group provides ZCL Closure Windo Covering Cluster macros defined in the ZCL v7 specification.

Macro Definition Documentation

§ ATTRID_WINDOW_COVERING_ACCELERATION_TIME_LIFT

#define ATTRID_WINDOW_COVERING_ACCELERATION_TIME_LIFT   0x0015

The AccelerationTimeLift attribute identifies any ramp up times to reaching the velocity setting (in tenth of a second) for positioning the Window Covering.

§ ATTRID_WINDOW_COVERING_CURRENT_POSITION_LIFT

#define ATTRID_WINDOW_COVERING_CURRENT_POSITION_LIFT   0x0003

The CurrentPositionLift attribute identifies the actual position (in centimeters) of the window covering from the top of the shade if Closed Loop Control is enabled. This attribute is ignored if the device is running in Open Loop Control.

§ ATTRID_WINDOW_COVERING_CURRENT_POSITION_LIFT_PERCENTAGE

#define ATTRID_WINDOW_COVERING_CURRENT_POSITION_LIFT_PERCENTAGE   0x0008

The CurrentPositionLiftPercentage attribute identifies the actual position as a percentage between the InstalledOpenLimitLift attribute and the InstalledClosedLimitLift attribute of the window covering from the up/open position if Closed Loop Control is enabled.

§ ATTRID_WINDOW_COVERING_CURRENT_POSITION_TILT

#define ATTRID_WINDOW_COVERING_CURRENT_POSITION_TILT   0x0004

The NumberOfActuationsTilt attribute identifies the total number of tilt actuations applied to the Window Covering since the device was installed.

§ ATTRID_WINDOW_COVERING_CURRENT_POSITION_TILT_PERCENTAGE

#define ATTRID_WINDOW_COVERING_CURRENT_POSITION_TILT_PERCENTAGE   0x0009

The CurrentPositionTiltPercentage attribute identifies the actual position as a percentage between the InstalledOpenLimitTilt attribute and the InstalledClosedLimitTilt attribute of the window covering from the up/open position if Closed Loop Control is enabled.

§ ATTRID_WINDOW_COVERING_DECELERATION_TIME_LIFT

#define ATTRID_WINDOW_COVERING_DECELERATION_TIME_LIFT   0x0016

The DecelerationTimeLift attribute identifies any ramp down times associated with stopping the positioning (in tenth of a second) of the Window Covering.

§ ATTRID_WINDOW_COVERING_INSTALLED_CLOSED_LIMIT_LIFT

#define ATTRID_WINDOW_COVERING_INSTALLED_CLOSED_LIMIT_LIFT   0x0011

The InstalledClosedLimitLift attribute identifies the Closed Limit for Lifting the Window Covering whether position (in centimeters) is encoded or timed.

§ ATTRID_WINDOW_COVERING_INSTALLED_CLOSED_LIMIT_TILT

#define ATTRID_WINDOW_COVERING_INSTALLED_CLOSED_LIMIT_TILT   0x0013

The InstalledClosedLimitTilt attribute identifies the Closed Limit for Tilting the Window Covering whether position (in tenth of a degree) is encoded or timed.

§ ATTRID_WINDOW_COVERING_INSTALLED_OPEN_LIMIT_LIFT

#define ATTRID_WINDOW_COVERING_INSTALLED_OPEN_LIMIT_LIFT   0x0010

The InstalledOpenLimitLift attribute identifies the Open Limit for Lifting the Window Covering whether position (in centimeters) is encoded or timed.

§ ATTRID_WINDOW_COVERING_INSTALLED_OPEN_LIMIT_TILT

#define ATTRID_WINDOW_COVERING_INSTALLED_OPEN_LIMIT_TILT   0x0012

The InstalledOpenLimitTilt attribute identifies the Open Limit for Tilting the Window Covering whether position (in tenth of a degree) is encoded or timed.

§ ATTRID_WINDOW_COVERING_INTERMEDIATE_SETPOINTS_LIFT

#define ATTRID_WINDOW_COVERING_INTERMEDIATE_SETPOINTS_LIFT   0x0018

Identifies the number of Intermediate Setpoints supported by the Window Covering for Lift and then identifies the position settings for those Intermediate Setpoints if Closed Loop Control is supported.

§ ATTRID_WINDOW_COVERING_INTERMEDIATE_SETPOINTS_TILT

#define ATTRID_WINDOW_COVERING_INTERMEDIATE_SETPOINTS_TILT   0x0019

Identifies the number of Intermediate Setpoints supported by the Window Covering for Tilt and then identifies the position settings for those Intermediate Setpoints if Closed Loop Control is supported.

§ ATTRID_WINDOW_COVERING_NUMBER_OF_ACTUATIONS_LIFT

#define ATTRID_WINDOW_COVERING_NUMBER_OF_ACTUATIONS_LIFT   0x0005

The NumberOfActuationsLift attribute identifies the total number of lift actuations applied to the Window Covering since the device was installed.

§ ATTRID_WINDOW_COVERING_NUMBER_OF_ACTUATIONS_TILT

#define ATTRID_WINDOW_COVERING_NUMBER_OF_ACTUATIONS_TILT   0x0006

The NumberOfActuationsTilt attribute identifies the total number of tilt actuations applied to the Window Covering since the device was installed.

§ ATTRID_WINDOW_COVERING_PHYSICAL_CLOSED_LIMIT_LIFT

#define ATTRID_WINDOW_COVERING_PHYSICAL_CLOSED_LIMIT_LIFT   0x0001

The PhysicalClosedLimitLift attribute identifies the maximum possible encoder position possible (in centimeters) to position the height of the window covering - this is ignored if the device is running in Open Loop Control.

§ ATTRID_WINDOW_COVERING_PHYSICAL_CLOSED_LIMIT_TILT

#define ATTRID_WINDOW_COVERING_PHYSICAL_CLOSED_LIMIT_TILT   0x0002

The PhysicalClosedLimitTilt attribute identifies the maximum possible encoder position possible (tenth of a degrees) to position the angle of the window covering - this is ignored if the device is running in Open Loop Control.

§ ATTRID_WINDOW_COVERING_VELOCITY_LIFT

#define ATTRID_WINDOW_COVERING_VELOCITY_LIFT   0x0014

The VelocityLift attribute identifies the velocity (in centimeters per second) associated with Lifting the Window Covering.

§ ATTRID_WINDOW_COVERING_WINDOW_COVERING_TYPE

#define ATTRID_WINDOW_COVERING_WINDOW_COVERING_TYPE   0x0000

The WindowCoveringType attribute identifies the type of window covering being controlled by this endpoint

§ COMMAND_WINDOW_COVERING_DOWN_OR_CLOSE

#define COMMAND_WINDOW_COVERING_DOWN_OR_CLOSE   ( 0x01 )

Upon receipt of this command, the Window Covering will adjust the window so the physical lift is at the InstalledClosedLimit - Lift and the tilt is at the InstalledClosedLimit - Tilt. This will happen as fast as possible.

§ COMMAND_WINDOW_COVERING_GO_TO_LIFT_PERCENTAGE

#define COMMAND_WINDOW_COVERING_GO_TO_LIFT_PERCENTAGE   ( 0x05 )

Upon receipt of this command, the Window Covering will adjust the window so the physical lift is at the lift percentage specified in the payload of this command.

§ COMMAND_WINDOW_COVERING_GO_TO_LIFT_VALUE

#define COMMAND_WINDOW_COVERING_GO_TO_LIFT_VALUE   ( 0x04 )

Upon receipt of this command, the Window Covering will adjust the window so the physical lift is at the lift value specified in the payload of this command as long as that value is not larger than InstalledOpenLimit - Lift and not smaller than InstalledClosedLimit - Lift.

§ COMMAND_WINDOW_COVERING_GO_TO_TILT_PERCENTAGE

#define COMMAND_WINDOW_COVERING_GO_TO_TILT_PERCENTAGE   ( 0x08 )

Upon receipt of this command, the Window Covering will adjust the window so the physical tilt is at the tilt percentage specified in the payload of this command.

§ COMMAND_WINDOW_COVERING_GO_TO_TILT_VALUE

#define COMMAND_WINDOW_COVERING_GO_TO_TILT_VALUE   ( 0x07 )

Upon receipt of this command, the Window Covering will adjust the window so the physical tilt is at the tilt value specified in the payload of this command as long as that value is not larger than InstalledOpenLimit - Tilt and not smaller than InstalledClosedLimit - Tilt.

§ COMMAND_WINDOW_COVERING_STOP

#define COMMAND_WINDOW_COVERING_STOP   ( 0x02 )

Upon receipt of this command, the Window Covering will stop any adjusting to the physical tilt and lift that is currently occurring.

§ COMMAND_WINDOW_COVERING_UP_OR_OPEN

#define COMMAND_WINDOW_COVERING_UP_OR_OPEN   ( 0x00 )

Upon receipt of this command, the Window Covering will adjust the window so the physical lift is at the InstalledOpenLimit - Lift and the tilt is at the InstalledOpenLimit - Tilt. This will happen as fast as possible.