Non-color controller

Macros
#define	ZB_ZLL_DEVICE_VER_NON_COLOR_CONTROLLER   0
#define	ZB_ZLL_NON_COLOR_CONTROLLER_IN_CLUSTER_NUM   1
#define	ZB_ZLL_NON_COLOR_CONTROLLER_OUT_CLUSTER_NUM   5
#define	ZB_ZLL_DECLARE_NON_COLOR_CONTROLLER_CLUSTER_LIST(cluster_list_name, commissioning_cluster_role)
	Declare cluster list for Non-color Controller device. More...
#define	ZB_ZCL_DECLARE_NON_COLOR_CONTROLLER_SIMPLE_DESC(ep_name, ep_id, in_clust_num, out_clust_num)
	Declare simple descriptor for Non-color Controller device. More...
#define	ZB_ZLL_DECLARE_NON_COLOR_CONTROLLER_EP(ep_name, ep_id, cluster_list)
	Declare endpoint for Non-color Controller device. More...
#define	ZB_ZLL_DECLARE_NON_COLOR_CONTROLLER_CTX(device_ctx, ep_name)

Detailed Description

ZLL Non-color controller

Non-color controller has 5 clusters (see spec 5.3.3):

• ZCL Basic cluster
  
• ZCL Identify cluster
  
• ZCL Groups cluster
  
• ZCL On/Off cluster
  
• ZCL Level control cluster

Sample use ZLL Non-color controller

Example

Delcaration clusters

/********************* Declare device **************************/
ZB_ZLL_DECLARE_NON_COLOR_CONTROLLER_CLUSTER_LIST(non_color_controller_clusters,
 ZB_ZCL_CLUSTER_MIXED_ROLE);

ZB_ZLL_DECLARE_NON_COLOR_CONTROLLER_EP(non_color_controller_ep, ENDPOINT, non_color_controller_clusters);

ZB_ZLL_DECLARE_NON_COLOR_CONTROLLER_CTX(non_color_controller_ctx, non_color_controller_ep);

Register device list

 /* Register device list */
 ZB_AF_REGISTER_DEVICE_CTX(&non_color_controller_ctx);
 ZB_AF_SET_ENDPOINT_HANDLER(ENDPOINT, zcl_specific_cluster_cmd_handler);

Handler sample

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;

 TRACE_MSG(TRACE_ZCL1, "> zcl_specific_cluster_cmd_handler %i", (FMT__H, param));
 TRACE_MSG(TRACE_ZCL1, "payload size: %i", (FMT__D, ZB_BUF_LEN(zcl_cmd_buf)));

 if( cmd_info -> cmd_direction == ZB_ZCL_FRAME_DIRECTION_TO_CLI )
 {
 switch( cmd_info -> cluster_id )
 {
 case ZB_ZCL_CLUSTER_ID_BASIC:
 if( cmd_info -> is_common_command )
 {
 switch( cmd_info -> cmd_id )
 {
 case ZB_ZCL_CMD_DEFAULT_RESP:
 TRACE_MSG(TRACE_ZCL3, "Got response in cluster 0x%04x",
 ( FMT__D, cmd_info->cluster_id));
 /* Process default response */
 cmd_processed = ZB_TRUE;
 break;

 case ZB_ZCL_CMD_READ_ATTRIB_RESP:
 cmd_processed = ZB_TRUE;
 break;

 case ZB_ZCL_CMD_WRITE_ATTRIB_RESP:
 cmd_processed = ZB_TRUE;
 break;

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

 default:
 TRACE_MSG(TRACE_ZCL1, "CLNT role cluster 0x%d is not supported", (FMT__D, cmd_info->cluster_id));
 break;
 }
 }
 else
 {
 /* Command from client to server ZB_ZCL_FRAME_DIRECTION_TO_SRV */
 TRACE_MSG(TRACE_ZCL1, "SRV role, cluster 0x%d is not supported", (FMT__D, cmd_info->cluster_id));
 }

 TRACE_MSG(TRACE_ZCL1, "<< zcl_specific_cluster_cmd_handler %hd", (FMT__H, cmd_processed));
 return cmd_processed;
}

See ll/all_devices test

Macro Definition Documentation

#define ZB_ZCL_DECLARE_NON_COLOR_CONTROLLER_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_ZLL_NON_COLOR_CONTROLLER_DEVICE_ID, \
 ZB_ZLL_DEVICE_VER_NON_COLOR_CONTROLLER, \
 0, \
 in_clust_num, \
 out_clust_num, \
 { \
 ZB_ZCL_CLUSTER_ID_BASIC, \
 ZB_ZCL_CLUSTER_ID_IDENTIFY, \
 ZB_ZCL_CLUSTER_ID_ON_OFF, \
 ZB_ZCL_CLUSTER_ID_GROUPS, \
 ZB_ZCL_CLUSTER_ID_LEVEL_CONTROL, \
 ZB_ZLL_CLUSTER_ID_COMMISSIONING \
 } \
 }

Declare simple descriptor for Non-color Controller device.

Parameters

ep_name	- endpoint variable name.
ep_id	[IN] - endpoint ID.
in_clust_num	[IN] - number of supported input clusters.
out_clust_num	[IN] - number of supported output clusters.

Note

in_clust_num, out_clust_num should be defined by numeric constants, not variables or any definitions, because these values are used to form simple descriptor type name.

#define ZB_ZLL_DECLARE_NON_COLOR_CONTROLLER_CLUSTER_LIST	(		cluster_list_name,
			commissioning_cluster_role
	)

Value:

zb_zcl_cluster_desc_t cluster_list_name[] = \
 { \
 ZB_ZCL_CLUSTER_DESC(ZB_ZCL_CLUSTER_ID_BASIC, 0, NULL, ZB_ZCL_CLUSTER_CLIENT_ROLE, ZB_ZCL_MANUF_CODE_INVALID ), \
 ZB_ZCL_CLUSTER_DESC(ZB_ZCL_CLUSTER_ID_IDENTIFY, 0, NULL, ZB_ZCL_CLUSTER_CLIENT_ROLE, ZB_ZCL_MANUF_CODE_INVALID ), \
 ZB_ZCL_CLUSTER_DESC(ZB_ZCL_CLUSTER_ID_ON_OFF, 0, NULL, ZB_ZCL_CLUSTER_CLIENT_ROLE, ZB_ZCL_MANUF_CODE_INVALID ), \
 ZB_ZCL_CLUSTER_DESC(ZB_ZCL_CLUSTER_ID_GROUPS, 0, NULL, ZB_ZCL_CLUSTER_CLIENT_ROLE, ZB_ZCL_MANUF_CODE_INVALID ), \
 ZB_ZCL_CLUSTER_DESC(ZB_ZCL_CLUSTER_ID_LEVEL_CONTROL, 0, NULL, ZB_ZCL_CLUSTER_CLIENT_ROLE, ZB_ZCL_MANUF_CODE_INVALID ), \
 ZB_ZCL_CLUSTER_DESC(ZB_ZLL_CLUSTER_ID_COMMISSIONING, 0, NULL, (commissioning_cluster_role), ZB_ZCL_MANUF_CODE_INVALID ), \
 }

Declare cluster list for Non-color Controller device.

Parameters

cluster_list_name	[IN] - cluster list variable name.
commissioning_cluster_role	[IN] - determines Commissioning cluster role.

#define ZB_ZLL_DECLARE_NON_COLOR_CONTROLLER_CTX	(		device_ctx,
			ep_name
	)

Value:

ZBOSS_DECLARE_DEVICE_CTX(device_ctx, ep_name, \
 ZB_ZCL_ARRAY_SIZE(ep_name, zb_af_endpoint_desc_t), \
 0, NULL, /* No reporting ctx */ \
 0, NULL) /* No CVC ctx */

#define ZB_ZLL_DECLARE_NON_COLOR_CONTROLLER_EP	(		ep_name,
			ep_id,
			cluster_list
	)

Value:

ZB_ZCL_DECLARE_NON_COLOR_CONTROLLER_SIMPLE_DESC( \
 ep_name, \
 ep_id, \
 ZB_ZLL_NON_COLOR_CONTROLLER_IN_CLUSTER_NUM, \
 ZB_ZLL_NON_COLOR_CONTROLLER_OUT_CLUSTER_NUM); \
 ZB_AF_START_DECLARE_ENDPOINT_LIST(ep_name) \
 ZB_AF_SET_ENDPOINT_DESC( \
 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_AF_FINISH_DECLARE_ENDPOINT_LIST

Declare endpoint for Non-color Controller device.

Parameters

ep_name	[IN] - endpoint variable name.
ep_id	[IN] - endpoint ID.
cluster_list	[IN] - endpoint cluster list.

#define ZB_ZLL_DEVICE_VER_NON_COLOR_CONTROLLER   0

Non-color controller input clusters number.

#define ZB_ZLL_NON_COLOR_CONTROLLER_IN_CLUSTER_NUM   1

Non-color controller output clusters number.