Data Structures
struct	zb_zcl_scene_table_record_fixed_s
	Fixed-size part of the Scene table. More...

struct	zb_zcl_scene_table_record_type_s
	Typical Scene table record structure. More...

struct	zb_zcl_scenes_fieldset_common_s
	Common part of the field set definition. More...

struct	zb_zcl_scenes_on_off_fieldset_content_s
	Scenes fieldsets representation structure for On/Off cluster-specific content. More...

struct	zb_zcl_scenes_fieldset_on_off_s
	Scenes fieldsets representation structure for On/Off cluster. More...

struct	zb_zcl_scenes_level_control_fieldset_content_s
	Scenes fieldsets representation structure for Level control cluster-specific content. More...

struct	zb_zcl_scenes_fieldset_level_control_s
	Scenes fieldsets representation structure for LevelControl cluster. More...

struct	zb_zcl_scenes_color_control_fieldset_content_s
	Scenes fieldsets representation structure for Color control cluster-specific content. More...

struct	zb_zcl_scenes_fieldset_color_control_s
	Scenes fieldsets representation structure for ColorControl cluster. More...

struct	zb_zcl_scenes_door_lock_fieldset_content_s
	Scenes fieldsets representation structure for Door lock cluster-specific content. More...

struct	zb_zcl_scenes_fieldset_door_lock_s
	Scenes fieldsets representation structure for Door lock cluster. More...

struct	zb_zcl_scenes_thermostat_fieldset_content_s
	Scenes fieldsets representation structure for Thermostat cluster-specific content. More...

struct	zb_zcl_scenes_fieldset_thermostat_s
	Scenes fieldsets representation structure for Thermostat cluster. More...

struct	zb_zcl_scenes_window_covering_fieldset_content_s
	Scenes fieldsets representation structure for Window covering cluster-specific content. More...

struct	zb_zcl_scenes_fieldset_window_covering_s
	Scenes fieldsets representation structure for WindowCovering cluster. More...

struct	zb_zcl_scenes_add_scene_req_s
	Add scene command payload constant-structure part. More...

struct	zb_zcl_scenes_view_scene_req_s
	View scene command payload structure. More...

struct	zb_zcl_scenes_remove_scene_req_s
	Remove scene command payload structure. More...

struct	zb_zcl_scenes_remove_all_scenes_req_s
	Remove all scenes command payload structure. More...

struct	zb_zcl_scenes_store_scene_req_s
	Store scene command payload structure. More...

struct	zb_zcl_scenes_recall_scene_req_s
	Recall scene command payload structure. More...

struct	zb_zcl_scenes_get_scene_membership_req_s
	Get scene membership command payload structure. More...

struct	zb_zcl_scenes_add_scene_res_s
	Add scene response payload structure. More...

struct	zb_zcl_scenes_view_scene_res_fixed_size_s
	Mandatory part of the Scenes.ViewSceneResponse payload. More...

struct	zb_zcl_scenes_view_scene_res_variable_size_s
	Optional part of the Scenes.ViewSceneResponse payload. More...

struct	zb_zcl_scenes_view_scene_res_s
	View scene response payload structure. More...

struct	zb_zcl_scenes_fieldset_view_scene_res_s

struct	zb_zcl_scenes_remove_scene_res_s
	Remove scene response payload structure. More...

struct	zb_zcl_scenes_remove_all_scenes_res_s
	Remove all scenes response payload structure. More...

struct	zb_zcl_scenes_store_scene_res_s
	Store scene response payload structure. More...

struct	zb_zcl_scenes_get_scene_membership_res_mandatory_s
	Get scene membership response fixed-structure payload part representation. More...

struct	zb_zcl_scenes_get_scene_membership_res_optional_s
	Get scene membership response optional payload part representation. More...

struct	zb_zcl_scenes_get_scene_membership_res_s
	Get scene membership response. More...

Scenes cluster attributes
enum	zb_zcl_scene_attr_e { ZB_ZCL_ATTR_SCENES_SCENE_COUNT_ID = 0x0000, ZB_ZCL_ATTR_SCENES_CURRENT_SCENE_ID = 0x001, ZB_ZCL_ATTR_SCENES_CURRENT_GROUP_ID = 0x002, ZB_ZCL_ATTR_SCENES_SCENE_VALID_ID = 0x003, ZB_ZCL_ATTR_SCENES_NAME_SUPPORT_ID = 0x004, ZB_ZCL_ATTR_SCENES_LAST_CONFIGURED_BY_ID = 0x005 }
	Scene cluster attribute identifiers. More...

typedef struct zb_zcl_scene_table_record_fixed_s	zb_zcl_scene_table_record_fixed_t
	Fixed-size part of the Scene table.

typedef struct zb_zcl_scene_table_record_type_s	zb_zcl_scene_table_record_type_t
	Typical Scene table record structure. More...

typedef struct zb_zcl_scenes_fieldset_common_s	zb_zcl_scenes_fieldset_common_t
	Common part of the field set definition.

zb_zcl_status_t	zb_zcl_scenes_process_store_scene (zb_uint8_t endpoint, zb_uint8_t group_id, zb_uint8_t scene_id)
	Store scene. More...

zb_ret_t	zb_zcl_scenes_recall_global_scene (zb_uint8_t param, zb_uint8_t endpoint)
	Recall Global scene. More...

zb_void_t	zb_zcl_scenes_remove_scenes_in_all_endpoints (zb_uint16_t group_id)
	Removes All scenes corresponding to a group identifiers in a whole device. More...

Scenes cluster internals
Internal structures for Scenes cluster
typedef struct zb_zcl_scenes_on_off_fieldset_content_s	zb_zcl_scenes_on_off_fieldset_content_t
	Scenes fieldsets representation structure for On/Off cluster-specific content.

typedef struct zb_zcl_scenes_fieldset_on_off_s	zb_zcl_scenes_fieldset_on_off_t
	Scenes fieldsets representation structure for On/Off cluster.

typedef struct zb_zcl_scenes_level_control_fieldset_content_s	zb_zcl_scenes_level_control_fieldset_content_t
	Scenes fieldsets representation structure for Level control cluster-specific content.

typedef struct zb_zcl_scenes_fieldset_level_control_s	zb_zcl_scenes_fieldset_level_control_t
	Scenes fieldsets representation structure for LevelControl cluster.

typedef struct zb_zcl_scenes_color_control_fieldset_content_s	zb_zcl_scenes_color_control_fieldset_content_t
	Scenes fieldsets representation structure for Color control cluster-specific content.

typedef struct zb_zcl_scenes_fieldset_color_control_s	zb_zcl_scenes_fieldset_color_control_t
	Scenes fieldsets representation structure for ColorControl cluster.

typedef struct zb_zcl_scenes_door_lock_fieldset_content_s	zb_zcl_scenes_door_lock_fieldset_content_t
	Scenes fieldsets representation structure for Door lock cluster-specific content.

typedef struct zb_zcl_scenes_fieldset_door_lock_s	zb_zcl_scenes_fieldset_door_lock_t
	Scenes fieldsets representation structure for Door lock cluster.

typedef struct zb_zcl_scenes_thermostat_fieldset_content_s	zb_zcl_scenes_thermostat_fieldset_content_t
	Scenes fieldsets representation structure for Thermostat cluster-specific content.

typedef struct zb_zcl_scenes_fieldset_thermostat_s	zb_zcl_scenes_fieldset_thermostat_t
	Scenes fieldsets representation structure for Thermostat cluster.

typedef struct zb_zcl_scenes_window_covering_fieldset_content_s	zb_zcl_scenes_window_covering_fieldset_content_t
	Scenes fieldsets representation structure for Window covering cluster-specific content.

typedef struct zb_zcl_scenes_fieldset_window_covering_s	zb_zcl_scenes_fieldset_window_covering_t
	Scenes fieldsets representation structure for WindowCovering cluster.

zb_uint8_t	zb_zcl_scenes_remove_all_scenes_action (zb_uint8_t endpoint, zb_uint16_t group)

Scenes cluster commands
enum	zb_zcl_scenes_cmd_e { ZB_ZCL_CMD_SCENES_ADD_SCENE = 0x00, ZB_ZCL_CMD_SCENES_VIEW_SCENE = 0x01, ZB_ZCL_CMD_SCENES_REMOVE_SCENE = 0x02, ZB_ZCL_CMD_SCENES_REMOVE_ALL_SCENES = 0x03, ZB_ZCL_CMD_SCENES_STORE_SCENE = 0x04, ZB_ZCL_CMD_SCENES_RECALL_SCENE = 0x05, ZB_ZCL_CMD_SCENES_GET_SCENE_MEMBERSHIP = 0x06 }
	Command identifiers for Scenes Cluster. More...

enum	zb_zcl_scenes_cmd_resp_e { ZB_ZCL_CMD_SCENES_ADD_SCENE_RESPONSE = 0x00, ZB_ZCL_CMD_SCENES_VIEW_SCENE_RESPONSE = 0x01, ZB_ZCL_CMD_SCENES_REMOVE_SCENE_RESPONSE = 0x02, ZB_ZCL_CMD_SCENES_REMOVE_ALL_SCENES_REPONSE = 0x03, ZB_ZCL_CMD_SCENES_STORE_SCENE_RESPONSE = 0x04, ZB_ZCL_CMD_SCENES_GET_SCENE_MEMBERSHIP_RESPONSE = 0x06 }
	Command response identifiers for Scenes Cluster. More...

typedef struct zb_zcl_scenes_add_scene_req_s	zb_zcl_scenes_add_scene_req_t
	Add scene command payload constant-structure part.

typedef struct zb_zcl_scenes_view_scene_req_s	zb_zcl_scenes_view_scene_req_t
	View scene command payload structure.

typedef struct zb_zcl_scenes_remove_scene_req_s	zb_zcl_scenes_remove_scene_req_t
	Remove scene command payload structure.

typedef struct zb_zcl_scenes_remove_all_scenes_req_s	zb_zcl_scenes_remove_all_scenes_req_t
	Remove all scenes command payload structure.

typedef struct zb_zcl_scenes_store_scene_req_s	zb_zcl_scenes_store_scene_req_t
	Store scene command payload structure.

typedef struct zb_zcl_scenes_recall_scene_req_s	zb_zcl_scenes_recall_scene_req_t
	Recall scene command payload structure.

typedef struct zb_zcl_scenes_get_scene_membership_req_s	zb_zcl_scenes_get_scene_membership_req_t
	Get scene membership command payload structure.

typedef struct zb_zcl_scenes_add_scene_res_s	zb_zcl_scenes_add_scene_res_t
	Add scene response payload structure.

typedef struct zb_zcl_scenes_view_scene_res_fixed_size_s	zb_zcl_scenes_view_scene_res_fixed_size_t
	Mandatory part of the Scenes.ViewSceneResponse payload.

typedef struct zb_zcl_scenes_view_scene_res_variable_size_s	zb_zcl_scenes_view_scene_res_variable_size_t
	Optional part of the Scenes.ViewSceneResponse payload.

typedef struct zb_zcl_scenes_view_scene_res_s	zb_zcl_scenes_view_scene_res_t
	View scene response payload structure.

typedef struct zb_zcl_scenes_fieldset_view_scene_res_s	zb_zcl_scenes_fieldset_view_scene_res_t

typedef struct zb_zcl_scenes_remove_scene_res_s	zb_zcl_scenes_remove_scene_res_t
	Remove scene response payload structure.

typedef struct zb_zcl_scenes_remove_all_scenes_res_s	zb_zcl_scenes_remove_all_scenes_res_t
	Remove all scenes response payload structure.

typedef struct zb_zcl_scenes_store_scene_res_s	zb_zcl_scenes_store_scene_res_t
	Store scene response payload structure.

typedef struct zb_zcl_scenes_get_scene_membership_res_mandatory_s	zb_zcl_scenes_get_scene_membership_res_mandatory_t
	Get scene membership response fixed-structure payload part representation.

typedef struct zb_zcl_scenes_get_scene_membership_res_optional_s	zb_zcl_scenes_get_scene_membership_res_optional_t
	Get scene membership response optional payload part representation.

typedef struct zb_zcl_scenes_get_scene_membership_res_s	zb_zcl_scenes_get_scene_membership_res_t
	Get scene membership response.

Detailed Description

ZCL Scenes cluster definitions

Typedef Documentation

typedef struct zb_zcl_scene_table_record_type_s zb_zcl_scene_table_record_type_t

Typical Scene table record structure.

For each endpoint corresponding type must be declared with ... macro.

Note: Scene names are optional and so are not supported.

Enumeration Type Documentation

enum zb_zcl_scene_attr_e

Scene cluster attribute identifiers.

See Also: ZCL specification, subclause 3.7.2.2

Enumerator
ZB_ZCL_ATTR_SCENES_SCENE_COUNT_ID	Number of scenes currently in the device's scene table
ZB_ZCL_ATTR_SCENES_CURRENT_SCENE_ID	Scene ID of the scene last invoked
ZB_ZCL_ATTR_SCENES_CURRENT_GROUP_ID	Group ID of the scene last invoked. Can hold 0x0000 if the scene last invoked is not associated with a group
ZB_ZCL_ATTR_SCENES_SCENE_VALID_ID	Indicates whether the state of the device corresponds to that associated with the CurrentScene and CurrentGroup attributes. TRUE indicates that these attributes are valid FALSE indicates that they are not valid
ZB_ZCL_ATTR_SCENES_NAME_SUPPORT_ID	Indicates support for scene names. The most significant bit of the NameSupport attribute indicates whether or not scene names are supported 1 indicates that they are supported 0 indicates that they are not supported Note Currently scene names are not supported
ZB_ZCL_ATTR_SCENES_LAST_CONFIGURED_BY_ID	specifies the IEEE address of the device that last configured the scene table The value 0xffffffffffffffff indicates that the device has not been configured, or that the address of the device that last configured the scenes cluster is not known Attention The attribute is not supported!

enum zb_zcl_scenes_cmd_e

Command identifiers for Scenes Cluster.

See Also: ZCL spec, subclause 3.7.2.4

Enumerator
ZB_ZCL_CMD_SCENES_ADD_SCENE	Add scene command
ZB_ZCL_CMD_SCENES_VIEW_SCENE	View scene command
ZB_ZCL_CMD_SCENES_REMOVE_SCENE	Remove scene command
ZB_ZCL_CMD_SCENES_REMOVE_ALL_SCENES	Remove all scenes command
ZB_ZCL_CMD_SCENES_STORE_SCENE	Store scene command
ZB_ZCL_CMD_SCENES_RECALL_SCENE	Recall scene command
ZB_ZCL_CMD_SCENES_GET_SCENE_MEMBERSHIP	Get scene membership command

enum zb_zcl_scenes_cmd_resp_e

Command response identifiers for Scenes Cluster.

See Also: ZCL spec, subclause 3.7.2.5

Enumerator
ZB_ZCL_CMD_SCENES_ADD_SCENE_RESPONSE	Add scene response
ZB_ZCL_CMD_SCENES_VIEW_SCENE_RESPONSE	View scene response
ZB_ZCL_CMD_SCENES_REMOVE_SCENE_RESPONSE	Remove scene response
ZB_ZCL_CMD_SCENES_REMOVE_ALL_SCENES_REPONSE	Remove all scenes response
ZB_ZCL_CMD_SCENES_STORE_SCENE_RESPONSE	Store scene response
ZB_ZCL_CMD_SCENES_GET_SCENE_MEMBERSHIP_RESPONSE	Get scene membership response

Function Documentation

zb_zcl_status_t zb_zcl_scenes_process_store_scene	(	zb_uint8_t	endpoint,
		zb_uint8_t	group_id,
		zb_uint8_t	scene_id
	)

Store scene.

Parameters

endpoint	- endpoint
group_id	- scene group ID
scene_id	- scene ID

Returns: status store scene

zb_ret_t zb_zcl_scenes_recall_global_scene	(	zb_uint8_t	param,
		zb_uint8_t	endpoint
	)

Recall Global scene.

Parameters

param	- buffer for recall scene
endpoint	- enpoint scene for recall

Returns: operation status

zb_void_t zb_zcl_scenes_remove_scenes_in_all_endpoints ( zb_uint16_t group_id )

Removes All scenes corresponding to a group identifiers in a whole device.

Parameters

group_id - group identifier for which all scenes must be removed.

Data Structures

Scenes cluster attributes

Scenes cluster internals

Scenes cluster commands

Detailed Description

Typedef Documentation

Enumeration Type Documentation

Function Documentation