ThreadBorderRouterManagement¶

Attributes¶

class st.matter.generated.zap_clusters.ThreadBorderRouterManagement.server.attributes.BorderRouterName¶

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

NAME: str¶: “BorderRouterName” the name of this attribute

data_type: st.matter.data_types.UTF8String1¶: the data type of this attribute

new_value(...)¶

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

This is also usable with the BorderRouterName(…) syntax

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

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: BorderRouterName => 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 BorderRouterName 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.ThreadBorderRouterManagement.server.attributes.BorderAgentID¶

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

NAME: str¶: “BorderAgentID” the name of this attribute

data_type: st.matter.data_types.OctetString1¶: the data type of this attribute

new_value(...)¶

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

This is also usable with the BorderAgentID(…) syntax

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

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: BorderAgentID => 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 BorderAgentID 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.ThreadBorderRouterManagement.server.attributes.ThreadVersion¶

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

NAME: str¶: “ThreadVersion” 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 ThreadVersion(…) 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:

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: ThreadVersion => 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 ThreadVersion 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.ThreadBorderRouterManagement.server.attributes.InterfaceEnabled¶

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

NAME: str¶: “InterfaceEnabled” the name of this attribute

data_type: st.matter.data_types.Boolean¶: the data type of this attribute

new_value(...)¶

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

This is also usable with the InterfaceEnabled(…) syntax

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

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: InterfaceEnabled => 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 InterfaceEnabled 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.ThreadBorderRouterManagement.server.attributes.ActiveDatasetTimestamp¶

ID: number¶: 0x0004 the ID of this attribute

NAME: str¶: “ActiveDatasetTimestamp” the name of this attribute

data_type: st.matter.data_types.Uint64¶: the data type of this attribute

new_value(...)¶

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

This is also usable with the ActiveDatasetTimestamp(…) syntax

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

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: ActiveDatasetTimestamp => 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 ActiveDatasetTimestamp 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.ThreadBorderRouterManagement.server.attributes.PendingDatasetTimestamp¶

ID: number¶: 0x0005 the ID of this attribute

NAME: str¶: “PendingDatasetTimestamp” the name of this attribute

data_type: st.matter.data_types.Uint64¶: the data type of this attribute

new_value(...)¶

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

This is also usable with the PendingDatasetTimestamp(…) syntax

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

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: PendingDatasetTimestamp => 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 PendingDatasetTimestamp 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.ThreadBorderRouterManagement.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.ThreadBorderRouterManagement.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.ThreadBorderRouterManagement.client.commands.DatasetResponse: st.matter.data_types.Structure ¶

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

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

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

Builds an DatasetResponse 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)
dataset (st.matter.data_types.OctetString1)

Returns:

of type COMMAND_RESPONSE

Return type:

st.matter.st.matter.interaction_model.InteractionResponse

init()¶

Initialize the DatasetResponse command

Return type:: nil

deserialize(tlv_buf)¶

Parameters:: tlv_buf (any)

Server Commands¶

class st.matter.generated.zap_clusters.ThreadBorderRouterManagement.server.commands.GetActiveDatasetRequest: st.matter.data_types.Structure ¶

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

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

init(device)¶

Refer to DatasetResponse:build_test_command_response for

building a test command reponse for the driver integration testing framework Initialize the GetActiveDatasetRequest 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.ThreadBorderRouterManagement.server.commands.GetPendingDatasetRequest: st.matter.data_types.Structure ¶

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

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

init(device)¶

Refer to DatasetResponse:build_test_command_response for

building a test command reponse for the driver integration testing framework Initialize the GetPendingDatasetRequest 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.ThreadBorderRouterManagement.server.commands.SetActiveDatasetRequest: st.matter.data_types.Structure ¶

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

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

active_dataset: st.matter.data_types.OctetString1¶

breadcrumb: st.matter.data_types.Uint64¶

build_test_command_response(device, endpoint_id, status)¶

Builds an SetActiveDatasetRequest 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, active_dataset, breadcrumb)¶

Initialize the SetActiveDatasetRequest command

Parameters:

device (st.matter.Device) – the device to build this message to
active_dataset (st.matter.data_types.OctetString1)
breadcrumb (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.ThreadBorderRouterManagement.server.commands.SetPendingDatasetRequest: st.matter.data_types.Structure ¶

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

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

pending_dataset: st.matter.data_types.OctetString1¶

build_test_command_response(device, endpoint_id, status)¶

Builds an SetPendingDatasetRequest 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, pending_dataset)¶

Initialize the SetPendingDatasetRequest command

Parameters:

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

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.ThreadBorderRouterManagement.types.Feature¶

PAN_CHANGE: number¶: 1

is_pan_change_set()¶

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

set_pan_change()¶: Set the value of the bit in the PAN_CHANGE field to 1

unset_pan_change()¶: Set the value of the bits in the PAN_CHANGE field to 0