Cameras1362 — Camera AV Settings User Level Management

Matter Cluster 1362 — Camera AV Settings User Level Management

Matter Cluster 1362 (0x0552) Camera AV Settings User Level Management: attributes, commands, events, data types, shadow paths and bridge payload examples.

Matter Cluster 1362 — Camera AV Settings User Level Management Cluster

Matter Cluster 1362, also written as 0x0552, is the Camera AV Settings User Level Management Cluster. This cluster provides an interface into controls associated with the operation of a camera that provides pan, tilt, and zoom functions, either mechanically, or against a digital image.

Cluster Identity

FieldValue
Cluster ID decimal1362
Cluster ID hex0x0552
Cluster nameCamera AV Settings User Level Management
Cluster revision (Matter 1.6.1)1
Roleapplication
ScopeEndpoint
PICS codeAVSUM
Typical endpoint1

Revision history

RevisionChange
1Initial release

Shadow Path Format

Cluster 1362 values in the device shadow use this format:

endpoint_id / 1362 / attribute_id

Example:

{
  "1/1362/0": {
    "pan": 1,
    "tilt": 1,
    "zoom": 1
  }
}
PartMeaning
1Endpoint ID
1362Camera AV Settings User Level Management cluster
0MPTZPosition attribute

Cluster 1362 Features

The FeatureMap attribute (1/1362/65532) is a bitmap. Each bit set means the device implements that feature and the attributes and commands that depend on it.

BitCodeFeatureConformanceMeaning
0DPTZDigitalPTZODigital PTZ support
1MPANMechanicalPanOMechanical Pan support
2MTILTMechanicalTiltOMechanical Tilt support
3MZOOMMechanicalZoomOMechanical Zoom support
4MPRESETSMechanicalPresets[MPAN | MTILT | MZOOM]Mechanical saved presets support

Example: FeatureMap = 0 means no optional feature is enabled; 31 means every feature listed above is enabled.


Data Types

PhysicalMovementEnum

The PhysicalMovementEnum provides an enumeration of the possible physical movement states in which the camera could be.

ValueNameConformanceMeaning
0IdleMThe camera is idle.
1MovingMThe camera is moving to a new value of Pan, Tilt, and/or Zoom.

DPTZStruct (struct)

This type is used to indicate support for the per stream digital pan, tilt, and zoom values.

FieldNameTypeConformanceConstraintMeaning
0VideoStreamIDVideoStreamIDM——
1ViewportViewportStructM—Indicates the per stream viewport applied to this video stream.

MPTZPresetStruct (struct)

This type is used to save a preset location for mechanical pan, tilt and zoom.

FieldNameTypeConformanceConstraintMeaning
0PresetIDuint8M1 to MaxPresets—
1NamestringMmax length 32The is a string representing the name of the Preset.
2SettingsMPTZStructM—This holds the mechanical pan, tilt and zoom values.

MPTZStruct (struct)

This type is used to indicate the mechanical pan, tilt, and zoom values.

FieldNameTypeConformanceConstraintMeaning
0Panint16MPANPanMin to PanMaxIndicates the mechanical pan value in angular degrees of angle.
1Tiltint16MTILTTiltMin to TiltMaxIndicates the mechanical tilt value in angular degrees of angle.
2Zoomuint8MZOOM1 to ZoomMaxIndicates the zoom value to use.

Cluster 1362 Attributes

Cluster 1362 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 …".

IDHexAttributeTypeConformanceAccessQualitiesDefault
00x0000MPTZPositionMPTZStructMPAN | MTILT | MZOOMR (read: view)persisted—
10x0001MaxPresetsuint8MPRESETSR (read: view)——
20x0002MPTZPresetslist of MPTZPresetStructMPRESETSR (read: view)persisted—
30x0003DPTZStreamslist of DPTZStructDPTZR (read: view)persisted—
40x0004ZoomMaxuint8MZOOMR (read: view)——
50x0005TiltMinint16MTILTR (read: view)——
60x0006TiltMaxint16MTILTR (read: view)——
70x0007PanMinint16MPANR (read: view)——
80x0008PanMaxint16MPANR (read: view)——
90x0009MovementStatePhysicalMovementEnumMPAN | MTILT | MZOOMR (read: view)——

Global attributes

IDHexAttributeMeaning
655280xFFF8GeneratedCommandListResponse command IDs this server generates.
655290xFFF9AcceptedCommandListCommand IDs this server accepts.
655310xFFFBAttributeListAttribute IDs implemented.
655320xFFFCFeatureMapImplemented optional features (see above).
655330xFFFDClusterRevisionCluster revision implemented; 1 for a Matter 1.6.1 device.

Attribute Details

Attribute 0 / 0x0000 — MPTZPosition

Path example:

1/1362/0

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

PropertyValue
TypeMPTZStruct
ConformanceMPAN | MTILT | MZOOM
AccessR (read: view)
Qualitiespersisted

Value is a MPTZStruct struct (see Data Types).

Example:

{
  "1/1362/0": {
    "pan": 1,
    "tilt": 1,
    "zoom": 1
  }
}

Attribute 1 / 0x0001 — MaxPresets

Path example:

1/1362/1

This attribute indicates the maximum number of presets for the mechanical pan, tilt, zoom.

PropertyValue
Typeuint8
ConformanceMPRESETS
AccessR (read: view)

Example:

{
  "1/1362/1": 1
}

Attribute 2 / 0x0002 — MPTZPresets

Path example:

1/1362/2

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

PropertyValue
Typelist of MPTZPresetStruct
ConformanceMPRESETS
AccessR (read: view)
Qualitiespersisted
Constraintmax MaxPresets entries

Each entry is a MPTZPresetStruct (see Data Types).

Example:

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

Attribute 3 / 0x0003 — DPTZStreams

Path example:

1/1362/3

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

PropertyValue
Typelist of DPTZStruct
ConformanceDPTZ
AccessR (read: view)
Qualitiespersisted

Each entry is a DPTZStruct (see Data Types).

Example:

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

Attribute 4 / 0x0004 — ZoomMax

Path example:

1/1362/4

Indicates the maximum value for the mechanical zoom specified by the camera manufacturer that allows for increments of 1 to be noticeable. The handling of this value is implementation specific.

PropertyValue
Typeuint8
ConformanceMZOOM
AccessR (read: view)
Constraint2 to 100

Example:

{
  "1/1362/4": 2
}

Attribute 5 / 0x0005 — TiltMin

Path example:

1/1362/5

Indicates the minimum value for the mechanical tilt specified by the camera manufacturer in angular degrees.

PropertyValue
Typeint16
ConformanceMTILT
AccessR (read: view)
Constraint-180 to 0

Example:

{
  "1/1362/5": 1
}

Attribute 6 / 0x0006 — TiltMax

Path example:

1/1362/6

Indicates the maximum value for the mechanical tilt specified by the camera manufacturer in angular degrees.

PropertyValue
Typeint16
ConformanceMTILT
AccessR (read: view)
Constraint1 to 180

Example:

{
  "1/1362/6": 1
}

Attribute 7 / 0x0007 — PanMin

Path example:

1/1362/7

Indicates the minimum value for the mechanical pan specified by the camera manufacturer in angular degrees.

PropertyValue
Typeint16
ConformanceMPAN
AccessR (read: view)
Constraint-180 to 0

Example:

{
  "1/1362/7": 1
}

Attribute 8 / 0x0008 — PanMax

Path example:

1/1362/8

Indicates the maximum value for the mechanical pan specified by the camera manufacturer in angular degrees.

PropertyValue
Typeint16
ConformanceMPAN
AccessR (read: view)
Constraint1 to 180

Example:

{
  "1/1362/8": 1
}

Attribute 9 / 0x0009 — MovementState

Path example:

1/1362/9

Indicates the current movement state of the camera.

PropertyValue
TypePhysicalMovementEnum
ConformanceMPAN | MTILT | MZOOM
AccessR (read: view)

Values (PhysicalMovementEnum):

ValueNameMeaning
0IdleThe camera is idle.
1MovingThe camera is moving to a new value of Pan, Tilt, and/or Zoom.

Example:

{
  "1/1362/9": 0
}

Cluster 1362 Commands

Cluster 1362 has 7 client-to-server commands and 0 responses.

IDHexCommandDirectionConformanceResponseDescription
00x00MPTZSetPositionclient → serverMPAN | MTILT | MZOOMstatus—
10x01MPTZRelativeMoveclient → serverMPAN | MTILT | MZOOMstatus—
20x02MPTZMoveToPresetclient → serverMPRESETSstatus—
30x03MPTZSavePresetclient → serverMPRESETSstatus—
40x04MPTZRemovePresetclient → serverMPRESETSstatus—
50x05DPTZSetViewportclient → serverDPTZstatus—
60x06DPTZRelativeMoveclient → server[DPTZ]status—

AcceptedCommandList

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

endpoint_id / 1362 / 65529
{
  "1/1362/65529": [
    0,
    1,
    2,
    3,
    4,
    5,
    6
  ]
}

Before sending a Cluster 1362 command, check that the command ID exists in endpoint/1362/65529. Optional commands are only present when the matching feature is set in FeatureMap.


Bridge Command Payload Format

The bridge accepts Matter commands in this structure:

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

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

Purpose

MPTZSetPosition is a client-to-server command of the Camera AV Settings User Level Management cluster.

Command Identity

FieldValue
Command ID0
Command hex0x00
Command nameMPTZSetPosition
Directionclient → server
ConformanceMPAN | MTILT | MZOOM
Responsestatus
Access(invoke: operate)

Payload Fields

IDFieldPayload keyTypeConformanceConstraintMeaning
0Panpanint16[MPAN]PanMin to PanMax—
1Tilttiltint16[MTILT]TiltMin to TiltMax—
2Zoomzoomuint8[MZOOM]1 to ZoomMax—

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1362,
    "command_name": "MPTZSetPosition",
    "payload": {
      "pan": 1,
      "tilt": 1
    }
  }
}

Command: MPTZRelativeMove

Purpose

MPTZRelativeMove is a client-to-server command of the Camera AV Settings User Level Management cluster.

Command Identity

FieldValue
Command ID1
Command hex0x01
Command nameMPTZRelativeMove
Directionclient → server
ConformanceMPAN | MTILT | MZOOM
Responsestatus
Access(invoke: operate)

Payload Fields

IDFieldPayload keyTypeConformanceConstraintMeaning
0PanDeltapanDeltaint16[MPAN]compute to compute—
1TiltDeltatiltDeltaint16[MTILT]compute to compute—
2ZoomDeltazoomDeltaint8[MZOOM]compute to compute—

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1362,
    "command_name": "MPTZRelativeMove",
    "payload": {
      "panDelta": 1,
      "tiltDelta": 1
    }
  }
}

Command: MPTZMoveToPreset

Purpose

MPTZMoveToPreset is a client-to-server command of the Camera AV Settings User Level Management cluster.

Command Identity

FieldValue
Command ID2
Command hex0x02
Command nameMPTZMoveToPreset
Directionclient → server
ConformanceMPRESETS
Responsestatus
Access(invoke: operate)

Payload Fields

IDFieldPayload keyTypeConformanceConstraintMeaning
0PresetIDpresetIDuint8M1 to MaxPresets—

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1362,
    "command_name": "MPTZMoveToPreset",
    "payload": {
      "presetID": 1
    }
  }
}

Command: MPTZSavePreset

Purpose

MPTZSavePreset is a client-to-server command of the Camera AV Settings User Level Management cluster.

Command Identity

FieldValue
Command ID3
Command hex0x03
Command nameMPTZSavePreset
Directionclient → server
ConformanceMPRESETS
Responsestatus
Access(invoke: operate)

Payload Fields

IDFieldPayload keyTypeConformanceConstraintMeaning
0PresetIDpresetIDuint8O1 to MaxPresets—
1NamenamestringMmax length 32—

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1362,
    "command_name": "MPTZSavePreset",
    "payload": {
      "name": "example"
    }
  }
}

Command: MPTZRemovePreset

Purpose

MPTZRemovePreset is a client-to-server command of the Camera AV Settings User Level Management cluster.

Command Identity

FieldValue
Command ID4
Command hex0x04
Command nameMPTZRemovePreset
Directionclient → server
ConformanceMPRESETS
Responsestatus
Access(invoke: operate)

Payload Fields

IDFieldPayload keyTypeConformanceConstraintMeaning
0PresetIDpresetIDuint8M1 to MaxPresets—

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1362,
    "command_name": "MPTZRemovePreset",
    "payload": {
      "presetID": 1
    }
  }
}

Command: DPTZSetViewport

Purpose

DPTZSetViewport is a client-to-server command of the Camera AV Settings User Level Management cluster.

Command Identity

FieldValue
Command ID5
Command hex0x05
Command nameDPTZSetViewport
Directionclient → server
ConformanceDPTZ
Responsestatus
Access(invoke: operate)

Payload Fields

IDFieldPayload keyTypeConformanceConstraintMeaning
0VideoStreamIDvideoStreamIDVideoStreamIDM——
1ViewportviewportViewportStructM——

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1362,
    "command_name": "DPTZSetViewport",
    "payload": {
      "videoStreamID": 0,
      "viewport": 0
    }
  }
}

Command: DPTZRelativeMove

Purpose

DPTZRelativeMove is a client-to-server command of the Camera AV Settings User Level Management cluster.

Command Identity

FieldValue
Command ID6
Command hex0x06
Command nameDPTZRelativeMove
Directionclient → server
Conformance[DPTZ]
Responsestatus
Access(invoke: operate)

Payload Fields

IDFieldPayload keyTypeConformanceConstraintMeaning
0VideoStreamIDvideoStreamIDVideoStreamIDM——
1DeltaXdeltaXint16O——
2DeltaYdeltaYint16O——
3ZoomDeltazoomDeltaint8O-100 to 100—

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1362,
    "command_name": "DPTZRelativeMove",
    "payload": {
      "videoStreamID": 0
    }
  }
}

Cluster 1362 Events

Cluster 1362 defines no events.


SmartphoneKey Notes

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