ZCL scenes

Zigbee Cluster Library (ZCL) scenes cluster usage definition for ESP Zigbee SDK.

Header File

• components/esp-zigbee-lib/include/zcl/esp_zigbee_zcl_scenes.h

Macros

ESP_ZB_ZCL_SCENES_SCENE_COUNT_DEFAULT_VALUE

Default value for Scene count attribute.

ESP_ZB_ZCL_SCENES_CURRENT_SCENE_DEFAULT_VALUE

Default value for Current scene attribute.

ESP_ZB_ZCL_SCENES_CURRENT_GROUP_DEFAULT_VALUE

Default value for Current group attribute.

ESP_ZB_ZCL_SCENES_SCENE_VALID_DEFAULT_VALUE

Default value for Scene valid attribute.

ESP_ZB_ZCL_SCENES_NAME_SUPPORT_DEFAULT_VALUE

Default value for Name support attribute.

Enumerations

enum esp_zb_zcl_scene_attr_t

Scene cluster attribute identifiers.

Values:

enumerator ESP_ZB_ZCL_ATTR_SCENES_SCENE_COUNT_ID

Number of scenes currently in the device’s scene table

enumerator ESP_ZB_ZCL_ATTR_SCENES_CURRENT_SCENE_ID

Scene ID of the scene last invoked

enumerator ESP_ZB_ZCL_ATTR_SCENES_CURRENT_GROUP_ID

Group ID of the scene last invoked

enumerator ESP_ZB_ZCL_ATTR_SCENES_SCENE_VALID_ID

Indicates whether the state of the device corresponds to CurrentScene and CurrentGroup attributes

enumerator ESP_ZB_ZCL_ATTR_SCENES_NAME_SUPPORT_ID

The most significant bit of the NameSupport attribute indicates whether or not scene names are supported

enumerator ESP_ZB_ZCL_ATTR_SCENES_LAST_CONFIGURED_BY_ID

specifies the IEEE address of the device that last configured the scene table

enum esp_zb_zcl_scenes_cmd_id_t

Command identifiers for Scenes Cluster.

Values:

enumerator ESP_ZB_ZCL_CMD_SCENES_ADD_SCENE

Add scene command

enumerator ESP_ZB_ZCL_CMD_SCENES_VIEW_SCENE

View scene command

enumerator ESP_ZB_ZCL_CMD_SCENES_REMOVE_SCENE

Remove scene command

enumerator ESP_ZB_ZCL_CMD_SCENES_REMOVE_ALL_SCENES

Remove all scenes command

enumerator ESP_ZB_ZCL_CMD_SCENES_STORE_SCENE

Store scene command

enumerator ESP_ZB_ZCL_CMD_SCENES_RECALL_SCENE

Recall scene command

enumerator ESP_ZB_ZCL_CMD_SCENES_GET_SCENE_MEMBERSHIP

Get scene membership command

enumerator ESP_ZB_ZCL_CMD_SCENES_ENHANCED_ADD_SCENE

The Enhanced Add Scene command allows a scene to be added using a finer scene transition time than the Add Scene command.

enumerator ESP_ZB_ZCL_CMD_SCENES_ENHANCED_VIEW_SCENE

The Enhanced View Scene command allows a scene to be retrieved using a finer scene transition time than the View Scene command.

enumerator ESP_ZB_ZCL_CMD_SCENES_COPY_SCENE

The Copy Scene command allows a device to efficiently copy scenes from one group/scene identifier pair to another group/scene identifier pair.

enum esp_zb_zcl_scenes_cmd_resp_id_t

Response command identifiers for Scenes Cluster.

Values:

enumerator ESP_ZB_ZCL_CMD_SCENES_ADD_SCENE_RESPONSE

Add scene response

enumerator ESP_ZB_ZCL_CMD_SCENES_VIEW_SCENE_RESPONSE

View scene response

enumerator ESP_ZB_ZCL_CMD_SCENES_REMOVE_SCENE_RESPONSE

Remove scene response

enumerator ESP_ZB_ZCL_CMD_SCENES_REMOVE_ALL_SCENES_RESPONSE

Remove all scenes response

enumerator ESP_ZB_ZCL_CMD_SCENES_STORE_SCENE_RESPONSE

Store scene response

enumerator ESP_ZB_ZCL_CMD_SCENES_GET_SCENE_MEMBERSHIP_RESPONSE

Get scene membership response

enumerator ESP_ZB_ZCL_CMD_SCENES_ENHANCED_ADD_SCENE_RESPONSE

The Enhanced Add Scene Response command allows a device to respond to an Enhanced Add Scene command.

enumerator ESP_ZB_ZCL_CMD_SCENES_ENHANCED_VIEW_SCENE_RESPONSE

The Enhanced View Scene Response command allows a device to respond to an Enhanced View Scene command using a finer scene transition time that was available in the ZCL.

enumerator ESP_ZB_ZCL_CMD_SCENES_COPY_SCENE_RESPONSE

The Copy Scene Response command allows a device to respond to a Copy Scene command.