WebRTCTransportRequestor

Attributes

class st.matter.generated.zap_clusters.WebRTCTransportRequestor.server.attributes.CurrentSessions

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

NAME: str: “CurrentSessions” 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 CurrentSessions(…) 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: CurrentSessions => 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 CurrentSessions 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.WebRTCTransportRequestor.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.WebRTCTransportRequestor.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) –

Server Commands

class st.matter.generated.zap_clusters.WebRTCTransportRequestor.server.commands.Offer: st.matter.data_types.Structure 

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

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

webrtc_sessionid: st.matter.data_types.Uint16

sdp: st.matter.data_types.UTF8String1

ice_servers: st.matter.data_types.Array

ice_transport_policy: st.matter.data_types.UTF8String1

build_test_command_response(device, endpoint_id, status)

Builds an Offer 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, webrtc_sessionid, sdp, ice_servers, ice_transport_policy)

Initialize the Offer command

Parameters

device (st.matter.Device) – the device to build this message to
webrtc_sessionid (st.matter.data_types.Uint16) –
sdp (st.matter.data_types.UTF8String1) –
ice_servers (st.matter.data_types.Array) –
ice_transport_policy (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.WebRTCTransportRequestor.server.commands.Answer: st.matter.data_types.Structure 

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

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

webrtc_sessionid: st.matter.data_types.Uint16

sdp: st.matter.data_types.UTF8String1

build_test_command_response(device, endpoint_id, status)

Builds an Answer 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, webrtc_sessionid, sdp)

Initialize the Answer command

Parameters

device (st.matter.Device) – the device to build this message to
webrtc_sessionid (st.matter.data_types.Uint16) –
sdp (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.WebRTCTransportRequestor.server.commands.ICECandidates: st.matter.data_types.Structure 

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

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

webrtc_sessionid: st.matter.data_types.Uint16

ice_candidates: st.matter.data_types.Array

build_test_command_response(device, endpoint_id, status)

Builds an ICECandidates 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, webrtc_sessionid, ice_candidates)

Initialize the ICECandidates command

Parameters

device (st.matter.Device) – the device to build this message to
webrtc_sessionid (st.matter.data_types.Uint16) –
ice_candidates (st.matter.data_types.Array) –

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.WebRTCTransportRequestor.server.commands.End: st.matter.data_types.Structure 

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

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

webrtc_sessionid: st.matter.data_types.Uint16

reason: st.matter.generated.zap_clusters.Global.types.WebRTCEndReasonEnum

build_test_command_response(device, endpoint_id, status)

Builds an End 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, webrtc_sessionid, reason)

Initialize the End command

Parameters

device (st.matter.Device) – the device to build this message to
webrtc_sessionid (st.matter.data_types.Uint16) –
reason (st.matter.generated.zap_clusters.Global.types.WebRTCEndReasonEnum) –

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) –