nRF5 SDK for Thread and Zigbee v3.2.0
Macros
On/Off Switch

Macros

#define ZB_HA_DECLARE_ON_OFF_SWITCH_CLUSTER_LIST(cluster_list_name,on_off_switch_config_attr_list,basic_attr_list,identify_attr_list)
 Declare cluster list for On/Off switch device. More...
 
#define ZB_HA_DECLARE_ON_OFF_SWITCH_EP(ep_name, ep_id, cluster_list)
 Declare endpoint for On/off Switch device. More...
 
#define ZB_HA_DECLARE_ON_OFF_SWITCH_CTX(device_ctx, ep_name)   ZBOSS_DECLARE_DEVICE_CTX_1_EP(device_ctx, ep_name)
 Declare On/Off Switch device context. More...
 

Detailed Description

On/Off Switch device has 6 clusters (see spec 7.4.1):

On/Off Switch device sample

Example
Declaring clusters
/******************* Declare attributes ************************/
/* Switch config cluster attributes data */
zb_uint8_t attr_switch_type =
zb_uint8_t attr_switch_actions =
ZB_ZCL_DECLARE_ON_OFF_SWITCH_CONFIGURATION_ATTRIB_LIST(switch_cfg_attr_list, &attr_switch_type, &attr_switch_actions);
/* Basic cluster attributes data */
ZB_ZCL_DECLARE_BASIC_ATTRIB_LIST(basic_attr_list, &attr_zcl_version, &attr_power_source);
/* Identify cluster attributes data */
zb_uint16_t attr_identify_time = 0;
ZB_ZCL_DECLARE_IDENTIFY_ATTRIB_LIST(identify_attr_list, &attr_identify_time);
/********************* Declare device **************************/
#define HA_SWITCH_ENDPOINT 10
ZB_HA_DECLARE_ON_OFF_SWITCH_CLUSTER_LIST(on_off_switch_clusters, switch_cfg_attr_list, basic_attr_list, identify_attr_list);
ZB_HA_DECLARE_ON_OFF_SWITCH_EP(on_off_switch_ep, HA_SWITCH_ENDPOINT, on_off_switch_clusters);
ZB_HA_DECLARE_ON_OFF_SWITCH_CTX(on_off_switch_ctx, on_off_switch_ep);
Registering device list
ZB_AF_REGISTER_DEVICE_CTX(&on_off_switch_ctx);
ZB_AF_SET_ENDPOINT_HANDLER(HA_SWITCH_ENDPOINT, zcl_specific_cluster_cmd_handler);
Example of command handler
zb_buf_t *zcl_cmd_buf = (zb_buf_t *)ZB_BUF_FROM_REF(param);
zb_bool_t unknown_cmd_received = ZB_TRUE;
{
if (cmd_info->cmd_id == ZB_ZCL_CMD_DEFAULT_RESP)
{
unknown_cmd_received = ZB_FALSE;
cmd_in_progress = ZB_FALSE;
zb_free_buf(zcl_cmd_buf);
}
}

The complete set of On/Off samples can be found in /snippet/ha_on_off_switch_sample.c.

Macro Definition Documentation

#define ZB_HA_DECLARE_ON_OFF_SWITCH_CLUSTER_LIST (   cluster_list_name,
  on_off_switch_config_attr_list,
  basic_attr_list,
  identify_attr_list 
)

Declare cluster list for On/Off switch device.

Parameters
cluster_list_name- cluster list variable name
on_off_switch_config_attr_list- attribute list for On/off switch configuration cluster
basic_attr_list- attribute list for Basic cluster
identify_attr_list- attribute list for Identify cluster
#define ZB_HA_DECLARE_ON_OFF_SWITCH_CTX (   device_ctx,
  ep_name 
)    ZBOSS_DECLARE_DEVICE_CTX_1_EP(device_ctx, ep_name)

Declare On/Off Switch device context.

Parameters
device_ctx- device context variable name.
ep_name- endpoint variable name.
#define ZB_HA_DECLARE_ON_OFF_SWITCH_EP (   ep_name,
  ep_id,
  cluster_list 
)
Value:
ZB_ZCL_DECLARE_ON_OFF_SWITCH_SIMPLE_DESC( \
ep_name, \
ep_id, \
ZB_HA_ON_OFF_SWITCH_IN_CLUSTER_NUM, \
ZB_HA_ON_OFF_SWITCH_OUT_CLUSTER_NUM); \
ep_id, \
0, \
NULL, \
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 On/off Switch device.

Parameters
ep_name- endpoint variable name
ep_id- endpoint ID
cluster_list- endpoint cluster list

Documentation feedback | Developer Zone | Subscribe | Updated