Matter Cluster 60 — Administrator Commissioning Cluster

Cluster Identity

Revision history

Shadow Path Format

Cluster 60 values in the device shadow use this format:

endpoint_id / 60 / attribute_id

Example:

{
  "0/60/0": 0
}

Cluster 60 Features

The FeatureMap attribute (0/60/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

CommissioningWindowStatusEnum

StatusCodeEnum

Cluster 60 Attributes

Cluster 60 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 — WindowStatus

Path example:

0/60/0

Indicates whether a new Commissioning window has been opened by an Administrator, using either the OpenCommissioningWindow command or the OpenBasicCommissioningWindow command. This attribute must revert to WindowNotOpen upon expiry of a commissioning window. An initial commissioning window is not opened using either the OpenCommissioningWindow command or the OpenBasicCommissioningWindow command, and therefore this attribute is set to WindowNotOpen on initial commissioning.

Values (CommissioningWindowStatusEnum):

Example:

{
  "0/60/0": 0
}

Attribute 1 / 0x0001 — AdminFabricIndex

Path example:

0/60/1

When the WindowStatus attribute is not set to WindowNotOpen, this attribute indicates the FabricIndex associated with the Fabric scoping of the Administrator that opened the window. This may be used to cross-reference in the Fabrics attribute of the Operational Credentials cluster. If, during an open commissioning window, the fabric for the Administrator that opened the window is removed, then this attribute is set to null. When the WindowStatus attribute is set to WindowNotOpen, this attribute is set to null.

Example:

{
  "0/60/1": 1
}

Attribute 2 / 0x0002 — AdminVendorId

Path example:

0/60/2

When the WindowStatus attribute is not set to WindowNotOpen, this attribute indicates the Vendor ID associated with the Fabric scoping of the Administrator that opened the window. This field must match the VendorID field of the Fabrics attribute list entry associated with the Administrator having opened the window, at the time of window opening. If the fabric for the Administrator that opened the window is removed from the node while the commissioning window is still open, this attribute must NOT be updated. When the WindowStatus attribute is set to WindowNotOpen, this attribute is set to null.

Example:

{
  "0/60/2": 1
}

Cluster 60 Commands

Cluster 60 has 3 client-to-server commands and 0 responses.

AcceptedCommandList

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

endpoint_id / 60 / 65529

{
  "0/60/65529": [
    0,
    1,
    2
  ]
}

Bridge Command Payload Format

The bridge accepts Matter commands in this structure:

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

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

Purpose

This command is used by a current Administrator to instruct a Node to go into commissioning mode. The Enhanced Commissioning Method specifies a window of time during which an already commissioned Node accepts PASE sessions. The current Administrator specifies a timeout value for the duration of the OpenCommissioningWindow command. When the OpenCommissioningWindow command expires or commissioning completes, the Node must remove the Passcode by deleting the PAKE passcode verifier as well as stop publishing the DNS-SD record corresponding to this command.

Command Identity

Payload Fields

Bridge Command Example

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

This is a timed command: the bridge must send it inside a timed interaction, so timed_request_timeout_ms is required.

Command: OpenBasicCommissioningWindow

Purpose

This command may be used by a current Administrator to instruct a Node to go into commissioning mode, if the node supports the Basic Commissioning Method. The Basic Commissioning Method specifies a window of time during which an already commissioned Node accepts PASE sessions. The current Administrator specifies a timeout value for the duration of the OpenBasicCommissioningWindow command. If a commissioning window is already currently open, this command must fail with a cluster specific status code of Busy.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 0,
    "cluster_id": 60,
    "command_name": "OpenBasicCommissioningWindow",
    "payload": {
      "commissioningTimeout": 0
    },
    "timed_request_timeout_ms": 1000
  }
}

This is a timed command: the bridge must send it inside a timed interaction, so timed_request_timeout_ms is required.

Command: RevokeCommissioning

Purpose

This is an idempotent command.

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": 60,
    "command_name": "RevokeCommissioning",
    "payload": {},
    "timed_request_timeout_ms": 1000
  }
}

This is a timed command: the bridge must send it inside a timed interaction, so timed_request_timeout_ms is required.

Cluster 60 Events

Cluster 60 defines no events.

SmartphoneKey Notes

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