Mains Power Outlet

Macros
#define	ZB_HA_DEVICE_VER_MAINS_POWER_OUTLET   0
#define	ZB_HA_DECLARE_MAINS_POWER_OUTLET_CLUSTER_LIST(cluster_list_name,basic_attr_list,identify_attr_list,on_off_attr_list,scenes_attr_list,groups_attr_list)
	Declare cluster list for Mains power outlet device. More...
#define	ZB_HA_DECLARE_MAINS_POWER_OUTLET_EP(ep_name, ep_id, cluster_list)
	Declare endpoint for Mains power outlet device. More...
#define	ZB_HA_DECLARE_MAINS_POWER_OUTLET_CTX(device_ctx, ep_name)   ZBOSS_DECLARE_DEVICE_CTX_1_EP(device_ctx, ep_name)
	Declare Mains Power Outlet device context. More...

Detailed Description

Mains Power Outlet device has 5 clusters (see spec 7.4.10):

• ZCL Identify cluster
  
• ZCL Basic cluster
  
• ZCL On/Off cluster
  
• ZCL Scenes cluster
  
• ZCL Groups cluster

Mains Power Outlet device sample

Example

Declaring clusters

/******************* Declare attributes ************************/

/* Basic cluster attributes data */
zb_uint8_t g_attr_zcl_version = ZB_ZCL_VERSION;
zb_uint8_t g_attr_power_source = ZB_ZCL_BASIC_POWER_SOURCE_UNKNOWN;

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);


/* On/Off cluster attributes data */
zb_uint8_t g_attr_on_off = ZB_FALSE;

ZB_ZCL_DECLARE_ON_OFF_ATTRIB_LIST(on_off_attr_list, &g_attr_on_off);


/* Groups cluster attributes data */
zb_uint8_t g_attr_name_support = 0;

ZB_ZCL_DECLARE_GROUPS_ATTRIB_LIST(groups_attr_list, &g_attr_name_support);


/* Scenes cluster attribute data */
zb_uint8_t g_attr_scenes_scene_count;
zb_uint8_t g_attr_scenes_current_scene;
zb_uint16_t g_attr_scenes_current_group;
zb_uint8_t g_attr_scenes_scene_valid;
zb_uint8_t g_attr_scenes_name_support;

ZB_ZCL_DECLARE_SCENES_ATTRIB_LIST(scenes_attr_list, &g_attr_scenes_scene_count,
 &g_attr_scenes_current_scene, &g_attr_scenes_current_group,
 &g_attr_scenes_scene_valid, &g_attr_scenes_name_support);

/********************* Declare device **************************/

ZB_HA_DECLARE_MAINS_POWER_OUTLET_CLUSTER_LIST(mains_power_outlet_clusters, basic_attr_list, identify_attr_list,
 on_off_attr_list, groups_attr_list, scenes_attr_list);

ZB_HA_DECLARE_MAINS_POWER_OUTLET_EP(mains_power_outlet_ep, HA_MAINS_POWER_OUTLET_ENDPOINT, mains_power_outlet_clusters);

ZB_HA_DECLARE_MAINS_POWER_OUTLET_CTX(mains_power_outlet_ctx, mains_power_outlet_ep);

Registering device list

 ZB_AF_REGISTER_DEVICE_CTX(&mains_power_outlet_ctx);
 ZB_AF_SET_ENDPOINT_HANDLER(HA_MAINS_POWER_OUTLET_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_zcl_parsed_hdr_t *cmd_info = ZB_GET_BUF_PARAM(zcl_cmd_buf, zb_zcl_parsed_hdr_t);
 zb_bool_t cmd_processed = ZB_FALSE;

 switch (cmd_info->cluster_id)
 {
 case ZB_ZCL_CLUSTER_ID_ON_OFF:
 if (cmd_info->is_common_command)
 {
 switch (cmd_info->cmd_id)
 {
 default:
 TRACE_MSG(TRACE_ZCL2, "Skip general command %hd", (FMT__H, cmd_info->cmd_id));
 break;
 }
 }
 else
 {
 switch (cmd_info->cmd_id)
 {
 case ZB_ZCL_CMD_ON_OFF_ON_ID:
 TRACE_MSG(TRACE_ZCL3, "Got cluster command 0x%04x", (FMT__D, cmd_info->cluster_id));
 /* Process cluster command */
 cmd_processed = ZB_TRUE;
 break;

 default:
 TRACE_MSG(TRACE_ZCL2, "Cluster command %hd, skip it", (FMT__H, cmd_info->cmd_id));
 break;
 }
 }
 break;

The complete set of Mains Power Outlet device samples can be found in /snippet/ha_mains_power_outlet_sample.c.

Macro Definition Documentation

#define ZB_HA_DECLARE_MAINS_POWER_OUTLET_CLUSTER_LIST	(		cluster_list_name,
			basic_attr_list,
			identify_attr_list,
			on_off_attr_list,
			scenes_attr_list,
			groups_attr_list
	)

Declare cluster list for Mains power outlet 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
on_off_attr_list	- attribute list for On/Off cluster
scenes_attr_list	- attribute list for Scenes cluster
groups_attr_list	- attribute list for Groups cluster

#define ZB_HA_DECLARE_MAINS_POWER_OUTLET_CTX	(		device_ctx,
			ep_name
	)		ZBOSS_DECLARE_DEVICE_CTX_1_EP(device_ctx, ep_name)

Declare Mains Power Outlet device context.

Parameters

device_ctx	- device context variable name.
ep_name	- andloint variable name.

#define ZB_HA_DECLARE_MAINS_POWER_OUTLET_EP	(		ep_name,
			ep_id,
			cluster_list
	)

Value:

ZB_ZCL_DECLARE_MAINS_POWER_OUTLET_SIMPLE_DESC(ep_name, ep_id, \
 ZB_HA_MAINS_POWER_OUTLET_IN_CLUSTER_NUM, ZB_HA_MAINS_POWER_OUTLET_OUT_CLUSTER_NUM); \
 ZBOSS_DEVICE_DECLARE_REPORTING_CTX(reporting_info## device_ctx_name, \
 ZB_HA_MAINS_POWER_OUTLET_REPORT_ATTR_COUNT); \
 ZB_AF_DECLARE_ENDPOINT_DESC(ep_name, ep_id, ZB_AF_HA_PROFILE_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, \
 ZB_HA_MAINS_POWER_OUTLET_REPORT_ATTR_COUNT, reporting_info## device_ctx_name, 0, NULL)

Declare endpoint for Mains power outlet device.

Parameters

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

#define ZB_HA_DEVICE_VER_MAINS_POWER_OUTLET   0

Mains power outlet device version