Matter Cluster 1292 — Application Launcher Cluster

Cluster Identity

Revision history

Shadow Path Format

Cluster 1292 values in the device shadow use this format:

endpoint_id / 1292 / attribute_id

Example:

{
  "1/1292/0": []
}

Cluster 1292 Features

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

Data Types

StatusEnum

ApplicationEPStruct (struct)

This specifies an app along with its corresponding endpoint.

ApplicationStruct (struct)

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

Cluster 1292 Attributes

Cluster 1292 defines 2 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 — CatalogList

Path example:

1/1292/0

This attribute specifies the list of supported application catalogs, where each entry in the list is the Connectivity Standards Alliance-issued vendor ID for the catalog. The DIAL registry must use value 0x0000. It is expected that Content App Platform providers will have their own catalog vendor ID (set to their own Vendor ID) and will assign an ApplicationID to each Content App.

Example:

{
  "1/1292/0": []
}

Attribute 1 / 0x0001 — CurrentApp

Path example:

1/1292/1

This attribute specifies the current in-focus application, identified using an Application ID, catalog vendor ID and the corresponding endpoint number when the application is represented by a Content App endpoint. A null is used to indicate there is no current in-focus application.

Value is a ApplicationEPStruct struct (see Data Types).

Example:

{
  "1/1292/1": {
    "application": {
      "catalogVendorID": 1,
      "applicationID": "example"
    },
    "endpoint": 1
  }
}

Cluster 1292 Commands

Cluster 1292 has 3 client-to-server commands and 1 response.

AcceptedCommandList

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

endpoint_id / 1292 / 65529

{
  "1/1292/65529": [
    0,
    1,
    2
  ]
}

Bridge Command Payload Format

The bridge accepts Matter commands in this structure:

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

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

Purpose

On receipt, the server must launch the application with optional data. The application is either - the specified application, if the Application Platform feature is supported; - otherwise the application corresponding to the endpoint. The endpoint must launch and bring to foreground the requisite application if the application is not already launched and in foreground. The Status attribute is updated to ActiveVisibleFocus on the Application Basic cluster of the Endpoint corresponding to the launched application.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1292,
    "command_name": "LaunchApp",
    "payload": {
      "application": {
        "catalogVendorID": 1,
        "applicationID": "example"
      },
      "data": "AQID"
    }
  }
}

The device answers with LauncherResponse (see below).

Command: StopApp

Purpose

On receipt, the server must stop the application if it is running. The application is either - the specified application, if the Application Platform feature is supported; - otherwise the application corresponding to the endpoint. The Status attribute is updated to Stopped on the Application Basic cluster of the Endpoint corresponding to the stopped application. The Status attribute is updated on any other application whose Status may have changed as a result of this command.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1292,
    "command_name": "StopApp",
    "payload": {
      "application": {
        "catalogVendorID": 1,
        "applicationID": "example"
      }
    }
  }
}

The device answers with LauncherResponse (see below).

Command: HideApp

Purpose

On receipt, the server must hide the application. The application is either - the specified application, if the Application Platform feature is supported; - otherwise the application corresponding to the endpoint. The endpoint may decide to stop the application based on manufacturer specific behavior or resource constraints if any. The Status attribute is updated to ActiveHidden or Stopped, depending on the action taken, on the Application Basic cluster of the Endpoint corresponding to the application on which the action was taken.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1292,
    "command_name": "HideApp",
    "payload": {
      "application": {
        "catalogVendorID": 1,
        "applicationID": "example"
      }
    }
  }
}

The device answers with LauncherResponse (see below).

Command: LauncherResponse

Purpose

This command is generated in response to LaunchApp/StopApp/HideApp commands.

Command Identity

Response Fields

Status values (StatusEnum): 0 = Success, 1 = AppNotAvailable, 2 = SystemBusy, 3 = PendingUserApproval, 4 = Downloading, 5 = Installing

Cluster 1292 Events

Cluster 1292 defines no events.

SmartphoneKey Notes

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