LevelControl

Attributes

class st.matter.clusters.LevelControl.CurrentLevel
ID: number

0x0000 the ID of this attribute

NAME: str

“CurrentLevel” 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 CurrentLevel(…) 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
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: CurrentLevel => 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 CurrentLevel 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.LevelControl.RemainingTime
ID: number

0x0001 the ID of this attribute

NAME: str

“RemainingTime” 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 RemainingTime(…) 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
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: RemainingTime => 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 RemainingTime 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.LevelControl.MinLevel
ID: number

0x0002 the ID of this attribute

NAME: str

“MinLevel” 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 MinLevel(…) 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
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: MinLevel => 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 MinLevel 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.LevelControl.MaxLevel
ID: number

0x0003 the ID of this attribute

NAME: str

“MaxLevel” 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 MaxLevel(…) 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
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: MaxLevel => 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 MaxLevel 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.LevelControl.CurrentFrequency
ID: number

0x0004 the ID of this attribute

NAME: str

“CurrentFrequency” 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 CurrentFrequency(…) 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
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: CurrentFrequency => 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 CurrentFrequency 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.LevelControl.MinFrequency
ID: number

0x0005 the ID of this attribute

NAME: str

“MinFrequency” 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 MinFrequency(…) 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
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: MinFrequency => 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 MinFrequency 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.LevelControl.MaxFrequency
ID: number

0x0006 the ID of this attribute

NAME: str

“MaxFrequency” 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 MaxFrequency(…) 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
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: MaxFrequency => 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 MaxFrequency 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.LevelControl.Options
ID: number

0x000F the ID of this attribute

NAME: str

“Options” the name of this attribute

data_type: st.matter.generated.zap_clusters.LevelControl.types.OptionsBitmap

the data type of this attribute

new_value(...)

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

This is also usable with the Options(…) syntax

Parameters

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

Return type

st.matter.generated.zap_clusters.LevelControl.types.OptionsBitmap

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters

  • device (st.matter.Device) –

  • endpoint_id (number or nil) –

  • value (st.matter.generated.zap_clusters.LevelControl.types.OptionsBitmap) – the value to write

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: Options => 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 Options 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.LevelControl.OnOffTransitionTime
ID: number

0x0010 the ID of this attribute

NAME: str

“OnOffTransitionTime” 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 OnOffTransitionTime(…) 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
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters
Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: OnOffTransitionTime => 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 OnOffTransitionTime 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.LevelControl.OnLevel
ID: number

0x0011 the ID of this attribute

NAME: str

“OnLevel” 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 OnLevel(…) 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
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters
Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: OnLevel => 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 OnLevel 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.LevelControl.OnTransitionTime
ID: number

0x0012 the ID of this attribute

NAME: str

“OnTransitionTime” 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 OnTransitionTime(…) 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
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters
Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: OnTransitionTime => 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 OnTransitionTime 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.LevelControl.OffTransitionTime
ID: number

0x0013 the ID of this attribute

NAME: str

“OffTransitionTime” 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 OffTransitionTime(…) 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
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters
Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: OffTransitionTime => 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 OffTransitionTime 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.LevelControl.DefaultMoveRate
ID: number

0x0014 the ID of this attribute

NAME: str

“DefaultMoveRate” 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 DefaultMoveRate(…) 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
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters
Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: DefaultMoveRate => 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 DefaultMoveRate 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.LevelControl.StartUpCurrentLevel
ID: number

0x4000 the ID of this attribute

NAME: str

“StartUpCurrentLevel” 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 StartUpCurrentLevel(…) 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
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters
Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: StartUpCurrentLevel => 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 StartUpCurrentLevel 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.LevelControl.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
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.LevelControl.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
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.LevelControl.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
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) –

Server Commands

class st.matter.clusters.LevelControl.MoveToLevel
ID: number

0x0000 the ID of this command

NAME: str

“MoveToLevel” the name of this command

level: st.matter.data_types.Uint8
transition_time: st.matter.data_types.Uint16
options_mask: st.matter.generated.zap_clusters.LevelControl.types.OptionsBitmap
options_override: st.matter.generated.zap_clusters.LevelControl.types.OptionsBitmap
build_test_command_response(device, endpoint_id, status)

Builds an MoveToLevel 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(self, device, level, transition_time, options_mask, options_override)

Initialize the MoveToLevel command

Parameters

  • self (MoveToLevel) – the template class for this command

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

  • level (st.matter.data_types.Uint8) –

  • transition_time (st.matter.data_types.Uint16) –

  • options_mask (st.matter.generated.zap_clusters.LevelControl.types.OptionsBitmap) –

  • options_override (st.matter.generated.zap_clusters.LevelControl.types.OptionsBitmap) –

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.LevelControl.Move
ID: number

0x0001 the ID of this command

NAME: str

“Move” the name of this command

move_mode: st.matter.generated.zap_clusters.LevelControl.types.MoveModeEnum
rate: st.matter.data_types.Uint8
options_mask: st.matter.generated.zap_clusters.LevelControl.types.OptionsBitmap
options_override: st.matter.generated.zap_clusters.LevelControl.types.OptionsBitmap
build_test_command_response(device, endpoint_id, status)

Builds an Move 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(self, device, move_mode, rate, options_mask, options_override)

Initialize the Move command

Parameters

  • self (Move) – the template class for this command

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

  • move_mode (st.matter.generated.zap_clusters.LevelControl.types.MoveModeEnum) –

  • rate (st.matter.data_types.Uint8) –

  • options_mask (st.matter.generated.zap_clusters.LevelControl.types.OptionsBitmap) –

  • options_override (st.matter.generated.zap_clusters.LevelControl.types.OptionsBitmap) –

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.LevelControl.Step
ID: number

0x0002 the ID of this command

NAME: str

“Step” the name of this command

step_mode: st.matter.generated.zap_clusters.LevelControl.types.StepModeEnum
step_size: st.matter.data_types.Uint8
transition_time: st.matter.data_types.Uint16
options_mask: st.matter.generated.zap_clusters.LevelControl.types.OptionsBitmap
options_override: st.matter.generated.zap_clusters.LevelControl.types.OptionsBitmap
build_test_command_response(device, endpoint_id, status)

Builds an Step 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(self, device, step_mode, step_size, transition_time, options_mask, options_override)

Initialize the Step command

Parameters

  • self (Step) – the template class for this command

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

  • step_mode (st.matter.generated.zap_clusters.LevelControl.types.StepModeEnum) –

  • step_size (st.matter.data_types.Uint8) –

  • transition_time (st.matter.data_types.Uint16) –

  • options_mask (st.matter.generated.zap_clusters.LevelControl.types.OptionsBitmap) –

  • options_override (st.matter.generated.zap_clusters.LevelControl.types.OptionsBitmap) –

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.LevelControl.Stop
ID: number

0x0003 the ID of this command

NAME: str

“Stop” the name of this command

options_mask: st.matter.generated.zap_clusters.LevelControl.types.OptionsBitmap
options_override: st.matter.generated.zap_clusters.LevelControl.types.OptionsBitmap
build_test_command_response(device, endpoint_id, status)

Builds an Stop 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(self, device, options_mask, options_override)

Initialize the Stop command

Parameters

  • self (Stop) – the template class for this command

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

  • options_mask (st.matter.generated.zap_clusters.LevelControl.types.OptionsBitmap) –

  • options_override (st.matter.generated.zap_clusters.LevelControl.types.OptionsBitmap) –

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.LevelControl.MoveToLevelWithOnOff
ID: number

0x0004 the ID of this command

NAME: str

“MoveToLevelWithOnOff” the name of this command

level: st.matter.data_types.Uint8
transition_time: st.matter.data_types.Uint16
options_mask: st.matter.generated.zap_clusters.LevelControl.types.OptionsBitmap
options_override: st.matter.generated.zap_clusters.LevelControl.types.OptionsBitmap
build_test_command_response(device, endpoint_id, status)

Builds an MoveToLevelWithOnOff 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(self, device, level, transition_time, options_mask, options_override)

Initialize the MoveToLevelWithOnOff command

Parameters

  • self (MoveToLevelWithOnOff) – the template class for this command

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

  • level (st.matter.data_types.Uint8) –

  • transition_time (st.matter.data_types.Uint16) –

  • options_mask (st.matter.generated.zap_clusters.LevelControl.types.OptionsBitmap) –

  • options_override (st.matter.generated.zap_clusters.LevelControl.types.OptionsBitmap) –

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.LevelControl.MoveWithOnOff
ID: number

0x0005 the ID of this command

NAME: str

“MoveWithOnOff” the name of this command

move_mode: st.matter.generated.zap_clusters.LevelControl.types.MoveModeEnum
rate: st.matter.data_types.Uint8
options_mask: st.matter.generated.zap_clusters.LevelControl.types.OptionsBitmap
options_override: st.matter.generated.zap_clusters.LevelControl.types.OptionsBitmap
build_test_command_response(device, endpoint_id, status)

Builds an MoveWithOnOff 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(self, device, move_mode, rate, options_mask, options_override)

Initialize the MoveWithOnOff command

Parameters

  • self (MoveWithOnOff) – the template class for this command

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

  • move_mode (st.matter.generated.zap_clusters.LevelControl.types.MoveModeEnum) –

  • rate (st.matter.data_types.Uint8) –

  • options_mask (st.matter.generated.zap_clusters.LevelControl.types.OptionsBitmap) –

  • options_override (st.matter.generated.zap_clusters.LevelControl.types.OptionsBitmap) –

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.LevelControl.StepWithOnOff
ID: number

0x0006 the ID of this command

NAME: str

“StepWithOnOff” the name of this command

step_mode: st.matter.generated.zap_clusters.LevelControl.types.StepModeEnum
step_size: st.matter.data_types.Uint8
transition_time: st.matter.data_types.Uint16
options_mask: st.matter.generated.zap_clusters.LevelControl.types.OptionsBitmap
options_override: st.matter.generated.zap_clusters.LevelControl.types.OptionsBitmap
build_test_command_response(device, endpoint_id, status)

Builds an StepWithOnOff 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(self, device, step_mode, step_size, transition_time, options_mask, options_override)

Initialize the StepWithOnOff command

Parameters

  • self (StepWithOnOff) – the template class for this command

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

  • step_mode (st.matter.generated.zap_clusters.LevelControl.types.StepModeEnum) –

  • step_size (st.matter.data_types.Uint8) –

  • transition_time (st.matter.data_types.Uint16) –

  • options_mask (st.matter.generated.zap_clusters.LevelControl.types.OptionsBitmap) –

  • options_override (st.matter.generated.zap_clusters.LevelControl.types.OptionsBitmap) –

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.LevelControl.StopWithOnOff
ID: number

0x0007 the ID of this command

NAME: str

“StopWithOnOff” the name of this command

options_mask: st.matter.generated.zap_clusters.LevelControl.types.OptionsBitmap
options_override: st.matter.generated.zap_clusters.LevelControl.types.OptionsBitmap
build_test_command_response(device, endpoint_id, status)

Builds an StopWithOnOff 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(self, device, options_mask, options_override)

Initialize the StopWithOnOff command

Parameters

  • self (StopWithOnOff) – the template class for this command

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

  • options_mask (st.matter.generated.zap_clusters.LevelControl.types.OptionsBitmap) –

  • options_override (st.matter.generated.zap_clusters.LevelControl.types.OptionsBitmap) –

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.LevelControl.MoveToClosestFrequency
ID: number

0x0008 the ID of this command

NAME: str

“MoveToClosestFrequency” the name of this command

frequency: st.matter.data_types.Uint16
build_test_command_response(device, endpoint_id, status)

Builds an MoveToClosestFrequency 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(self, device, frequency)

Initialize the MoveToClosestFrequency command

Parameters
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.LevelControl.types.Feature
ON_OFF: number

1

LIGHTING: number

2

FREQUENCY: number

4

is_on_off_set()
Returns

True if the value of ON_OFF is non-zero

Return type

boolean

set_on_off()

Set the value of the bit in the ON_OFF field to 1

unset_on_off()

Set the value of the bits in the ON_OFF field to 0

is_lighting_set()
Returns

True if the value of LIGHTING is non-zero

Return type

boolean

set_lighting()

Set the value of the bit in the LIGHTING field to 1

unset_lighting()

Set the value of the bits in the LIGHTING field to 0

is_frequency_set()
Returns

True if the value of FREQUENCY is non-zero

Return type

boolean

set_frequency()

Set the value of the bit in the FREQUENCY field to 1

unset_frequency()

Set the value of the bits in the FREQUENCY field to 0

class st.matter.clusters.LevelControl.types.OptionsBitmap
EXECUTE_IF_OFF: number

1

COUPLE_COLOR_TEMP_TO_LEVEL: number

2

is_execute_if_off_set()
Returns

True if the value of EXECUTE_IF_OFF is non-zero

Return type

boolean

set_execute_if_off()

Set the value of the bit in the EXECUTE_IF_OFF field to 1

unset_execute_if_off()

Set the value of the bits in the EXECUTE_IF_OFF field to 0

is_couple_color_temp_to_level_set()
Returns

True if the value of COUPLE_COLOR_TEMP_TO_LEVEL is non-zero

Return type

boolean

set_couple_color_temp_to_level()

Set the value of the bit in the COUPLE_COLOR_TEMP_TO_LEVEL field to 1

unset_couple_color_temp_to_level()

Set the value of the bits in the COUPLE_COLOR_TEMP_TO_LEVEL field to 0

Enum types

class st.matter.clusters.LevelControl.types.MoveModeEnum: st.matter.data_types.Uint8
byte_length: number

1

UP: number

0

DOWN: number

1

class st.matter.clusters.LevelControl.types.StepModeEnum: st.matter.data_types.Uint8
byte_length: number

1

UP: number

0

DOWN: number

1