Matter Cluster 1295 — Content Control Cluster

Cluster Identity

Revision history

Shadow Path Format

Cluster 1295 values in the device shadow use this format:

endpoint_id / 1295 / attribute_id

Example:

{
  "1/1295/0": true
}

Cluster 1295 Features

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

Data Types

StatusCodeEnum

DayOfWeekBitmap (bitmap)

AppInfoStruct (struct)

BlockChannelStruct (struct)

RatingNameStruct (struct)

TimePeriodStruct (struct)

TimeWindowStruct (struct)

Cluster 1295 Attributes

Cluster 1295 defines 11 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 — Enabled

Path example:

1/1295/0

Indicates whether the Content Control feature implemented on a media device is turned off (FALSE) or turned on (TRUE).

Example:

{
  "1/1295/0": true
}

Attribute 1 / 0x0001 — OnDemandRatings

Path example:

1/1295/1

This attribute provides the collection of ratings that are currently valid for this media device. The items should honor the metadata of the on-demand content (e.g. Movie) rating system for one country or region where the media device has been provisioned. For example, for the MPAA system, RatingName may be one value out of "G", "PG", "PG-13", "R", "NC-17".

Each entry is a RatingNameStruct (see Data Types).

Example:

{
  "1/1295/1": []
}

Attribute 2 / 0x0002 — OnDemandRatingThreshold

Path example:

1/1295/2

Indicates a threshold rating as a content filter which is compared with the rating for on-demand content. For example, if the on-demand content rating is greater than or equal to OnDemandRatingThreshold, for a rating system that is ordered from lower viewer age to higher viewer age, then on-demand content is not appropriate for the User and the Node must prevent the playback of content. This attribute is set to one of the values present in the OnDemandRatings attribute. When this attribute changes, the device should make the user aware of any limits of this feature.

Example:

{
  "1/1295/2": "example"
}

Attribute 3 / 0x0003 — ScheduledContentRatings

Path example:

1/1295/3

Indicates a collection of ratings which ScheduledContentRatingThreshold can be set to. The items should honor metadata of the scheduled content rating system for the country or region where the media device has been provisioned. The media device has a way to determine which scheduled content rating system applies and then populate this attribute. For example, this can be done by examining the Location attribute in Basic Information cluster, and then determining which rating system applies.

Each entry is a RatingNameStruct (see Data Types).

Example:

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

Attribute 4 / 0x0004 — ScheduledContentRatingThreshold

Path example:

1/1295/4

Indicates a threshold rating as a content filter which is used to compare with the rating for scheduled content. For example, if the scheduled content rating is greater than or equal to ScheduledContentRatingThreshold for a rating system that is ordered from lower viewer age to higher viewer age, then the scheduled content is not appropriate for the User and is blocked. This attribute is set to one of the values present in the ScheduledContentRatings attribute. When this attribute changes, the device should make the user aware of any limits of this feature.

Example:

{
  "1/1295/4": "example"
}

Attribute 5 / 0x0005 — ScreenDailyTime

Path example:

1/1295/5

Indicates the amount of time (in seconds) which the User is allowed to spend watching TV within one day when the Content Control feature is activated.

Example:

{
  "1/1295/5": 0
}

Attribute 6 / 0x0006 — RemainingScreenTime

Path example:

1/1295/6

Indicates the remaining screen time (in seconds) which the User is allowed to spend watching TV for the current day when the Content Control feature is activated. When this value equals 0, the media device must terminate the playback of content. This attribute is updated when the AddBonusTime command is received and processed successfully (with the correct PIN).

Example:

{
  "1/1295/6": 0
}

Attribute 7 / 0x0007 — BlockUnrated

Path example:

1/1295/7

Indicates whether the playback of unrated content is allowed when the Content Control feature is activated. If this attribute equals FALSE, then playback of unrated content is permitted. Otherwise, the media device must prevent the playback of unrated content. When this attribute changes, the device should make the user aware of any limits of this feature.

Example:

{
  "1/1295/7": true
}

Attribute 8 / 0x0008 — BlockChannelList

Path example:

1/1295/8

Indicates a set of channels that is blocked when the Content Control feature is activated.

Each entry is a BlockChannelStruct (see Data Types).

Example:

{
  "1/1295/8": []
}

Attribute 9 / 0x0009 — BlockApplicationList

Path example:

1/1295/9

Indicates a set of applications that is blocked when the Content Control feature is activated.

Each entry is a AppInfoStruct (see Data Types).

Example:

{
  "1/1295/9": []
}

Attribute 10 / 0x000A — BlockContentTimeWindow

Path example:

1/1295/10

Indicates a set of periods during which the playback of content on media device is blocked when the Content Control feature is activated. The media device must reject any request to play content during one period of this attribute. If it is entering any one period of this attribute, the media device must block content which is playing and generate an event EnteringBlockContentTimeWindow. There must NOT be multiple entries in this attribute list for the same day of week.

Each entry is a TimeWindowStruct (see Data Types).

Example:

{
  "1/1295/10": []
}

Cluster 1295 Commands

Cluster 1295 has 16 client-to-server commands and 1 response.

AcceptedCommandList

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

endpoint_id / 1295 / 65529

{
  "1/1295/65529": [
    0,
    1,
    3,
    4,
    5,
    6,
    7,
    8,
    9,
    10,
    11,
    12,
    13,
    14,
    15,
    16
  ]
}

Bridge Command Payload Format

The bridge accepts Matter commands in this structure:

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

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

Purpose

UpdatePIN is a client-to-server command of the Content Control cluster.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1295,
    "command_name": "UpdatePIN",
    "payload": {
      "oldPIN": "example",
      "newPIN": "example"
    },
    "timed_request_timeout_ms": 1000
  }
}

This is a timed command: the bridge must send it inside a timed interaction, so timed_request_timeout_ms is required.

Command: ResetPIN

Purpose

ResetPIN is a client-to-server command of the Content Control cluster.

Command Identity

Payload Fields

This command has no payload fields.

Bridge Command Example

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

This is a timed command: the bridge must send it inside a timed interaction, so timed_request_timeout_ms is required.

The device answers with ResetPINResponse (see below).

Command: ResetPINResponse

Purpose

ResetPINResponse is a server response of the Content Control cluster.

Command Identity

Response Fields

Command: Enable

Purpose

The purpose of this command is to turn on the Content Control feature on a media device. Upon receipt of the Enable command, the media device must set the Enabled attribute to TRUE.

Command Identity

Payload Fields

This command has no payload fields.

Bridge Command Example

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

This is a timed command: the bridge must send it inside a timed interaction, so timed_request_timeout_ms is required.

Command: Disable

Purpose

The purpose of this command is to turn off the Content Control feature on a media device. On receipt of the Disable command, the media device must set the Enabled attribute to FALSE.

Command Identity

Payload Fields

This command has no payload fields.

Bridge Command Example

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

This is a timed command: the bridge must send it inside a timed interaction, so timed_request_timeout_ms is required.

Command: AddBonusTime

Purpose

The purpose of this command is to add the extra screen time for the user. If a client with Operate privilege invokes this command, the media device must check whether the PINCode passed in the command matches the current PINCode value. If these match, then the RemainingScreenTime attribute is increased by the specified BonusTime value. If the PINs do not match, then a response with InvalidPINCode error status is returned, and no changes is made to RemainingScreenTime.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1295,
    "command_name": "AddBonusTime",
    "payload": {
      "bonusTime": 0
    }
  }
}

Command: SetScreenDailyTime

Purpose

The purpose of this command is to set the ScreenDailyTime attribute. Upon receipt of the SetScreenDailyTime command, the media device must set the ScreenDailyTime attribute to the ScreenTime value.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1295,
    "command_name": "SetScreenDailyTime",
    "payload": {
      "screenTime": 0
    }
  }
}

Command: BlockUnratedContent

Purpose

The purpose of this command is to specify whether programs with no Content rating must be blocked by this media device. Upon receipt of the BlockUnratedContent command, the media device must set the BlockUnrated attribute to TRUE.

Command Identity

Payload Fields

This command has no payload fields.

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1295,
    "command_name": "BlockUnratedContent",
    "payload": {}
  }
}

Command: UnblockUnratedContent

Purpose

The purpose of this command is to specify whether programs with no Content rating must be blocked by this media device. Upon receipt of the UnblockUnratedContent command, the media device must set the BlockUnrated attribute to FALSE.

Command Identity

Payload Fields

This command has no payload fields.

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1295,
    "command_name": "UnblockUnratedContent",
    "payload": {}
  }
}

Command: SetOnDemandRatingThreshold

Purpose

The purpose of this command is to set the OnDemandRatingThreshold attribute. Upon receipt of the SetOnDemandRatingThreshold command, the media device must check if the Rating field is one of values present in the OnDemandRatings attribute. If not, then a response with InvalidRating error status is returned.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1295,
    "command_name": "SetOnDemandRatingThreshold",
    "payload": {
      "rating": "example"
    }
  }
}

Command: SetScheduledContentRatingThreshold

Purpose

The purpose of this command is to set ScheduledContentRatingThreshold attribute. Upon receipt of the SetScheduledContentRatingThreshold command, the media device must check if the Rating field is one of values present in the ScheduledContentRatings attribute. If not, then a response with InvalidRating error status is returned.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1295,
    "command_name": "SetScheduledContentRatingThreshold",
    "payload": {
      "rating": "example"
    }
  }
}

Command: AddBlockChannels

Purpose

The purpose of this command is to set BlockChannelList attribute. Upon receipt of the AddBlockChannels command, the media device must check if the channels passed in this command are valid. If the channel is invalid, then a response with InvalidChannel error Status is returned. If there is at least one channel in Channels field which is not in the BlockChannelList attribute, the media device must process the request by adding these new channels into the BlockChannelList attribute and return a successful Status Response.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1295,
    "command_name": "AddBlockChannels",
    "payload": {
      "channels": []
    }
  }
}

Command: RemoveBlockChannels

Purpose

The purpose of this command is to remove channels from the BlockChannelList attribute. Upon receipt of the RemoveBlockChannels command, the media device must check if the channels indicated by ChannelIndexes passed in this command are present in BlockChannelList attribute. If one or more channels indicated by ChannelIndexes passed in this command field are not present in the BlockChannelList attribute, then a response with ChannelNotExist error Status is returned.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1295,
    "command_name": "RemoveBlockChannels",
    "payload": {
      "channelIndexes": []
    }
  }
}

Command: AddBlockApplications

Purpose

The purpose of this command is to set applications to the BlockApplicationList attribute. Upon receipt of the AddBlockApplications command, the media device must check if the Applications passed in this command are installed. If there is an application in Applications field which is not identified by media device, then a response with UnidentifiableApplication error Status may be returned. If there is one or more applications which are not present in BlockApplicationList attribute, the media device must process the request by adding the new application to the BlockApplicationList attribute and return a successful Status Response.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1295,
    "command_name": "AddBlockApplications",
    "payload": {
      "applications": []
    }
  }
}

Command: RemoveBlockApplications

Purpose

The purpose of this command is to remove applications from the BlockApplicationList attribute. Upon receipt of the RemoveBlockApplications command, the media device must check if the applications passed in this command present in the BlockApplicationList attribute. If one or more applications in Applications field which are not present in the BlockApplicationList attribute, then a response with ApplicationNotExist error Status is returned.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1295,
    "command_name": "RemoveBlockApplications",
    "payload": {
      "applications": []
    }
  }
}

Command: SetBlockContentTimeWindow

Purpose

The purpose of this command is to set the BlockContentTimeWindow attribute. Upon receipt of the SetBlockContentTimeWindow command, the media device must check if the TimeWindowIndex field passed in this command is null. If the TimeWindowIndex field is null, the media device must check if there is an entry in the BlockContentTimeWindow attribute which matches with the TimePeriod and DayOfWeek fields passed in this command. If Yes, then a response with TimeWindowAlreadyExist error status is returned.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1295,
    "command_name": "SetBlockContentTimeWindow",
    "payload": {
      "timeWindow": {
        "timeWindowIndex": 0,
        "dayOfWeek": 0,
        "timePeriod": []
      }
    }
  }
}

Command: RemoveBlockContentTimeWindow

Purpose

The purpose of this command is to remove the selected time windows from the BlockContentTimeWindow attribute. Upon receipt of the RemoveBlockContentTimeWindow command, the media device must check if the time window index passed in this command presents in the BlockContentTimeWindow attribute. If one or more time window indexes passed in this command are not present in BlockContentTimeWindow attribute, then a response with TimeWindowNotExist error status is returned.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1295,
    "command_name": "RemoveBlockContentTimeWindow",
    "payload": {
      "timeWindowIndexes": []
    }
  }
}

Cluster 1295 Events

Event 0 — RemainingScreenTimeExpired

This event is generated when the RemainingScreenTime equals 0.

This event has no fields.

Event 1 — EnteringBlockContentTimeWindow

This event is generated when entering a period of blocked content as configured in the BlockContentTimeWindow attribute.

This event has no fields.

SmartphoneKey Notes

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