Matter Cluster 1875 — Joint Fabric Administrator Cluster

Cluster Identity

Revision history

Shadow Path Format

Cluster 1875 values in the device shadow use this format:

endpoint_id / 1875 / attribute_id

Example:

{
  "0/1875/0": 1
}

Data Types

ICACCSRResponseStatusCodeEnum

ICACResponseStatusEnum

This enumeration is used by the AddICAC command to convey the outcome of this cluster's operations.

TransferAnchorResponseStatusEnum

This enumeration is used by the TransferAnchorResponse command to convey the detailed outcome of this cluster's TransferAnchorRequest command.

Cluster 1875 Attributes

Cluster 1875 defines 1 attribute 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 — AdministratorFabricIndex

Path example:

0/1875/0

The AdministratorFabricIndex attribute indicates the FabricIndex from the Endpoint 0's Operational Cluster Fabrics attribute (i.e. the Fabric Table) which is associated with the JointFabric. This field has the value of null if there is no fabric associated with the JointFabric.

Example:

{
  "0/1875/0": 1
}

Cluster 1875 Commands

Cluster 1875 has 6 client-to-server commands and 3 responses.

AcceptedCommandList

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

endpoint_id / 1875 / 65529

{
  "0/1875/65529": [
    0,
    2,
    4,
    5,
    7,
    8
  ]
}

Bridge Command Payload Format

The bridge accepts Matter commands in this structure:

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

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

Purpose

ICACCSRRequest is a client-to-server command of the Joint Fabric Administrator cluster.

Command Identity

Payload Fields

This command has no payload fields.

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 0,
    "cluster_id": 1875,
    "command_name": "ICACCSRRequest",
    "payload": {}
  }
}

The device answers with ICACCSRResponse (see below).

Command: ICACCSRResponse

Purpose

ICACCSRResponse is a server response of the Joint Fabric Administrator cluster.

Command Identity

Response Fields

StatusCode values (ICACCSRResponseStatusCodeEnum): 0 = OK, 1 = Busy, 2 = PAKEParameterError, 3 = WindowNotOpen, 4 = VIDNotVerified, 5 = InvalidAdministratorFabricIndex

Command: AddICAC

Purpose

AddICAC is a client-to-server command of the Joint Fabric Administrator cluster.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 0,
    "cluster_id": 1875,
    "command_name": "AddICAC",
    "payload": {
      "icacValue": "AQID"
    }
  }
}

The device answers with ICACResponse (see below).

Command: ICACResponse

Purpose

ICACResponse is a server response of the Joint Fabric Administrator cluster.

Command Identity

Response Fields

StatusCode values (ICACResponseStatusEnum): 0 = OK, 1 = InvalidPublicKey, 2 = InvalidICAC

Command: OpenJointCommissioningWindow

Purpose

This is an alias onto the OpenCommissioningWindow command within the Joint Fabric Administrator Cluster. Refer to the OpenCommissioningWindow command for a description of the command behavior and parameters. This command must fail with a InvalidAdministratorFabricIndex status code sent back to the initiator if the AdministratorFabricIndex attribute has the value of null. The parameters for OpenJointCommissioningWindow command are as follows:

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 0,
    "cluster_id": 1875,
    "command_name": "OpenJointCommissioningWindow",
    "payload": {
      "commissioningTimeout": 0,
      "pakePasscodeVerifier": "AQID",
      "discriminator": 1,
      "iterations": 1000,
      "salt": "AQID"
    }
  }
}

Command: TransferAnchorRequest

Purpose

This command is sent by a candidate Joint Fabric Anchor Administrator to the current Joint Fabric Anchor Administrator to request transfer of the Anchor Fabric.

Command Identity

Payload Fields

This command has no payload fields.

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 0,
    "cluster_id": 1875,
    "command_name": "TransferAnchorRequest",
    "payload": {}
  }
}

The device answers with TransferAnchorResponse (see below).

Command: TransferAnchorResponse

Purpose

This command is generated in response to the Transfer Anchor Request command.

Command Identity

Response Fields

StatusCode values (TransferAnchorResponseStatusEnum): 0 = OK, 1 = TransferAnchorStatusDatastoreBusy, 2 = TransferAnchorStatusNoUserConsent

Command: TransferAnchorComplete

Purpose

This command indicates the completion of the transfer of the Anchor Fabric to another Joint Fabric Ecosystem Administrator.

Command Identity

Payload Fields

This command has no payload fields.

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 0,
    "cluster_id": 1875,
    "command_name": "TransferAnchorComplete",
    "payload": {}
  }
}

Command: AnnounceJointFabricAdministrator

Purpose

This command is used for communicating to client the endpoint that holds the Joint Fabric Administrator Cluster. This field contains the unique identifier for the endpoint that holds the Joint Fabric Administrator Cluster.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 0,
    "cluster_id": 1875,
    "command_name": "AnnounceJointFabricAdministrator",
    "payload": {
      "endpointID": 1
    }
  }
}

Cluster 1875 Events

Cluster 1875 defines no events.

SmartphoneKey Notes

• Cluster 1875 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/1875/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.