ServiceArea

Attributes

class st.matter.clusters.ServiceArea.SupportedAreas

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

NAME: str: “SupportedAreas” the name of this attribute

data_type: st.matter.data_types.Array: the data type of this attribute

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters: base_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 SupportedAreas(…) 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: SupportedAreas => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an SupportedAreas 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.clusters.ServiceArea.SupportedMaps

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

NAME: str: “SupportedMaps” the name of this attribute

data_type: st.matter.data_types.Array: the data type of this attribute

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters: base_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 SupportedMaps(…) 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: SupportedMaps => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an SupportedMaps 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.clusters.ServiceArea.SelectedAreas

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

NAME: str: “SelectedAreas” the name of this attribute

data_type: st.matter.data_types.Array: the data type of this attribute

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters: base_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 SelectedAreas(…) 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: SelectedAreas => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an SelectedAreas 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.clusters.ServiceArea.CurrentArea

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

NAME: str: “CurrentArea” the name of this attribute

data_type: st.matter.data_types.Uint32: the data type of this attribute

new_value(...)

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

This is also usable with the CurrentArea(…) syntax

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

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: CurrentArea => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an CurrentArea 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.clusters.ServiceArea.EstimatedEndTime

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

NAME: str: “EstimatedEndTime” the name of this attribute

data_type: st.matter.data_types.Uint32: the data type of this attribute

new_value(...)

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

This is also usable with the EstimatedEndTime(…) syntax

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

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: EstimatedEndTime => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an EstimatedEndTime 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.clusters.ServiceArea.Progress

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

NAME: str: “Progress” the name of this attribute

data_type: st.matter.data_types.Array: the data type of this attribute

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters: base_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 Progress(…) 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: Progress => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an Progress 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.clusters.ServiceArea.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(base_type_obj)

Add additional functionality to the base type object

Parameters: base_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

set_parent_cluster(cluster)

Parameters: cluster (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.clusters.ServiceArea.EventList

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

NAME: str: “EventList” the name of this attribute

data_type: st.matter.data_types.Array: the data type of this attribute

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters: base_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 EventList(…) 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: EventList => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an EventList 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.clusters.ServiceArea.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(base_type_obj)

Add additional functionality to the base type object

Parameters: base_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

set_parent_cluster(cluster)

Parameters: cluster (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.clusters.ServiceArea.SelectAreasResponse

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

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

status: st.matter.generated.zap_clusters.ServiceArea.types.SelectAreasStatus

status_text: 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, status_text)

Builds an SelectAreasResponse 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.ServiceArea.types.SelectAreasStatus) –
status_text (st.matter.data_types.UTF8String1) –

Returns

of type COMMAND_RESPONSE

Return type

st.matter.st.matter.interaction_model.InteractionResponse

init()

Initialize the SelectAreasResponse command

Return type: nil

set_parent_cluster(cluster)

Parameters: cluster (any) –

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.ServiceArea.SkipAreaResponse

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

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

status: st.matter.generated.zap_clusters.ServiceArea.types.SkipAreaStatus

status_text: 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, status_text)

Builds an SkipAreaResponse 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.ServiceArea.types.SkipAreaStatus) –
status_text (st.matter.data_types.UTF8String1) –

Returns

of type COMMAND_RESPONSE

Return type

st.matter.st.matter.interaction_model.InteractionResponse

init()

Initialize the SkipAreaResponse command

Return type: nil

set_parent_cluster(cluster)

Parameters: cluster (any) –

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

Server Commands

class st.matter.clusters.ServiceArea.SelectAreas

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

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

new_areas: st.matter.data_types.Array

init(self, device, new_areas)

Refer to SelectAreasResponse:build_test_command_response for

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

Parameters

self (SelectAreas) – the template class for this command
device (st.matter.Device) – the device to build this message to
new_areas (st.matter.data_types.Array) –

Returns

of type INVOKE

Return type

st.matter.interaction_model.InteractionRequest

set_parent_cluster(cluster)

Parameters: cluster (any) –

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.clusters.ServiceArea.SkipArea

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

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

skipped_area: st.matter.data_types.Uint32

init(self, device, skipped_area)

Refer to SkipAreaResponse:build_test_command_response for

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

Parameters

self (SkipArea) – the template class for this command
device (st.matter.Device) – the device to build this message to
skipped_area (st.matter.data_types.Uint32) –

Returns

of type INVOKE

Return type

st.matter.interaction_model.InteractionRequest

set_parent_cluster(cluster)

Parameters: cluster (any) –

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.clusters.ServiceArea.types.Feature

SELECT_WHILE_RUNNING: number: 1

PROGRESS_REPORTING: number: 2

MAPS: number: 4

is_select_while_running_set()

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

set_select_while_running(): Set the value of the bit in the SELECT_WHILE_RUNNING field to 1

unset_select_while_running(): Set the value of the bits in the SELECT_WHILE_RUNNING field to 0

is_progress_reporting_set()

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

set_progress_reporting(): Set the value of the bit in the PROGRESS_REPORTING field to 1

unset_progress_reporting(): Set the value of the bits in the PROGRESS_REPORTING field to 0

is_maps_set()

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

set_maps(): Set the value of the bit in the MAPS field to 1

unset_maps(): Set the value of the bits in the MAPS field to 0

Enum types

class st.matter.clusters.ServiceArea.types.OperationalStatusEnum: st.matter.data_types.Uint8 

byte_length: number: 1

PENDING: number: 0

OPERATING: number: 1

SKIPPED: number: 2

COMPLETED: number: 3

class st.matter.clusters.ServiceArea.types.SelectAreasStatus: st.matter.data_types.Uint8 

byte_length: number: 1

SUCCESS: number: 0

UNSUPPORTED_AREA: number: 1

INVALID_IN_MODE: number: 2

INVALID_SET: number: 3

class st.matter.clusters.ServiceArea.types.SkipAreaStatus: st.matter.data_types.Uint8 

byte_length: number: 1

SUCCESS: number: 0

INVALID_AREA_LIST: number: 1

INVALID_IN_MODE: number: 2

INVALID_SKIPPED_AREA: number: 3

Struct types

class st.matter.clusters.ServiceArea.types.LandmarkInfoStruct: st.matter.data_types.Structure 

landmark_tag: st.matter.generated.zap_clusters.Global.types.LandmarkTag

relative_position_tag: st.matter.generated.zap_clusters.Global.types.RelativePositionTag

class st.matter.clusters.ServiceArea.types.AreaInfoStruct: st.matter.data_types.Structure 

location_info: st.matter.generated.zap_clusters.Global.types.LocationDescriptorStruct

landmark_info: st.matter.generated.zap_clusters.ServiceArea.types.LandmarkInfoStruct

class st.matter.clusters.ServiceArea.types.AreaStruct: st.matter.data_types.Structure 

area_id: st.matter.data_types.Uint32

map_id: st.matter.data_types.Uint32

area_info: st.matter.generated.zap_clusters.ServiceArea.types.AreaInfoStruct

class st.matter.clusters.ServiceArea.types.MapStruct: st.matter.data_types.Structure 

map_id: st.matter.data_types.Uint32

name: st.matter.data_types.UTF8String1

class st.matter.clusters.ServiceArea.types.ProgressStruct: st.matter.data_types.Structure 

area_id: st.matter.data_types.Uint32

status: st.matter.generated.zap_clusters.ServiceArea.types.OperationalStatusEnum

total_operational_time: st.matter.data_types.Uint32

estimated_time: st.matter.data_types.Uint32