Matter Cluster 1360 — Zone Management Cluster

Cluster Identity

Revision history

Shadow Path Format

Cluster 1360 values in the device shadow use this format:

endpoint_id / 1360 / attribute_id

Example:

{
  "1/1360/1": 1
}

Cluster 1360 Features

The FeatureMap attribute (1/1360/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

ZoneEventStoppedReasonEnum

ZoneEventTriggeredReasonEnum

ZoneSourceEnum

ZoneTypeEnum

ZoneUseEnum

This data type is derived from enum8, and is used to indicate intended Zone usage.

TwoDCartesianVertexStruct (struct)

This struct is used to encode a point on the 2 Dimensional Cartesian Plane for the TwoDCartesianZone feature.

TwoDCartesianZoneStruct (struct)

This struct is used to encode all information needed to define a TwoDCartesianZone.

ZoneInformationStruct (struct)

This struct is used to encode basic information about a Zone without containing the specifics of how the zone is defined.

ZoneTriggerControlStruct (struct)

This struct is used to encode a set of values for controlling the generation of ZoneTriggered and ZoneStopped events from the Node. Zone events can be triggered due to many underlying reasons, such as a motion sensor on the device, and this is intended to be manufacturer-specific.

Cluster 1360 Attributes

Cluster 1360 defines 7 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 — MaxUserDefinedZones

Path example:

1/1360/0

This attribute specifies the maximum number of user-defined zones that can be supported by the Node. This value is manufacturer-defined.

Example:

{
  "1/1360/0": 5
}

Attribute 1 / 0x0001 — MaxZones

Path example:

1/1360/1

This attribute specifies the maximum number of zones allowed to created. This value is the sum of the number of predefined Mfg Zones, and MaxUserDefinedZones, if supported. This value is manufacturer-defined.

Example:

{
  "1/1360/1": 1
}

Attribute 2 / 0x0002 — Zones

Path example:

1/1360/2

This attribute specifies all currently defined zones as a list of ZoneInformationStruct. Use the commands from this cluster to add, update or remove entries.

Each entry is a ZoneInformationStruct (see Data Types).

Example:

{
  "1/1360/2": []
}

Attribute 3 / 0x0003 — Triggers

Path example:

1/1360/3

This attribute specifies all currently defined triggers controlling the generation of ZoneTriggered and ZoneStopped events and is a list of ZoneTriggerControlStruct. To add an entry use CreateOrUpdateTrigger. To remove an entry use RemoveTrigger.

Each entry is a ZoneTriggerControlStruct (see Data Types).

Example:

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

Attribute 4 / 0x0004 — SensitivityMax

Path example:

1/1360/4

This attribute specifies the hardware specific value for the number of supported sensitivity levels. This value is manufacturer defined. If the PerZoneSensitivity feature is supported, the value of this attribute determines valid values for the Sensitivity field in ZoneTriggerControlStruct; if the PerZoneSensitivity feature is not supported, the value of this attribute determines valid values for the Sensitivity Attribute. Implementations require two to ten levels of sensitivity control in order to ensure that there is some user-level customization of the Trigger.

Example:

{
  "1/1360/4": 2
}

Attribute 5 / 0x0005 — Sensitivity

Path example:

1/1360/5

This attribute specifies the sensitivity of the underlying zone triggering detection mechanism if the PerZoneSensitivity features is not supported. The higher the value the more sensitive the detection. The actual meaning of the values is implementation specific.

Example:

{
  "1/1360/5": 1
}

Attribute 6 / 0x0006 — TwoDCartesianMax

Path example:

1/1360/6

This attribute specifies the maximum X and Y points that are allowed for TwoD Cartesian Zones. If this cluster is on the same endpoint as Camera AV Stream Management Cluster, these values is equal to the value of SensorWidth - 1 and SensorHeight - 1 from the VideoSensorParams attribute.

Value is a TwoDCartesianVertexStruct struct (see Data Types).

Example:

{
  "1/1360/6": {
    "x": 1,
    "y": 1
  }
}

Cluster 1360 Commands

Cluster 1360 has 5 client-to-server commands and 1 response.

AcceptedCommandList

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

endpoint_id / 1360 / 65529

{
  "1/1360/65529": [
    0,
    2,
    3,
    4,
    5
  ]
}

Bridge Command Payload Format

The bridge accepts Matter commands in this structure:

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1360,
    "command_name": "CreateTwoDCartesianZone",
    "payload": {},
    "timed_request_timeout_ms": 1000
  }
}

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

Purpose

This command must create and store a TwoD Cartesian Zone.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1360,
    "command_name": "CreateTwoDCartesianZone",
    "payload": {
      "zone": {
        "name": "example",
        "use": 0,
        "vertices": [],
        "color": "example"
      }
    }
  }
}

The device answers with CreateTwoDCartesianZoneResponse (see below).

Command: CreateTwoDCartesianZoneResponse

Purpose

This command is generated in response to a CreateTwoDCartesianZone command.

Command Identity

Response Fields

Command: UpdateTwoDCartesianZone

Purpose

The UpdateTwoDCartesianZone must update a stored TwoD Cartesian Zone.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1360,
    "command_name": "UpdateTwoDCartesianZone",
    "payload": {
      "zoneID": 0,
      "zone": {
        "name": "example",
        "use": 0,
        "vertices": [],
        "color": "example"
      }
    }
  }
}

Command: RemoveZone

Purpose

This command must remove the user-defined Zone indicated by ZoneID.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1360,
    "command_name": "RemoveZone",
    "payload": {
      "zoneID": 0
    }
  }
}

Command: CreateOrUpdateTrigger

Purpose

This command is used to create or update a Trigger for the specified motion Zone.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1360,
    "command_name": "CreateOrUpdateTrigger",
    "payload": {
      "trigger": {
        "zoneID": 0,
        "initialDuration": 1,
        "augmentationDuration": 1,
        "maxDuration": 1
      }
    }
  }
}

Command: RemoveTrigger

Purpose

This command must remove the Trigger for the provided ZoneID.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1360,
    "command_name": "RemoveTrigger",
    "payload": {
      "zoneID": 0
    }
  }
}

Cluster 1360 Events

Event 0 — ZoneTriggered

This event is generated when a Zone is first triggered.

Event 1 — ZoneStopped

This event is generated when either the TriggerDetectedDuration value is exceeded by the TimeSinceInitialTrigger value or the MaxDuration value is exceeded by the TimeSinceInitialTrigger value.

SmartphoneKey Notes

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