Matter Cluster 1073 — Ambient Context Sensing Cluster

Cluster Identity

Revision history

Shadow Path Format

Cluster 1073 values in the device shadow use this format:

endpoint_id / 1073 / attribute_id

Example:

{
  "1/1073/0": true
}

Cluster 1073 Features

The FeatureMap attribute (1/1073/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; 31 means every feature listed above is enabled.

Data Types

AmbientContextTypeStruct (struct)

This structure provides information on the server's supported values for the Ambient Context type attribute.

HoldTimeLimitsStruct (struct)

This structure provides information on the server's supported values for the HoldTime attribute.

ObjectCountConfigStruct (struct)

This structure provides information on the server's supported values for the ObjectCountConfig attribute.

PredictedActivityStruct (struct)

This data structure provides information on future predicted activities.

Cluster 1073 Attributes

Cluster 1073 defines 12 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 — HumanActivityDetected

Path example:

1/1073/0

Indicates the human activity detection in Boolean data. The detected human activity type can be found from the AmbientContextType attribute.

Example:

{
  "1/1073/0": true
}

Attribute 1 / 0x0001 — ObjectIdentified

Path example:

1/1073/1

Indicates the occurrence of object identification in Boolean data. The identified object information can be found from the AmbientContextType attribute.

Example:

{
  "1/1073/1": true
}

Attribute 2 / 0x0002 — AudioContextDetected

Path example:

1/1073/2

Indicates the ambient audio context detection in Boolean data. The detected audio context type can be found from the AmbientContextType attribute.

Example:

{
  "1/1073/2": true
}

Attribute 3 / 0x0003 — AmbientContextType

Path example:

1/1073/3

Indicates the details for the currently observed and detected ambient context. This attribute supports multiple simultaneous ambient context detections. The attribute expression rule is defined in the MultipleAmbientSensingDetection section. The total number of simultaneous ambient context detections is constrained by the SimultaneousDetectionLimit attribute.

Each entry is a AmbientContextTypeStruct (see Data Types).

Example:

{
  "1/1073/3": []
}

Attribute 4 / 0x0004 — AmbientContextTypeSupported

Path example:

1/1073/4

Indicates the list of ambient context detection types supported by the server. Each supported ambient context detection type element must correspond to a feature type supported in the AmbientContextFeatureMap and is represented by a SemanticTagStruct from one of the following StandardNamespaces: Identified Human Activity Namespace, Identified Object Namespace, or Identified Sound Namespace.

Example:

{
  "1/1073/4": []
}

Attribute 5 / 0x0005 — ObjectCountThresholdReached

Path example:

1/1073/5

Indicates whether the number count of the specified object is greater or equal to the threshold specified by the ObjectCountThreshold. The object being counted is limited to one identified object type and is identified by the tag ID from the Identified Object namespace, as presented in the AmbientContextTypeSupported attribute.

Example:

{
  "1/1073/5": true
}

Attribute 6 / 0x0006 — ObjectCountConfig

Path example:

1/1073/6

This attribute specifies the configuration parameters required to support an object counting feature, including the identification of the object to be detected and counted, as well as the counting threshold value for the ObjectCountThresholdReached detection.

Value is a ObjectCountConfigStruct struct (see Data Types).

Example:

{
  "1/1073/6": {
    "countingObject": 0,
    "objectCountThreshold": 1
  }
}

Attribute 7 / 0x0007 — ObjectCount

Path example:

1/1073/7

This optional attribute indicates the number of objects detected in the area covered by the sensor. ObjectCount is exposed only when the ObjectCountThresholdReached attribute is true.

Example:

{
  "1/1073/7": 1
}

Attribute 8 / 0x0008 — SimultaneousDetectionLimit

Path example:

1/1073/8

Indicates the maximum number of simultaneous multiple ambient context detections supported by the server. If an additional detection event causes the total number of simultaneous detection events to exceed a SimultaneousDetectionLimit, the oldest ambient sensing detection event is removed and the latest detection is added. The consecutive recurrence of the same ambient context sensing event within the HoldTime duration must not increase the total number of simultaneous detection events. If simultaneous detection is not supported, then the value is set to 1.

Example:

{
  "1/1073/8": 1
}

Attribute 9 / 0x0009 — HoldTime

Path example:

1/1073/9

Indicates the time duration (in seconds) of True state before transitioning its sensing detection state from True to False after the last detection. Low HoldTime value should be avoided to prevent excessive data reporting for subscription. This attribute is equivalent to the HoldTime attribute of the OccupancySensing cluster. For further information, refer to the HoldTime attribute description of the Occupancy Sensing Cluster.

Example:

{
  "1/1073/9": 0
}

Attribute 10 / 0x000A — HoldTimeLimits

Path example:

1/1073/10

Indicates the server's limits, and default value, for the HoldTime attribute. This is equivalent to the HoldTimeLimits attribute of the Occupancy Sensing Cluster attribute. For further information, refer to the HoldTimeLimits attribute description of the Occupancy Sensing Cluster.

Value is a HoldTimeLimitsStruct struct (see Data Types).

Example:

{
  "1/1073/10": {
    "holdTimeMin": 1,
    "holdTimeMax": 0,
    "holdTimeDefault": 0
  }
}

Attribute 11 / 0x000B — PredictedActivity

Path example:

1/1073/11

Indicates the server's prediction of upcoming changes to the monitored area's ambient context. The value of the StartTimestamp field on each PredictedActivityStruct in this list other than the first is greater than the value of the EndTimestamp field on the previous PredictedActivityStruct in this list.

Each entry is a PredictedActivityStruct (see Data Types).

Example:

{
  "1/1073/11": []
}

Cluster 1073 Commands

Cluster 1073 defines no commands. It is read (and, for writable attributes, written) through attribute access only.

Cluster 1073 Events

Event 0 — AmbientContextDetectStarted

This event is generated when a new ambient context detection is added to the AmbientContextType attribute.

Event 1 — AmbientContextDetectEnded

This event is generated when the ambient context previously reported by an AmbientContextDetectStarted event is removed from the AmbientContextType attribute. This termination event doesn't necessarily reflect or coincide with the end of the actual event progression. For example, while both AmbientContextDetectStarted and AmbientContextDetectEnded events are used to inform the "sleeping" event occurrence, the AmbientContextDetectEnded event doesn't necessarily indicate the actual end of "sleeping" action.

SmartphoneKey Notes

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