TargetNavigator

Attributes

class st.matter.generated.zap_clusters.TargetNavigator.server.attributes.TargetList

ID: number

0x0000 the ID of this attribute

NAME: str

“TargetList” 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 TargetList(…) 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: TargetList => 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 TargetList 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.TargetNavigator.server.attributes.CurrentTarget

ID: number

0x0001 the ID of this attribute

NAME: str

“CurrentTarget” the name of this attribute

data_type: st.matter.data_types.Uint8

the data type of this attribute

new_value(...)

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

This is also usable with the CurrentTarget(…) syntax

Parameters:

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

Return type:

st.matter.data_types.Uint8

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: CurrentTarget => 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 CurrentTarget 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.TargetNavigator.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.TargetNavigator.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.TargetNavigator.client.commands.NavigateTargetResponse: st.matter.data_types.Structure

ID: number

0x0001 the ID of this command

NAME: str

“NavigateTargetResponse” the name of this command

status: st.matter.generated.zap_clusters.TargetNavigator.types.StatusEnum

data: 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, data)

Builds an NavigateTargetResponse 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 (st.matter.generated.zap_clusters.TargetNavigator.types.StatusEnum)

• data (st.matter.data_types.UTF8String1)

Returns:

of type COMMAND_RESPONSE

Return type:

st.matter.st.matter.interaction_model.InteractionResponse

init()

Initialize the NavigateTargetResponse command

Return type:

nil

deserialize(tlv_buf)

Parameters:

tlv_buf (any)

Server Commands

class st.matter.generated.zap_clusters.TargetNavigator.server.commands.NavigateTarget: st.matter.data_types.Structure

ID: number

0x0000 the ID of this command

NAME: str

“NavigateTarget” the name of this command

target: st.matter.data_types.Uint8

data: st.matter.data_types.UTF8String1

init(device, target, data)

Refer to NavigateTargetResponse:build_test_command_response for

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

Parameters:

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

• target (st.matter.data_types.Uint8)

• data (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)

Events

class st.matter.generated.zap_clusters.TargetNavigator.server.events.TargetUpdated: st.matter.data_types.Structure

ID: number

0x0000 the ID of this event

NAME: str

“TargetUpdated” the name of this event

target_list: st.matter.data_types.Array

current_target: st.matter.data_types.Uint8

data: st.matter.data_types.OctetString1

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

Enum types

class st.matter.generated.zap_clusters.TargetNavigator.types.StatusEnum: st.matter.data_types.Uint8

byte_length: number

1

SUCCESS: number

0

TARGET_NOT_FOUND: number

1

NOT_ALLOWED: number

2

Struct types

class st.matter.generated.zap_clusters.TargetNavigator.types.TargetInfoStruct: st.matter.data_types.Structure

identifier: st.matter.data_types.Uint8

name: st.matter.data_types.UTF8String1