ScenesManagement

Attributes

class st.matter.generated.zap_clusters.ScenesManagement.server.attributes.SceneTableSize
ID: number

0x0001 the ID of this attribute

NAME: str

“SceneTableSize” the name of this attribute

data_type: st.matter.data_types.Uint16

the data type of this attribute

new_value(...)

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

This is also usable with the SceneTableSize(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Uint16

Return type:

st.matter.data_types.Uint16

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:
Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: SceneTableSize => true => mandatory

Sets up a Subscribe Interaction

Parameters:

  • device (any)

  • endpoint_id (number or nil)

Return type:

any

build_test_report_data(device, endpoint_id, value, status)

Builds an SceneTableSize 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.generated.zap_clusters.ScenesManagement.server.attributes.FabricSceneInfo
ID: number

0x0002 the ID of this attribute

NAME: str

“FabricSceneInfo” the name of this attribute

data_type: st.matter.data_types.Array

the data type of this attribute

augment_type(data_type_obj)

Add additional functionality to the base type object

Parameters:

data_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 FabricSceneInfo(…) 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:
Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: FabricSceneInfo => true => mandatory

Sets up a Subscribe Interaction

Parameters:

  • device (any)

  • endpoint_id (number or nil)

Return type:

any

build_test_report_data(device, endpoint_id, value, status)

Builds an FabricSceneInfo 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.generated.zap_clusters.ScenesManagement.server.attributes.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(data_type_obj)

Add additional functionality to the base type object

Parameters:

data_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:
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

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.generated.zap_clusters.ScenesManagement.server.attributes.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(data_type_obj)

Add additional functionality to the base type object

Parameters:

data_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:
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

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.generated.zap_clusters.ScenesManagement.client.commands.AddSceneResponse: st.matter.data_types.Structure
ID: number

0x0000 the ID of this command

NAME: str

“AddSceneResponse” the name of this command

status: st.matter.data_types.Uint8
groupid: st.matter.data_types.Uint16
sceneid: st.matter.data_types.Uint8
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, groupid, sceneid)

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

Parameters:
Returns:

of type COMMAND_RESPONSE

Return type:

st.matter.st.matter.interaction_model.InteractionResponse

init()

Initialize the AddSceneResponse command

Return type:

nil

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

class st.matter.generated.zap_clusters.ScenesManagement.client.commands.ViewSceneResponse: st.matter.data_types.Structure
ID: number

0x0001 the ID of this command

NAME: str

“ViewSceneResponse” the name of this command

status: st.matter.data_types.Uint8
groupid: st.matter.data_types.Uint16
sceneid: st.matter.data_types.Uint8
transition_time: st.matter.data_types.Uint32
scene_name: st.matter.data_types.UTF8String1
extension_field_set_structs: st.matter.data_types.Array
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, groupid, sceneid, transition_time, scene_name, extension_field_set_structs)

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

Parameters:
Returns:

of type COMMAND_RESPONSE

Return type:

st.matter.st.matter.interaction_model.InteractionResponse

init()

Initialize the ViewSceneResponse command

Return type:

nil

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

class st.matter.generated.zap_clusters.ScenesManagement.client.commands.RemoveSceneResponse: st.matter.data_types.Structure
ID: number

0x0002 the ID of this command

NAME: str

“RemoveSceneResponse” the name of this command

status: st.matter.data_types.Uint8
groupid: st.matter.data_types.Uint16
sceneid: st.matter.data_types.Uint8
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, groupid, sceneid)

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

Parameters:
Returns:

of type COMMAND_RESPONSE

Return type:

st.matter.st.matter.interaction_model.InteractionResponse

init()

Initialize the RemoveSceneResponse command

Return type:

nil

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

class st.matter.generated.zap_clusters.ScenesManagement.client.commands.RemoveAllScenesResponse: st.matter.data_types.Structure
ID: number

0x0003 the ID of this command

NAME: str

“RemoveAllScenesResponse” the name of this command

status: st.matter.data_types.Uint8
groupid: st.matter.data_types.Uint16
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, groupid)

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

Parameters:
Returns:

of type COMMAND_RESPONSE

Return type:

st.matter.st.matter.interaction_model.InteractionResponse

init()

Initialize the RemoveAllScenesResponse command

Return type:

nil

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

class st.matter.generated.zap_clusters.ScenesManagement.client.commands.StoreSceneResponse: st.matter.data_types.Structure
ID: number

0x0004 the ID of this command

NAME: str

“StoreSceneResponse” the name of this command

status: st.matter.data_types.Uint8
groupid: st.matter.data_types.Uint16
sceneid: st.matter.data_types.Uint8
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, groupid, sceneid)

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

Parameters:
Returns:

of type COMMAND_RESPONSE

Return type:

st.matter.st.matter.interaction_model.InteractionResponse

init()

Initialize the StoreSceneResponse command

Return type:

nil

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

class st.matter.generated.zap_clusters.ScenesManagement.client.commands.GetSceneMembershipResponse: st.matter.data_types.Structure
ID: number

0x0006 the ID of this command

NAME: str

“GetSceneMembershipResponse” the name of this command

status: st.matter.data_types.Uint8
capacity: st.matter.data_types.Uint8
groupid: st.matter.data_types.Uint16
scene_list: st.matter.data_types.Array
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, capacity, groupid, scene_list)

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

Parameters:
Returns:

of type COMMAND_RESPONSE

Return type:

st.matter.st.matter.interaction_model.InteractionResponse

init()

Initialize the GetSceneMembershipResponse command

Return type:

nil

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

class st.matter.generated.zap_clusters.ScenesManagement.client.commands.CopySceneResponse: st.matter.data_types.Structure
ID: number

0x0040 the ID of this command

NAME: str

“CopySceneResponse” the name of this command

status: st.matter.data_types.Uint8
group_identifier_from: st.matter.data_types.Uint16
scene_identifier_from: st.matter.data_types.Uint8
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, group_identifier_from, scene_identifier_from)

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

Parameters:
Returns:

of type COMMAND_RESPONSE

Return type:

st.matter.st.matter.interaction_model.InteractionResponse

init()

Initialize the CopySceneResponse command

Return type:

nil

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

Server Commands

class st.matter.generated.zap_clusters.ScenesManagement.server.commands.AddScene: st.matter.data_types.Structure
ID: number

0x0000 the ID of this command

NAME: str

“AddScene” the name of this command

groupid: st.matter.data_types.Uint16
sceneid: st.matter.data_types.Uint8
transition_time: st.matter.data_types.Uint32
scene_name: st.matter.data_types.UTF8String1
extension_field_set_structs: st.matter.data_types.Array
init(device, groupid, sceneid, transition_time, scene_name, extension_field_set_structs)

Refer to AddSceneResponse:build_test_command_response for

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

Parameters:
Returns:

of type INVOKE

Return type:

st.matter.interaction_model.InteractionRequest

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.generated.zap_clusters.ScenesManagement.server.commands.ViewScene: st.matter.data_types.Structure
ID: number

0x0001 the ID of this command

NAME: str

“ViewScene” the name of this command

groupid: st.matter.data_types.Uint16
sceneid: st.matter.data_types.Uint8
init(device, groupid, sceneid)

Refer to ViewSceneResponse:build_test_command_response for

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

Parameters:
Returns:

of type INVOKE

Return type:

st.matter.interaction_model.InteractionRequest

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.generated.zap_clusters.ScenesManagement.server.commands.RemoveScene: st.matter.data_types.Structure
ID: number

0x0002 the ID of this command

NAME: str

“RemoveScene” the name of this command

groupid: st.matter.data_types.Uint16
sceneid: st.matter.data_types.Uint8
init(device, groupid, sceneid)

Refer to RemoveSceneResponse:build_test_command_response for

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

Parameters:
Returns:

of type INVOKE

Return type:

st.matter.interaction_model.InteractionRequest

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.generated.zap_clusters.ScenesManagement.server.commands.RemoveAllScenes: st.matter.data_types.Structure
ID: number

0x0003 the ID of this command

NAME: str

“RemoveAllScenes” the name of this command

groupid: st.matter.data_types.Uint16
init(device, groupid)

Refer to RemoveAllScenesResponse:build_test_command_response for

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

Parameters:
Returns:

of type INVOKE

Return type:

st.matter.interaction_model.InteractionRequest

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.generated.zap_clusters.ScenesManagement.server.commands.StoreScene: st.matter.data_types.Structure
ID: number

0x0004 the ID of this command

NAME: str

“StoreScene” the name of this command

groupid: st.matter.data_types.Uint16
sceneid: st.matter.data_types.Uint8
init(device, groupid, sceneid)

Refer to StoreSceneResponse:build_test_command_response for

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

Parameters:
Returns:

of type INVOKE

Return type:

st.matter.interaction_model.InteractionRequest

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.generated.zap_clusters.ScenesManagement.server.commands.RecallScene: st.matter.data_types.Structure
ID: number

0x0005 the ID of this command

NAME: str

“RecallScene” the name of this command

groupid: st.matter.data_types.Uint16
sceneid: st.matter.data_types.Uint8
transition_time: st.matter.data_types.Uint32
build_test_command_response(device, endpoint_id, status)

Builds an RecallScene 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 (str) – Interaction status associated with the path

Returns:

of type COMMAND_RESPONSE

Return type:

st.matter.st.matter.interaction_model.InteractionResponse

init(device, groupid, sceneid, transition_time)

Initialize the RecallScene command

Parameters:
Returns:

of type INVOKE

Return type:

st.matter.interaction_model.InteractionRequest

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.generated.zap_clusters.ScenesManagement.server.commands.GetSceneMembership: st.matter.data_types.Structure
ID: number

0x0006 the ID of this command

NAME: str

“GetSceneMembership” the name of this command

groupid: st.matter.data_types.Uint16
init(device, groupid)

Refer to GetSceneMembershipResponse:build_test_command_response for

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

Parameters:
Returns:

of type INVOKE

Return type:

st.matter.interaction_model.InteractionRequest

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.generated.zap_clusters.ScenesManagement.server.commands.CopyScene: st.matter.data_types.Structure
ID: number

0x0040 the ID of this command

NAME: str

“CopyScene” the name of this command

mode: st.matter.generated.zap_clusters.ScenesManagement.types.CopyModeBitmap
group_identifier_from: st.matter.data_types.Uint16
scene_identifier_from: st.matter.data_types.Uint8
group_identifier_to: st.matter.data_types.Uint16
scene_identifier_to: st.matter.data_types.Uint8
init(device, mode, group_identifier_from, scene_identifier_from, group_identifier_to, scene_identifier_to)

Refer to CopySceneResponse:build_test_command_response for

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

Parameters:
Returns:

of type INVOKE

Return type:

st.matter.interaction_model.InteractionRequest

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.generated.zap_clusters.ScenesManagement.types.CopyModeBitmap
COPY_ALL_SCENES: number

1

is_copy_all_scenes_set()
Returns:

True if the value of COPY_ALL_SCENES is non-zero

Return type:

boolean

set_copy_all_scenes()

Set the value of the bit in the COPY_ALL_SCENES field to 1

unset_copy_all_scenes()

Set the value of the bits in the COPY_ALL_SCENES field to 0

class st.matter.generated.zap_clusters.ScenesManagement.types.Feature
SCENE_NAMES: number

1

is_scene_names_set()
Returns:

True if the value of SCENE_NAMES is non-zero

Return type:

boolean

set_scene_names()

Set the value of the bit in the SCENE_NAMES field to 1

unset_scene_names()

Set the value of the bits in the SCENE_NAMES field to 0

Struct types

class st.matter.generated.zap_clusters.ScenesManagement.types.AttributeValuePairStruct: st.matter.data_types.Structure
attribute_id: st.matter.data_types.Uint32
value_unsigned8: st.matter.data_types.Uint8
value_signed8: st.matter.data_types.Int8
value_unsigned16: st.matter.data_types.Uint16
value_signed16: st.matter.data_types.Int16
value_unsigned32: st.matter.data_types.Uint32
value_signed32: st.matter.data_types.Int32
value_unsigned64: st.matter.data_types.Uint64
value_signed64: st.matter.data_types.Int64
class st.matter.generated.zap_clusters.ScenesManagement.types.ExtensionFieldSetStruct: st.matter.data_types.Structure
cluster_id: st.matter.data_types.Uint32
attribute_value_list: st.matter.data_types.Array
class st.matter.generated.zap_clusters.ScenesManagement.types.SceneInfoStruct: st.matter.data_types.Structure
scene_count: st.matter.data_types.Uint8
current_scene: st.matter.data_types.Uint8
current_group: st.matter.data_types.Uint16
scene_valid: st.matter.data_types.Boolean
remaining_capacity: st.matter.data_types.Uint8
fabric_index: st.matter.data_types.Uint8