Matter Cluster 1874 — Joint Fabric Datastore Cluster

Cluster Identity

Revision history

Shadow Path Format

Cluster 1874 values in the device shadow use this format:

endpoint_id / 1874 / attribute_id

Example:

{
  "0/1874/0": "AQID"
}

Data Types

DatastoreAccessControlEntryAuthModeEnum

DatastoreAccessControlEntryPrivilegeEnum

DatastoreGroupKeyMulticastPolicyEnum

DatastoreGroupKeySecurityPolicyEnum

DatastoreStateEnum

DatastoreACLEntryStruct (struct)

The DatastoreACLEntryStruct is a holder for an ACL (DatastoreAccessControlEntryStruct) on a specific Node which is managed by the Datastore. Only ACLs on a specific Node that are fabric-scoped to the Joint Fabric are managed by the Datastore.

DatastoreAccessControlEntryStruct (struct)

The DatastoreAccessControlEntryStruct represents an ACL on a specific Node (identified by the DatastoreACLEntryStruct) which is managed by the Datastore. Only ACLs on a specific Node that are fabric-scoped to the Joint Fabric are managed by the Datastore.

DatastoreAccessControlTargetStruct (struct)

DatastoreAdministratorInformationEntryStruct (struct)

DatastoreBindingTargetStruct (struct)

The DatastoreBindingTargetStruct represents a Binding on a specific Node (identified by the DatastoreEndpointBindingEntryStruct) which is managed by the Datastore. Only bindings on a specific Node that are fabric-scoped to the Joint Fabric are managed by the Datastore.

DatastoreEndpointBindingEntryStruct (struct)

DatastoreEndpointEntryStruct (struct)

The DatastoreEndpointEntryStruct represents an Endpoint on a specific Node which is managed by the Datastore. Only Nodes on the Joint Fabric are managed by the Datastore.

DatastoreEndpointGroupIDEntryStruct (struct)

DatastoreGroupInformationEntryStruct (struct)

DatastoreGroupKeySetStruct (struct)

DatastoreNodeInformationEntryStruct (struct)

DatastoreNodeKeySetEntryStruct (struct)

DatastoreStatusEntryStruct (struct)

Cluster 1874 Attributes

Cluster 1874 defines 14 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 — AnchorRootCA

Path example:

0/1874/0

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

Example:

{
  "0/1874/0": "AQID"
}

Attribute 1 / 0x0001 — AnchorNodeID

Path example:

0/1874/1

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

Example:

{
  "0/1874/1": 1
}

Attribute 2 / 0x0002 — AnchorVendorID

Path example:

0/1874/2

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

Example:

{
  "0/1874/2": 1
}

Attribute 3 / 0x0003 — FriendlyName

Path example:

0/1874/3

Friendly name for the accessing fabric.

Example:

{
  "0/1874/3": "example"
}

Attribute 4 / 0x0004 — GroupKeySetList

Path example:

0/1874/4

This indicates the list of DatastoreGroupKeySetStruct used in the Joint Fabric for the accessing fabric. This attribute contains at least one entry, the IPK, which has GroupKeySetID of 0.

Each entry is a DatastoreGroupKeySetStruct (see Data Types).

Example:

{
  "0/1874/4": []
}

Attribute 5 / 0x0005 — GroupList

Path example:

0/1874/5

This indicates the list of groups in the Joint Fabric for the accessing fabric. This list includes, at a minimum, one group with GroupCAT value set to Administrator CAT and one group with GroupCAT value set to Anchor CAT.

Each entry is a DatastoreGroupInformationEntryStruct (see Data Types).

Example:

{
  "0/1874/5": []
}

Attribute 6 / 0x0006 — NodeList

Path example:

0/1874/6

This indicates the list of nodes in the Joint Fabric for the accessing fabric.

Each entry is a DatastoreNodeInformationEntryStruct (see Data Types).

Example:

{
  "0/1874/6": []
}

Attribute 7 / 0x0007 — AdminList

Path example:

0/1874/7

This indicates the list of administrators in the Joint Fabric for the accessing fabric. Only one Administrator may serve as the Anchor Root CA and Anchor Fabric Administrator and has index value 0. All other Joint Fabric Administrators is referenced at index 1 or greater. An empty list indicates that the Joint Fabric is not yet formed.

Each entry is a DatastoreAdministratorInformationEntryStruct (see Data Types).

Example:

{
  "0/1874/7": []
}

Attribute 8 / 0x0008 — Status

Path example:

0/1874/8

This indicates the current state of the Joint Fabric Datastore Cluster for the accessing fabric. The value is one of the following states: - Committed - indicates the DataStore is ready for use. - Pending - indicates that the DataStore is not yet ready for use. - DeletePending - indicates that the DataStore is in the process of being transferred to another Joint Fabric Anchor Administrator.

Value is a DatastoreStatusEntryStruct struct (see Data Types).

Example:

{
  "0/1874/8": {
    "state": 0,
    "updateTimestamp": 0,
    "failureCode": 0
  }
}

Attribute 9 / 0x0009 — EndpointGroupIDList

Path example:

0/1874/9

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

Each entry is a DatastoreEndpointGroupIDEntryStruct (see Data Types).

Example:

{
  "0/1874/9": []
}

Attribute 10 / 0x000A — EndpointBindingList

Path example:

0/1874/10

This indicates the binding list for endpoints in the accessing fabric.

Each entry is a DatastoreEndpointBindingEntryStruct (see Data Types).

Example:

{
  "0/1874/10": []
}

Attribute 11 / 0x000B — NodeKeySetList

Path example:

0/1874/11

This indicates the KeySet entries for nodes in the accessing fabric.

Each entry is a DatastoreNodeKeySetEntryStruct (see Data Types).

Example:

{
  "0/1874/11": []
}

Attribute 12 / 0x000C — NodeACLList

Path example:

0/1874/12

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

Each entry is a DatastoreACLEntryStruct (see Data Types).

Example:

{
  "0/1874/12": []
}

Attribute 13 / 0x000D — NodeEndpointList

Path example:

0/1874/13

This indicates the Endpoint entries for nodes in the accessing fabric.

Each entry is a DatastoreEndpointEntryStruct (see Data Types).

Example:

{
  "0/1874/13": []
}

Cluster 1874 Commands

Cluster 1874 has 20 client-to-server commands and 0 responses.

AcceptedCommandList

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

endpoint_id / 1874 / 65529

{
  "0/1874/65529": [
    0,
    1,
    2,
    3,
    4,
    5,
    6,
    7,
    8,
    9,
    10,
    11,
    12,
    13,
    14,
    15,
    16,
    17,
    18,
    19
  ]
}

Bridge Command Payload Format

The bridge accepts Matter commands in this structure:

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 0,
    "cluster_id": 1874,
    "command_name": "AddKeySet",
    "payload": {},
    "timed_request_timeout_ms": 1000
  }
}

For Cluster 1874, always use "cluster_id": 1874. 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: AddKeySet

Purpose

On receipt, this must add a KeySet to the Joint Fabric Datastore Cluster of the accessing fabric.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 0,
    "cluster_id": 1874,
    "command_name": "AddKeySet",
    "payload": {
      "groupKeySet": {
        "groupKeySetID": 1,
        "groupKeySecurityPolicy": 0,
        "epochKey0": "AQID",
        "epochStartTime0": 0
      }
    }
  }
}

Command: UpdateKeySet

Purpose

On receipt, this must update a KeySet in the Joint Fabric Datastore Cluster of the accessing fabric.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 0,
    "cluster_id": 1874,
    "command_name": "UpdateKeySet",
    "payload": {
      "groupKeySet": {
        "groupKeySetID": 1,
        "groupKeySecurityPolicy": 0,
        "epochKey0": "AQID",
        "epochStartTime0": 0
      }
    }
  }
}

Command: RemoveKeySet

Purpose

On receipt, this must remove a KeySet from the Joint Fabric Datastore Cluster of the accessing fabric.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 0,
    "cluster_id": 1874,
    "command_name": "RemoveKeySet",
    "payload": {
      "groupKeySetID": 1
    }
  }
}

Command: AddGroup

Purpose

On receipt, this must add a group to the Joint Fabric Datastore Cluster of the accessing fabric.

Command Identity

Payload Fields

GroupPermission values (DatastoreAccessControlEntryPrivilegeEnum): 1 = View, 3 = Operate, 4 = Manage, 5 = Administer

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 0,
    "cluster_id": 1874,
    "command_name": "AddGroup",
    "payload": {
      "groupID": 1,
      "friendlyName": "example",
      "groupKeySetID": 1,
      "groupCAT": 1,
      "groupCATVersion": 1,
      "groupPermission": 1
    }
  }
}

Command: UpdateGroup

Purpose

On receipt, this must update a group in the Joint Fabric Datastore Cluster of the accessing fabric.

Command Identity

Payload Fields

GroupPermission values (DatastoreAccessControlEntryPrivilegeEnum): 1 = View, 3 = Operate, 4 = Manage, 5 = Administer

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 0,
    "cluster_id": 1874,
    "command_name": "UpdateGroup",
    "payload": {
      "groupID": 1,
      "friendlyName": "example",
      "groupKeySetID": 1,
      "groupCAT": 1,
      "groupCATVersion": 1,
      "groupPermission": 1
    }
  }
}

Command: RemoveGroup

Purpose

On receipt, this must remove a group from the Joint Fabric Datastore Cluster of the accessing fabric.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 0,
    "cluster_id": 1874,
    "command_name": "RemoveGroup",
    "payload": {
      "groupID": 1
    }
  }
}

Command: AddAdmin

Purpose

On receipt, this must add an admin to the Joint Fabric Datastore Cluster of the accessing fabric.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 0,
    "cluster_id": 1874,
    "command_name": "AddAdmin",
    "payload": {
      "nodeID": 1,
      "friendlyName": "example",
      "vendorID": 1,
      "icac": "AQID"
    }
  }
}

Command: UpdateAdmin

Purpose

On receipt, this must update an admin entry in the AdminList attribute.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 0,
    "cluster_id": 1874,
    "command_name": "UpdateAdmin",
    "payload": {
      "nodeID": 1
    }
  }
}

Command: RemoveAdmin

Purpose

On receipt, this must remove an admin from the Joint Fabric Datastore Cluster of the accessing fabric.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 0,
    "cluster_id": 1874,
    "command_name": "RemoveAdmin",
    "payload": {
      "nodeID": 1
    }
  }
}

Command: AddPendingNode

Purpose

On receipt, this must add a node to the Joint Fabric Datastore Cluster of the accessing fabric.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 0,
    "cluster_id": 1874,
    "command_name": "AddPendingNode",
    "payload": {
      "nodeID": 1,
      "friendlyName": "example"
    }
  }
}

Command: RefreshNode

Purpose

On receipt, this must request that Datastore information relating to a Node of the accessing fabric is refreshed.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 0,
    "cluster_id": 1874,
    "command_name": "RefreshNode",
    "payload": {
      "nodeID": 1
    }
  }
}

Command: UpdateNode

Purpose

On receipt, this must update the friendly name for a node in the Joint Fabric Datastore Cluster of the accessing fabric.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 0,
    "cluster_id": 1874,
    "command_name": "UpdateNode",
    "payload": {
      "nodeID": 1,
      "friendlyName": "example"
    }
  }
}

Command: RemoveNode

Purpose

On receipt, this must remove a node from the Joint Fabric Datastore Cluster of the accessing fabric.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 0,
    "cluster_id": 1874,
    "command_name": "RemoveNode",
    "payload": {
      "nodeID": 1
    }
  }
}

Command: UpdateEndpointForNode

Purpose

On receipt, this must update the state of an endpoint for a node in the Joint Fabric Datastore Cluster of the accessing fabric.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 0,
    "cluster_id": 1874,
    "command_name": "UpdateEndpointForNode",
    "payload": {
      "endpointID": 1,
      "nodeID": 1,
      "friendlyName": "example"
    }
  }
}

Command: AddGroupIDToEndpointForNode

Purpose

AddGroupIDToEndpointForNode is a client-to-server command of the Joint Fabric Datastore cluster.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 0,
    "cluster_id": 1874,
    "command_name": "AddGroupIDToEndpointForNode",
    "payload": {
      "nodeID": 1,
      "endpointID": 1,
      "groupID": 1
    }
  }
}

Command: RemoveGroupIDFromEndpointForNode

Purpose

RemoveGroupIDFromEndpointForNode is a client-to-server command of the Joint Fabric Datastore cluster.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 0,
    "cluster_id": 1874,
    "command_name": "RemoveGroupIDFromEndpointForNode",
    "payload": {
      "nodeID": 1,
      "endpointID": 1,
      "groupID": 1
    }
  }
}

Command: AddBindingToEndpointForNode

Purpose

On receipt, this must add a binding to an endpoint for a node in the Joint Fabric Datastore Cluster of the accessing fabric.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 0,
    "cluster_id": 1874,
    "command_name": "AddBindingToEndpointForNode",
    "payload": {
      "nodeID": 1,
      "endpointID": 1,
      "binding": {
        "node": 1,
        "group": 1,
        "endpoint": 1,
        "cluster": 1
      }
    }
  }
}

Command: RemoveBindingFromEndpointForNode

Purpose

On receipt, this must remove a binding from an endpoint for a node in the Joint Fabric Datastore Cluster of the accessing fabric.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 0,
    "cluster_id": 1874,
    "command_name": "RemoveBindingFromEndpointForNode",
    "payload": {
      "listID": 1,
      "endpointID": 1,
      "nodeID": 1
    }
  }
}

Command: AddACLToNode

Purpose

AddACLToNode is a client-to-server command of the Joint Fabric Datastore cluster.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 0,
    "cluster_id": 1874,
    "command_name": "AddACLToNode",
    "payload": {
      "nodeID": 1,
      "aclEntry": {
        "privilege": 1,
        "authMode": 1,
        "subjects": [],
        "targets": []
      }
    }
  }
}

Command: RemoveACLFromNode

Purpose

RemoveACLFromNode is a client-to-server command of the Joint Fabric Datastore cluster.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 0,
    "cluster_id": 1874,
    "command_name": "RemoveACLFromNode",
    "payload": {
      "listID": 1,
      "nodeID": 1
    }
  }
}

Cluster 1874 Events

Cluster 1874 defines no events.

SmartphoneKey Notes

• Cluster 1874 is not currently exposed by SmartphoneKey devices. This page documents the Matter 1.6.1 specification so that future devices can be interpreted without changes to the backend.
• Shadow paths follow endpoint/1874/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.