Matter Cluster 1030 — Occupancy Sensing Cluster

Cluster Identity

Revision history

Shadow Path Format

Cluster 1030 values in the device shadow use this format:

endpoint_id / 1030 / attribute_id

Example:

{
  "1/1030/0": 0
}

Cluster 1030 Features

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

Data Types

OccupancySensorTypeEnum

This enum is as defined in ClusterRevision 4 and its definition must NOT be extended; the feature flags provide the sensor modality (or modalities) for later cluster revisions. See Backward Compatibility section.

OccupancyBitmap (bitmap)

OccupancySensorTypeBitmap (bitmap)

This enum is as defined in ClusterRevision 4 and its definition must NOT be extended; the feature flags provide the sensor modality (or modalities) for later cluster revisions. See Backward Compatibility section.

HoldTimeLimitsStruct (struct)

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

Cluster 1030 Attributes

Cluster 1030 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 — Occupancy

Path example:

1/1030/0

Indicates the sensed (processed) status of occupancy. For compatibility reasons this is expressed as a bitmap where the status is indicated in bit 0: a value of 1 means occupied, and 0 means unoccupied, with the other bits set to 0; this can be considered equivalent to a boolean.

Bits (OccupancyBitmap):

Example:

{
  "1/1030/0": 0
}

Attribute 1 / 0x0001 — OccupancySensorType

Path example:

1/1030/1

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

Values (OccupancySensorTypeEnum):

Example:

{
  "1/1030/1": 0
}

Attribute 2 / 0x0002 — OccupancySensorTypeBitmap

Path example:

1/1030/2

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

Bits (OccupancySensorTypeBitmap):

Example:

{
  "1/1030/2": 0
}

Attribute 3 / 0x0003 — HoldTime

Path example:

1/1030/3

This attribute specifies the time delay, in seconds, before the sensor changes to its unoccupied state after the last detection of occupancy in the sensed area. This is equivalent to the legacy *OccupiedToUnoccupiedDelay attributes. Low values of HoldTime should be avoided since they could lead to many reporting messages. A value 0 for HoldTime must NOT be used.

Example:

{
  "1/1030/3": 0
}

Attribute 4 / 0x0004 — HoldTimeLimits

Path example:

1/1030/4

Indicates the server's limits, and default value, for the HoldTime attribute.

Value is a HoldTimeLimitsStruct struct (see Data Types).

Example:

{
  "1/1030/4": {
    "holdTimeMin": 1,
    "holdTimeMax": 0,
    "holdTimeDefault": 0
  }
}

Attribute 16 / 0x0010 — PIROccupiedToUnoccupiedDelay

Path example:

1/1030/16

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

Example:

{
  "1/1030/16": 1
}

Attribute 17 / 0x0011 — PIRUnoccupiedToOccupiedDelay

Path example:

1/1030/17

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

Example:

{
  "1/1030/17": 1
}

Attribute 18 / 0x0012 — PIRUnoccupiedToOccupiedThreshold

Path example:

1/1030/18

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

Example:

{
  "1/1030/18": 1
}

Attribute 32 / 0x0020 — UltrasonicOccupiedToUnoccupiedDelay

Path example:

1/1030/32

This attribute specifies the time delay, in seconds, before the Ultrasonic sensor changes to its unoccupied state after the last detection of occupancy in the sensed area.

Example:

{
  "1/1030/32": 1
}

Attribute 33 / 0x0021 — UltrasonicUnoccupiedToOccupiedDelay

Path example:

1/1030/33

This attribute specifies the time delay, in seconds, before the Ultrasonic sensor changes to its occupied state after the first detection of occupancy in the sensed area.

Example:

{
  "1/1030/33": 1
}

Attribute 34 / 0x0022 — UltrasonicUnoccupiedToOccupiedThreshold

Path example:

1/1030/34

This attribute specifies the number of occupancy detection events that must occur in the period UltrasonicUnoccupiedToOccupiedDelay, before the Ultrasonic sensor changes to its occupied state.

Example:

{
  "1/1030/34": 1
}

Attribute 48 / 0x0030 — PhysicalContactOccupiedToUnoccupiedDelay

Path example:

1/1030/48

This attribute specifies the time delay, in seconds, before the physical contact occupancy sensor changes to its unoccupied state after detecting the unoccupied event.

Example:

{
  "1/1030/48": 1
}

Attribute 49 / 0x0031 — PhysicalContactUnoccupiedToOccupiedDelay

Path example:

1/1030/49

This attribute specifies the time delay, in seconds, before the physical contact sensor changes to its occupied state after the first detection of the occupied event.

Example:

{
  "1/1030/49": 1
}

Attribute 50 / 0x0032 — PhysicalContactUnoccupiedToOccupiedThreshold

Path example:

1/1030/50

This attribute specifies the number of occupancy detection events that must occur in the period PhysicalContactUnoccupiedToOccupiedDelay, before the PhysicalContact sensor changes to its occupied state.

Example:

{
  "1/1030/50": 1
}

Cluster 1030 Commands

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

Cluster 1030 Events

Event 0 — OccupancyChanged

If this event is supported, it is generated when the Occupancy attribute changes.

SmartphoneKey Notes

• Occupancy (attribute 0) is a bitmap; bit 0 set = occupied. Aqara FP400 presence sensors additionally expose vendor clusters that are not covered here.
• Shadow paths follow endpoint/1030/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.