Cluster Commands: Scenes#

This group describes the CLI commands for the Scenes cluster. Listed below is a description of the cluster:

Attributes and commands for scene configuration and manipulation.

Macros#

#define

zcl scenes add [groupId:2] [sceneId:1] [transitionTime:2] [sceneName:-1] [extensionFieldSets:4]

#define

zcl scenes view [groupId:2] [sceneId:1]

#define

zcl scenes remove [groupId:2] [sceneId:1]

#define

zcl scenes rmall [groupId:2]

#define

zcl scenes store [groupId:2] [sceneId:1]

#define

zcl scenes recall [groupId:2] [sceneId:1] [transitionTime:2]

#define

zcl scenes get [groupId:2]

#define

zcl scenes eadd [groupId:2] [sceneId:1] [transitionTime:2] [sceneName:-1] [extensionFieldSets:4]

#define

zcl scenes eview [groupId:2] [sceneId:1]

#define

zcl scenes copy [mode:1] [groupIdFrom:2] [sceneIdFrom:1] [groupIdTo:2] [sceneIdTo:1]

Macro Definition Documentation#

EMBER_AF_DOXYGEN_CLI_COMMAND_SCENES_ADD#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_SCENES_ADD

zcl scenes add [groupId:2] [sceneId:1] [transitionTime:2] [sceneName:-1] [extensionFieldSets:4]

  • Add a scene to the scene table. Extension field sets are supported, and are inputed as arrays of the form [[cluster ID] [length] [value0...n] ...]

    • groupId - INT16U

    • sceneId - INT8U

    • transitionTime - INT16U

    • sceneName - CHAR_STRING

    • extensionFieldSets - struct SceneExtensionFieldSet


Definition at line 2365 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_SCENES_VIEW#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_SCENES_VIEW

zcl scenes view [groupId:2] [sceneId:1]

  • Command description for ViewScene

    • groupId - INT16U

    • sceneId - INT8U


Definition at line 2372 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_SCENES_REMOVE#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_SCENES_REMOVE

zcl scenes remove [groupId:2] [sceneId:1]

  • Command description for RemoveScene

    • groupId - INT16U

    • sceneId - INT8U


Definition at line 2379 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_SCENES_RMALL#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_SCENES_RMALL

zcl scenes rmall [groupId:2]

  • Command description for RemoveAllScenes

    • groupId - INT16U


Definition at line 2385 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_SCENES_STORE#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_SCENES_STORE

zcl scenes store [groupId:2] [sceneId:1]

  • Command description for StoreScene

    • groupId - INT16U

    • sceneId - INT8U


Definition at line 2392 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_SCENES_RECALL#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_SCENES_RECALL

zcl scenes recall [groupId:2] [sceneId:1] [transitionTime:2]

  • Command description for RecallScene

    • groupId - INT16U

    • sceneId - INT8U

    • transitionTime - INT16U


Definition at line 2400 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_SCENES_GET#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_SCENES_GET

zcl scenes get [groupId:2]

  • Command description for GetSceneMembership

    • groupId - INT16U


Definition at line 2406 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_SCENES_EADD#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_SCENES_EADD

zcl scenes eadd [groupId:2] [sceneId:1] [transitionTime:2] [sceneName:-1] [extensionFieldSets:4]

  • Command description for EnhancedAddScene

    • groupId - INT16U

    • sceneId - INT8U

    • transitionTime - INT16U

    • sceneName - CHAR_STRING

    • extensionFieldSets - struct SceneExtensionFieldSet


Definition at line 2416 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_SCENES_EVIEW#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_SCENES_EVIEW

zcl scenes eview [groupId:2] [sceneId:1]

  • Command description for EnhancedViewScene

    • groupId - INT16U

    • sceneId - INT8U


Definition at line 2423 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_SCENES_COPY#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_SCENES_COPY

zcl scenes copy [mode:1] [groupIdFrom:2] [sceneIdFrom:1] [groupIdTo:2] [sceneIdTo:1]

  • Command description for CopyScene

    • mode - ScenesCopyMode [BITMAP8]

    • groupIdFrom - INT16U

    • sceneIdFrom - INT8U

    • groupIdTo - INT16U

    • sceneIdTo - INT8U


Definition at line 2433 of file app/framework/test/headers/cli.doc