Media1293 — Application Basic

Matter Cluster 1293 — Application Basic

Matter Cluster 1293 (0x050D) Application Basic: attributes, commands, events, data types, shadow paths and bridge payload examples.

Matter Cluster 1293 — Application Basic Cluster

Matter Cluster 1293, also written as 0x050D, is the Application Basic Cluster. This cluster provides information about a Content App running on a Video Player device which is represented as an endpoint. The cluster server for this cluster should be supported on each endpoint that represents a Content App on a Video Player device. This cluster provides identification information about the Content App such as vendor and product.

Cluster Identity

FieldValue
Cluster ID decimal1293
Cluster ID hex0x050D
Cluster nameApplication Basic
Cluster revision (Matter 1.6.1)1
Roleapplication
ScopeEndpoint
PICS codeAPBSC
Typical endpoint1

Revision history

RevisionChange
1Initial revision

Shadow Path Format

Cluster 1293 values in the device shadow use this format:

endpoint_id / 1293 / attribute_id

Example:

{
  "1/1293/2": "example"
}
PartMeaning
1Endpoint ID
1293Application Basic cluster
2ApplicationName attribute

Data Types

ApplicationStatusEnum

ValueNameConformanceMeaning
0StoppedMApplication is not running.
1ActiveVisibleFocusMApplication is running, is visible to the user, and is the active target for input.
2ActiveHiddenMApplication is running but not visible to the user.
3ActiveVisibleNotFocusMApplication is running and visible, but is not the active target for input.

ApplicationStruct (struct)

This indicates a global identifier for an Application given a catalog.

FieldNameTypeConformanceConstraintMeaning
0CatalogVendorIDuint16M——
1ApplicationIDstringM——

Cluster 1293 Attributes

Cluster 1293 defines 8 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
00x0000VendorNamestringOR (read: view)—empty
10x0001VendorIDvendor-idOR (read: view)——
20x0002ApplicationNamestringMR (read: view)——
30x0003ProductIDuint16OR (read: view)——
40x0004ApplicationApplicationStructMR (read: view)——
50x0005StatusApplicationStatusEnumMR (read: view)—MS
60x0006ApplicationVersionstringMR (read: view)——
70x0007AllowedVendorListlist of vendor-idMR (read: admin)——

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 — VendorName

Path example:

1/1293/0

This attribute specifies a human readable (displayable) name of the vendor for the Content App.

PropertyValue
Typestring
ConformanceO
AccessR (read: view)
Constraintmax length 32
Defaultempty

Example:

{
  "1/1293/0": "example"
}

Attribute 1 / 0x0001 — VendorID

Path example:

1/1293/1

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

PropertyValue
Typevendor-id
ConformanceO
AccessR (read: view)

Example:

{
  "1/1293/1": 1
}

Attribute 2 / 0x0002 — ApplicationName

Path example:

1/1293/2

This attribute specifies a human readable (displayable) name of the Content App assigned by the vendor. For example, "NPR On Demand".

PropertyValue
Typestring
ConformanceM
AccessR (read: view)
Constraintmax length 256

Example:

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

Attribute 3 / 0x0003 — ProductID

Path example:

1/1293/3

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

PropertyValue
Typeuint16
ConformanceO
AccessR (read: view)

Example:

{
  "1/1293/3": 1
}

Attribute 4 / 0x0004 — Application

Path example:

1/1293/4

This attribute specifies a Content App which consists of an Application ID using a specified catalog.

PropertyValue
TypeApplicationStruct
ConformanceM
AccessR (read: view)
Constraintdesc

Value is a ApplicationStruct struct (see Data Types).

Example:

{
  "1/1293/4": {
    "catalogVendorID": 1,
    "applicationID": "example"
  }
}

Attribute 5 / 0x0005 — Status

Path example:

1/1293/5

This attribute specifies the current running status of the application.

PropertyValue
TypeApplicationStatusEnum
ConformanceM
AccessR (read: view)
Constraintdesc
DefaultMS

Values (ApplicationStatusEnum):

ValueNameMeaning
0StoppedApplication is not running.
1ActiveVisibleFocusApplication is running, is visible to the user, and is the active target for input.
2ActiveHiddenApplication is running but not visible to the user.
3ActiveVisibleNotFocusApplication is running and visible, but is not the active target for input.

Example:

{
  "1/1293/5": 0
}

Attribute 6 / 0x0006 — ApplicationVersion

Path example:

1/1293/6

This attribute specifies a human readable (displayable) version of the Content App assigned by the vendor.

PropertyValue
Typestring
ConformanceM
AccessR (read: view)
Constraintmax length 32

Example:

{
  "1/1293/6": "example"
}

Attribute 7 / 0x0007 — AllowedVendorList

Path example:

1/1293/7

This attribute is a list of vendor IDs. Each entry is a vendor-id.

PropertyValue
Typelist of vendor-id
ConformanceM
AccessR (read: admin)

Example:

{
  "1/1293/7": []
}

Cluster 1293 Commands

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

Cluster 1293 Events

Cluster 1293 defines no events.


SmartphoneKey Notes

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