Matter Cluster 70 — ICD Management Cluster

Cluster Identity

Revision history

Shadow Path Format

Cluster 70 values in the device shadow use this format:

endpoint_id / 70 / attribute_id

Example:

{
  "0/70/0": 1
}

Cluster 70 Features

The FeatureMap attribute (0/70/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; 15 means every feature listed above is enabled.

Data Types

ClientTypeEnum

OperatingModeEnum

UserActiveModeTriggerBitmap (bitmap)

See the UserActiveModeTriggerHint table for requirements associated to each bit.

MonitoringRegistrationStruct (struct) — fabric-scoped

Cluster 70 Attributes

Cluster 70 defines 10 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 — IdleModeDuration

Path example:

0/70/0

Indicates the maximum interval in seconds the server can stay in idle mode. The IdleModeDuration must NOT be smaller than the ActiveModeDuration.

Example:

{
  "0/70/0": 1
}

Attribute 1 / 0x0001 — ActiveModeDuration

Path example:

0/70/1

Indicates the minimum interval in milliseconds the server typically will stay in active mode after initial transition out of idle mode. The ActiveModeDuration does not include the ActiveModeThreshold.

Example:

{
  "0/70/1": 1
}

Attribute 2 / 0x0002 — ActiveModeThreshold

Path example:

0/70/2

Indicates the minimum amount of time in milliseconds the server typically will stay active after network activity when in active mode.

Example:

{
  "0/70/2": 1
}

Attribute 3 / 0x0003 — RegisteredClients

Path example:

0/70/3

This attribute contains all clients registered to receive notification if their subscription is lost. The maximum number of entries that can be in the list is ClientsSupportedPerFabric for each fabric supported on the server, as indicated by the value of the SupportedFabrics attribute in the Operational Credentials cluster.

Each entry is a MonitoringRegistrationStruct (see Data Types).

Example:

{
  "0/70/3": []
}

Attribute 4 / 0x0004 — ICDCounter

Path example:

0/70/4

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

Example:

{
  "0/70/4": 1
}

Attribute 5 / 0x0005 — ClientsSupportedPerFabric

Path example:

0/70/5

Indicates the maximum number of entries that the server is able to store for each fabric in the RegisteredClients attribute.

Example:

{
  "0/70/5": 1
}

Attribute 6 / 0x0006 — UserActiveModeTriggerHint

Path example:

0/70/6

Indicates which user action(s) will trigger the ICD to switch to Active mode. If the attribute indicates support for a trigger that is dependent on the UserActiveModeTriggerInstruction in the UserActiveModeTriggerHint table, the UserActiveModeTriggerInstruction attribute is implemented and provides the required information, unless specified otherwise in the requirement column of the UserActiveModeTriggerHint table. ActuateSensorLightsBlink, ResetButtonLightsBlink and SetupButtonLightsBlink (i.e. bits 7, 9 and 14) have a dependency on the UserActiveModeTriggerInstruction attribute but do not require the attribute to be present.

Bits (UserActiveModeTriggerBitmap):

Example:

{
  "0/70/6": 0
}

Attribute 7 / 0x0007 — UserActiveModeTriggerInstruction

Path example:

0/70/7

The meaning of the attribute is dependent upon the UserActiveModeTriggerHint attribute value, and the conformance is in indicated in the "dependency" column in UserActiveModeTriggerHint table. The UserActiveModeTriggerInstruction attribute may give additional information on how to transition the device to Active Mode. If the attribute is present, the value is encoded as a valid UTF-8 string with a maximum length of 128 bytes.

Example:

{
  "0/70/7": "example"
}

Attribute 8 / 0x0008 — OperatingMode

Path example:

0/70/8

Indicates the operating mode of the ICD as specified in the OperatingModeEnum. - If the ICD is operating as a LIT ICD, OperatingMode is LIT. - If the ICD is operating as a SIT ICD, OperatingMode is SIT.

Values (OperatingModeEnum):

Example:

{
  "0/70/8": 0
}

Attribute 9 / 0x0009 — MaximumCheckInBackoff

Path example:

0/70/9

Indicates the maximum time in seconds between two Check-In messages when back-off is active. The MaximumCheckInBackoff must NOT be smaller than the IdleModeDuration. If the MaximumCheckInBackoff is equal to the IdleModeDuration, it means the ICD does not back-off.

Example:

{
  "0/70/9": 1
}

Cluster 70 Commands

Cluster 70 has 3 client-to-server commands and 2 responses.

AcceptedCommandList

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

endpoint_id / 70 / 65529

{
  "0/70/65529": [
    0,
    2,
    3
  ]
}

Bridge Command Payload Format

The bridge accepts Matter commands in this structure:

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

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

Purpose

This command allows a client to register itself with the ICD to be notified when the device is available for communication.

Command Identity

Payload Fields

ClientType values (ClientTypeEnum): 0 = Permanent, 1 = Ephemeral

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 0,
    "cluster_id": 70,
    "command_name": "RegisterClient",
    "payload": {
      "checkInNodeID": 1,
      "monitoredSubject": 1,
      "key": "AQID",
      "clientType": 0
    }
  }
}

The device answers with RegisterClientResponse (see below).

Command: RegisterClientResponse

Purpose

This command is sent by the ICD Management Cluster server in response to a successful RegisterClient command.

Command Identity

Response Fields

Command: UnregisterClient

Purpose

This command allows a client to unregister itself with the ICD. Example: a client that is leaving the network (e.g. running on a phone which is leaving the home) can (and should) remove its subscriptions and send this UnregisterClient command before leaving to prevent the burden on the ICD of an absent client.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 0,
    "cluster_id": 70,
    "command_name": "UnregisterClient",
    "payload": {
      "checkInNodeID": 1
    }
  }
}

Command: StayActiveRequest

Purpose

This command allows a client to request that the server stays in active mode for at least a given time duration (in milliseconds) from when this command is received. This StayActiveDuration may be longer than the ActiveModeThreshold value and would, typically, be used by the client to request the server to stay active and responsive for this period to allow a sequence of message exchanges during that period. The client may slightly overestimate the duration it wants the ICD to be active for, in order to account for network delays.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 0,
    "cluster_id": 70,
    "command_name": "StayActiveRequest",
    "payload": {
      "stayActiveDuration": 1
    }
  }
}

The device answers with StayActiveResponse (see below).

Command: StayActiveResponse

Purpose

This message is sent by the ICD in response to the StayActiveRequest command and contains the computed duration (in milliseconds) that the ICD intends to stay active for.

Command Identity

Response Fields

Cluster 70 Events

Cluster 70 defines no events.

SmartphoneKey Notes

• Sleepy devices (locks, sensors) are ICDs: expect 0/70/* on them. Long Idle Time (LIT) devices only wake on their own schedule; live attribute reads time out by design.
• Shadow paths follow endpoint/70/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.