AccountLogin¶

class st.matter.generated.zap_clusters.AccountLogin.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:

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

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.AccountLogin.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:

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

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.AccountLogin.client.commands.GetSetupPINResponse: st.matter.data_types.Structure ¶

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

NAME: str¶: “GetSetupPINResponse” the name of this command

setuppin: 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, setuppin)¶

Builds an GetSetupPINResponse 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)
setuppin (st.matter.data_types.UTF8String1)

Returns:

of type COMMAND_RESPONSE

Return type:

st.matter.st.matter.interaction_model.InteractionResponse

init()¶

Initialize the GetSetupPINResponse command

Return type:: nil

deserialize(tlv_buf)¶

Parameters:: tlv_buf (any)

Server Commands¶

class st.matter.generated.zap_clusters.AccountLogin.server.commands.GetSetupPIN: st.matter.data_types.Structure ¶

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

NAME: str¶: “GetSetupPIN” the name of this command

temp_account_identifier: st.matter.data_types.UTF8String1¶

init(device, temp_account_identifier)¶

Refer to GetSetupPINResponse:build_test_command_response for

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

Parameters:

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

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.AccountLogin.server.commands.Login: st.matter.data_types.Structure ¶

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

NAME: str¶: “Login” the name of this command

temp_account_identifier: st.matter.data_types.UTF8String1¶

setuppin: st.matter.data_types.UTF8String1¶

node: st.matter.data_types.Uint64¶

build_test_command_response(device, endpoint_id, status)¶

Builds an Login 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, temp_account_identifier, setuppin, node)¶

Initialize the Login command

Parameters:

device (st.matter.Device) – the device to build this message to
temp_account_identifier (st.matter.data_types.UTF8String1)
setuppin (st.matter.data_types.UTF8String1)
node (st.matter.data_types.Uint64)

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.AccountLogin.server.commands.Logout: st.matter.data_types.Structure ¶

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

NAME: str¶: “Logout” the name of this command

node: st.matter.data_types.Uint64¶

build_test_command_response(device, endpoint_id, status)¶

Builds an Logout 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, node)¶

Initialize the Logout command

Parameters:

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

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)

Events¶

class st.matter.generated.zap_clusters.AccountLogin.server.events.LoggedOut: st.matter.data_types.Structure ¶

ID: number¶: 0x0000 the ID of this event

NAME: str¶: “LoggedOut” the name of this event

node: st.matter.data_types.Uint64¶

fabric_index: st.matter.data_types.Uint8¶

augment_type(base_type_obj)¶

Add field names to each event field

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

read(device, endpoint_id)¶

Constructs a read InteractionRequest for the Event

Parameters:

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

Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)¶

Constructs a subscribe InteractionRequest for the Event

Parameters:

device (any)
endpoint_id (number or nil)

Return type:

st.matter.interaction_model.InteractionRequest

build_test_event_report(device, endpoint_id, fields, status)¶

Builds an LoggedOut test event report reponse to be used by

the driver integration testing framework.

Parameters:

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil)
fields (table) – containing the event fields
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)