struct
Matter::Cluster::Definitions::Scenes::CopySceneRequest
- Matter::Cluster::Definitions::Scenes::CopySceneRequest
- Struct
- Value
- Object
Overview
Input to the Scenes copyScene command
Included Modules
- TLV::Serializable
Defined in:
matter/cluster/definitions/scenes.crConstructors
Instance Method Summary
-
#group_identifier_from : DataType::GroupId
The GroupIdentifierFrom field specifies the identifier of the group from which the scene is to be copied.
-
#group_identifier_from=(group_identifier_from : DataType::GroupId)
The GroupIdentifierFrom field specifies the identifier of the group from which the scene is to be copied.
-
#group_identifier_to : DataType::GroupId
The GroupIdentifierTo field specifies the identifier of the group to which the scene is to be copied.
-
#group_identifier_to=(group_identifier_to : DataType::GroupId)
The GroupIdentifierTo field specifies the identifier of the group to which the scene is to be copied.
-
#mode : UInt8
The Mode field contains information of how the scene copy is to proceed.
-
#mode=(mode : UInt8)
The Mode field contains information of how the scene copy is to proceed.
-
#scene_identifier_from : UInt8
The SceneIdentifierFrom field specifies the identifier of the scene from which the scene is to be copied.
-
#scene_identifier_from=(scene_identifier_from : UInt8)
The SceneIdentifierFrom field specifies the identifier of the scene from which the scene is to be copied.
-
#scene_identifier_to : UInt8
The SceneIdentifierTo field specifies the identifier of the scene to which the scene is to be copied.
-
#scene_identifier_to=(scene_identifier_to : UInt8)
The SceneIdentifierTo field specifies the identifier of the scene to which the scene is to be copied.
Constructor Detail
Instance Method Detail
The GroupIdentifierFrom field specifies the identifier of the group from which the scene is to be copied. Together with the SceneIdentifierFrom field, this field uniquely identifies the scene to copy from the Scene Table.
The GroupIdentifierFrom field specifies the identifier of the group from which the scene is to be copied. Together with the SceneIdentifierFrom field, this field uniquely identifies the scene to copy from the Scene Table.
The GroupIdentifierTo field specifies the identifier of the group to which the scene is to be copied. Together with the SceneIdentifierTo field, this field uniquely identifies the scene to copy to the Scene Table.
The GroupIdentifierTo field specifies the identifier of the group to which the scene is to be copied. Together with the SceneIdentifierTo field, this field uniquely identifies the scene to copy to the Scene Table.
The Mode field contains information of how the scene copy is to proceed. This field shall be formatted as illustrated in Format of the Mode Field of the CopyScene Command.
The CopyAllScenes subfield is 1-bit in length and indicates whether all scenes are to be copied. If this value is set to 1, all scenes are to be copied and the SceneIdentifierFrom and SceneIdentifierTo fields shall be ignored. Otherwise this field is set to 0.
The Mode field contains information of how the scene copy is to proceed. This field shall be formatted as illustrated in Format of the Mode Field of the CopyScene Command.
The CopyAllScenes subfield is 1-bit in length and indicates whether all scenes are to be copied. If this value is set to 1, all scenes are to be copied and the SceneIdentifierFrom and SceneIdentifierTo fields shall be ignored. Otherwise this field is set to 0.
The SceneIdentifierFrom field specifies the identifier of the scene from which the scene is to be copied. Together with the GroupIdentifierFrom field, this field uniquely identifies the scene to copy from the Scene Table.
The SceneIdentifierFrom field specifies the identifier of the scene from which the scene is to be copied. Together with the GroupIdentifierFrom field, this field uniquely identifies the scene to copy from the Scene Table.
The SceneIdentifierTo field specifies the identifier of the scene to which the scene is to be copied. Together with the GroupIdentifierTo field, this field uniquely identifies the scene to copy to the Scene Table.
The SceneIdentifierTo field specifies the identifier of the scene to which the scene is to be copied. Together with the GroupIdentifierTo field, this field uniquely identifies the scene to copy to the Scene Table.