ZCL Groups cluster

Modules
	Add group command definitions
	View group command definitions
	Get Group Membership command definitions
	Remove Group command definitions
	Remove All Groups command definitions
	Add group if identifying command definitions

Functions
zb_bool_t	zb_zcl_process_groups_commands_srv (zb_uint8_t param)
zb_bool_t	zb_zcl_process_groups_commands_cli (zb_uint8_t param)

Groups cluster attributes
enum	zb_zcl_groups_attr_e { ZB_ZCL_ATTR_GROUPS_NAME_SUPPORT_ID = 0 }
	Groups cluster attribute identifiers. More...
enum	zb_zcl_groups_name_support_e { ZB_ZCL_ATTR_GROUPS_NAME_NOT_SUPPORTED = 0, ZB_ZCL_ATTR_GROUPS_NAME_SUPPORTED = 1 << 7 }
	Values for NameSupport attribute. More...
#define	ZB_ZCL_DECLARE_GROUPS_ATTRIB_LIST(attr_list, name_support)
	Declare attribute list for Groups cluster. More...

Groups cluster command identifiers
enum	zb_zcl_groups_cmd_e {   ZB_ZCL_CMD_GROUPS_ADD_GROUP = 0x00, ZB_ZCL_CMD_GROUPS_VIEW_GROUP = 0x01, ZB_ZCL_CMD_GROUPS_GET_GROUP_MEMBERSHIP = 0x02, ZB_ZCL_CMD_GROUPS_REMOVE_GROUP = 0x03,   ZB_ZCL_CMD_GROUPS_REMOVE_ALL_GROUPS = 0x04, ZB_ZCL_CMD_GROUPS_ADD_GROUP_IF_IDENTIFYING = 0x05 }
	Groups cluster command identifiers. More...
enum	zb_zcl_groups_cmd_resp_e { ZB_ZCL_CMD_GROUPS_ADD_GROUP_RES = 0x00, ZB_ZCL_CMD_GROUPS_VIEW_GROUP_RES = 0x01, ZB_ZCL_CMD_GROUPS_GET_GROUP_MEMBERSHIP_RES = 0x02, ZB_ZCL_CMD_GROUPS_REMOVE_GROUP_RES = 0x03 }
	Groups cluster response command identifiers. More...

Detailed Description

Groups cluster defined in ZCL spec, clause 3.6. Currently no group name attribute support is implemented. However, this attribute must be supported for sending and receiving in commands' payload, so it is being sent as zero string (i. e. single zero byte). On receipt of the command is able to contain a scene name in the payload, this field will be ignored as a string.

Cluster requests and responses are documented in submodules.

Macro Definition Documentation

ZB_ZCL_DECLARE_GROUPS_ATTRIB_LIST

#define ZB_ZCL_DECLARE_GROUPS_ATTRIB_LIST	(		attr_list,
			name_support
	)

Value:

  ZB_ZCL_START_DECLARE_ATTRIB_LIST(attr_list)                           \
  ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_GROUPS_NAME_SUPPORT_ID, (name_support)) \
  ZB_ZCL_FINISH_DECLARE_ATTRIB_LIST

Declare attribute list for Groups cluster.

Parameters

attr_list	- attribute list name.
name_support	- pointer to variable to store name_support attribute value

Enumeration Type Documentation

zb_zcl_groups_attr_e

enum zb_zcl_groups_attr_e

Groups cluster attribute identifiers.

See also

ZCL spec, subclause 3.6.2.2

Enumerator
ZB_ZCL_ATTR_GROUPS_NAME_SUPPORT_ID	NameSupport attribute.

zb_zcl_groups_cmd_e

enum zb_zcl_groups_cmd_e

Groups cluster command identifiers.

See also

ZCL spec, subclause 3.6.2.2.2.

Enumerator
ZB_ZCL_CMD_GROUPS_ADD_GROUP	Add group command identifier.
ZB_ZCL_CMD_GROUPS_VIEW_GROUP	View group command identifier.
ZB_ZCL_CMD_GROUPS_GET_GROUP_MEMBERSHIP	Get group membership command identifier.
ZB_ZCL_CMD_GROUPS_REMOVE_GROUP	Remove group command identifier.
ZB_ZCL_CMD_GROUPS_REMOVE_ALL_GROUPS	Remove all groups command identifier.
ZB_ZCL_CMD_GROUPS_ADD_GROUP_IF_IDENTIFYING	Add group if identifying command identifier.

zb_zcl_groups_cmd_resp_e

enum zb_zcl_groups_cmd_resp_e

Groups cluster response command identifiers.

See also

ZCL spec, subclause 3.6.2.3

Enumerator
ZB_ZCL_CMD_GROUPS_ADD_GROUP_RES	Add group response command identifier.
ZB_ZCL_CMD_GROUPS_VIEW_GROUP_RES	View group response command identifier.
ZB_ZCL_CMD_GROUPS_GET_GROUP_MEMBERSHIP_RES	Get group response membership command identifier.
ZB_ZCL_CMD_GROUPS_REMOVE_GROUP_RES	Remove group response command identifier.

zb_zcl_groups_name_support_e

enum zb_zcl_groups_name_support_e

Values for NameSupport attribute.

Enumerator
ZB_ZCL_ATTR_GROUPS_NAME_NOT_SUPPORTED	"Not supported" value
ZB_ZCL_ATTR_GROUPS_NAME_SUPPORTED	"On" value

Function Documentation

zb_zcl_process_groups_commands_cli()

zb_bool_t zb_zcl_process_groups_commands_cli

(

zb_uint8_t

param

)

Handler for incoming group commands directed to client

Parameters

param

- reference to buffer containing command

Returns

ZB_TRUE - if command was processed ZB_FALSE - if command is not for client or is not supported

zb_zcl_process_groups_commands_srv()

zb_bool_t zb_zcl_process_groups_commands_srv

(

zb_uint8_t

param

)

Handler for incoming group commands directed to server

Parameters

param

- reference to buffer containing command

Returns

ZB_TRUE - if command was processed ZB_FALSE - if command is not for server or is not supported