nRF5 SDK for Thread and Zigbee v4.2.0
Macros
Configuration Tool

Macros

#define ZB_HA_DEVICE_VER_CONFIGURATION_TOOL   0
 
#define ZB_HA_DECLARE_CONFIGURATION_TOOL_CLUSTER_LIST(cluster_list_name,basic_client_attr_list,basic_server_attr_list,identify_client_attr_list,identify_server_attr_list,groups_client_attr_list)
 Declare cluster list for Configuration tool device. More...
 
#define ZB_ZCL_DECLARE_CONFIGURATION_TOOL_SIMPLE_DESC(ep_name, ep_id, in_clust_num, out_clust_num)
 Declare simple descriptor for Configuration tool device. More...
 
#define ZB_HA_DECLARE_CONFIGURATION_TOOL_EP(ep_name, ep_id, cluster_list)
 Declare endpoint for Configuration tool device. More...
 

Detailed Description

Configuration Tool device has 3 clusters (see spec 7.4.6):

Configuration Tool device sample

Example

Macro Definition Documentation

#define ZB_HA_DECLARE_CONFIGURATION_TOOL_CLUSTER_LIST (   cluster_list_name,
  basic_client_attr_list,
  basic_server_attr_list,
  identify_client_attr_list,
  identify_server_attr_list,
  groups_client_attr_list 
)

Declare cluster list for Configuration tool device.

Parameters
cluster_list_name- cluster list variable name
basic_client_attr_list- attribute list for Basic cluster (client role)
basic_server_attr_list- attribute list for Basic cluster (server role)
identify_client_attr_list- attribute list for Identify cluster (client role)
identify_server_attr_list- attribute list for Identify cluster (server role)
groups_client_attr_list- attribute list for Groups cluster (client role)
#define ZB_HA_DECLARE_CONFIGURATION_TOOL_EP (   ep_name,
  ep_id,
  cluster_list 
)
Value:
ZB_HA_CONFIGURATION_TOOL_IN_CLUSTER_NUM, ZB_HA_CONFIGURATION_TOOL_OUT_CLUSTER_NUM); \
ZB_ZCL_ARRAY_SIZE(cluster_list, zb_zcl_cluster_desc_t), cluster_list, \
(zb_af_simple_desc_1_1_t*)&simple_desc_##ep_name, \
0, NULL, /* No reporting ctx */ \
0, NULL) /* No CVC ctx */
#define ZB_AF_HA_PROFILE_ID
Definition: zboss_api_af.h:286
ZCL cluster description.
Definition: zb_zcl_common.h:146
#define ZB_ZCL_DECLARE_CONFIGURATION_TOOL_SIMPLE_DESC(ep_name, ep_id, in_clust_num, out_clust_num)
Declare simple descriptor for Configuration tool device.
Definition: zb_ha_configuration_tool.h:154
#define ZB_AF_DECLARE_ENDPOINT_DESC(ep_name,ep_id,profile_id,reserved_length,reserved_ptr,cluster_number,cluster_list,simple_desc,rep_count,rep_ctx,lev_ctrl_count,lev_ctrl_ctx)
Initialize endpoint descriptor.
Definition: zboss_api_af.h:431
Definition: zboss_api_af.h:259

Declare endpoint for Configuration tool device.

Parameters
ep_name- endpoint variable name
ep_id- endpoint ID
cluster_list- endpoint cluster list
#define ZB_HA_DEVICE_VER_CONFIGURATION_TOOL   0

Configuration tool device version

#define ZB_ZCL_DECLARE_CONFIGURATION_TOOL_SIMPLE_DESC (   ep_name,
  ep_id,
  in_clust_num,
  out_clust_num 
)
Value:
ZB_DECLARE_SIMPLE_DESC(in_clust_num, out_clust_num); \
ZB_AF_SIMPLE_DESC_TYPE(in_clust_num, out_clust_num) simple_desc_##ep_name = \
{ \
ep_id, \
ZB_AF_HA_PROFILE_ID, \
ZB_HA_CONFIGURATION_TOOL_DEVICE_ID, \
ZB_HA_DEVICE_VER_CONFIGURATION_TOOL, \
0, \
in_clust_num, \
out_clust_num, \
{ \
ZB_ZCL_CLUSTER_ID_BASIC, \
ZB_ZCL_CLUSTER_ID_IDENTIFY, \
ZB_ZCL_CLUSTER_ID_BASIC, \
ZB_ZCL_CLUSTER_ID_IDENTIFY, \
ZB_ZCL_CLUSTER_ID_GROUPS \
} \
}
#define ZB_AF_SIMPLE_DESC_TYPE(in_num, out_num)
Definition: zboss_api_af.h:223
#define ZB_DECLARE_SIMPLE_DESC(in_clusters_count, out_clusters_count)
Definition: zboss_api_af.h:237

Declare simple descriptor for Configuration tool device.

Parameters
ep_name- endpoint variable name
ep_id- endpoint ID
in_clust_num- number of supported input clusters
out_clust_num- number of supported output clusters

Documentation feedback | Developer Zone | Subscribe | Updated