Developing with ZBOSS for Zigbee
|
Data Structures | |
struct | zb_zcl_scene_table_record_fixed_s |
Fixed-size part of the Scene table. More... | |
struct | zb_zcl_scenes_fieldset_common_s |
Common part of the field set definition. More... | |
struct | zb_zcl_scenes_add_scene_req_s |
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_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_scenes_fieldset_common_s | zb_zcl_scenes_fieldset_common_t |
Common part of the field set definition. | |
#define | ZB_ZCL_SCENES_NAME_SUPPORT_BIT_MASK 0x80 |
Mask to extract Name support bit. | |
#define | ZB_ZCL_ATTR_SCENES_CURRENT_GROUP_MIN_VALUE 0x0001 |
#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_SCENES_FREE_SCENE_TABLE_RECORD 0xffff |
Declares a "free record" marker for a scene table Used as a value of a group_id field in a corresponding table record. | |
#define | ZB_ZCL_SCENES_TRANSITION_TIME_DEFAULT_VALUE 0 |
Default value for scene transition time. | |
#define | ZB_ZCL_DECLARE_SCENES_ATTRIB_LIST( attr_list, scene_count, current_scene, current_group, scene_valid, name_support) |
Declares Scenes attribute list. More... | |
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, ZB_ZCL_CMD_SCENES_ENHANCED_ADD_SCENE = 0x40, ZB_ZCL_CMD_SCENES_ENHANCED_VIEW_SCENE = 0x41, ZB_ZCL_CMD_SCENES_COPY_SCENE = 0x42 } |
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_RESPONSE = 0x03, ZB_ZCL_CMD_SCENES_STORE_SCENE_RESPONSE = 0x04, ZB_ZCL_CMD_SCENES_GET_SCENE_MEMBERSHIP_RESPONSE = 0x06, ZB_ZCL_CMD_SCENES_ENHANCED_ADD_SCENE_RESPONSE = 0x40, ZB_ZCL_CMD_SCENES_ENHANCED_VIEW_SCENE_RESPONSE = 0x41, ZB_ZCL_CMD_SCENES_COPY_SCENE_RESPONSE = 0x42 } |
Command response identifiers for Scenes Cluster. More... | |
typedef struct zb_zcl_scenes_add_scene_req_s | zb_zcl_scenes_add_scene_req_t |
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_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_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_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_RECALL_SCENE_REQ_PAYLOAD_LEN sizeof(zb_zcl_scenes_recall_scene_req_t) |
Recall scene payload length macro. | |
#define | ZB_ZCL_SCENES_RECALL_SCENE_REQ_TRANSITION_TIME_PAYLOAD_LEN sizeof(zb_uint16_t) |
Transition Time field of Recall scene payload length macro. | |
#define | ZB_ZCL_SCENES_RECALL_SCENE_REQ_TRANSITION_TIME_INVALID_VALUE (zb_uint16_t)0xFFFF |
Transition Time field invalid value. | |
#define | ZB_ZCL_SCENES_GET_RECALL_SCENE_REQ(buffer, cmd_struct_ptr, req_len) |
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 common part of the Scenes.ViewSceneResponse. More... | |
#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_ZCL_ATTR_SCENES_CURRENT_GROUP_MAX_VALUE 0xfff7 |
Maximal permissible value for Current group attribute
#define ZB_ZCL_ATTR_SCENES_CURRENT_GROUP_MIN_VALUE 0x0001 |
Minimal permissible value for Current group attribute
#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_MAX_SCENE_TABLE_RECORDS 16 |
Maximal number of scene table records
#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 the Stack does not support scene names, the define 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_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_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_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_t or NULL pointer if payload size is too small |
#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_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_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, | |||
req_len | |||
) |
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 |
req_len | - length of ZCL command |
#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_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 common 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 zcl_status 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 zcl_status 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 the Stack does not support scene names, the default value for the attribute can be declared until name support will be added
#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 zcl_status 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 zcl_status 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 zcl_status 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 zcl_status 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 |
typedef struct zb_zcl_scenes_add_scene_req_s zb_zcl_scenes_add_scene_req_t |
Inform User App about Scene cluster Add Scene command.
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.