Logo
Developing with ZBOSS for Zigbee
zb_zcl_window_covering.h File Reference

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...
 

Macros

#define ZB_ZCL_CLUSTER_ID_WINDOW_COVERING_SERVER_ROLE_INIT   zb_zcl_window_covering_init_server
 
#define ZB_ZCL_CLUSTER_ID_WINDOW_COVERING_CLIENT_ROLE_INIT   zb_zcl_window_covering_init_client
 
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...
 

Functions

void zb_zcl_window_covering_init_server (void)
 
void zb_zcl_window_covering_init_client (void)
 

Window Covering cluster attributes

#define ZB_ZCL_WINDOW_COVERING_CLUSTER_REVISION_DEFAULT   ((zb_uint16_t)0x0003u)
 Default value for Window Covering cluster revision global attribute. More...
 
#define ZB_ZCL_WINDOW_COVERING_PHYSICAL_CLOSED_LIMIT_LIFT_DEFAULT_VALUE   ((zb_uint16_t)0x0000)
 Default value for PhysicalClosedLimitLift attribute. More...
 
#define ZB_ZCL_WINDOW_COVERING_PHY_CLOSED_LIMIT_TILT_DEFAULT_VALUE   ((zb_uint16_t)0x0000)
 Default value for PhyClosedLimitTilt attribute. More...
 
#define ZB_ZCL_WINDOW_COVERING_CURRENT_POSITION_LIFT_DEFAULT_VALUE   ((zb_uint16_t)0x0000)
 Default value for CurrentPositionLift attribute. More...
 
#define ZB_ZCL_WINDOW_COVERING_CURRENT_POSITION_TILT_DEFAULT_VALUE   ((zb_uint16_t)0x0000)
 Default value for CurrentPositionTilt attribute. More...
 
#define ZB_ZCL_WINDOW_COVERING_NUMBER_OF_ACTUATIONS_LIFT_DEFAULT_VALUE   ((zb_uint16_t)0x0000)
 Default value for NumberOfActuationsLift attribute. More...
 
#define ZB_ZCL_WINDOW_COVERING_NUMBER_OF_ACTUATIONS_TILT_DEFAULT_VALUE   ((zb_uint16_t)0x0000)
 Default value for NumberOfActuationsTilt attribute. More...
 
#define ZB_ZCL_WINDOW_COVERING_WINDOW_COVERING_TYPE_DEFAULT_VALUE   0x00
 Window covering type attribute default value. More...
 
#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   0xff
 Current position lift percentage attribute default value. More...
 
#define ZB_ZCL_WINDOW_COVERING_CURRENT_POSITION_LIFT_PERCENTAGE_MAX_VALUE   0x64
 Current position lift percentage attribute max value. More...
 
#define ZB_ZCL_WINDOW_COVERING_CURRENT_POSITION_TILT_PERCENTAGE_DEFAULT_VALUE   0xff
 Current position tilt percentage attribute default value. More...
 
#define ZB_ZCL_WINDOW_COVERING_CURRENT_POSITION_TILT_PERCENTAGE_MAX_VALUE   0x64
 Current position tilt percentage attribute max value. More...
 
#define ZB_ZCL_WINDOW_COVERING_INSTALLED_OPEN_LIMIT_LIFT_DEFAULT_VALUE   0x0000
 Installed open limit lift attribute default value. More...
 
#define ZB_ZCL_WINDOW_COVERING_INSTALLED_CLOSED_LIMIT_LIFT_DEFAULT_VALUE   0xffff
 Installed closed limit lift attribute default value. More...
 
#define ZB_ZCL_WINDOW_COVERING_INSTALLED_OPEN_LIMIT_TILT_DEFAULT_VALUE   0x0000
 Installed open limit tilt attribute default value. More...
 
#define ZB_ZCL_WINDOW_COVERING_INSTALLED_CLOSED_LIMIT_TILT_DEFAULT_VALUE   0xffff
 Installed closed limit tilt attribute default value. More...
 
#define ZB_ZCL_WINDOW_COVERING_VELOCITY_DEFAULT_VALUE   ((zb_uint16_t)0x0000)
 Default value for Velocity attribute. More...
 
#define ZB_ZCL_WINDOW_COVERING_ACCELERATION_TIME_DEFAULT_VALUE   ((zb_uint16_t)0x0000)
 Default value for AccelerationTime attribute. More...
 
#define ZB_ZCL_WINDOW_COVERING_DECELERATION_TIME_DEFAULT_VALUE   ((zb_uint16_t)0x0000)
 Default value for DecelerationTime attribute. More...
 
#define ZB_ZCL_WINDOW_COVERING_MODE_DEFAULT_VALUE   ZB_ZCL_ATTR_WINDOW_COVERING_TYPE_MOTOR_IS_RUNNING_IN_MAINTENANCE_MODE
 Mode attribute default value. More...
 
#define ZB_ZCL_WINDOW_COVERING_INTERMEDIATE_SETPOINTS_LIFT_DEFAULT_VALUE   {0x31, 0x2C, 0x30, 0x78, 0x30, 0x30, 0x30, 0x30, 0x00}
 Default value for IntermediateSetpointsLift attribute. More...
 
#define ZB_ZCL_WINDOW_COVERING_INTERMEDIATE_SETPOINTS_TILT_DEFAULT_VALUE   {0x31, 0x2C, 0x30, 0x78, 0x30, 0x30, 0x30, 0x30, 0x00}
 Default value for IntermediateSetpointsTilt attribute. More...
 
#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...
 
enum  zb_zcl_window_covering_attribute_sets_e { ZB_ZCL_WINDOW_COVERING_INFORMATION = 0x000, ZB_ZCL_WINDOW_COVERING_SETTINGS = 0x001 }
 Window Covering Attribute Sets Identifiers. More...
 
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...
 

Window Covering cluster commands

#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...
 
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. More...
 
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...
 

Macro Definition Documentation

§ ZB_ZCL_CLUSTER_ID_WINDOW_COVERING_CLIENT_ROLE_INIT

#define ZB_ZCL_CLUSTER_ID_WINDOW_COVERING_CLIENT_ROLE_INIT   zb_zcl_window_covering_init_client

§ ZB_ZCL_CLUSTER_ID_WINDOW_COVERING_SERVER_ROLE_INIT

#define ZB_ZCL_CLUSTER_ID_WINDOW_COVERING_SERVER_ROLE_INIT   zb_zcl_window_covering_init_server

Function Documentation

§ zb_zcl_window_covering_init_client()

void zb_zcl_window_covering_init_client ( void  )

§ zb_zcl_window_covering_init_server()

void zb_zcl_window_covering_init_server ( void  )