The following commands and attributes are accepted as JSON payloads for the Scenes cluster.
Scenes Attributes
The following attribute topics are used to retrieve the Scenes cluster state.
Scenes/SceneCount Attribute
MQTT Topic Pattern:
[PREFIX]/Scenes/Attributes/SceneCount/Reported
[PREFIX]/Scenes/Attributes/SceneCount/Desired
MQTT Payload JSON Schema:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Scenes Cluster SceneCount Attribute Properties",
"type": "object",
"properties": {
"value": {
"type": "integer"
}
},
"required": [
"value"
]
}
Example Mosquitto CLI Tool Usage
To see desired/reported value for SceneCount attribute under the by-unid topic space:
mosquitto_sub -t 'ucl/by-unid/+/+/Scenes/Attributes/SceneCount/+'
# Example output
ucl/by-unid/<UNID>/ep0/Scenes/Attributes/SceneCount/Desired { "value": <DESIRED_SCENE_COUNT>}
ucl/by-unid/<UNID>/ep0/Scenes/Attributes/SceneCount/Reported { "value": <REPORTED_SCENE_COUNT>}
Scenes/CurrentScene Attribute
MQTT Topic Pattern:
[PREFIX]/Scenes/Attributes/CurrentScene/Reported
[PREFIX]/Scenes/Attributes/CurrentScene/Desired
MQTT Payload JSON Schema:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Scenes Cluster CurrentScene Attribute Properties",
"type": "object",
"properties": {
"value": {
"type": "integer"
}
},
"required": [
"value"
]
}
Example Mosquitto CLI Tool Usage
To see desired/reported value for CurrentScene attribute under the by-unid topic space:
mosquitto_sub -t 'ucl/by-unid/+/+/Scenes/Attributes/CurrentScene/+'
# Example output
ucl/by-unid/<UNID>/ep0/Scenes/Attributes/CurrentScene/Desired { "value": <DESIRED_CURRENT_SCENE>}
ucl/by-unid/<UNID>/ep0/Scenes/Attributes/CurrentScene/Reported { "value": <REPORTED_CURRENT_SCENE>}
Scenes/CurrentGroup Attribute
MQTT Topic Pattern:
[PREFIX]/Scenes/Attributes/CurrentGroup/Reported
[PREFIX]/Scenes/Attributes/CurrentGroup/Desired
MQTT Payload JSON Schema:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Scenes Cluster CurrentGroup Attribute Properties",
"type": "object",
"properties": {
"value": {
"type": "SGroupId"
}
},
"required": [
"value"
]
}
Example Mosquitto CLI Tool Usage
To see desired/reported value for CurrentGroup attribute under the by-unid topic space:
mosquitto_sub -t 'ucl/by-unid/+/+/Scenes/Attributes/CurrentGroup/+'
# Example output
ucl/by-unid/<UNID>/ep0/Scenes/Attributes/CurrentGroup/Desired { "value": <DESIRED_CURRENT_GROUP>}
ucl/by-unid/<UNID>/ep0/Scenes/Attributes/CurrentGroup/Reported { "value": <REPORTED_CURRENT_GROUP>}
Scenes/SceneValid Attribute
MQTT Topic Pattern:
[PREFIX]/Scenes/Attributes/SceneValid/Reported
[PREFIX]/Scenes/Attributes/SceneValid/Desired
MQTT Payload JSON Schema:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Scenes Cluster SceneValid Attribute Properties",
"type": "object",
"properties": {
"value": {
"type": "boolean"
}
},
"required": [
"value"
]
}
Example Mosquitto CLI Tool Usage
To see desired/reported value for SceneValid attribute under the by-unid topic space:
mosquitto_sub -t 'ucl/by-unid/+/+/Scenes/Attributes/SceneValid/+'
# Example output
ucl/by-unid/<UNID>/ep0/Scenes/Attributes/SceneValid/Desired { "value": <DESIRED_SCENE_VALID>}
ucl/by-unid/<UNID>/ep0/Scenes/Attributes/SceneValid/Reported { "value": <REPORTED_SCENE_VALID>}
Scenes/NameSupport Attribute
MQTT Topic Pattern:
[PREFIX]/Scenes/Attributes/NameSupport/Reported
[PREFIX]/Scenes/Attributes/NameSupport/Desired
MQTT Payload JSON Schema:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Scenes Cluster NameSupport Attribute Properties",
"type": "object",
"properties": {
"value": {
"type": "ScenesNameSupport"
}
},
"required": [
"value"
]
}
Example Mosquitto CLI Tool Usage
To see desired/reported value for NameSupport attribute under the by-unid topic space:
mosquitto_sub -t 'ucl/by-unid/+/+/Scenes/Attributes/NameSupport/+'
# Example output
ucl/by-unid/<UNID>/ep0/Scenes/Attributes/NameSupport/Desired { "value": <DESIRED_NAME_SUPPORT>}
ucl/by-unid/<UNID>/ep0/Scenes/Attributes/NameSupport/Reported { "value": <REPORTED_NAME_SUPPORT>}
Scenes/LastConfiguredBy Attribute
MQTT Topic Pattern:
[PREFIX]/Scenes/Attributes/LastConfiguredBy/Reported
[PREFIX]/Scenes/Attributes/LastConfiguredBy/Desired
MQTT Payload JSON Schema:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Scenes Cluster LastConfiguredBy Attribute Properties",
"type": "object",
"properties": {
"value": {
"type": "EUI64"
}
},
"required": [
"value"
]
}
Example Mosquitto CLI Tool Usage
To see desired/reported value for LastConfiguredBy attribute under the by-unid topic space:
mosquitto_sub -t 'ucl/by-unid/+/+/Scenes/Attributes/LastConfiguredBy/+'
# Example output
ucl/by-unid/<UNID>/ep0/Scenes/Attributes/LastConfiguredBy/Desired { "value": <DESIRED_LAST_CONFIGURED_BY>}
ucl/by-unid/<UNID>/ep0/Scenes/Attributes/LastConfiguredBy/Reported { "value": <REPORTED_LAST_CONFIGURED_BY>}
Scenes/SceneTable Attribute
MQTT Topic Pattern:
[PREFIX]/Scenes/Attributes/SceneTable/Reported
[PREFIX]/Scenes/Attributes/SceneTable/Desired
MQTT Payload JSON Schema:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Scenes Cluster SceneTable Attribute Properties",
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"type": "SSceneTable"
}
}
},
"required": [
"value"
]
}
Example Mosquitto CLI Tool Usage
To see desired/reported value for SceneTable attribute under the by-unid topic space:
mosquitto_sub -t 'ucl/by-unid/+/+/Scenes/Attributes/SceneTable/+'
# Example output
ucl/by-unid/<UNID>/ep0/Scenes/Attributes/SceneTable/Desired { "value": [<DESIRED_SCENE_TABLE>,<DESIRED_SCENE_TABLE>]}
ucl/by-unid/<UNID>/ep0/Scenes/Attributes/SceneTable/Reported { "value": [<REPORTED_SCENE_TABLE>,<REPORTED_SCENE_TABLE>]}
Scenes/ClusterRevision Attribute
MQTT Topic Pattern:
[PREFIX]/Scenes/Attributes/ClusterRevision/Reported
[PREFIX]/Scenes/Attributes/ClusterRevision/Desired
MQTT Payload JSON Schema:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Scenes Cluster ClusterRevision Attribute Properties",
"type": "object",
"properties": {
"value": {
"type": "integer"
}
},
"required": [
"value"
]
}
Example Mosquitto CLI Tool Usage
To see desired/reported value for ClusterRevision attribute under the by-unid topic space:
mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/Scenes/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/Scenes/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }
Scenes Command Support
MQTT Topic Pattern:
[PREFIX]/Scenes/SupportedCommands
[PREFIX]/Scenes/SupportedGeneratedCommands
MQTT Payload JSON Schema:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Scenes Command Support Properties",
"type": "object",
"properties": {
"value": {
"type": "array",
"items" : {
"type": "string",
"enum": [
"AddScene",
"AddSceneResponse",
"ViewScene",
"ViewSceneResponse",
"RemoveScene",
"RemoveSceneResponse",
"RemoveAllScenes",
"RemoveAllScenesResponse",
"StoreScene",
"StoreSceneResponse",
"RecallScene",
"GetSceneMembership",
"GetSceneMembershipResponse",
"EnhancedAddScene",
"EnhancedAddSceneResponse",
"EnhancedViewScene",
"EnhancedViewSceneResponse",
"CopyScene",
"CopySceneResponse",
"WriteAttributes",
"ForceReadAttributes"
]
}
}
}
},
"required": [
"value"
]
}
Example Mosquitto CLI Tool Usage
To see supported commands for Scenes cluster under the by-unid topic space:
mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/Scenes/SupportedCommands { "value": ["AddScene","ViewScene","RemoveScene","RemoveAllScenes","StoreScene","RecallScene","GetSceneMembership","EnhancedAddScene","EnhancedViewScene","CopyScene",] }
To see supported generated commands for Scenes cluster under the by-unid topic space:
mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/Scenes/SupportedGeneratedCommands { "value": ["AddSceneResponse","ViewSceneResponse","RemoveSceneResponse","RemoveAllScenesResponse","StoreSceneResponse","GetSceneMembershipResponse","EnhancedAddSceneResponse","EnhancedViewSceneResponse","CopySceneResponse"] }
Scenes Commands
Scenes/AddScene Command
MQTT Topic Pattern:
[PREFIX]/Scenes/Commands/AddScene
[PREFIX]/Scenes/GeneratedCommands/AddScene
MQTT Payload JSON Schema:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Scenes Cluster AddScene Command Properties",
"type": "object",
"properties": {
"GroupID": {
"type": "SGroupId"
},
"SceneID": {
"type": "integer"
},
"TransitionTime": {
"type": "integer"
},
"SceneName": {
"type": "SSceneName"
},
"ExtensionFieldSets": {
"type": "array",
"items": {
"type": "SExtensionFieldSetList"
}
,
"TransitionTime100ms": {
"type": "integer"
}
},
"required": [
"GroupID",
"SceneID",
"TransitionTime",
"SceneName",
"ExtensionFieldSets",
"TransitionTime100ms"
]
}
Example Mosquitto CLI Tool Usage
To send a Scenes/AddScene command under the by-unid topic space:
mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/AddScene' -m '{ "GroupID": <GROUPID_VALUE>,"SceneID": <SCENEID_VALUE>,"TransitionTime": <TRANSITION_TIME_VALUE>,"SceneName": <SCENE_NAME_VALUE>,"ExtensionFieldSets": <EXTENSION_FIELD_SETS_VALUE>,"TransitionTime100ms": <TRANSITION_TIME100MS_VALUE> }'
To receive a Scenes/AddScene generated command from a UNID/endpoint:
mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/GeneratedCommands/AddScene'
Scenes/AddSceneResponse Command
MQTT Topic Pattern:
[PREFIX]/Scenes/Commands/AddSceneResponse
[PREFIX]/Scenes/GeneratedCommands/AddSceneResponse
MQTT Payload JSON Schema:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Scenes Cluster AddSceneResponse Command Properties",
"type": "object",
"properties": {
"Status": {
"type": "zclStatus"
},
"GroupID": {
"type": "SGroupId"
},
"SceneID": {
"type": "integer"
}
},
"required": [
"Status",
"GroupID",
"SceneID"
]
}
Example Mosquitto CLI Tool Usage
To send a Scenes/AddSceneResponse command under the by-unid topic space:
mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/AddSceneResponse' -m '{ "Status": <STATUS_VALUE>,"GroupID": <GROUPID_VALUE>,"SceneID": <SCENEID_VALUE> }'
To receive a Scenes/AddSceneResponse generated command from a UNID/endpoint:
mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/GeneratedCommands/AddSceneResponse'
Scenes/ViewScene Command
MQTT Topic Pattern:
[PREFIX]/Scenes/Commands/ViewScene
[PREFIX]/Scenes/GeneratedCommands/ViewScene
MQTT Payload JSON Schema:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Scenes Cluster ViewScene Command Properties",
"type": "object",
"properties": {
"GroupID": {
"type": "SGroupId"
},
"SceneID": {
"type": "integer"
}
},
"required": [
"GroupID",
"SceneID"
]
}
Example Mosquitto CLI Tool Usage
To send a Scenes/ViewScene command under the by-unid topic space:
mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/ViewScene' -m '{ "GroupID": <GROUPID_VALUE>,"SceneID": <SCENEID_VALUE> }'
To receive a Scenes/ViewScene generated command from a UNID/endpoint:
mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/GeneratedCommands/ViewScene'
Scenes/ViewSceneResponse Command
MQTT Topic Pattern:
[PREFIX]/Scenes/Commands/ViewSceneResponse
[PREFIX]/Scenes/GeneratedCommands/ViewSceneResponse
MQTT Payload JSON Schema:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Scenes Cluster ViewSceneResponse Command Properties",
"type": "object",
"properties": {
"Status": {
"type": "zclStatus"
},
"GroupID": {
"type": "SGroupId"
},
"SceneID": {
"type": "integer"
},
"TransitionTime": {
"type": "integer"
},
"SceneName": {
"type": "SSceneName"
},
"ExtensionFieldSets": {
"type": "array",
"items": {
"type": "SExtensionFieldSetList"
}
},
"required": [
"Status",
"GroupID",
"SceneID",
"TransitionTime",
"SceneName",
"ExtensionFieldSets"
]
}
Example Mosquitto CLI Tool Usage
To send a Scenes/ViewSceneResponse command under the by-unid topic space:
mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/ViewSceneResponse' -m '{ "Status": <STATUS_VALUE>,"GroupID": <GROUPID_VALUE>,"SceneID": <SCENEID_VALUE>,"TransitionTime": <TRANSITION_TIME_VALUE>,"SceneName": <SCENE_NAME_VALUE>,"ExtensionFieldSets": <EXTENSION_FIELD_SETS_VALUE> }'
To receive a Scenes/ViewSceneResponse generated command from a UNID/endpoint:
mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/GeneratedCommands/ViewSceneResponse'
Scenes/RemoveScene Command
MQTT Topic Pattern:
[PREFIX]/Scenes/Commands/RemoveScene
[PREFIX]/Scenes/GeneratedCommands/RemoveScene
MQTT Payload JSON Schema:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Scenes Cluster RemoveScene Command Properties",
"type": "object",
"properties": {
"GroupID": {
"type": "SGroupId"
},
"SceneID": {
"type": "integer"
}
},
"required": [
"GroupID",
"SceneID"
]
}
Example Mosquitto CLI Tool Usage
To send a Scenes/RemoveScene command under the by-unid topic space:
mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/RemoveScene' -m '{ "GroupID": <GROUPID_VALUE>,"SceneID": <SCENEID_VALUE> }'
To receive a Scenes/RemoveScene generated command from a UNID/endpoint:
mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/GeneratedCommands/RemoveScene'
Scenes/RemoveSceneResponse Command
MQTT Topic Pattern:
[PREFIX]/Scenes/Commands/RemoveSceneResponse
[PREFIX]/Scenes/GeneratedCommands/RemoveSceneResponse
MQTT Payload JSON Schema:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Scenes Cluster RemoveSceneResponse Command Properties",
"type": "object",
"properties": {
"Status": {
"type": "zclStatus"
},
"GroupID": {
"type": "SGroupId"
},
"SceneID": {
"type": "integer"
}
},
"required": [
"Status",
"GroupID",
"SceneID"
]
}
Example Mosquitto CLI Tool Usage
To send a Scenes/RemoveSceneResponse command under the by-unid topic space:
mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/RemoveSceneResponse' -m '{ "Status": <STATUS_VALUE>,"GroupID": <GROUPID_VALUE>,"SceneID": <SCENEID_VALUE> }'
To receive a Scenes/RemoveSceneResponse generated command from a UNID/endpoint:
mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/GeneratedCommands/RemoveSceneResponse'
Scenes/RemoveAllScenes Command
MQTT Topic Pattern:
[PREFIX]/Scenes/Commands/RemoveAllScenes
[PREFIX]/Scenes/GeneratedCommands/RemoveAllScenes
MQTT Payload JSON Schema:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Scenes Cluster RemoveAllScenes Command Properties",
"type": "object",
"properties": {
"GroupID": {
"type": "SGroupId"
}
},
"required": [
"GroupID"
]
}
Example Mosquitto CLI Tool Usage
To send a Scenes/RemoveAllScenes command under the by-unid topic space:
mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/RemoveAllScenes' -m '{ "GroupID": <GROUPID_VALUE> }'
To receive a Scenes/RemoveAllScenes generated command from a UNID/endpoint:
mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/GeneratedCommands/RemoveAllScenes'
Scenes/RemoveAllScenesResponse Command
MQTT Topic Pattern:
[PREFIX]/Scenes/Commands/RemoveAllScenesResponse
[PREFIX]/Scenes/GeneratedCommands/RemoveAllScenesResponse
MQTT Payload JSON Schema:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Scenes Cluster RemoveAllScenesResponse Command Properties",
"type": "object",
"properties": {
"Status": {
"type": "zclStatus"
},
"GroupID": {
"type": "SGroupId"
}
},
"required": [
"Status",
"GroupID"
]
}
Example Mosquitto CLI Tool Usage
To send a Scenes/RemoveAllScenesResponse command under the by-unid topic space:
mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/RemoveAllScenesResponse' -m '{ "Status": <STATUS_VALUE>,"GroupID": <GROUPID_VALUE> }'
To receive a Scenes/RemoveAllScenesResponse generated command from a UNID/endpoint:
mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/GeneratedCommands/RemoveAllScenesResponse'
Scenes/StoreScene Command
MQTT Topic Pattern:
[PREFIX]/Scenes/Commands/StoreScene
[PREFIX]/Scenes/GeneratedCommands/StoreScene
MQTT Payload JSON Schema:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Scenes Cluster StoreScene Command Properties",
"type": "object",
"properties": {
"GroupID": {
"type": "SGroupId"
},
"SceneID": {
"type": "integer"
}
},
"required": [
"GroupID",
"SceneID"
]
}
Example Mosquitto CLI Tool Usage
To send a Scenes/StoreScene command under the by-unid topic space:
mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/StoreScene' -m '{ "GroupID": <GROUPID_VALUE>,"SceneID": <SCENEID_VALUE> }'
To receive a Scenes/StoreScene generated command from a UNID/endpoint:
mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/GeneratedCommands/StoreScene'
Scenes/StoreSceneResponse Command
MQTT Topic Pattern:
[PREFIX]/Scenes/Commands/StoreSceneResponse
[PREFIX]/Scenes/GeneratedCommands/StoreSceneResponse
MQTT Payload JSON Schema:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Scenes Cluster StoreSceneResponse Command Properties",
"type": "object",
"properties": {
"Status": {
"type": "zclStatus"
},
"GroupID": {
"type": "SGroupId"
},
"SceneID": {
"type": "integer"
}
},
"required": [
"Status",
"GroupID",
"SceneID"
]
}
Example Mosquitto CLI Tool Usage
To send a Scenes/StoreSceneResponse command under the by-unid topic space:
mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/StoreSceneResponse' -m '{ "Status": <STATUS_VALUE>,"GroupID": <GROUPID_VALUE>,"SceneID": <SCENEID_VALUE> }'
To receive a Scenes/StoreSceneResponse generated command from a UNID/endpoint:
mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/GeneratedCommands/StoreSceneResponse'
Scenes/RecallScene Command
MQTT Topic Pattern:
[PREFIX]/Scenes/Commands/RecallScene
[PREFIX]/Scenes/GeneratedCommands/RecallScene
MQTT Payload JSON Schema:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Scenes Cluster RecallScene Command Properties",
"type": "object",
"properties": {
"GroupID": {
"type": "SGroupId"
},
"SceneID": {
"type": "integer"
},
"TransitionTime": {
"type": "integer"
}
},
"required": [
"GroupID",
"SceneID",
"TransitionTime"
]
}
Example Mosquitto CLI Tool Usage
To send a Scenes/RecallScene command under the by-unid topic space:
mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/RecallScene' -m '{ "GroupID": <GROUPID_VALUE>,"SceneID": <SCENEID_VALUE>,"TransitionTime": <TRANSITION_TIME_VALUE> }'
To receive a Scenes/RecallScene generated command from a UNID/endpoint:
mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/GeneratedCommands/RecallScene'
Scenes/GetSceneMembership Command
MQTT Topic Pattern:
[PREFIX]/Scenes/Commands/GetSceneMembership
[PREFIX]/Scenes/GeneratedCommands/GetSceneMembership
MQTT Payload JSON Schema:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Scenes Cluster GetSceneMembership Command Properties",
"type": "object",
"properties": {
"GroupID": {
"type": "SGroupId"
}
},
"required": [
"GroupID"
]
}
Example Mosquitto CLI Tool Usage
To send a Scenes/GetSceneMembership command under the by-unid topic space:
mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/GetSceneMembership' -m '{ "GroupID": <GROUPID_VALUE> }'
To receive a Scenes/GetSceneMembership generated command from a UNID/endpoint:
mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/GeneratedCommands/GetSceneMembership'
Scenes/GetSceneMembershipResponse Command
MQTT Topic Pattern:
[PREFIX]/Scenes/Commands/GetSceneMembershipResponse
[PREFIX]/Scenes/GeneratedCommands/GetSceneMembershipResponse
MQTT Payload JSON Schema:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Scenes Cluster GetSceneMembershipResponse Command Properties",
"type": "object",
"properties": {
"Status": {
"type": "zclStatus"
},
"Capacity": {
"type": "integer"
},
"GroupID": {
"type": "SGroupId"
},
"SceneList": {
"type": "array",
"items": {
"type": "integer"
}
},
"required": [
"Status",
"Capacity",
"GroupID",
"SceneList"
]
}
Example Mosquitto CLI Tool Usage
To send a Scenes/GetSceneMembershipResponse command under the by-unid topic space:
mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/GetSceneMembershipResponse' -m '{ "Status": <STATUS_VALUE>,"Capacity": <CAPACITY_VALUE>,"GroupID": <GROUPID_VALUE>,"SceneList": <SCENE_LIST_VALUE> }'
To receive a Scenes/GetSceneMembershipResponse generated command from a UNID/endpoint:
mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/GeneratedCommands/GetSceneMembershipResponse'
Scenes/EnhancedAddScene Command
MQTT Topic Pattern:
[PREFIX]/Scenes/Commands/EnhancedAddScene
[PREFIX]/Scenes/GeneratedCommands/EnhancedAddScene
MQTT Payload JSON Schema:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Scenes Cluster EnhancedAddScene Command Properties",
"type": "object",
"properties": {
"GroupID": {
"type": "SGroupId"
},
"SceneID": {
"type": "integer"
},
"TransitionTime": {
"type": "integer"
},
"SceneName": {
"type": "SSceneName"
},
"ExtensionFieldSets": {
"type": "array",
"items": {
"type": "SExtensionFieldSetList"
}
},
"required": [
"GroupID",
"SceneID",
"TransitionTime",
"SceneName",
"ExtensionFieldSets"
]
}
Example Mosquitto CLI Tool Usage
To send a Scenes/EnhancedAddScene command under the by-unid topic space:
mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/EnhancedAddScene' -m '{ "GroupID": <GROUPID_VALUE>,"SceneID": <SCENEID_VALUE>,"TransitionTime": <TRANSITION_TIME_VALUE>,"SceneName": <SCENE_NAME_VALUE>,"ExtensionFieldSets": <EXTENSION_FIELD_SETS_VALUE> }'
To receive a Scenes/EnhancedAddScene generated command from a UNID/endpoint:
mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/GeneratedCommands/EnhancedAddScene'
Scenes/EnhancedAddSceneResponse Command
MQTT Topic Pattern:
[PREFIX]/Scenes/Commands/EnhancedAddSceneResponse
[PREFIX]/Scenes/GeneratedCommands/EnhancedAddSceneResponse
MQTT Payload JSON Schema:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Scenes Cluster EnhancedAddSceneResponse Command Properties",
"type": "object",
"properties": {
"Status": {
"type": "zclStatus"
},
"GroupID": {
"type": "SGroupId"
},
"SceneID": {
"type": "integer"
}
},
"required": [
"Status",
"GroupID",
"SceneID"
]
}
Example Mosquitto CLI Tool Usage
To send a Scenes/EnhancedAddSceneResponse command under the by-unid topic space:
mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/EnhancedAddSceneResponse' -m '{ "Status": <STATUS_VALUE>,"GroupID": <GROUPID_VALUE>,"SceneID": <SCENEID_VALUE> }'
To receive a Scenes/EnhancedAddSceneResponse generated command from a UNID/endpoint:
mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/GeneratedCommands/EnhancedAddSceneResponse'
Scenes/EnhancedViewScene Command
MQTT Topic Pattern:
[PREFIX]/Scenes/Commands/EnhancedViewScene
[PREFIX]/Scenes/GeneratedCommands/EnhancedViewScene
MQTT Payload JSON Schema:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Scenes Cluster EnhancedViewScene Command Properties",
"type": "object",
"properties": {
"GroupID": {
"type": "SGroupId"
},
"SceneID": {
"type": "integer"
}
},
"required": [
"GroupID",
"SceneID"
]
}
Example Mosquitto CLI Tool Usage
To send a Scenes/EnhancedViewScene command under the by-unid topic space:
mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/EnhancedViewScene' -m '{ "GroupID": <GROUPID_VALUE>,"SceneID": <SCENEID_VALUE> }'
To receive a Scenes/EnhancedViewScene generated command from a UNID/endpoint:
mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/GeneratedCommands/EnhancedViewScene'
Scenes/EnhancedViewSceneResponse Command
MQTT Topic Pattern:
[PREFIX]/Scenes/Commands/EnhancedViewSceneResponse
[PREFIX]/Scenes/GeneratedCommands/EnhancedViewSceneResponse
MQTT Payload JSON Schema:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Scenes Cluster EnhancedViewSceneResponse Command Properties",
"type": "object",
"properties": {
"Status": {
"type": "zclStatus"
},
"GroupID": {
"type": "SGroupId"
},
"SceneID": {
"type": "integer"
},
"TransitionTime": {
"type": "integer"
},
"SceneName": {
"type": "SSceneName"
},
"ExtensionFieldSets": {
"type": "array",
"items": {
"type": "SExtensionFieldSetList"
}
},
"required": [
"Status",
"GroupID",
"SceneID",
"TransitionTime",
"SceneName",
"ExtensionFieldSets"
]
}
Example Mosquitto CLI Tool Usage
To send a Scenes/EnhancedViewSceneResponse command under the by-unid topic space:
mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/EnhancedViewSceneResponse' -m '{ "Status": <STATUS_VALUE>,"GroupID": <GROUPID_VALUE>,"SceneID": <SCENEID_VALUE>,"TransitionTime": <TRANSITION_TIME_VALUE>,"SceneName": <SCENE_NAME_VALUE>,"ExtensionFieldSets": <EXTENSION_FIELD_SETS_VALUE> }'
To receive a Scenes/EnhancedViewSceneResponse generated command from a UNID/endpoint:
mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/GeneratedCommands/EnhancedViewSceneResponse'
Scenes/CopyScene Command
MQTT Topic Pattern:
[PREFIX]/Scenes/Commands/CopyScene
[PREFIX]/Scenes/GeneratedCommands/CopyScene
MQTT Payload JSON Schema:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Scenes Cluster CopyScene Command Properties",
"type": "object",
"properties": {
"Mode": {
"type": "CopySceneMode"
},
"GroupIdentifierFrom": {
"type": "SGroupId"
},
"SceneIdentifierFrom": {
"type": "integer"
},
"GroupIdentifierTo": {
"type": "SGroupId"
},
"SceneIdentifierTo": {
"type": "integer"
}
},
"required": [
"Mode",
"GroupIdentifierFrom",
"SceneIdentifierFrom",
"GroupIdentifierTo",
"SceneIdentifierTo"
]
}
Example Mosquitto CLI Tool Usage
To send a Scenes/CopyScene command under the by-unid topic space:
mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/CopyScene' -m '{ "Mode": <MODE_VALUE>,"GroupIdentifierFrom": <GROUP_IDENTIFIER_FROM_VALUE>,"SceneIdentifierFrom": <SCENE_IDENTIFIER_FROM_VALUE>,"GroupIdentifierTo": <GROUP_IDENTIFIER_TO_VALUE>,"SceneIdentifierTo": <SCENE_IDENTIFIER_TO_VALUE> }'
To receive a Scenes/CopyScene generated command from a UNID/endpoint:
mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/GeneratedCommands/CopyScene'
Scenes/CopySceneResponse Command
MQTT Topic Pattern:
[PREFIX]/Scenes/Commands/CopySceneResponse
[PREFIX]/Scenes/GeneratedCommands/CopySceneResponse
MQTT Payload JSON Schema:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Scenes Cluster CopySceneResponse Command Properties",
"type": "object",
"properties": {
"Status": {
"type": "zclStatus"
},
"GroupIdentifierFrom": {
"type": "SGroupId"
},
"SceneIdentifierFrom": {
"type": "integer"
}
},
"required": [
"Status",
"GroupIdentifierFrom",
"SceneIdentifierFrom"
]
}
Example Mosquitto CLI Tool Usage
To send a Scenes/CopySceneResponse command under the by-unid topic space:
mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/CopySceneResponse' -m '{ "Status": <STATUS_VALUE>,"GroupIdentifierFrom": <GROUP_IDENTIFIER_FROM_VALUE>,"SceneIdentifierFrom": <SCENE_IDENTIFIER_FROM_VALUE> }'
To receive a Scenes/CopySceneResponse generated command from a UNID/endpoint:
mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/GeneratedCommands/CopySceneResponse'
Scenes/WriteAttributes Command
MQTT Topic Pattern:
[PREFIX]/Scenes/Commands/WriteAttributes
MQTT Payload JSON Schema:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Scenes Cluster WriteAttributes Command Properties",
"type": "object",
"properties": {
},
"required": [
"value"
]
}
Example Mosquitto CLI Tool Usage
To update all Scenes attributes under the by-unid topic space:
mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/WriteAttributes' -m '{ }'
NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.
Scenes/ForceReadAttributes Command
MQTT Topic Pattern:
[PREFIX]/Scenes/Commands/ForceReadAttributes
MQTT Payload JSON Schema:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Scenes Cluster ForceReadAttributes Command Properties",
"type": "object",
"properties": {
"value": {
"type": "array"
"items": {
"type": "string",
"enum": [
"SceneCount",
"CurrentScene",
"CurrentGroup",
"SceneValid",
"NameSupport",
"LastConfiguredBy",
"SceneTable"
]
}
}
},
"required": [
"value"
]
}
Example Mosquitto CLI Tool Usage
To force read all Scenes attributes under the by-unid topic space (by sending an empty array):
mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/ForceReadAttributes' -m '{ "value": [] }'
To force read one of the Scenes attributes under the by-unid topic space:
mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Scenes/Commands/ForceReadAttributes' -m '{ "value": ["SceneCount"] }'
1.9.4