Groups

Attributes

class st.matter.generated.zap_clusters.Groups.server.attributes.NameSupport
ID: number

0x0000 the ID of this attribute

NAME: str

“NameSupport” the name of this attribute

data_type: st.matter.generated.zap_clusters.Groups.types.NameSupportBitmap

the data type of this attribute

new_value(...)

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

This is also usable with the NameSupport(…) syntax

Parameters:

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

Return type:

st.matter.generated.zap_clusters.Groups.types.NameSupportBitmap

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: NameSupport => 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 NameSupport 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.Groups.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.Groups.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.Groups.client.commands.AddGroupResponse: st.matter.data_types.Structure
ID: number

0x0000 the ID of this command

NAME: str

“AddGroupResponse” 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 AddGroupResponse 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 AddGroupResponse command

Return type:

nil

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

class st.matter.generated.zap_clusters.Groups.client.commands.ViewGroupResponse: st.matter.data_types.Structure
ID: number

0x0001 the ID of this command

NAME: str

“ViewGroupResponse” the name of this command

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

Builds an ViewGroupResponse 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 ViewGroupResponse command

Return type:

nil

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

class st.matter.generated.zap_clusters.Groups.client.commands.GetGroupMembershipResponse: st.matter.data_types.Structure
ID: number

0x0002 the ID of this command

NAME: str

“GetGroupMembershipResponse” the name of this command

capacity: st.matter.data_types.Uint8
group_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, capacity, group_list)

Builds an GetGroupMembershipResponse 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 GetGroupMembershipResponse command

Return type:

nil

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

class st.matter.generated.zap_clusters.Groups.client.commands.RemoveGroupResponse: st.matter.data_types.Structure
ID: number

0x0003 the ID of this command

NAME: str

“RemoveGroupResponse” 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 RemoveGroupResponse 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 RemoveGroupResponse command

Return type:

nil

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

Server Commands

class st.matter.generated.zap_clusters.Groups.server.commands.AddGroup: st.matter.data_types.Structure
ID: number

0x0000 the ID of this command

NAME: str

“AddGroup” the name of this command

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

Refer to AddGroupResponse:build_test_command_response for

building a test command reponse for the driver integration testing framework Initialize the AddGroup 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.Groups.server.commands.ViewGroup: st.matter.data_types.Structure
ID: number

0x0001 the ID of this command

NAME: str

“ViewGroup” the name of this command

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

Refer to ViewGroupResponse:build_test_command_response for

building a test command reponse for the driver integration testing framework Initialize the ViewGroup 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.Groups.server.commands.GetGroupMembership: st.matter.data_types.Structure
ID: number

0x0002 the ID of this command

NAME: str

“GetGroupMembership” the name of this command

group_list: st.matter.data_types.Array
init(device, group_list)

Refer to GetGroupMembershipResponse:build_test_command_response for

building a test command reponse for the driver integration testing framework Initialize the GetGroupMembership 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.Groups.server.commands.RemoveGroup: st.matter.data_types.Structure
ID: number

0x0003 the ID of this command

NAME: str

“RemoveGroup” the name of this command

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

Refer to RemoveGroupResponse:build_test_command_response for

building a test command reponse for the driver integration testing framework Initialize the RemoveGroup 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.Groups.server.commands.RemoveAllGroups: st.matter.data_types.Structure
ID: number

0x0004 the ID of this command

NAME: str

“RemoveAllGroups” the name of this command

build_test_command_response(device, endpoint_id, status)

Builds an RemoveAllGroups 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)

Initialize the RemoveAllGroups command

Parameters:

device (st.matter.Device) – the device to build this message to

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.Groups.server.commands.AddGroupIfIdentifying: st.matter.data_types.Structure
ID: number

0x0005 the ID of this command

NAME: str

“AddGroupIfIdentifying” the name of this command

groupid: st.matter.data_types.Uint16
group_name: st.matter.data_types.UTF8String1
build_test_command_response(device, endpoint_id, status)

Builds an AddGroupIfIdentifying 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, group_name)

Initialize the AddGroupIfIdentifying 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.Groups.types.Feature
GROUP_NAMES: number

1

is_group_names_set()
Returns:

True if the value of GROUP_NAMES is non-zero

Return type:

boolean

set_group_names()

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

unset_group_names()

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

class st.matter.generated.zap_clusters.Groups.types.NameSupportBitmap
GROUP_NAMES: number

128

is_group_names_set()
Returns:

True if the value of GROUP_NAMES is non-zero

Return type:

boolean

set_group_names()

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

unset_group_names()

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