nRF5 SDK for Thread and Zigbee v3.2.0
Macros
Range Extender

Macros

#define ZB_HA_DEVICE_VER_RANGE_EXTENDER   0
 
#define ZB_HA_DECLARE_RANGE_EXTENDER_CLUSTER_LIST(cluster_list_name,basic_attr_list,identify_attr_list)
 Declare cluster list for Range extender device. More...
 
#define ZB_HA_DECLARE_RANGE_EXTENDER_EP(ep_name, ep_id, cluster_list)
 Declare endpoint for Range extender device. More...
 
#define ZB_HA_DECLARE_RANGE_EXTENDER_CTX(device_ctx, ep_name)   ZBOSS_DECLARE_DEVICE_CTX_1_EP(device_ctx, ep_name)
 Declare Range Extender device context. More...
 

Detailed Description

Range Entender device has 2 clusters (see spec 7.4.8):

Range Extender device sample

Example
Declaring clusters
/******************* Declare attributes ************************/
/* Basic cluster attributes data */
zb_uint8_t g_attr_zcl_version = ZB_ZCL_VERSION;
ZB_ZCL_DECLARE_BASIC_ATTRIB_LIST(basic_attr_list, &g_attr_zcl_version, &g_attr_power_source);
/* Identify cluster attributes data */
zb_uint16_t g_attr_identify_time = 0;
ZB_ZCL_DECLARE_IDENTIFY_ATTRIB_LIST(identify_attr_list, &g_attr_identify_time);
/********************* Declare device **************************/
ZB_HA_DECLARE_RANGE_EXTENDER_CLUSTER_LIST(range_extender_clusters, basic_attr_list, identify_attr_list);
ZB_HA_DECLARE_RANGE_EXTENDER_EP(range_extender_ep, HA_RANGE_EXTENDER_ENDPOINT, range_extender_clusters);
ZB_HA_DECLARE_RANGE_EXTENDER_CTX(range_extender_ctx, range_extender_ep);
Registering device list
ZB_AF_REGISTER_DEVICE_CTX(&range_extender_ctx);
ZB_AF_SET_ENDPOINT_HANDLER(HA_RANGE_EXTENDER_ENDPOINT, zcl_specific_cluster_cmd_handler);
Example of command handler
zb_uint8_t zcl_specific_cluster_cmd_handler(zb_uint8_t param)
{
zb_buf_t *zcl_cmd_buf = (zb_buf_t *)ZB_BUF_FROM_REF(param);
zb_bool_t cmd_processed = ZB_FALSE;
switch (cmd_info->cmd_id)
{
TRACE_MSG(TRACE_ZCL3, "Got cluster command 0x%04x", (FMT__D, cmd_info->cmd_id));
/* process identify command */
cmd_processed = ZB_TRUE;
break;
default:
TRACE_MSG(TRACE_ZCL2, "Cluster command %hd, skip it", (FMT__H, cmd_info->cmd_id));
break;
}

The complete set of Range Extended device samples can be found in /snippet/ha_range_extender_sample.c.

Macro Definition Documentation

#define ZB_HA_DECLARE_RANGE_EXTENDER_CLUSTER_LIST (   cluster_list_name,
  basic_attr_list,
  identify_attr_list 
)
Value:
zb_zcl_cluster_desc_t cluster_list_name[] = \
{ \
ZB_ZCL_CLUSTER_DESC( \
ZB_ZCL_ARRAY_SIZE(identify_attr_list, zb_zcl_attr_t), \
(identify_attr_list), \
), \
ZB_ZCL_CLUSTER_DESC( \
ZB_ZCL_ARRAY_SIZE(basic_attr_list, zb_zcl_attr_t), \
(basic_attr_list), \
) \
}
ZCL cluster description.
Definition: zb_zcl_common.h:143
Definition: zb_zcl_common.h:204
Definition: zb_zcl_common.h:200
#define ZB_ZCL_MANUF_CODE_INVALID
Internal invalid manufacturer code value.
Definition: zb_zcl_common.h:312
ZCL attribute definiton structure.
Definition: zb_zcl_common.h:594
Definition: zb_zcl_common.h:187

Declare cluster list for Range extender device.

Parameters
cluster_list_name- cluster list variable name
basic_attr_list- attribute list for Basic cluster
identify_attr_list- attribute list for Identify cluster
#define ZB_HA_DECLARE_RANGE_EXTENDER_CTX (   device_ctx,
  ep_name 
)    ZBOSS_DECLARE_DEVICE_CTX_1_EP(device_ctx, ep_name)

Declare Range Extender device context.

Parameters
device_ctx- device context variable name.
ep_name- endpoint variable name.
#define ZB_HA_DECLARE_RANGE_EXTENDER_EP (   ep_name,
  ep_id,
  cluster_list 
)
Value:
ZB_ZCL_DECLARE_RANGE_EXTENDER_SIMPLE_DESC(ep_name, ep_id, \
ZB_HA_RANGE_EXTENDER_IN_CLUSTER_NUM, ZB_HA_RANGE_EXTENDER_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 */
ZCL cluster description.
Definition: zb_zcl_common.h:143
Definition: zboss_api_af.h:287
#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:490
Definition: zboss_api_af.h:201

Declare endpoint for Range extender device.

internals_doc

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

Range extender device version


Documentation feedback | Developer Zone | Subscribe | Updated