Matter Cluster 98 — Scenes Management Cluster

Cluster Identity

Revision history

Shadow Path Format

Cluster 98 values in the device shadow use this format:

endpoint_id / 98 / attribute_id

Example:

{
  "1/98/1": 1
}

Cluster 98 Features

The FeatureMap attribute (1/98/65532) is a bitmap. Each bit set means the device implements that feature and the attributes and commands that depend on it.

Example: FeatureMap = 0 means no optional feature is enabled; 1 means every feature listed above is enabled.

Data Types

CopyModeBitmap (bitmap)

AttributeValuePairStruct (struct)

This data type indicates a combination of an identifier and the value of an attribute.

ExtensionFieldSetStruct (struct)

This data type indicates for a given cluster a set of attributes and their values.

SceneInfoStruct (struct) — fabric-scoped

Cluster 98 Attributes

Cluster 98 defines 3 attributes plus the global attributes. Conformance: M mandatory, O optional, a feature code means "mandatory when that feature is present", square brackets mean "optional when …".

Global attributes

Attribute Details

Attribute 0 / 0x0000 — DoNotUse

Path example:

1/98/0

No condensed specification text is available for DoNotUse; use the type, conformance and constraint below together with the cluster description above.

Example:

{
  "1/98/0": 0
}

Attribute 1 / 0x0001 — SceneTableSize

Path example:

1/98/1

Indicates the number of entries in the Scene Table on this endpoint. This is the total across all fabrics; note that a single fabric cannot use all those entries. The minimum size of this table, (i.e., the minimum number of scenes to support across all fabrics per endpoint) is 16, unless a device type in which this cluster is used, defines a larger value in the device type definition.

Example:

{
  "1/98/1": 1
}

Attribute 2 / 0x0002 — FabricSceneInfo

Path example:

1/98/2

Indicates a list of fabric scoped information about scenes on this endpoint. The number of list entries for this attribute must NOT exceed the number of supported fabrics by the device.

Each entry is a SceneInfoStruct (see Data Types).

Example:

{
  "1/98/2": []
}

Cluster 98 Commands

Cluster 98 has 8 client-to-server commands and 7 responses.

AcceptedCommandList

The AcceptedCommandList attribute lists the command IDs the endpoint actually implements:

endpoint_id / 98 / 65529

{
  "1/98/65529": [
    0,
    1,
    2,
    3,
    4,
    5,
    6,
    64
  ]
}

Bridge Command Payload Format

The bridge accepts Matter commands in this structure:

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 98,
    "command_name": "AddScene",
    "payload": {},
    "timed_request_timeout_ms": 1000
  }
}

For Cluster 98, always use "cluster_id": 98. Payload keys are the command field names in lowerCamelCase. Octet-string fields are base64-encoded. timed_request_timeout_ms is required for timed commands and ignored otherwise.

Command: AddScene

Purpose

This command is used to add a new scene. It is not mandatory for an extension field set to be included in the command for every cluster on that endpoint that has a defined extension field set. Extension field sets may be omitted, including the case of no extension field sets at all.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 98,
    "command_name": "AddScene",
    "payload": {
      "groupID": 1,
      "sceneID": 1,
      "transitionTime": 0,
      "sceneName": "example",
      "extensionFieldSetStructs": []
    }
  }
}

The device answers with AddSceneResponse (see below).

Command: AddSceneResponse

Purpose

This command is sent in response to the AddScene command.

Command Identity

Response Fields

Command: ViewScene

Purpose

This command returns the details for the requested scene.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 98,
    "command_name": "ViewScene",
    "payload": {
      "groupID": 1,
      "sceneID": 1
    }
  }
}

The device answers with ViewSceneResponse (see below).

Command: ViewSceneResponse

Purpose

This command is sent in response to the ViewScene command.

Command Identity

Response Fields

Command: RemoveScene

Purpose

This command removes the specified scene.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 98,
    "command_name": "RemoveScene",
    "payload": {
      "groupID": 1,
      "sceneID": 1
    }
  }
}

The device answers with RemoveSceneResponse (see below).

Command: RemoveSceneResponse

Purpose

This command is sent in response to the RemoveScene command.

Command Identity

Response Fields

Command: RemoveAllScenes

Purpose

This command removes all scenes for the specified GroupID.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 98,
    "command_name": "RemoveAllScenes",
    "payload": {
      "groupID": 1
    }
  }
}

The device answers with RemoveAllScenesResponse (see below).

Command: RemoveAllScenesResponse

Purpose

This command is sent in response to the RemoveAllScenes command.

Command Identity

Response Fields

Command: StoreScene

Purpose

This command will create a new entry for the requested scene.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 98,
    "command_name": "StoreScene",
    "payload": {
      "groupID": 1,
      "sceneID": 1
    }
  }
}

The device answers with StoreSceneResponse (see below).

Command: StoreSceneResponse

Purpose

This command is sent in response to the StoreScene command.

Command Identity

Response Fields

Command: RecallScene

Purpose

This command will cause the specified scene to be recalled.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 98,
    "command_name": "RecallScene",
    "payload": {
      "groupID": 1,
      "sceneID": 1
    }
  }
}

Command: GetSceneMembership

Purpose

This command can be used to get the used scene identifiers within a certain group, for the endpoint that implements this cluster.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 98,
    "command_name": "GetSceneMembership",
    "payload": {
      "groupID": 1
    }
  }
}

The device answers with GetSceneMembershipResponse (see below).

Command: GetSceneMembershipResponse

Purpose

This command is sent in response to the GetSceneMembership command.

Command Identity

Response Fields

Command: CopyScene

Purpose

This command allows a client to efficiently copy scenes from one group/scene identifier pair to another group/scene identifier pair.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 98,
    "command_name": "CopyScene",
    "payload": {
      "mode": 0,
      "groupIdentifierFrom": 1,
      "sceneIdentifierFrom": 1,
      "groupIdentifierTo": 1,
      "sceneIdentifierTo": 1
    }
  }
}

The device answers with CopySceneResponse (see below).

Command: CopySceneResponse

Purpose

This command is sent in response to the CopyScene command.

Command Identity

Response Fields

Cluster 98 Events

Cluster 98 defines no events.

SmartphoneKey Notes

• Cluster 98 is present on SmartphoneKey devices or hubs today. See Matter Bridge Clusters — Detailed Reference and Matter Device Attributes & Commands for the values the bridge actually reports.
• Shadow paths follow endpoint/98/attribute; attribute values that the device reports as unreadable are written as n/a.
• Attribute IDs, command IDs and enum values on this page come from the CSA Matter 1.6.1 data model; descriptions are condensed from the specification text.