ApplicationLauncher

Attributes

class st.matter.clusters.ApplicationLauncher.CatalogList

ID: number: 0x0000 the ID of this attribute

NAME: str: “CatalogList” the name of this attribute

data_type: st.matter.data_types.Array: the data type of this attribute

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters: base_type_obj (st.matter.data_types.Array) – the base data type object to add functionality to

new_value(...)

Create a Array object of this attribute with any additional features provided for the attribute

This is also usable with the CatalogList(…) syntax

Parameters: vararg (vararg) – the values needed to construct a Array
Return type: st.matter.data_types.Array

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: CatalogList => true => suggested

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an CatalogList test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.ApplicationLauncher.CurrentApp

ID: number: 0x0001 the ID of this attribute

NAME: str: “CurrentApp” the name of this attribute

data_type: st.matter.generated.zap_clusters.ApplicationLauncher.types.ApplicationEPStruct: the data type of this attribute

new_value(...)

Create a ApplicationEPStruct object of this attribute with any additional features provided for the attribute

This is also usable with the CurrentApp(…) syntax

Parameters: vararg (vararg) – the values needed to construct a ApplicationEPStruct
Return type: st.matter.generated.zap_clusters.ApplicationLauncher.types.ApplicationEPStruct

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: CurrentApp => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an CurrentApp test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.ApplicationLauncher.AcceptedCommandList

ID: number: 0xFFF9 the ID of this attribute

NAME: str: “AcceptedCommandList” the name of this attribute

data_type: st.matter.data_types.Array: the data type of this attribute

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters: base_type_obj (st.matter.data_types.Array) – the base data type object to add functionality to

new_value(...)

Create a Array object of this attribute with any additional features provided for the attribute

This is also usable with the AcceptedCommandList(…) syntax

Parameters: vararg (vararg) – the values needed to construct a Array
Return type: st.matter.data_types.Array

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: AcceptedCommandList => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an AcceptedCommandList test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.ApplicationLauncher.EventList

ID: number: 0xFFFA the ID of this attribute

NAME: str: “EventList” the name of this attribute

data_type: st.matter.data_types.Array: the data type of this attribute

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters: base_type_obj (st.matter.data_types.Array) – the base data type object to add functionality to

new_value(...)

Create a Array object of this attribute with any additional features provided for the attribute

This is also usable with the EventList(…) syntax

Parameters: vararg (vararg) – the values needed to construct a Array
Return type: st.matter.data_types.Array

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: EventList => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an EventList test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.ApplicationLauncher.AttributeList

ID: number: 0xFFFB the ID of this attribute

NAME: str: “AttributeList” the name of this attribute

data_type: st.matter.data_types.Array: the data type of this attribute

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters: base_type_obj (st.matter.data_types.Array) – the base data type object to add functionality to

new_value(...)

Create a Array object of this attribute with any additional features provided for the attribute

This is also usable with the AttributeList(…) syntax

Parameters: vararg (vararg) – the values needed to construct a Array
Return type: st.matter.data_types.Array

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: AttributeList => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an AttributeList test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

Client Commands

class st.matter.clusters.ApplicationLauncher.LauncherResponse

ID: number: 0x0003 the ID of this command

NAME: str: “LauncherResponse” the name of this command

status: st.matter.generated.zap_clusters.ApplicationLauncher.types.StatusEnum

data: st.matter.data_types.OctetString1

augment_type(base_type_obj)

Add field names to each command field

Parameters: base_type_obj (st.matter.data_types.Structure) –

build_test_command_response(device, endpoint_id, status, data)

Builds an LauncherResponse test command reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message to
endpoint_id (number or nil) –
status (st.matter.generated.zap_clusters.ApplicationLauncher.types.StatusEnum) –
data (st.matter.data_types.OctetString1) –

Returns

of type COMMAND_RESPONSE

Return type

st.matter.st.matter.interaction_model.InteractionResponse

init()

Initialize the LauncherResponse command

Return type: nil

set_parent_cluster(cluster)

Parameters: cluster (any) –

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

Server Commands

class st.matter.clusters.ApplicationLauncher.LaunchApp

ID: number: 0x0000 the ID of this command

NAME: str: “LaunchApp” the name of this command

application: st.matter.generated.zap_clusters.ApplicationLauncher.types.ApplicationStruct

data: st.matter.data_types.OctetString1

init(self, device, application, data)

Refer to LauncherResponse:build_test_command_response for

building a test command reponse for the driver integration testing framework Initialize the LaunchApp command

Parameters

self (LaunchApp) – the template class for this command
device (st.matter.Device) – the device to build this message to
application (st.matter.generated.zap_clusters.ApplicationLauncher.types.ApplicationStruct) –
data (st.matter.data_types.OctetString1) –

Returns

of type INVOKE

Return type

st.matter.interaction_model.InteractionRequest

set_parent_cluster(cluster)

Parameters: cluster (any) –

augment_type(base_type_obj)

Add field names to each command field

Parameters: base_type_obj (st.matter.data_types.Structure) –

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.ApplicationLauncher.StopApp

ID: number: 0x0001 the ID of this command

NAME: str: “StopApp” the name of this command

application: st.matter.generated.zap_clusters.ApplicationLauncher.types.ApplicationStruct

init(self, device, application)

Refer to LauncherResponse:build_test_command_response for

building a test command reponse for the driver integration testing framework Initialize the StopApp command

Parameters

self (StopApp) – the template class for this command
device (st.matter.Device) – the device to build this message to
application (st.matter.generated.zap_clusters.ApplicationLauncher.types.ApplicationStruct) –

Returns

of type INVOKE

Return type

st.matter.interaction_model.InteractionRequest

set_parent_cluster(cluster)

Parameters: cluster (any) –

augment_type(base_type_obj)

Add field names to each command field

Parameters: base_type_obj (st.matter.data_types.Structure) –

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.ApplicationLauncher.HideApp

ID: number: 0x0002 the ID of this command

NAME: str: “HideApp” the name of this command

application: st.matter.generated.zap_clusters.ApplicationLauncher.types.ApplicationStruct

init(self, device, application)

Refer to LauncherResponse:build_test_command_response for

building a test command reponse for the driver integration testing framework Initialize the HideApp command

Parameters

self (HideApp) – the template class for this command
device (st.matter.Device) – the device to build this message to
application (st.matter.generated.zap_clusters.ApplicationLauncher.types.ApplicationStruct) –

Returns

of type INVOKE

Return type

st.matter.interaction_model.InteractionRequest

set_parent_cluster(cluster)

Parameters: cluster (any) –

augment_type(base_type_obj)

Add field names to each command field

Parameters: base_type_obj (st.matter.data_types.Structure) –

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

Bitmap types

class st.matter.clusters.ApplicationLauncher.types.Feature

APPLICATION_PLATFORM: number: 1

is_application_platform_set()

Returns: True if the value of APPLICATION_PLATFORM is non-zero
Return type: boolean

set_application_platform(): Set the value of the bit in the APPLICATION_PLATFORM field to 1

unset_application_platform(): Set the value of the bits in the APPLICATION_PLATFORM field to 0

Enum types

class st.matter.clusters.ApplicationLauncher.types.StatusEnum: st.matter.data_types.Uint8 

byte_length: number: 1

SUCCESS: number: 0

APP_NOT_AVAILABLE: number: 1

SYSTEM_BUSY: number: 2

Struct types

class st.matter.clusters.ApplicationLauncher.types.ApplicationStruct: st.matter.data_types.Structure 

catalog_vendor_id: st.matter.data_types.Uint16

application_id: st.matter.data_types.UTF8String1

class st.matter.clusters.ApplicationLauncher.types.ApplicationEPStruct: st.matter.data_types.Structure 

application: st.matter.generated.zap_clusters.ApplicationLauncher.types.ApplicationStruct

endpoint: st.matter.data_types.Uint16