![]() |
nRF5 SDK for Thread and Zigbee v1.0.0
|
Data Structures | |
struct | zb_zcl_scene_table_record_fixed_s |
Fixed-size part of the Scene table. More... | |
struct | zb_zcl_scene_table_record_type_s |
Typical Scene table record structure. More... | |
struct | zb_zcl_scenes_fieldset_common_s |
Common part of the field set definition. More... | |
struct | zb_zcl_scenes_on_off_fieldset_content_s |
Scenes fieldsets representation structure for On/Off cluster-specific content. More... | |
struct | zb_zcl_scenes_fieldset_on_off_s |
Scenes fieldsets representation structure for On/Off cluster. More... | |
struct | zb_zcl_scenes_level_control_fieldset_content_s |
Scenes fieldsets representation structure for Level control cluster-specific content. More... | |
struct | zb_zcl_scenes_fieldset_level_control_s |
Scenes fieldsets representation structure for LevelControl cluster. More... | |
struct | zb_zcl_scenes_color_control_fieldset_content_s |
Scenes fieldsets representation structure for Color control cluster-specific content. More... | |
struct | zb_zcl_scenes_fieldset_color_control_s |
Scenes fieldsets representation structure for ColorControl cluster. More... | |
struct | zb_zcl_scenes_door_lock_fieldset_content_s |
Scenes fieldsets representation structure for Door lock cluster-specific content. More... | |
struct | zb_zcl_scenes_fieldset_door_lock_s |
Scenes fieldsets representation structure for Door lock cluster. More... | |
struct | zb_zcl_scenes_thermostat_fieldset_content_s |
Scenes fieldsets representation structure for Thermostat cluster-specific content. More... | |
struct | zb_zcl_scenes_fieldset_thermostat_s |
Scenes fieldsets representation structure for Thermostat cluster. More... | |
struct | zb_zcl_scenes_window_covering_fieldset_content_s |
Scenes fieldsets representation structure for Window covering cluster-specific content. More... | |
struct | zb_zcl_scenes_fieldset_window_covering_s |
Scenes fieldsets representation structure for WindowCovering cluster. More... | |
struct | zb_zcl_scenes_add_scene_req_s |
Add scene command payload constant-structure part. More... | |
struct | zb_zcl_scenes_view_scene_req_s |
View scene command payload structure. More... | |
struct | zb_zcl_scenes_remove_scene_req_s |
Remove scene command payload structure. More... | |
struct | zb_zcl_scenes_remove_all_scenes_req_s |
Remove all scenes command payload structure. More... | |
struct | zb_zcl_scenes_store_scene_req_s |
Store scene command payload structure. More... | |
struct | zb_zcl_scenes_recall_scene_req_s |
Recall scene command payload structure. More... | |
struct | zb_zcl_scenes_get_scene_membership_req_s |
Get scene membership command payload structure. More... | |
struct | zb_zcl_scenes_add_scene_res_s |
Add scene response payload structure. More... | |
struct | zb_zcl_scenes_view_scene_res_fixed_size_s |
Mandatory part of the Scenes.ViewSceneResponse payload. More... | |
struct | zb_zcl_scenes_view_scene_res_variable_size_s |
Optional part of the Scenes.ViewSceneResponse payload. More... | |
struct | zb_zcl_scenes_view_scene_res_s |
View scene response payload structure. More... | |
struct | zb_zcl_scenes_fieldset_view_scene_res_s |
struct | zb_zcl_scenes_remove_scene_res_s |
Remove scene response payload structure. More... | |
struct | zb_zcl_scenes_remove_all_scenes_res_s |
Remove all scenes response payload structure. More... | |
struct | zb_zcl_scenes_store_scene_res_s |
Store scene response payload structure. More... | |
struct | zb_zcl_scenes_get_scene_membership_res_mandatory_s |
Get scene membership response fixed-structure payload part representation. More... | |
struct | zb_zcl_scenes_get_scene_membership_res_optional_s |
Get scene membership response optional payload part representation. More... | |
struct | zb_zcl_scenes_get_scene_membership_res_s |
Get scene membership response. More... | |
Scenes cluster attributes | |
enum | zb_zcl_scene_attr_e { ZB_ZCL_ATTR_SCENES_SCENE_COUNT_ID = 0x0000, ZB_ZCL_ATTR_SCENES_CURRENT_SCENE_ID = 0x001, ZB_ZCL_ATTR_SCENES_CURRENT_GROUP_ID = 0x002, ZB_ZCL_ATTR_SCENES_SCENE_VALID_ID = 0x003, ZB_ZCL_ATTR_SCENES_NAME_SUPPORT_ID = 0x004, ZB_ZCL_ATTR_SCENES_LAST_CONFIGURED_BY_ID = 0x005 } |
Scene cluster attribute identifiers. More... | |
typedef struct zb_zcl_scene_table_record_fixed_s | zb_zcl_scene_table_record_fixed_t |
Fixed-size part of the Scene table. | |
typedef struct zb_zcl_scene_table_record_type_s | zb_zcl_scene_table_record_type_t |
Typical Scene table record structure. More... | |
typedef struct zb_zcl_scenes_fieldset_common_s | zb_zcl_scenes_fieldset_common_t |
Common part of the field set definition. | |
zb_zcl_status_t | zb_zcl_scenes_process_store_scene (zb_uint8_t endpoint, zb_uint8_t group_id, zb_uint8_t scene_id) |
Store scene. More... | |
zb_ret_t | zb_zcl_scenes_recall_global_scene (zb_uint8_t param, zb_uint8_t endpoint) |
Recall Global scene. More... | |
zb_void_t | zb_zcl_scenes_remove_scenes_in_all_endpoints (zb_uint16_t group_id) |
Removes All scenes corresponding to a group identifiers in a whole device. More... | |
#define | ZB_ZCL_SCENES_NAME_SUPPORT_BIT_MASK 0x80 |
Mask to extract Name support bit. | |
#define | ZB_ZCL_ATTR_SCENES_CURRENT_GROUP_MAX_VALUE 0xfff7 |
#define | ZB_ZCL_MAX_SCENE_TABLE_RECORDS 16 |
#define | ZB_ZCL_SCENES_SCENE_COUNT_DEFAULT_VALUE 0 |
Default value for Scene count attribute. | |
#define | ZB_ZCL_SCENES_CURRENT_SCENE_DEFAULT_VALUE 0 |
Default value for Current scene attribute. | |
#define | ZB_ZCL_SCENES_CURRENT_GROUP_DEFAULT_VALUE 0 |
Default value for Current group attribute. | |
#define | ZB_ZCL_SCENES_SCENE_VALID_DEFAULT_VALUE 0 |
Default value for Scene valid attribute. | |
#define | ZB_ZCL_SCENES_NAME_SUPPORT_DEFAULT_VALUE 0 |
Default value for Name support attribute. More... | |
#define | ZB_ZCL_SCENE_GLOBAL_SCENE_GROUP_ID 0x00 |
Global Scene - group identifier see ZLL spec 6.5.1.3.1. | |
#define | ZB_ZCL_SCENE_GLOBAL_SCENE_ID 0x00 |
Global Scene - scene identifier see ZLL spec 6.5.1.3.1. | |
#define | ZB_ZCL_DECLARE_DEVICE_SCENE_TABLE_RECORD_TYPE(type_name,FIELD_SETS_LENGTH) |
Declares Scene table record type. More... | |
#define | ZB_ZCL_SCENES_TABLE_RECORD_SIZE(FIELD_SETS_LENGTH) (FIELD_SETS_LENGTH + sizeof(zb_zcl_scene_table_record_fixed_t)) |
Evaluates Scene table record size. More... | |
#define | ZB_ZCL_DEFINE_DEVICE_SCENE_TABLE(type_name, table_name) type_name table_name[ZB_ZCL_MAX_SCENE_TABLE_RECORDS] |
#define | ZB_ZCL_SCENES_FREE_SCENE_TABLE_RECORD 0xffff |
Declares a "free record" marker for a scene table. More... | |
#define | ZB_ZCL_SCENES_TRANSITION_TIME_DEFAULT_VALUE 0 |
Default value for scene transition time. | |
#define | ZB_ZCL_SCENES_CLEAR_SCENE_TABLE(table_name) |
Marks all records in a table as free. More... | |
#define | ZB_ZCL_SCENES_CLEAR_ENDPOINT_SCENE_TABLE(endpoint_desc, remove_zero_group, status) |
Marks all records in a table as free. More... | |
#define | ZB_AF_SET_ENDPOINT_SCENE_TABLE_INFO(endpoint, record_size, table) |
Sets endpoint scene table information. More... | |
#define | ZB_ZCL_DECLARE_SCENES_ATTRIB_LIST(attr_list,scene_count,current_scene,current_group,scene_valid,name_support) |
Declares Scenes attribute list. More... | |
#define | ZB_ZCL_SCENES_FIELDSETS_LENGTH(CLUSTER_SYMBOL) (CLUSTER_SYMBOL ## _SCENE_FIELD_SETS_LENGTH) |
Evaluates length if a fieldset for a particular cluster. More... | |
#define | ZB_ZCL_SCENES_FIELDSETS_LENGTH_2(CLUSTER_SYMBOL1, CLUSTER_SYMBOL2) |
Evaluates length if a fieldset for a particular cluster. More... | |
#define | ZB_ZCL_SCENES_FIELDSETS_LENGTH_3(CLUSTER_SYMBOL1,CLUSTER_SYMBOL2,CLUSTER_SYMBOL3) |
Evaluates length if a fieldset for a particular cluster. More... | |
#define | ZB_ZCL_SCENES_FIELDSETS_LENGTH_4(CLUSTER_SYMBOL1,CLUSTER_SYMBOL2,CLUSTER_SYMBOL3,CLUSTER_SYMBOL4) |
Evaluates length if a fieldset for a particular cluster. More... | |
#define | ZB_ZCL_SCENES_FIELDSETS_LENGTH_5(CLUSTER_SYMBOL1,CLUSTER_SYMBOL2,CLUSTER_SYMBOL3,CLUSTER_SYMBOL4,CLUSTER_SYMBOL5) |
Evaluates length if a fieldset for a particular cluster. More... | |
Scenes cluster internals | |
typedef struct zb_zcl_scenes_on_off_fieldset_content_s | zb_zcl_scenes_on_off_fieldset_content_t |
Scenes fieldsets representation structure for On/Off cluster-specific content. | |
typedef struct zb_zcl_scenes_fieldset_on_off_s | zb_zcl_scenes_fieldset_on_off_t |
Scenes fieldsets representation structure for On/Off cluster. | |
typedef struct zb_zcl_scenes_level_control_fieldset_content_s | zb_zcl_scenes_level_control_fieldset_content_t |
Scenes fieldsets representation structure for Level control cluster-specific content. | |
typedef struct zb_zcl_scenes_fieldset_level_control_s | zb_zcl_scenes_fieldset_level_control_t |
Scenes fieldsets representation structure for LevelControl cluster. | |
typedef struct zb_zcl_scenes_color_control_fieldset_content_s | zb_zcl_scenes_color_control_fieldset_content_t |
Scenes fieldsets representation structure for Color control cluster-specific content. | |
typedef struct zb_zcl_scenes_fieldset_color_control_s | zb_zcl_scenes_fieldset_color_control_t |
Scenes fieldsets representation structure for ColorControl cluster. | |
typedef struct zb_zcl_scenes_door_lock_fieldset_content_s | zb_zcl_scenes_door_lock_fieldset_content_t |
Scenes fieldsets representation structure for Door lock cluster-specific content. | |
typedef struct zb_zcl_scenes_fieldset_door_lock_s | zb_zcl_scenes_fieldset_door_lock_t |
Scenes fieldsets representation structure for Door lock cluster. | |
typedef struct zb_zcl_scenes_thermostat_fieldset_content_s | zb_zcl_scenes_thermostat_fieldset_content_t |
Scenes fieldsets representation structure for Thermostat cluster-specific content. | |
typedef struct zb_zcl_scenes_fieldset_thermostat_s | zb_zcl_scenes_fieldset_thermostat_t |
Scenes fieldsets representation structure for Thermostat cluster. | |
typedef struct zb_zcl_scenes_window_covering_fieldset_content_s | zb_zcl_scenes_window_covering_fieldset_content_t |
Scenes fieldsets representation structure for Window covering cluster-specific content. | |
typedef struct zb_zcl_scenes_fieldset_window_covering_s | zb_zcl_scenes_fieldset_window_covering_t |
Scenes fieldsets representation structure for WindowCovering cluster. | |
zb_uint8_t | zb_zcl_scenes_remove_all_scenes_action (zb_uint8_t endpoint, zb_uint16_t group) |
#define | ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_SCENES_SCENE_COUNT_ID(data_ptr) |
#define | ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_SCENES_CURRENT_SCENE_ID(data_ptr) |
#define | ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_SCENES_CURRENT_GROUP_ID(data_ptr) |
#define | ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_SCENES_SCENE_VALID_ID(data_ptr) |
#define | ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_SCENES_NAME_SUPPORT_ID(data_ptr) |
#define | ZB_ZCL_CLUSTER_ID_SCENES_SCENE_FIELD_SETS_LENGTH 0 |
#define | ZB_ZCL_CLUSTER_ID_ON_OFF_SCENE_FIELD_SETS_LENGTH (sizeof(zb_zcl_scenes_fieldset_on_off_t)) |
#define | ZB_ZCL_SCENES_STORE_ON_OFF_FIELDSET(endpoint,data_ptr,max_data_size,field_sets_length,status) |
#define | ZB_ZCL_CLUSTER_ID_LEVEL_CONTROL_SCENE_FIELD_SETS_LENGTH (sizeof(zb_zcl_scenes_fieldset_level_control_t)) |
#define | ZB_ZCL_SCENES_STORE_LEVEL_CONTROL_FIELDSET(endpoint,data_ptr,max_data_size,field_sets_length,status) |
#define | ZB_ZCL_CLUSTER_ID_COLOR_CONTROL_SCENE_FIELD_SETS_LENGTH (sizeof(zb_zcl_scenes_fieldset_color_control_t)) |
#define | ZB_ZCL_SCENES_STORE_COLOR_CONTROL_FIELDSET(endpoint,data_ptr,max_data_size,field_sets_length,status) |
#define | ZB_ZCL_CLUSTER_ID_DOOR_LOCK_SCENE_FIELD_SETS_LENGTH (sizeof(zb_zcl_scenes_fieldset_door_lock_t)) |
#define | ZB_ZCL_SCENES_STORE_DOOR_LOCK_FIELDSET(endpoint,data_ptr,max_data_size,field_sets_length,status) |
#define | ZB_ZCL_CLUSTER_ID_THERMOSTAT_SCENE_FIELD_SETS_LENGTH (sizeof(zb_zcl_scenes_fieldset_thermostat_t)) |
#define | ZB_ZCL_SCENES_STORE_THERMOSTAT_FIELDSET(endpoint,data_ptr,max_data_size,field_sets_length,status) |
#define | ZB_ZCL_CLUSTER_ID_WINDOW_COVERING_SCENE_FIELD_SETS_LENGTH (sizeof(zb_zcl_scenes_fieldset_window_covering_t)) |
#define | ZB_ZCL_SCENES_STORE_WINDOW_COVERING_FIELDSET(endpoint,data_ptr,max_data_size,field_sets_length,status) |
#define | ZB_ZCL_SCENES_GET_16BIT_VALUE(dst_data_ptr,src_data_ptr,content_length,dst_fieldset_length,status) |
#define | ZB_ZCL_SCENES_GET_TABLE_FIELDSETS_BEGIN(scene_table_record) |
#define | ZB_ZCL_SCENES_ADJUST_FIELDSET_PTR_INCONDITIONAL(cmd_struct_ptr) |
#define | ZB_ZCL_SCENES_ADJUST_FIELDSET_PTR(cmd_struct_ptr) |
#define | ZB_ZCL_SCENES_RECALL_ON_OFF_ON_OFF(endpoint, cmd_struct_ptr) |
#define | ZB_ZCL_SCENES_RECALL_ON_OFF_FIELDSET(endpoint,cmd_struct_ptr) |
#define | ZB_ZCL_SCENES_RECALL_LEVEL_CONTROL_CURRENT_LEVEL(endpoint,cmd_struct_ptr) |
#define | ZB_ZCL_SCENES_RECALL_LEVEL_CONTROL_FIELDSET(endpoint,cmd_struct_ptr) |
#define | ZB_ZCL_SCENES_RECALL_COLOR_CONTROL_CURRENT_X(endpoint,cmd_struct_ptr) |
#define | ZB_ZCL_SCENES_RECALL_COLOR_CONTROL_CURRENT_Y(endpoint,cmd_struct_ptr) |
#define | ZB_ZCL_SCENES_RECALL_COLOR_CONTROL_CURRENT_SATURATION(endpoint,cmd_struct_ptr) |
#define | ZB_ZCL_SCENES_RECALL_COLOR_CONTROL_FIELDSET(endpoint,cmd_struct_ptr) |
#define | ZB_ZCL_SCENES_RECALL_DOOR_LOCK_LOCK_STATE(endpoint, cmd_struct_ptr) |
#define | ZB_ZCL_SCENES_RECALL_DOOR_LOCK_FIELDSET(endpoint,cmd_struct_ptr) |
#define | ZB_ZCL_SCENES_RECALL_THERMOSTAT_OCCUPIED_COOLING_SETPOINT(endpoint,cmd_struct_ptr) |
#define | ZB_ZCL_SCENES_RECALL_THERMOSTAT_OCCUPIED_HEATING_SETPOINT(endpoint,cmd_struct_ptr) |
#define | ZB_ZCL_SCENES_RECALL_THERMOSTAT_SYSTEM_MODE(endpoint, cmd_struct_ptr) |
#define | ZB_ZCL_SCENES_RECALL_THERMOSTAT_FIELDSET(endpoint,cmd_struct_ptr) |
#define | ZB_ZCL_SCENES_RECALL_WINDOW_COVERING_CURRENT_POSITION_LIFT_PERCENTAGE(endpoint,cmd_struct_ptr) |
#define | ZB_ZCL_SCENES_RECALL_WINDOW_COVERING_CURRENT_POSITION_TILT_PERCENTAGE(endpoint,cmd_struct_ptr) |
#define | ZB_ZCL_SCENES_RECALL_WINDOW_COVERING_FIELDSET(endpoint,cmd_struct_ptr) |
#define | ZB_ZCL_SCENES_ADD_COMMON_FIELDSET_PART(cmd_struct_ptr, dst_data_ptr) |
#define | ZB_ZCL_SCENES_VIEW_SCENE_ON_OFF_ON_OFF(cmd_struct_ptr, dst_data_ptr) |
#define | ZB_ZCL_SCENES_VIEW_SCENE_ON_OFF_FIELDSET(cmd_struct_ptr,dst_data_ptr) |
#define | ZB_ZCL_SCENES_VIEW_SCENE_LEVEL_CONTROL_CURRENT_LEVEL(cmd_struct_ptr,dst_data_ptr) |
#define | ZB_ZCL_SCENES_VIEW_SCENE_LEVEL_CONTROL_FIELDSET(cmd_struct_ptr,dst_data_ptr) |
#define | ZB_ZCL_SCENES_VIEW_SCENE_COLOR_CONTROL_FIELDSET(cmd_struct_ptr,dst_data_ptr) |
#define | ZB_ZCL_SCENES_VIEW_SCENE_DOOR_LOCK_LOCK_STATE(cmd_struct_ptr,dst_data_ptr) |
#define | ZB_ZCL_SCENES_VIEW_SCENE_DOOR_LOCK_FIELDSET(cmd_struct_ptr,dst_data_ptr) |
#define | ZB_ZCL_SCENES_VIEW_SCENE_THERMOSTAT_OCCUPIED_COOLING_SETPOINT(cmd_struct_ptr,dst_data_ptr) |
#define | ZB_ZCL_SCENES_VIEW_SCENE_THERMOSTAT_OCCUPIED_HEATING_SETPOINT(cmd_struct_ptr,dst_data_ptr) |
#define | ZB_ZCL_SCENES_VIEW_SCENE_THERMOSTAT_SYSTEM_MODE(cmd_struct_ptr,dst_data_ptr) |
#define | ZB_ZCL_SCENES_VIEW_SCENE_THERMOSTAT_FIELDSET(cmd_struct_ptr,dst_data_ptr) |
#define | ZB_ZCL_SCENES_VIEW_SCENE_WINDOW_COVERING_CURRENT_POSITION_LIFT_PERCENTAGE(cmd_struct_ptr,dst_data_ptr) |
#define | ZB_ZCL_SCENES_VIEW_SCENE_WINDOW_COVERING_CURRENT_POSITION_TILT_PERCENTAGE(cmd_struct_ptr,dst_data_ptr) |
#define | ZB_ZCL_SCENES_VIEW_SCENE_WINDOW_COVERING_FIELDSET(cmd_struct_ptr,dst_data_ptr) |
Scenes cluster commands | |
enum | zb_zcl_scenes_cmd_e { ZB_ZCL_CMD_SCENES_ADD_SCENE = 0x00, ZB_ZCL_CMD_SCENES_VIEW_SCENE = 0x01, ZB_ZCL_CMD_SCENES_REMOVE_SCENE = 0x02, ZB_ZCL_CMD_SCENES_REMOVE_ALL_SCENES = 0x03, ZB_ZCL_CMD_SCENES_STORE_SCENE = 0x04, ZB_ZCL_CMD_SCENES_RECALL_SCENE = 0x05, ZB_ZCL_CMD_SCENES_GET_SCENE_MEMBERSHIP = 0x06 } |
Command identifiers for Scenes Cluster. More... | |
enum | zb_zcl_scenes_cmd_resp_e { ZB_ZCL_CMD_SCENES_ADD_SCENE_RESPONSE = 0x00, ZB_ZCL_CMD_SCENES_VIEW_SCENE_RESPONSE = 0x01, ZB_ZCL_CMD_SCENES_REMOVE_SCENE_RESPONSE = 0x02, ZB_ZCL_CMD_SCENES_REMOVE_ALL_SCENES_REPONSE = 0x03, ZB_ZCL_CMD_SCENES_STORE_SCENE_RESPONSE = 0x04, ZB_ZCL_CMD_SCENES_GET_SCENE_MEMBERSHIP_RESPONSE = 0x06 } |
Command response identifiers for Scenes Cluster. More... | |
typedef struct zb_zcl_scenes_add_scene_req_s | zb_zcl_scenes_add_scene_req_t |
Add scene command payload constant-structure part. | |
typedef struct zb_zcl_scenes_view_scene_req_s | zb_zcl_scenes_view_scene_req_t |
View scene command payload structure. | |
typedef struct zb_zcl_scenes_remove_scene_req_s | zb_zcl_scenes_remove_scene_req_t |
Remove scene command payload structure. | |
typedef struct zb_zcl_scenes_remove_all_scenes_req_s | zb_zcl_scenes_remove_all_scenes_req_t |
Remove all scenes command payload structure. | |
typedef struct zb_zcl_scenes_store_scene_req_s | zb_zcl_scenes_store_scene_req_t |
Store scene command payload structure. | |
typedef struct zb_zcl_scenes_recall_scene_req_s | zb_zcl_scenes_recall_scene_req_t |
Recall scene command payload structure. | |
typedef struct zb_zcl_scenes_get_scene_membership_req_s | zb_zcl_scenes_get_scene_membership_req_t |
Get scene membership command payload structure. | |
typedef struct zb_zcl_scenes_add_scene_res_s | zb_zcl_scenes_add_scene_res_t |
Add scene response payload structure. | |
typedef struct zb_zcl_scenes_view_scene_res_fixed_size_s | zb_zcl_scenes_view_scene_res_fixed_size_t |
Mandatory part of the Scenes.ViewSceneResponse payload. | |
typedef struct zb_zcl_scenes_view_scene_res_variable_size_s | zb_zcl_scenes_view_scene_res_variable_size_t |
Optional part of the Scenes.ViewSceneResponse payload. | |
typedef struct zb_zcl_scenes_view_scene_res_s | zb_zcl_scenes_view_scene_res_t |
View scene response payload structure. | |
typedef struct zb_zcl_scenes_fieldset_view_scene_res_s | zb_zcl_scenes_fieldset_view_scene_res_t |
typedef struct zb_zcl_scenes_remove_scene_res_s | zb_zcl_scenes_remove_scene_res_t |
Remove scene response payload structure. | |
typedef struct zb_zcl_scenes_remove_all_scenes_res_s | zb_zcl_scenes_remove_all_scenes_res_t |
Remove all scenes response payload structure. | |
typedef struct zb_zcl_scenes_store_scene_res_s | zb_zcl_scenes_store_scene_res_t |
Store scene response payload structure. | |
typedef struct zb_zcl_scenes_get_scene_membership_res_mandatory_s | zb_zcl_scenes_get_scene_membership_res_mandatory_t |
Get scene membership response fixed-structure payload part representation. | |
typedef struct zb_zcl_scenes_get_scene_membership_res_optional_s | zb_zcl_scenes_get_scene_membership_res_optional_t |
Get scene membership response optional payload part representation. | |
typedef struct zb_zcl_scenes_get_scene_membership_res_s | zb_zcl_scenes_get_scene_membership_res_t |
Get scene membership response. | |
#define | ZB_ZCL_SCENES_INIT_ADD_SCENE_REQ(buffer,cmd_struct_ptr,dis_default_resp,group_id,scene_id,transition_time) |
Start filling Add scene command frame. More... | |
#define | ZB_ZCL_SCENES_SEND_ADD_SCENE_REQ(buffer,cmd_struct_ptr,dst_addr,dst_ep,ep,prof_id,callback) |
Sends Add scene command. More... | |
#define | ZB_ZCL_SCENES_INIT_FIELDSET(cmd_struct_ptr, cluster, fs_length) |
Adds fieldset into the buffer for sending command. More... | |
#define | ZB_ZCL_SCENES_ADD_FIELDSET_ON_OFF_ATTR_ON_OFF(cmd_struct_ptr,on_off_value) ZB_ZCL_PACKET_PUT_DATA8(cmd_struct_ptr, on_off_value) |
Adds OnOff.OnOff attribute value to the fieldset. More... | |
#define | ZB_ZCL_SCENES_ADD_FIELDSET_LEVEL_CONTROL_ATTR_CURRENT_LEVEL(cmd_struct_ptr,current_level_value) ZB_ZCL_PACKET_PUT_DATA8(cmd_struct_ptr, current_level_value) |
Adds LevelControl.CurrentLevel attribute value to the fieldset. More... | |
#define | ZB_ZCL_SCENES_ADD_FIELDSET_COLOR_CONTROL_ATTR_CURRENT_X(cmd_struct_ptr,current_x_value) ZB_ZCL_PACKET_PUT_DATA16_VAL(cmd_struct_ptr, current_x_value) |
Adds ColorControl.CurrentX attribute value to the fieldset. More... | |
#define | ZB_ZCL_SCENES_ADD_FIELDSET_COLOR_CONTROL_ATTR_CURRENT_Y(cmd_struct_ptr,current_y_value) ZB_ZCL_PACKET_PUT_DATA16_VAL(cmd_struct_ptr, current_y_value) |
Adds ColorControl.CurrentY attribute value to the fieldset. More... | |
#define | ZB_ZCL_SCENES_ADD_FIELDSET_COLOR_CONTROL_ATTR_CURRENT_SATURATION(cmd_struct_ptr,current_saturation_value) ZB_ZCL_PACKET_PUT_DATA8(cmd_struct_ptr, current_saturation_value) |
Adds ColorControl.CurrentSaturation attribute value to the fieldset. More... | |
#define | ZB_ZCL_SCENES_ADD_FIELDSET_DOOR_LOCK_ATTR_LOCK_STATE(cmd_struct_ptr,lock_state_value) ZB_ZCL_PACKET_PUT_DATA8(cmd_struct_ptr, lock_state_value) |
Adds DoorLock.LockState attribute value to the fieldset. More... | |
#define | ZB_ZCL_SCENES_ADD_FIELDSET_THERMOSTAT_ATTR_OCCUPIED_COOLING_SETPOINT(cmd_struct_ptr,occupied_cooling_setpoint_value) ZB_ZCL_PACKET_PUT_DATA16(cmd_struct_ptr, occupied_cooling_setpoint_value) |
Adds Thermostat.OccupiedCoolingSetpoint attribute value to the fieldset. More... | |
#define | ZB_ZCL_SCENES_ADD_FIELDSET_THERMOSTAT_ATTR_OCCUPIED_HEATING_SETPOINT(cmd_struct_ptr,occupied_heating_setpoint_value) ZB_ZCL_PACKET_PUT_DATA16(cmd_struct_ptr, occupied_heating_setpoint_value) |
Adds Thermostat.OccupiedHeatingSetpoint attribute value to the fieldset. More... | |
#define | ZB_ZCL_SCENES_ADD_FIELDSET_THERMOSTAT_ATTR_SYSTEM_MODE(cmd_struct_ptr,system_mode_value) ZB_ZCL_PACKET_PUT_DATA8(cmd_struct_ptr, system_mode_value) |
Adds Thermostat.SystemMode attribute value to the fieldset. More... | |
#define | ZB_ZCL_SCENES_ADD_FIELDSET_WINDOW_COVERING_ATTR_CURRENT_POSITION_LIFT_PERCENTAGE(cmd_struct_ptr,current_position_lift_percentage_value) |
Adds WindowCovering.CurrentPositionLiftPercentage attribute value to the fieldset. More... | |
#define | ZB_ZCL_SCENES_ADD_FIELDSET_WINDOW_COVERING_ATTR_CURRENT_POSITION_TILT_PERCENTAGE(cmd_struct_ptr,current_position_tilt_percentage_value) |
Adds WindowCovering.CurrentPositionTiltPercentage attribute value to the fieldset. More... | |
#define | ZB_ZCL_SCENES_ADD_ON_OFF_FIELDSET(cmd_struct_ptr, on_off_value) |
Adds fieldset for On/Off cluster. More... | |
#define | ZB_ZCL_SCENES_ADD_LEVEL_CONTROL_FIELDSET(cmd_struct_ptr,current_level_value) |
Adds fieldset for Level control cluster. More... | |
#define | ZB_ZCL_SCENES_ADD_COLOR_CONTROL_FIELDSET(cmd_struct_ptr,current_x_value,current_y_value) |
Adds fieldset for Color control cluster. More... | |
#define | ZB_ZCL_SCENES_ADD_DOOR_LOCK_FIELDSET(cmd_struct_ptr, lock_state_value) |
Adds fieldset for Door lock cluster. More... | |
#define | ZB_ZCL_SCENES_ADD_THERMOSTAT_FIELDSET(cmd_struct_ptr,occupied_cooling_setpoint_value,occupied_heating_setpoint_value,system_mode_value) |
Adds fieldset for Thermostat cluster. More... | |
#define | ZB_ZCL_SCENES_ADD_WINDOW_COVERING_FIELDSET(cmd_struct_ptr,current_position_lift_percentage_value,current_position_tilt_percentage_value) |
Adds fieldset for Window covering cluster. More... | |
#define | ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_COMMON(buffer, cmd_struct_ptr) |
Parse common part of Add Scene command. More... | |
#define | ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_NEXT_FIELDSET_DESC(buffer,cmd_struct_ptr,content_length) |
Parses fieldset description. More... | |
#define | ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_STORE_FIELDSET_COMMON(src_data_ptr,dst_data_ptr,content_length) |
Copies parsed fieldset description into designated memory area. More... | |
#define | ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_ON_OFF_ON_OFF(dst_data_ptr,src_data_ptr,content_length,dst_fieldset_length) |
Copies OnOff.OnOff attribute value from Scenes.AddScene command payload into the specified point in memory. More... | |
#define | ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_ON_OFF_FIELDSET(dst_data_ptr,src_data_ptr,content_length,dst_fieldset_length) |
Extracts OnOff fieldset value from Scenes.AddScene command payload into the specified point in memory. More... | |
#define | ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_LEVEL_CONTROL_CURRENT_LEVEL(dst_data_ptr,src_data_ptr,content_length,dst_fieldset_length) |
Copies LevelControl.CurrentLevel attribute value from Scenes.AddScene command payload into the specified point in memory. More... | |
#define | ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_LEVEL_CONTROL_FIELDSET(dst_data_ptr,src_data_ptr,content_length,dst_fieldset_length) |
Extracts LevelControl fieldset value from Scenes.AddScene command payload into the specified point in memory. More... | |
#define | ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_COLOR_CONTROL_CURRENT_X(dst_data_ptr,src_data_ptr,content_length,dst_fieldset_length) |
Copies ColorControl.CurrentX attribute value from Scenes.AddScene command payload into the specified point in memory. More... | |
#define | ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_COLOR_CONTROL_CURRENT_Y(dst_data_ptr,src_data_ptr,content_length,dst_fieldset_length) |
Copies ColorControl.CurrentY attribute value from Scenes.AddScene command payload into the specified point in memory. More... | |
#define | ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_COLOR_CONTROL_CURRENT_SATURATION(dst_data_ptr,src_data_ptr,content_length,dst_fieldset_length) |
Copies ColorControl.CurrentSaturation attribute value from Scenes.AddScene command payload into the specified point in memory. More... | |
#define | ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_COLOR_CONTROL_FIELDSET(dst_data_ptr,src_data_ptr,content_length,dst_fieldset_length) |
Extracts ColorControl fieldset value from Scenes.AddScene command payload into the specified point in memory. More... | |
#define | ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_DOOR_LOCK_LOCK_STATE(dst_data_ptr,src_data_ptr,content_length,dst_fieldset_length) |
Copies DoorLock.LockState attribute value from Scenes.AddScene command payload into the specified point in memory. More... | |
#define | ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_DOOR_LOCK_FIELDSET(dst_data_ptr,src_data_ptr,content_length,dst_fieldset_length) |
Extracts DoorLock fieldset value from Scenes.AddScene command payload into the specified point in memory. More... | |
#define | ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_THERMOSTAT_OCCUPIED_COOLING_SETPOINT(dst_data_ptr,src_data_ptr,content_length,dst_fieldset_length) |
Copies Thermostat.OccupiedCoolingSetpoint attribute value from Scenes.AddScene command payload into the specified point in memory. More... | |
#define | ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_THERMOSTAT_OCCUPIED_HEATING_SETPOINT(dst_data_ptr,src_data_ptr,content_length,dst_fieldset_length) |
Copies Thermostat.OccupiedHeatingSetpoint attribute value from Scenes.AddScene command payload into the specified point in memory. More... | |
#define | ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_THERMOSTAT_SYSTEM_MODE(dst_data_ptr,src_data_ptr,content_length,dst_fieldset_length) |
Copies Thermostat.SystemMode attribute value from Scenes.AddScene command payload into the specified point in memory. More... | |
#define | ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_THERMOSTAT_FIELDSET(dst_data_ptr,src_data_ptr,content_length,dst_fieldset_length) |
Extracts Thermostat fieldset value from Scenes.AddScene command payload into the specified point in memory. More... | |
#define | ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_WINDOW_COVERING_LIFT_PERCENTAGE(dst_data_ptr,src_data_ptr,content_length,dst_fieldset_length) |
Copies WindowCovering.LiftPercentage attribute value from Scenes.AddScene command payload into the specified point in memory. More... | |
#define | ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_WINDOW_COVERING_TILT_PERCENTAGE(dst_data_ptr,src_data_ptr,content_length,dst_fieldset_length) |
Copies WindowCovering.TiltPercentage attribute value from Scenes.AddScene command payload into the specified point in memory. More... | |
#define | ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_WINDOW_COVERING_FIELDSET(dst_data_ptr,src_data_ptr,content_length,dst_fieldset_length) |
Extracts WindowCovering fieldset value from Scenes.AddScene command payload into the specified point in memory. More... | |
#define | ZB_ZCL_SCENES_SEND_VIEW_SCENE_REQ(buffer,dst_addr,dst_ep,ep,prof_id,dis_default_resp,callback,group_id,scene_id) |
Send View Scene command. More... | |
#define | ZB_ZCL_SCENES_GET_VIEW_SCENE_REQ(buffer, cmd_struct_ptr) |
Parses Scenes.ViewScene command payload. More... | |
#define | ZB_ZCL_SCENES_SEND_REMOVE_SCENE_REQ(buffer,dst_addr,dst_addr_mode,dst_ep,ep,prof_id,dis_default_resp,callback,group_id,scene_id) |
Send Remove scene command. More... | |
#define | ZB_ZCL_SCENES_GET_REMOVE_SCENE_REQ(buffer, cmd_struct_ptr) |
Parses Scenes.RemoveScene command payload. More... | |
#define | ZB_ZCL_SCENES_SEND_REMOVE_ALL_SCENES_REQ(buffer,dst_addr,dst_addr_mode,dst_ep,ep,prof_id,dis_default_resp,callback,group_id) |
Send Remove all scenes command. More... | |
#define | ZB_ZCL_SCENES_GET_REMOVE_ALL_SCENES_REQ(buffer, cmd_struct_ptr) |
Parses Scenes.RemoveScene command payload. More... | |
#define | ZB_ZCL_SCENES_SEND_STORE_SCENE_REQ(buffer,dst_addr,dst_addr_mode,dst_ep,ep,prof_id,dis_default_resp,callback,group_id,scene_id) |
Send Store Scene command. More... | |
#define | ZB_ZCL_SCENES_GET_STORE_SCENE_REQ(buffer, cmd_struct_ptr) |
Parse Store Scene command. More... | |
#define | ZB_ZCL_SCENES_SEND_RECALL_SCENE_REQ(buffer,dst_addr,dst_addr_mode,dst_ep,ep,prof_id,dis_default_resp,callback,group_id,scene_id) |
Send Recall scene command. More... | |
#define | ZB_ZCL_SCENES_GET_RECALL_SCENE_REQ(buffer, cmd_struct_ptr) |
Parse Recall Scene command. More... | |
#define | ZB_ZCL_SCENES_SEND_GET_SCENE_MEMBERSHIP_REQ(buffer,dst_addr,dst_addr_mode,dst_ep,ep,prof_id,dis_default_resp,callback,group_id) |
Send Remove all scenes command. More... | |
#define | ZB_ZCL_SCENES_GET_GET_SCENE_MEMBERSHIP_REQ(buffer, cmd_struct_ptr) |
Parses Scenes.GetSceneMembership command payload. More... | |
#define | ZB_ZCL_SCENES_SEND_ADD_SCENE_RES(buffer,seq_num,dst_addr,dst_ep,ep,prof_id,callback,status,group_id,scene_id) |
Send Add Scene response. More... | |
#define | ZB_ZCL_SCENES_GET_ADD_SCENE_RES(buffer, cmd_struct_ptr) |
Parses Scenes.AddSceneResponse command payload. More... | |
#define | ZB_ZCL_SCENES_INIT_VIEW_SCENE_RES(buffer,cmd_struct_ptr,seq_num,status,group_id,scene_id) |
Start filling View scene response frame. More... | |
#define | ZB_ZCL_SCENES_SEND_VIEW_SCENE_RES(buffer,cmd_struct_ptr,dst_addr,dst_ep,ep,prof_id,callback) |
Sends View scene response. More... | |
#define | ZB_ZCL_SCENES_ADD_TRANSITION_TIME_VIEW_SCENE_RES(cmd_struct_ptr,trans_time) ZB_ZCL_PACKET_PUT_DATA16((cmd_struct_ptr), &(trans_time)) |
Adds transition time into Scenes.ViewSceneResponse payload. More... | |
#define | ZB_ZCL_SCENES_ADD_SCENE_NAME_VIEW_SCENE_RES(cmd_struct_ptr,scene_name) ZB_ZCL_PACKET_PUT_DATA8((cmd_struct_ptr), 0) |
Adds scene name into Scenes.ViewSceneResponse payload. More... | |
#define | ZB_ZCL_SCENES_GET_VIEW_SCENE_RES_COMMON(buffer, response_ptr) |
Parses comon part of the Scenes.ViewSceneResponse. More... | |
#define | ZB_ZCL_SCENES_GET_NEXT_FIELDSET_VIEW_SCENE_RES(buffer, fieldset_ptr) |
#define | ZB_ZCL_SCENES_SEND_REMOVE_SCENE_RES(buffer,seq_num,dst_addr,dst_ep,ep,prof_id,callback,status,group_id,scene_id) |
Send Remove Scene response. More... | |
#define | ZB_ZCL_SCENES_GET_REMOVE_SCENE_RES(buffer, cmd_struct_ptr) |
Parses Scenes.RemoveSceneResponse command payload. More... | |
#define | ZB_ZCL_SCENES_SEND_REMOVE_ALL_SCENES_RES(buffer,seq_num,dst_addr,dst_ep,ep,prof_id,callback,status,group_id) |
Send Remove all scenes response. More... | |
#define | ZB_ZCL_SCENES_GET_REMOVE_ALL_SCENES_RES(buffer, cmd_struct_ptr) |
Parses Scenes.RemoveAllScenesResponse command payload. More... | |
#define | ZB_ZCL_SCENES_SEND_STORE_SCENE_RES(buffer,seq_num,dst_addr,dst_ep,ep,prof_id,callback,status,group_id,scene_id) |
Send Store scene response. More... | |
#define | ZB_ZCL_SCENES_GET_STORE_SCENE_RES(buffer, cmd_struct_ptr) |
Parses Scenes.StoreScene command payload. More... | |
#define | ZB_ZCL_SCENES_CAPACITY_ONE_MORE ((zb_uint8_t)0xfe) |
Scene table capacity: at least one scene can be added. More... | |
#define | ZB_ZCL_SCENES_CAPACITY_UNKNOWN ((zb_uint8_t)0xff) |
Scene table capacity unknown. | |
#define | ZB_ZCL_SCENES_INIT_GET_SCENE_MEMBERSHIP_RES(buffer,cmd_struct_ptr,seq_num,cap_ptr,status,capacity,group_id) |
Start filling Get scene membership response frame. More... | |
#define | ZB_ZCL_SCENES_ADD_SCENE_COUNT_GET_SCENE_MEMBERSHIP_RES(cmd_struct_ptr,scene_count) ZB_ZCL_PACKET_PUT_DATA8(cmd_struct_ptr, (scene_count)) |
Appends Scene count value to Get scene membership response constant-structure payload part. More... | |
#define | ZB_ZCL_SCENES_ADD_SCENE_ID_GET_SCENE_MEMBERSHIP_RES(cmd_struct_ptr,scene_id) ZB_ZCL_PACKET_PUT_DATA8(cmd_struct_ptr, (scene_id)) |
Appends a scene identifier to the Scene list in Get scene membership response payload. More... | |
#define | ZB_ZCL_SCENES_SEND_GET_SCENE_MEMBERSHIP_RES(buffer,cmd_struct_ptr,dst_addr,dst_ep,ep,prof_id,callback) |
Sends Get scene membership response. More... | |
#define | ZB_ZCL_SCENES_GET_GET_SCENE_MEMBERSHIP_RES(buffer, cmd_struct_ptr) |
Parses Scenes.RemoveAllScenesResponse command payload. More... | |
ZCL Scenes cluster definitions
#define ZB_AF_SET_ENDPOINT_SCENE_TABLE_INFO | ( | endpoint, | |
record_size, | |||
table | |||
) |
Sets endpoint scene table information.
endpoint | scene table belongs to |
record_size | - scene table record size for the endpoint |
table | - pointer to the scen table in the userspace |
#define ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_SCENES_CURRENT_GROUP_ID | ( | data_ptr | ) |
#define ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_SCENES_CURRENT_SCENE_ID | ( | data_ptr | ) |
#define ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_SCENES_NAME_SUPPORT_ID | ( | data_ptr | ) |
#define ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_SCENES_SCENE_COUNT_ID | ( | data_ptr | ) |
#define ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_SCENES_SCENE_VALID_ID | ( | data_ptr | ) |
#define ZB_ZCL_ATTR_SCENES_CURRENT_GROUP_MAX_VALUE 0xfff7 |
Maximal permissible value for Current group attribute
#define ZB_ZCL_CLUSTER_ID_SCENES_SCENE_FIELD_SETS_LENGTH 0 |
Scenes fieldset length for Scenes cluster
#define ZB_ZCL_DECLARE_DEVICE_SCENE_TABLE_RECORD_TYPE | ( | type_name, | |
FIELD_SETS_LENGTH | |||
) |
Declares Scene table record type.
type_name | name of the type for scene table record |
FIELD_SETS_LENGTH | length of the field sets for this particular device. Can be evaluated with ... macro. |
#define ZB_ZCL_DECLARE_SCENES_ATTRIB_LIST | ( | attr_list, | |
scene_count, | |||
current_scene, | |||
current_group, | |||
scene_valid, | |||
name_support | |||
) |
Declares Scenes attribute list.
attr_list | Attribute list name |
scene_count | ZB_ZCL_ATTR_SCENES_SCENE_COUNT_ID placeholder |
current_scene | ZB_ZCL_ATTR_SCENES_CURRENT_SCENE_ID placeholder |
current_group | ZB_ZCL_ATTR_SCENES_CURRENT_GROUP_ID placeholder |
scene_valid | ZB_ZCL_ATTR_SCENES_SCENE_VALID_ID placeholder |
name_support | ZB_ZCL_ATTR_SCENES_NAME_SUPPORT_ID placeholder |
#define ZB_ZCL_DEFINE_DEVICE_SCENE_TABLE | ( | type_name, | |
table_name | |||
) | type_name table_name[ZB_ZCL_MAX_SCENE_TABLE_RECORDS] |
Defines Scene table
type_name | Scene table record type name |
table_name | Scene table variable name |
#define ZB_ZCL_MAX_SCENE_TABLE_RECORDS 16 |
Maximal number of scene table records
#define ZB_ZCL_SCENES_ADD_COLOR_CONTROL_FIELDSET | ( | cmd_struct_ptr, | |
current_x_value, | |||
current_y_value | |||
) |
Adds fieldset for Color control cluster.
cmd_struct_ptr | - pionter to the place to put fieldset to |
current_x_value | - value of the ColorControl.CurrentX attribute to put into the fieldset |
current_y_value | - value of the ColorControl.CurrentY attribute to put into the fieldset |
#define ZB_ZCL_SCENES_ADD_COMMON_FIELDSET_PART | ( | cmd_struct_ptr, | |
dst_data_ptr | |||
) |
#define ZB_ZCL_SCENES_ADD_DOOR_LOCK_FIELDSET | ( | cmd_struct_ptr, | |
lock_state_value | |||
) |
Adds fieldset for Door lock cluster.
cmd_struct_ptr | - pionter to the place to put fieldset to |
lock_state_value | - value of the DoorLock.LockState attribute to put into the fieldset |
#define ZB_ZCL_SCENES_ADD_FIELDSET_COLOR_CONTROL_ATTR_CURRENT_SATURATION | ( | cmd_struct_ptr, | |
current_saturation_value | |||
) | ZB_ZCL_PACKET_PUT_DATA8(cmd_struct_ptr, current_saturation_value) |
Adds ColorControl.CurrentSaturation attribute value to the fieldset.
cmd_struct_ptr | - pointer to the place to put attribute value to |
current_saturation_value | - value to put into the buffer |
#define ZB_ZCL_SCENES_ADD_FIELDSET_COLOR_CONTROL_ATTR_CURRENT_X | ( | cmd_struct_ptr, | |
current_x_value | |||
) | ZB_ZCL_PACKET_PUT_DATA16_VAL(cmd_struct_ptr, current_x_value) |
Adds ColorControl.CurrentX attribute value to the fieldset.
cmd_struct_ptr | - pointer to the place to put attribute value to |
current_x_value | - value to put into the buffer |
#define ZB_ZCL_SCENES_ADD_FIELDSET_COLOR_CONTROL_ATTR_CURRENT_Y | ( | cmd_struct_ptr, | |
current_y_value | |||
) | ZB_ZCL_PACKET_PUT_DATA16_VAL(cmd_struct_ptr, current_y_value) |
Adds ColorControl.CurrentY attribute value to the fieldset.
cmd_struct_ptr | - pointer to the place to put attribute value to |
current_y_value | - value to put into the buffer |
#define ZB_ZCL_SCENES_ADD_FIELDSET_DOOR_LOCK_ATTR_LOCK_STATE | ( | cmd_struct_ptr, | |
lock_state_value | |||
) | ZB_ZCL_PACKET_PUT_DATA8(cmd_struct_ptr, lock_state_value) |
Adds DoorLock.LockState attribute value to the fieldset.
cmd_struct_ptr | - pointer to the place to put attribute value to |
lock_state_value | - value to put into the buffer |
#define ZB_ZCL_SCENES_ADD_FIELDSET_LEVEL_CONTROL_ATTR_CURRENT_LEVEL | ( | cmd_struct_ptr, | |
current_level_value | |||
) | ZB_ZCL_PACKET_PUT_DATA8(cmd_struct_ptr, current_level_value) |
Adds LevelControl.CurrentLevel attribute value to the fieldset.
cmd_struct_ptr | - pointer to the place to put attribute value to |
current_level_value | - value to put into the buffer |
#define ZB_ZCL_SCENES_ADD_FIELDSET_ON_OFF_ATTR_ON_OFF | ( | cmd_struct_ptr, | |
on_off_value | |||
) | ZB_ZCL_PACKET_PUT_DATA8(cmd_struct_ptr, on_off_value) |
Adds OnOff.OnOff attribute value to the fieldset.
cmd_struct_ptr | - pointer to the place to put attribute value to |
on_off_value | - value to put into the buffer |
#define ZB_ZCL_SCENES_ADD_FIELDSET_THERMOSTAT_ATTR_OCCUPIED_COOLING_SETPOINT | ( | cmd_struct_ptr, | |
occupied_cooling_setpoint_value | |||
) | ZB_ZCL_PACKET_PUT_DATA16(cmd_struct_ptr, occupied_cooling_setpoint_value) |
Adds Thermostat.OccupiedCoolingSetpoint attribute value to the fieldset.
cmd_struct_ptr | - pointer to the place to put attribute value to |
occupied_cooling_setpoint_value | - value to put into the buffer |
#define ZB_ZCL_SCENES_ADD_FIELDSET_THERMOSTAT_ATTR_OCCUPIED_HEATING_SETPOINT | ( | cmd_struct_ptr, | |
occupied_heating_setpoint_value | |||
) | ZB_ZCL_PACKET_PUT_DATA16(cmd_struct_ptr, occupied_heating_setpoint_value) |
Adds Thermostat.OccupiedHeatingSetpoint attribute value to the fieldset.
cmd_struct_ptr | - pointer to the place to put attribute value to |
occupied_heating_setpoint_value | - value to put into the buffer |
#define ZB_ZCL_SCENES_ADD_FIELDSET_THERMOSTAT_ATTR_SYSTEM_MODE | ( | cmd_struct_ptr, | |
system_mode_value | |||
) | ZB_ZCL_PACKET_PUT_DATA8(cmd_struct_ptr, system_mode_value) |
Adds Thermostat.SystemMode attribute value to the fieldset.
cmd_struct_ptr | - pointer to the place to put attribute value to |
system_mode_value | - value to put into the buffer |
#define ZB_ZCL_SCENES_ADD_FIELDSET_WINDOW_COVERING_ATTR_CURRENT_POSITION_LIFT_PERCENTAGE | ( | cmd_struct_ptr, | |
current_position_lift_percentage_value | |||
) |
Adds WindowCovering.CurrentPositionLiftPercentage attribute value to the fieldset.
cmd_struct_ptr | - pointer to the place to put attribute value to |
current_position_lift_percentage_value | - value to put into the buffer |
#define ZB_ZCL_SCENES_ADD_FIELDSET_WINDOW_COVERING_ATTR_CURRENT_POSITION_TILT_PERCENTAGE | ( | cmd_struct_ptr, | |
current_position_tilt_percentage_value | |||
) |
Adds WindowCovering.CurrentPositionTiltPercentage attribute value to the fieldset.
cmd_struct_ptr | - pointer to the place to put attribute value to |
current_position_tilt_percentage_value | - value to put into the buffer |
#define ZB_ZCL_SCENES_ADD_LEVEL_CONTROL_FIELDSET | ( | cmd_struct_ptr, | |
current_level_value | |||
) |
Adds fieldset for Level control cluster.
cmd_struct_ptr | - pionter to the place to put fieldset to |
current_level_value | - value of the LevelControl.CurrentLevel attribute to put into the fieldset |
#define ZB_ZCL_SCENES_ADD_ON_OFF_FIELDSET | ( | cmd_struct_ptr, | |
on_off_value | |||
) |
Adds fieldset for On/Off cluster.
cmd_struct_ptr | - pionter to the place to put fieldset to |
on_off_value | - value of the OnOff.OnOff attribute to put into the fieldset |
#define ZB_ZCL_SCENES_ADD_SCENE_COUNT_GET_SCENE_MEMBERSHIP_RES | ( | cmd_struct_ptr, | |
scene_count | |||
) | ZB_ZCL_PACKET_PUT_DATA8(cmd_struct_ptr, (scene_count)) |
Appends Scene count value to Get scene membership response constant-structure payload part.
cmd_struct_ptr | - pointer to the memory area SceneCount value should be put to |
scene_count | - number of scenes in the scene list |
#define ZB_ZCL_SCENES_ADD_SCENE_ID_GET_SCENE_MEMBERSHIP_RES | ( | cmd_struct_ptr, | |
scene_id | |||
) | ZB_ZCL_PACKET_PUT_DATA8(cmd_struct_ptr, (scene_id)) |
Appends a scene identifier to the Scene list in Get scene membership response payload.
cmd_struct_ptr | - pointer to the memory area scene identifier should be put to |
scene_id | - scene identifier |
#define ZB_ZCL_SCENES_ADD_SCENE_NAME_VIEW_SCENE_RES | ( | cmd_struct_ptr, | |
scene_name | |||
) | ZB_ZCL_PACKET_PUT_DATA8((cmd_struct_ptr), 0) |
Adds scene name into Scenes.ViewSceneResponse payload.
Since we don't support scene names, puts only zero scene name length byte to preserve payload format.
cmd_struct_ptr | - pointer to the place in buffer to put data to |
scene_name | - scene name to put (currently ignored) |
#define ZB_ZCL_SCENES_ADD_THERMOSTAT_FIELDSET | ( | cmd_struct_ptr, | |
occupied_cooling_setpoint_value, | |||
occupied_heating_setpoint_value, | |||
system_mode_value | |||
) |
Adds fieldset for Thermostat cluster.
cmd_struct_ptr | - pionter to the place to put fieldset to |
occupied_cooling_setpoint_value | - value of the Thermostat.OccupiedCoolingSetpoint attribute to put into the fieldset |
occupied_heating_setpoint_value | - value of the Thermostat.OccupiedHeatingSetpoint attribute to put into the fieldset |
system_mode_value | - value of the Thermostat.SystemMode attribute to put into the fieldset |
#define ZB_ZCL_SCENES_ADD_TRANSITION_TIME_VIEW_SCENE_RES | ( | cmd_struct_ptr, | |
trans_time | |||
) | ZB_ZCL_PACKET_PUT_DATA16((cmd_struct_ptr), &(trans_time)) |
Adds transition time into Scenes.ViewSceneResponse payload.
cmd_struct_ptr | - pointer to the place in buffer to put data to |
trans_time | - transition time to put |
#define ZB_ZCL_SCENES_ADD_WINDOW_COVERING_FIELDSET | ( | cmd_struct_ptr, | |
current_position_lift_percentage_value, | |||
current_position_tilt_percentage_value | |||
) |
Adds fieldset for Window covering cluster.
cmd_struct_ptr | - pionter to the place to put fieldset to |
current_position_lift_percentage_value | - value of the WindowCovering.CurrentPositionLiftPercentage attribute to put into the fieldset |
current_position_tilt_percentage_value | - value of the WindowCovering.CurrentPositionTiltPercentage attribute to put into the fieldset |
#define ZB_ZCL_SCENES_ADJUST_FIELDSET_PTR | ( | cmd_struct_ptr | ) |
#define ZB_ZCL_SCENES_ADJUST_FIELDSET_PTR_INCONDITIONAL | ( | cmd_struct_ptr | ) |
#define ZB_ZCL_SCENES_CAPACITY_ONE_MORE ((zb_uint8_t)0xfe) |
Scene table capacity: at least one scene can be added.
Exact number is unknown
#define ZB_ZCL_SCENES_CLEAR_ENDPOINT_SCENE_TABLE | ( | endpoint_desc, | |
remove_zero_group, | |||
status | |||
) |
Marks all records in a table as free.
endpoint_desc | - pointer to the description of the endpoint (of type zb_af_endpoint_desc_s) a scene table belongs to |
remove_zero_group | - boolean flag indicating we need to clean scenes for groups with zero group identifier too. |
status | of the operation |
#define ZB_ZCL_SCENES_CLEAR_SCENE_TABLE | ( | table_name | ) |
Marks all records in a table as free.
table_name | Name of the scene table variable |
#define ZB_ZCL_SCENES_FIELDSETS_LENGTH | ( | CLUSTER_SYMBOL | ) | (CLUSTER_SYMBOL ## _SCENE_FIELD_SETS_LENGTH) |
Evaluates length if a fieldset for a particular cluster.
CLUSTER_SYMBOL is a symbolic name for a cluster identifier, see literals in zb_zcl_cluster_id_e
#define ZB_ZCL_SCENES_FIELDSETS_LENGTH_2 | ( | CLUSTER_SYMBOL1, | |
CLUSTER_SYMBOL2 | |||
) |
Evaluates length if a fieldset for a particular cluster.
CLUSTER_SYMBOL is a symbolic name for a cluster identifier, see literals in zb_zcl_cluster_id_e
#define ZB_ZCL_SCENES_FIELDSETS_LENGTH_3 | ( | CLUSTER_SYMBOL1, | |
CLUSTER_SYMBOL2, | |||
CLUSTER_SYMBOL3 | |||
) |
Evaluates length if a fieldset for a particular cluster.
CLUSTER_SYMBOL is a symbolic name for a cluster identifier, see literals in zb_zcl_cluster_id_e
#define ZB_ZCL_SCENES_FIELDSETS_LENGTH_4 | ( | CLUSTER_SYMBOL1, | |
CLUSTER_SYMBOL2, | |||
CLUSTER_SYMBOL3, | |||
CLUSTER_SYMBOL4 | |||
) |
Evaluates length if a fieldset for a particular cluster.
CLUSTER_SYMBOL is a symbolic name for a cluster identifier, see literals in zb_zcl_cluster_id_e
#define ZB_ZCL_SCENES_FIELDSETS_LENGTH_5 | ( | CLUSTER_SYMBOL1, | |
CLUSTER_SYMBOL2, | |||
CLUSTER_SYMBOL3, | |||
CLUSTER_SYMBOL4, | |||
CLUSTER_SYMBOL5 | |||
) |
Evaluates length if a fieldset for a particular cluster.
CLUSTER_SYMBOL is a symbolic name for a cluster identifier, see literals in zb_zcl_cluster_id_e
#define ZB_ZCL_SCENES_FREE_SCENE_TABLE_RECORD 0xffff |
Declares a "free record" marker for a scene table.
Used as a value of a group_id field (see zb_zcl_scene_table_record_type_s) in a corresponding table record
#define ZB_ZCL_SCENES_GET_16BIT_VALUE | ( | dst_data_ptr, | |
src_data_ptr, | |||
content_length, | |||
dst_fieldset_length, | |||
status | |||
) |
#define ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_COLOR_CONTROL_CURRENT_SATURATION | ( | dst_data_ptr, | |
src_data_ptr, | |||
content_length, | |||
dst_fieldset_length | |||
) |
Copies ColorControl.CurrentSaturation attribute value from Scenes.AddScene command payload into the specified point in memory.
dst_data_ptr | - address to put value to |
src_data_ptr | - address to get value from |
content_length | - length of the content wsiting processing |
dst_fieldset_length | - pointer to the length of the destination fieldset |
#define ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_COLOR_CONTROL_CURRENT_X | ( | dst_data_ptr, | |
src_data_ptr, | |||
content_length, | |||
dst_fieldset_length | |||
) |
Copies ColorControl.CurrentX attribute value from Scenes.AddScene command payload into the specified point in memory.
dst_data_ptr | - address to put value to |
src_data_ptr | - address to get value from |
content_length | - length of the content wsiting processing |
dst_fieldset_length | - pointer to the length of the destination fieldset |
#define ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_COLOR_CONTROL_CURRENT_Y | ( | dst_data_ptr, | |
src_data_ptr, | |||
content_length, | |||
dst_fieldset_length | |||
) |
Copies ColorControl.CurrentY attribute value from Scenes.AddScene command payload into the specified point in memory.
dst_data_ptr | - address to put value to |
src_data_ptr | - address to get value from |
content_length | - length of the content wsiting processing |
dst_fieldset_length | - pointer to the length of the destination fieldset |
#define ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_COLOR_CONTROL_FIELDSET | ( | dst_data_ptr, | |
src_data_ptr, | |||
content_length, | |||
dst_fieldset_length | |||
) |
Extracts ColorControl fieldset value from Scenes.AddScene command payload into the specified point in memory.
dst_data_ptr | - address to put value to |
src_data_ptr | - address to get value from |
content_length | - length of the content wsiting processing |
dst_fieldset_length | - pointer to the length of the destination fieldset |
#define ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_COMMON | ( | buffer, | |
cmd_struct_ptr | |||
) |
Parse common part of Add Scene command.
buffer | containing Store scene command payload |
cmd_struct_ptr | - pointer to the request representation structure (of type zb_zcl_scenes_add_scene_req_s) or NULL pointer if payload size is too small |
#define ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_DOOR_LOCK_FIELDSET | ( | dst_data_ptr, | |
src_data_ptr, | |||
content_length, | |||
dst_fieldset_length | |||
) |
Extracts DoorLock fieldset value from Scenes.AddScene command payload into the specified point in memory.
dst_data_ptr | - address to put value to |
src_data_ptr | - address to get value from |
content_length | - length of the content wsiting processing |
dst_fieldset_length | - pointer to the length of the destination fieldset |
#define ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_DOOR_LOCK_LOCK_STATE | ( | dst_data_ptr, | |
src_data_ptr, | |||
content_length, | |||
dst_fieldset_length | |||
) |
Copies DoorLock.LockState attribute value from Scenes.AddScene command payload into the specified point in memory.
dst_data_ptr | - address to put value to |
src_data_ptr | - address to get value from |
content_length | - length of the content wsiting processing |
dst_fieldset_length | - pointer to the length of the destination fieldset |
#define ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_LEVEL_CONTROL_CURRENT_LEVEL | ( | dst_data_ptr, | |
src_data_ptr, | |||
content_length, | |||
dst_fieldset_length | |||
) |
Copies LevelControl.CurrentLevel attribute value from Scenes.AddScene command payload into the specified point in memory.
dst_data_ptr | - address to put value to |
src_data_ptr | - address to get value from |
content_length | - length of the content wsiting processing |
dst_fieldset_length | - pointer to the length of the destination fieldset |
#define ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_LEVEL_CONTROL_FIELDSET | ( | dst_data_ptr, | |
src_data_ptr, | |||
content_length, | |||
dst_fieldset_length | |||
) |
Extracts LevelControl fieldset value from Scenes.AddScene command payload into the specified point in memory.
dst_data_ptr | - address to put value to |
src_data_ptr | - address to get value from |
content_length | - length of the content wsiting processing |
dst_fieldset_length | - pointer to the length of the destination fieldset |
#define ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_NEXT_FIELDSET_DESC | ( | buffer, | |
cmd_struct_ptr, | |||
content_length | |||
) |
Parses fieldset description.
buffer | containing fieldset |
cmd_struct_ptr | - pointer to the fieldset description representation structure (of type zb_zcl_scenes_fieldset_common_s) or NULL pointer if payload size is too small |
content_length | - variable to contain size of the fieldset content left unprocessed |
#define ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_ON_OFF_FIELDSET | ( | dst_data_ptr, | |
src_data_ptr, | |||
content_length, | |||
dst_fieldset_length | |||
) |
Extracts OnOff fieldset value from Scenes.AddScene command payload into the specified point in memory.
dst_data_ptr | - address to put value to |
src_data_ptr | - address to get value from |
content_length | - length of the content wsiting processing |
dst_fieldset_length | - pointer to the length of the destination fieldset |
#define ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_ON_OFF_ON_OFF | ( | dst_data_ptr, | |
src_data_ptr, | |||
content_length, | |||
dst_fieldset_length | |||
) |
Copies OnOff.OnOff attribute value from Scenes.AddScene command payload into the specified point in memory.
dst_data_ptr | - address to put value to |
src_data_ptr | - address to get value from |
content_length | - length of the content wsiting processing |
dst_fieldset_length | - pointer to the length of the destination fieldset |
#define ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_STORE_FIELDSET_COMMON | ( | src_data_ptr, | |
dst_data_ptr, | |||
content_length | |||
) |
Copies parsed fieldset description into designated memory area.
src_data_ptr | - pointer to the memory area containing parsed fieldset description |
dst_data_ptr | - pointer to the memory area to put fieldset description to |
content_length | - remaining length of the unprocessed fieldset content |
#define ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_THERMOSTAT_FIELDSET | ( | dst_data_ptr, | |
src_data_ptr, | |||
content_length, | |||
dst_fieldset_length | |||
) |
Extracts Thermostat fieldset value from Scenes.AddScene command payload into the specified point in memory.
dst_data_ptr | - address to put value to |
src_data_ptr | - address to get value from |
content_length | - length of the content wsiting processing |
dst_fieldset_length | - pointer to the length of the destination fieldset |
#define ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_THERMOSTAT_OCCUPIED_COOLING_SETPOINT | ( | dst_data_ptr, | |
src_data_ptr, | |||
content_length, | |||
dst_fieldset_length | |||
) |
Copies Thermostat.OccupiedCoolingSetpoint attribute value from Scenes.AddScene command payload into the specified point in memory.
dst_data_ptr | - address to put value to |
src_data_ptr | - address to get value from |
content_length | - length of the content wsiting processing |
dst_fieldset_length | - pointer to the length of the destination fieldset |
#define ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_THERMOSTAT_OCCUPIED_HEATING_SETPOINT | ( | dst_data_ptr, | |
src_data_ptr, | |||
content_length, | |||
dst_fieldset_length | |||
) |
Copies Thermostat.OccupiedHeatingSetpoint attribute value from Scenes.AddScene command payload into the specified point in memory.
dst_data_ptr | - address to put value to |
src_data_ptr | - address to get value from |
content_length | - length of the content wsiting processing |
dst_fieldset_length | - pointer to the length of the destination fieldset |
#define ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_THERMOSTAT_SYSTEM_MODE | ( | dst_data_ptr, | |
src_data_ptr, | |||
content_length, | |||
dst_fieldset_length | |||
) |
Copies Thermostat.SystemMode attribute value from Scenes.AddScene command payload into the specified point in memory.
dst_data_ptr | - address to put value to |
src_data_ptr | - address to get value from |
content_length | - length of the content wsiting processing |
dst_fieldset_length | - pointer to the length of the destination fieldset |
#define ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_WINDOW_COVERING_FIELDSET | ( | dst_data_ptr, | |
src_data_ptr, | |||
content_length, | |||
dst_fieldset_length | |||
) |
Extracts WindowCovering fieldset value from Scenes.AddScene command payload into the specified point in memory.
dst_data_ptr | - address to put value to |
src_data_ptr | - address to get value from |
content_length | - length of the content wsiting processing |
dst_fieldset_length | - pointer to the length of the destination fieldset |
#define ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_WINDOW_COVERING_LIFT_PERCENTAGE | ( | dst_data_ptr, | |
src_data_ptr, | |||
content_length, | |||
dst_fieldset_length | |||
) |
Copies WindowCovering.LiftPercentage attribute value from Scenes.AddScene command payload into the specified point in memory.
dst_data_ptr | - address to put value to |
src_data_ptr | - address to get value from |
content_length | - length of the content wsiting processing |
dst_fieldset_length | - pointer to the length of the destination fieldset |
#define ZB_ZCL_SCENES_GET_ADD_SCENE_REQ_WINDOW_COVERING_TILT_PERCENTAGE | ( | dst_data_ptr, | |
src_data_ptr, | |||
content_length, | |||
dst_fieldset_length | |||
) |
Copies WindowCovering.TiltPercentage attribute value from Scenes.AddScene command payload into the specified point in memory.
dst_data_ptr | - address to put value to |
src_data_ptr | - address to get value from |
content_length | - length of the content wsiting processing |
dst_fieldset_length | - pointer to the length of the destination fieldset |
#define ZB_ZCL_SCENES_GET_ADD_SCENE_RES | ( | buffer, | |
cmd_struct_ptr | |||
) |
Parses Scenes.AddSceneResponse command payload.
buffer | to get data from |
cmd_struct_ptr | - pointer to the request representation structure (of type zb_zcl_scenes_add_scene_res_s) or NULL pointer if payload size is too small |
#define ZB_ZCL_SCENES_GET_GET_SCENE_MEMBERSHIP_REQ | ( | buffer, | |
cmd_struct_ptr | |||
) |
Parses Scenes.GetSceneMembership command payload.
buffer | to get data from |
cmd_struct_ptr | - pointer to the request representation structure (of type zb_zcl_scenes_get_scene_membership_req_s) or NULL pointer if payload size is too small |
#define ZB_ZCL_SCENES_GET_GET_SCENE_MEMBERSHIP_RES | ( | buffer, | |
cmd_struct_ptr | |||
) |
Parses Scenes.RemoveAllScenesResponse command payload.
buffer | to get data from |
cmd_struct_ptr | - pointer to the request representation structure (of type zb_zcl_scenes_get_scene_membership_res_s) or NULL pointer if payload size is too small to contain mandatory part |
#define ZB_ZCL_SCENES_GET_RECALL_SCENE_REQ | ( | buffer, | |
cmd_struct_ptr | |||
) |
Parse Recall Scene command.
buffer | containing Store scene command payload |
cmd_struct_ptr | - pointer to the request representation structure (of type zb_zcl_scenes_recall_scene_req_s) or NULL pointer if payload size is too small |
#define ZB_ZCL_SCENES_GET_REMOVE_ALL_SCENES_REQ | ( | buffer, | |
cmd_struct_ptr | |||
) |
Parses Scenes.RemoveScene command payload.
buffer | to get data from |
cmd_struct_ptr | - pointer to the request representation structure (of type zb_zcl_scenes_remove_scene_req_s) or NULL pointer if payload size is too small |
#define ZB_ZCL_SCENES_GET_REMOVE_ALL_SCENES_RES | ( | buffer, | |
cmd_struct_ptr | |||
) |
Parses Scenes.RemoveAllScenesResponse command payload.
buffer | to get data from |
cmd_struct_ptr | - pointer to the request representation structure (of type zb_zcl_scenes_remove_all_scenes_res_s) or NULL pointer if payload size is too small |
#define ZB_ZCL_SCENES_GET_REMOVE_SCENE_REQ | ( | buffer, | |
cmd_struct_ptr | |||
) |
Parses Scenes.RemoveScene command payload.
buffer | to get data from |
cmd_struct_ptr | - pointer to the request representation structure (of type zb_zcl_scenes_remove_scene_req_s) or NULL pointer if payload size is too small |
#define ZB_ZCL_SCENES_GET_REMOVE_SCENE_RES | ( | buffer, | |
cmd_struct_ptr | |||
) |
Parses Scenes.RemoveSceneResponse command payload.
buffer | to get data from |
cmd_struct_ptr | - pointer to the request representation structure (of type zb_zcl_scenes_remove_scene_res_s) or NULL pointer if payload size is too small |
#define ZB_ZCL_SCENES_GET_STORE_SCENE_REQ | ( | buffer, | |
cmd_struct_ptr | |||
) |
Parse Store Scene command.
buffer | containing Store scene command payload |
cmd_struct_ptr | - pointer to the request representation structure (of type zb_zcl_scenes_store_scene_req_s) or NULL pointer if payload size is too small |
#define ZB_ZCL_SCENES_GET_STORE_SCENE_RES | ( | buffer, | |
cmd_struct_ptr | |||
) |
Parses Scenes.StoreScene command payload.
buffer | to get data from |
cmd_struct_ptr | - pointer to the request representation structure (of type zb_zcl_scenes_store_scene_res_s) or NULL pointer if payload size is too small |
#define ZB_ZCL_SCENES_GET_TABLE_FIELDSETS_BEGIN | ( | scene_table_record | ) |
#define ZB_ZCL_SCENES_GET_VIEW_SCENE_REQ | ( | buffer, | |
cmd_struct_ptr | |||
) |
Parses Scenes.ViewScene command payload.
buffer | to get data from |
cmd_struct_ptr | - pointer to the request representation structure (of type zb_zcl_scenes_view_scene_req_s) or NULL pointer if payload size is too small |
#define ZB_ZCL_SCENES_GET_VIEW_SCENE_RES_COMMON | ( | buffer, | |
response_ptr | |||
) |
Parses comon part of the Scenes.ViewSceneResponse.
buffer | containing data |
response_ptr | - pointer to the extracted data |
#define ZB_ZCL_SCENES_INIT_ADD_SCENE_REQ | ( | buffer, | |
cmd_struct_ptr, | |||
dis_default_resp, | |||
group_id, | |||
scene_id, | |||
transition_time | |||
) |
Start filling Add scene command frame.
Fills the constant-structure part of the command payload only.
Command can contain no fieldsets defining empty scene. The new scene can be used, for example, for storing fieldsets with Store scene command.
buffer | to put packet to |
cmd_struct_ptr | - pointer to the place variable-structure part of the command payload (fieldsets) should be placed. |
dis_default_resp | - enable/disable default response |
group_id | - group identifier for the scene to store |
scene_id | - scene identifier for the scene to store |
transition_time | - scene transition time |
#define ZB_ZCL_SCENES_INIT_FIELDSET | ( | cmd_struct_ptr, | |
cluster, | |||
fs_length | |||
) |
Adds fieldset into the buffer for sending command.
cmd_struct_ptr | - pointer to the place in the buffer to put data to |
cluster | identifier the fieldset under consideration belongs to |
fs_length | - summary length of the attributes in the fieldset |
#define ZB_ZCL_SCENES_INIT_GET_SCENE_MEMBERSHIP_RES | ( | buffer, | |
cmd_struct_ptr, | |||
seq_num, | |||
cap_ptr, | |||
status, | |||
capacity, | |||
group_id | |||
) |
Start filling Get scene membership response frame.
Fills the mandatory part of the Get scene membership scene response payload.
buffer | to put packet to |
cmd_struct_ptr | - pointer to the place variable-structure part of the command payload (fieldsets) should be placed. |
seq_num | - ZCL sequence number |
cap_ptr | - pointer to the capacity fields of the response |
status | of the command execution. Appropriate values (defined in zb_zcl_status_e enumeration) are:
|
capacity | of the scene table |
group_id | - group identifier for the scene to store |
#define ZB_ZCL_SCENES_INIT_VIEW_SCENE_RES | ( | buffer, | |
cmd_struct_ptr, | |||
seq_num, | |||
status, | |||
group_id, | |||
scene_id | |||
) |
Start filling View scene response frame.
Fills the mandatory part of the View scene response payload.
buffer | to put packet to |
cmd_struct_ptr | - pointer to the place variable-structure part of the command payload (fieldsets) should be placed. |
seq_num | - ZCL sequence number |
status | of the command execution. Appropriate values (defined in zb_zcl_status_e enumeration) are:
|
group_id | - group identifier for the scene to store |
scene_id | - scene identifier for the scene to store |
#define ZB_ZCL_SCENES_NAME_SUPPORT_DEFAULT_VALUE 0 |
Default value for Name support attribute.
Actually Name support attribute has no default value (see ZCL spec, subclause 3.7.2.2.1.5), but we don't support scene names, so we are able to declare default value for the attribute until name support will be added
#define ZB_ZCL_SCENES_RECALL_COLOR_CONTROL_CURRENT_SATURATION | ( | endpoint, | |
cmd_struct_ptr | |||
) |
#define ZB_ZCL_SCENES_RECALL_COLOR_CONTROL_CURRENT_X | ( | endpoint, | |
cmd_struct_ptr | |||
) |
#define ZB_ZCL_SCENES_RECALL_COLOR_CONTROL_CURRENT_Y | ( | endpoint, | |
cmd_struct_ptr | |||
) |
#define ZB_ZCL_SCENES_RECALL_COLOR_CONTROL_FIELDSET | ( | endpoint, | |
cmd_struct_ptr | |||
) |
#define ZB_ZCL_SCENES_RECALL_DOOR_LOCK_FIELDSET | ( | endpoint, | |
cmd_struct_ptr | |||
) |
#define ZB_ZCL_SCENES_RECALL_DOOR_LOCK_LOCK_STATE | ( | endpoint, | |
cmd_struct_ptr | |||
) |
#define ZB_ZCL_SCENES_RECALL_LEVEL_CONTROL_CURRENT_LEVEL | ( | endpoint, | |
cmd_struct_ptr | |||
) |
#define ZB_ZCL_SCENES_RECALL_LEVEL_CONTROL_FIELDSET | ( | endpoint, | |
cmd_struct_ptr | |||
) |
#define ZB_ZCL_SCENES_RECALL_ON_OFF_FIELDSET | ( | endpoint, | |
cmd_struct_ptr | |||
) |
#define ZB_ZCL_SCENES_RECALL_ON_OFF_ON_OFF | ( | endpoint, | |
cmd_struct_ptr | |||
) |
#define ZB_ZCL_SCENES_RECALL_THERMOSTAT_FIELDSET | ( | endpoint, | |
cmd_struct_ptr | |||
) |
#define ZB_ZCL_SCENES_RECALL_THERMOSTAT_OCCUPIED_COOLING_SETPOINT | ( | endpoint, | |
cmd_struct_ptr | |||
) |
#define ZB_ZCL_SCENES_RECALL_THERMOSTAT_OCCUPIED_HEATING_SETPOINT | ( | endpoint, | |
cmd_struct_ptr | |||
) |
#define ZB_ZCL_SCENES_RECALL_THERMOSTAT_SYSTEM_MODE | ( | endpoint, | |
cmd_struct_ptr | |||
) |
#define ZB_ZCL_SCENES_RECALL_WINDOW_COVERING_CURRENT_POSITION_LIFT_PERCENTAGE | ( | endpoint, | |
cmd_struct_ptr | |||
) |
#define ZB_ZCL_SCENES_RECALL_WINDOW_COVERING_CURRENT_POSITION_TILT_PERCENTAGE | ( | endpoint, | |
cmd_struct_ptr | |||
) |
#define ZB_ZCL_SCENES_RECALL_WINDOW_COVERING_FIELDSET | ( | endpoint, | |
cmd_struct_ptr | |||
) |
#define ZB_ZCL_SCENES_SEND_ADD_SCENE_REQ | ( | buffer, | |
cmd_struct_ptr, | |||
dst_addr, | |||
dst_ep, | |||
ep, | |||
prof_id, | |||
callback | |||
) |
Sends Add scene command.
buffer | - with prepared command payload |
cmd_struct_ptr | - pointer to the place variable-structure part of the |
dst_addr | - address to send packet to |
dst_ep | - destination endpoint |
ep | - sending endpoint |
prof_id | - profile identifier |
callback | for getting command send status |
#define ZB_ZCL_SCENES_SEND_ADD_SCENE_RES | ( | buffer, | |
seq_num, | |||
dst_addr, | |||
dst_ep, | |||
ep, | |||
prof_id, | |||
callback, | |||
status, | |||
group_id, | |||
scene_id | |||
) |
Send Add Scene response.
buffer | to put packet to |
seq_num | - ZCL sequence number |
dst_addr | - address to send packet to |
dst_ep | - destination endpoint |
ep | - sending endpoint |
prof_id | - profile identifier |
callback | for getting command send status |
status | of the corresponding Add scene command execution. Appropriate values (defined in zb_zcl_status_e enumeration)are:
|
group_id | - group identifier for the scene to store |
scene_id | - scene identifier for the scene to store |
#define ZB_ZCL_SCENES_SEND_GET_SCENE_MEMBERSHIP_REQ | ( | buffer, | |
dst_addr, | |||
dst_addr_mode, | |||
dst_ep, | |||
ep, | |||
prof_id, | |||
dis_default_resp, | |||
callback, | |||
group_id | |||
) |
Send Remove all scenes command.
The command can be sent to device or group of devices either
buffer | to put packet to |
dst_addr | - address to send packet to |
dst_addr_mode | - addressing mode. Either ZB_APS_ADDR_MODE_16_ENDP_PRESENT or ZB_APS_ADDR_MODE_16_GROUP_ENDP_NOT_PRESENT will fit |
dst_ep | - destination endpoint (if sendting to a particular device) |
ep | - sending endpoint |
prof_id | - profile identifier |
dis_default_resp | - enable/disable default response |
callback | for getting command send status |
group_id | - group identifier for the scene to store |
#define ZB_ZCL_SCENES_SEND_GET_SCENE_MEMBERSHIP_RES | ( | buffer, | |
cmd_struct_ptr, | |||
dst_addr, | |||
dst_ep, | |||
ep, | |||
prof_id, | |||
callback | |||
) |
Sends Get scene membership response.
buffer | with prepared command payload |
cmd_struct_ptr | - pointer to the place directly after the payload |
dst_addr | - address to send packet to |
dst_ep | - destination endpoint |
ep | - sending endpoint |
prof_id | - profile identifier |
callback | for getting command send status |
#define ZB_ZCL_SCENES_SEND_RECALL_SCENE_REQ | ( | buffer, | |
dst_addr, | |||
dst_addr_mode, | |||
dst_ep, | |||
ep, | |||
prof_id, | |||
dis_default_resp, | |||
callback, | |||
group_id, | |||
scene_id | |||
) |
Send Recall scene command.
The command can be sent to device or group of devices either
buffer | to put packet to |
dst_addr | - address to send packet to |
dst_addr_mode | - addressing mode. Either ZB_APS_ADDR_MODE_16_ENDP_PRESENT or ZB_APS_ADDR_MODE_16_GROUP_ENDP_NOT_PRESENT will fit |
dst_ep | - destination endpoint (if sendting to a particular device) |
ep | - sending endpoint |
prof_id | - profile identifier |
dis_default_resp | - enable/disable default response |
callback | for getting command send status |
group_id | - group identifier for the scene to store |
scene_id | - scene identifier for the scene to store |
#define ZB_ZCL_SCENES_SEND_REMOVE_ALL_SCENES_REQ | ( | buffer, | |
dst_addr, | |||
dst_addr_mode, | |||
dst_ep, | |||
ep, | |||
prof_id, | |||
dis_default_resp, | |||
callback, | |||
group_id | |||
) |
Send Remove all scenes command.
The command can be sent to device or group of devices either
buffer | to put packet to |
dst_addr | - address to send packet to |
dst_addr_mode | - addressing mode. Either ZB_APS_ADDR_MODE_16_ENDP_PRESENT or ZB_APS_ADDR_MODE_16_GROUP_ENDP_NOT_PRESENT will fit |
dst_ep | - destination endpoint (if sendting to a particular device) |
ep | - sending endpoint |
prof_id | - profile identifier |
dis_default_resp | - enable/disable default response |
callback | for getting command send status |
group_id | - group identifier for the scene to store |
#define ZB_ZCL_SCENES_SEND_REMOVE_ALL_SCENES_RES | ( | buffer, | |
seq_num, | |||
dst_addr, | |||
dst_ep, | |||
ep, | |||
prof_id, | |||
callback, | |||
status, | |||
group_id | |||
) |
Send Remove all scenes response.
buffer | to put packet to |
seq_num | - ZCL sequence number |
dst_addr | - address to send packet to |
dst_ep | - destination endpoint |
ep | - sending endpoint |
prof_id | - profile identifier |
callback | for getting command send status |
status | of the corresponding Add scene command execution. Appropriate values (defined in zb_zcl_status_e enumeration)are:
|
group_id | - group identifier for the scene to store |
#define ZB_ZCL_SCENES_SEND_REMOVE_SCENE_REQ | ( | buffer, | |
dst_addr, | |||
dst_addr_mode, | |||
dst_ep, | |||
ep, | |||
prof_id, | |||
dis_default_resp, | |||
callback, | |||
group_id, | |||
scene_id | |||
) |
Send Remove scene command.
The command can be sent to device or group of devices either
buffer | to put packet to |
dst_addr | - address to send packet to |
dst_addr_mode | - addressing mode. Either ZB_APS_ADDR_MODE_16_ENDP_PRESENT or ZB_APS_ADDR_MODE_16_GROUP_ENDP_NOT_PRESENT will fit |
dst_ep | - destination endpoint (if sendting to a particular device) |
ep | - sending endpoint |
prof_id | - profile identifier |
dis_default_resp | - enable/disable default response |
callback | for getting command send status |
group_id | - group identifier for the scene to store |
scene_id | - scene identifier for the scene to store |
#define ZB_ZCL_SCENES_SEND_REMOVE_SCENE_RES | ( | buffer, | |
seq_num, | |||
dst_addr, | |||
dst_ep, | |||
ep, | |||
prof_id, | |||
callback, | |||
status, | |||
group_id, | |||
scene_id | |||
) |
Send Remove Scene response.
buffer | to put packet to |
seq_num | - ZCL sequence number |
dst_addr | - address to send packet to |
dst_ep | - destination endpoint |
ep | - sending endpoint |
prof_id | - profile identifier |
callback | for getting command send status |
status | of the corresponding Add scene command execution. Appropriate values (defined in zb_zcl_status_e enumeration)are:
|
group_id | - group identifier for the scene to store |
scene_id | - scene identifier for the scene to store |
#define ZB_ZCL_SCENES_SEND_STORE_SCENE_REQ | ( | buffer, | |
dst_addr, | |||
dst_addr_mode, | |||
dst_ep, | |||
ep, | |||
prof_id, | |||
dis_default_resp, | |||
callback, | |||
group_id, | |||
scene_id | |||
) |
Send Store Scene command.
The command can be sent to device or group of devices either
buffer | to put packet to |
dst_addr | - address to send packet to |
dst_addr_mode | - addressing mode. Either ZB_APS_ADDR_MODE_16_ENDP_PRESENT or ZB_APS_ADDR_MODE_16_GROUP_ENDP_NOT_PRESENT will fit |
dst_ep | - destination endpoint (if sendting to a particular device) |
ep | - sending endpoint |
prof_id | - profile identifier |
dis_default_resp | - enable/disable default response |
callback | for getting command send status |
group_id | - group identifier for the scene to store |
scene_id | - scene identifier for the scene to store |
#define ZB_ZCL_SCENES_SEND_STORE_SCENE_RES | ( | buffer, | |
seq_num, | |||
dst_addr, | |||
dst_ep, | |||
ep, | |||
prof_id, | |||
callback, | |||
status, | |||
group_id, | |||
scene_id | |||
) |
Send Store scene response.
buffer | to put packet to |
seq_num | - ZCL sequence number |
dst_addr | - address to send packet to |
dst_ep | - destination endpoint |
ep | - sending endpoint |
prof_id | - profile identifier |
callback | for getting command send status |
status | of the corresponding Add scene command execution. Appropriate values (defined in zb_zcl_status_e enumeration)are:
|
group_id | - group identifier for the scene to store |
scene_id | - scene identifier for the scene to store |
#define ZB_ZCL_SCENES_SEND_VIEW_SCENE_REQ | ( | buffer, | |
dst_addr, | |||
dst_ep, | |||
ep, | |||
prof_id, | |||
dis_default_resp, | |||
callback, | |||
group_id, | |||
scene_id | |||
) |
Send View Scene command.
buffer | to put packet to |
dst_addr | - address to send packet to |
dst_ep | - destination endpoint |
ep | - sending endpoint |
prof_id | - profile identifier |
dis_default_resp | - enable/disable default response |
callback | for getting command send status |
group_id | - group identifier for the scene to store |
scene_id | - scene identifier for the scene to store |
#define ZB_ZCL_SCENES_SEND_VIEW_SCENE_RES | ( | buffer, | |
cmd_struct_ptr, | |||
dst_addr, | |||
dst_ep, | |||
ep, | |||
prof_id, | |||
callback | |||
) |
Sends View scene response.
buffer | with prepared command payload |
cmd_struct_ptr | - pointer to the place variable-structure part of the |
dst_addr | - address to send packet to |
dst_ep | - destination endpoint |
ep | - sending endpoint |
prof_id | - profile identifier |
callback | for getting command send status |
#define ZB_ZCL_SCENES_TABLE_RECORD_SIZE | ( | FIELD_SETS_LENGTH | ) | (FIELD_SETS_LENGTH + sizeof(zb_zcl_scene_table_record_fixed_t)) |
Evaluates Scene table record size.
FIELD_SETS_LENGTH | length of the fieldsets (variable part of the record) |
#define ZB_ZCL_SCENES_VIEW_SCENE_COLOR_CONTROL_FIELDSET | ( | cmd_struct_ptr, | |
dst_data_ptr | |||
) |
#define ZB_ZCL_SCENES_VIEW_SCENE_DOOR_LOCK_FIELDSET | ( | cmd_struct_ptr, | |
dst_data_ptr | |||
) |
#define ZB_ZCL_SCENES_VIEW_SCENE_DOOR_LOCK_LOCK_STATE | ( | cmd_struct_ptr, | |
dst_data_ptr | |||
) |
#define ZB_ZCL_SCENES_VIEW_SCENE_LEVEL_CONTROL_CURRENT_LEVEL | ( | cmd_struct_ptr, | |
dst_data_ptr | |||
) |
#define ZB_ZCL_SCENES_VIEW_SCENE_LEVEL_CONTROL_FIELDSET | ( | cmd_struct_ptr, | |
dst_data_ptr | |||
) |
#define ZB_ZCL_SCENES_VIEW_SCENE_ON_OFF_FIELDSET | ( | cmd_struct_ptr, | |
dst_data_ptr | |||
) |
#define ZB_ZCL_SCENES_VIEW_SCENE_ON_OFF_ON_OFF | ( | cmd_struct_ptr, | |
dst_data_ptr | |||
) |
#define ZB_ZCL_SCENES_VIEW_SCENE_THERMOSTAT_FIELDSET | ( | cmd_struct_ptr, | |
dst_data_ptr | |||
) |
#define ZB_ZCL_SCENES_VIEW_SCENE_THERMOSTAT_OCCUPIED_COOLING_SETPOINT | ( | cmd_struct_ptr, | |
dst_data_ptr | |||
) |
#define ZB_ZCL_SCENES_VIEW_SCENE_THERMOSTAT_OCCUPIED_HEATING_SETPOINT | ( | cmd_struct_ptr, | |
dst_data_ptr | |||
) |
#define ZB_ZCL_SCENES_VIEW_SCENE_THERMOSTAT_SYSTEM_MODE | ( | cmd_struct_ptr, | |
dst_data_ptr | |||
) |
#define ZB_ZCL_SCENES_VIEW_SCENE_WINDOW_COVERING_CURRENT_POSITION_LIFT_PERCENTAGE | ( | cmd_struct_ptr, | |
dst_data_ptr | |||
) |
#define ZB_ZCL_SCENES_VIEW_SCENE_WINDOW_COVERING_CURRENT_POSITION_TILT_PERCENTAGE | ( | cmd_struct_ptr, | |
dst_data_ptr | |||
) |
#define ZB_ZCL_SCENES_VIEW_SCENE_WINDOW_COVERING_FIELDSET | ( | cmd_struct_ptr, | |
dst_data_ptr | |||
) |
typedef struct zb_zcl_scene_table_record_type_s zb_zcl_scene_table_record_type_t |
Typical Scene table record structure.
For each endpoint corresponding type must be declared with ... macro.
enum zb_zcl_scene_attr_e |
Scene cluster attribute identifiers.
enum zb_zcl_scenes_cmd_e |
Command identifiers for Scenes Cluster.
Command response identifiers for Scenes Cluster.
zb_zcl_status_t zb_zcl_scenes_process_store_scene | ( | zb_uint8_t | endpoint, |
zb_uint8_t | group_id, | ||
zb_uint8_t | scene_id | ||
) |
Store scene.
endpoint | - endpoint |
group_id | - scene group ID |
scene_id | - scene ID |
zb_ret_t zb_zcl_scenes_recall_global_scene | ( | zb_uint8_t | param, |
zb_uint8_t | endpoint | ||
) |
Recall Global scene.
param | - buffer for recall scene |
endpoint | - enpoint scene for recall |
zb_void_t zb_zcl_scenes_remove_scenes_in_all_endpoints | ( | zb_uint16_t | group_id | ) |
Removes All scenes corresponding to a group identifiers in a whole device.
group_id | - group identifier for which all scenes must be removed. |