Z-Stack API Reference  8.31.00.00
ZCL Scenes Cluster

Macros

#define ATTRID_SCENES_SCENE_COUNT   0x0000
 device's scene table.
 
#define ATTRID_SCENES_CURRENT_SCENE   0x0001
 The CurrentScene attribute holds the Scene ID of the scene last invoked.
 
#define ATTRID_SCENES_CURRENT_GROUP   0x0002
 
#define ATTRID_SCENES_SCENE_VALID   0x0003
 
#define ATTRID_SCENES_NAME_SUPPORT   0x0004
 
#define ATTRID_SCENES_LAST_CONFIGURED_BY   0x0005
 
#define COMMAND_SCENES_ADD_SCENE   0x00
 
#define COMMAND_SCENES_VIEW_SCENE   0x01
 
#define COMMAND_SCENES_REMOVE_SCENE   0x02
 
#define COMMAND_SCENES_REMOVE_ALL_SCENES   0x03
 
#define COMMAND_SCENES_STORE_SCENE   0x04
 
#define COMMAND_SCENES_RECALL_SCENE   0x05
 
#define COMMAND_SCENES_GET_SCENE_MEMBERSHIP   0x06
 
#define COMMAND_SCENES_ENHANCED_ADD_SCENE   0x40
 
#define COMMAND_SCENES_ENHANCED_VIEW_SCENE   0x41
 
#define COMMAND_SCENES_COPY_SCENE   0x42
 
#define COMMAND_SCENES_ADD_SCENE_RESPONSE   0x00
 This command is generated in response to a received Add Scene command.
 
#define COMMAND_SCENES_VIEW_SCENE_RESPONSE   0x01
 This command is generated in response to a received View Scene command.
 
#define COMMAND_SCENES_REMOVE_SCENE_RESPONSE   0x02
 This command is generated in response to a received Remove Scene command.
 
#define COMMAND_SCENES_REMOVE_ALL_SCENES_RESPONSE   0x03
 This command is generated in response to a received Remove All Scenes command.
 
#define COMMAND_SCENES_STORE_SCENE_RESPONSE   0x04
 This command is generated in response to a received Store Scene command.
 
#define COMMAND_SCENES_GET_SCENE_MEMBERSHIP_RESPONSE   0x06
 This command is generated in response to a received Get Scene Membership command.
 
#define COMMAND_SCENES_ENHANCED_ADD_SCENE_RESPONSE   0x40
 
#define COMMAND_SCENES_ENHANCED_VIEW_SCENE_RESPONSE   0x41
 
#define COMMAND_SCENES_COPY_SCENE_RESPONSE   0x42
 
#define SCENE_COPY_MODE_ALL_BIT   0x01
 

Detailed Description

Macro Definition Documentation

§ ATTRID_SCENES_CURRENT_GROUP

#define ATTRID_SCENES_CURRENT_GROUP   0x0002

The CurrentGroup attribute holds the Group ID of the scene last invoked, or 0x0000 if the scene last invoked is not associated with a group

§ ATTRID_SCENES_LAST_CONFIGURED_BY

#define ATTRID_SCENES_LAST_CONFIGURED_BY   0x0005

The LastConfiguredBy attribute is 64 bits in length and specifies the IEEE address of the device that last configured the scene table.

§ ATTRID_SCENES_NAME_SUPPORT

#define ATTRID_SCENES_NAME_SUPPORT   0x0004

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

§ ATTRID_SCENES_SCENE_VALID

#define ATTRID_SCENES_SCENE_VALID   0x0003

The SceneValid attribute indicates whether the state of the device corresponds to that associated with the CurrentScene and CurrentGroup attributes.

§ COMMAND_SCENES_ADD_SCENE

#define COMMAND_SCENES_ADD_SCENE   0x00

On receipt of this command, the device SHALL (if possible) create an entry in the Scene Table with fields copied from the command payload

§ COMMAND_SCENES_COPY_SCENE

#define COMMAND_SCENES_COPY_SCENE   0x42

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

§ COMMAND_SCENES_COPY_SCENE_RESPONSE

#define COMMAND_SCENES_COPY_SCENE_RESPONSE   0x42

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

§ COMMAND_SCENES_ENHANCED_ADD_SCENE

#define COMMAND_SCENES_ENHANCED_ADD_SCENE   0x40

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

§ COMMAND_SCENES_ENHANCED_ADD_SCENE_RESPONSE

#define COMMAND_SCENES_ENHANCED_ADD_SCENE_RESPONSE   0x40

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

§ COMMAND_SCENES_ENHANCED_VIEW_SCENE

#define COMMAND_SCENES_ENHANCED_VIEW_SCENE   0x41

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

§ COMMAND_SCENES_ENHANCED_VIEW_SCENE_RESPONSE

#define COMMAND_SCENES_ENHANCED_VIEW_SCENE_RESPONSE   0x41

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.

§ COMMAND_SCENES_GET_SCENE_MEMBERSHIP

#define COMMAND_SCENES_GET_SCENE_MEMBERSHIP   0x06

The Get Scene Membership command can be used to find an unused scene number within the group when no commissioning tool is in the network.

§ COMMAND_SCENES_RECALL_SCENE

#define COMMAND_SCENES_RECALL_SCENE   0x05

On receipt of this command, the device SHALL (if possible) locate the entry in its Scene Table with the Group ID and Scene ID given in the command.

§ COMMAND_SCENES_REMOVE_ALL_SCENES

#define COMMAND_SCENES_REMOVE_ALL_SCENES   0x03

On receipt of this command, the device SHALL, if possible, remove from its Scene Table all entries with this Group ID.

§ COMMAND_SCENES_REMOVE_SCENE

#define COMMAND_SCENES_REMOVE_SCENE   0x02

On receipt of this command, the device SHALL (if possible) remove from its Scene Table the entry with this Scene ID and group ID.

§ COMMAND_SCENES_STORE_SCENE

#define COMMAND_SCENES_STORE_SCENE   0x04

On receipt of this command, the device SHALL (if possible) add an entry to the Scene Table with the Scene ID and Group ID given in the command.

§ COMMAND_SCENES_VIEW_SCENE

#define COMMAND_SCENES_VIEW_SCENE   0x01

On receipt of this command, the device SHALL generate an appropriate View Scene Response command.