OnOff

Attributes

class st.matter.clusters.OnOff.OnOff

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

NAME: str: “OnOff” 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 OnOff(…) 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: OnOff => true => suggested

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 OnOff 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.OnOff.GlobalSceneControl

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

NAME: str: “GlobalSceneControl” 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 GlobalSceneControl(…) 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: GlobalSceneControl => 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 GlobalSceneControl 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.OnOff.OnTime

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

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

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.data_types.Uint16) –

Returns

the value to write

Return type

st.matter.data_types.Uint16

subscribe(device, endpoint_id)

Reporting policy: OnTime => 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 OnTime 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.OnOff.OffWaitTime

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

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

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.data_types.Uint16) –

Returns

the value to write

Return type

st.matter.data_types.Uint16

subscribe(device, endpoint_id)

Reporting policy: OffWaitTime => 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 OffWaitTime 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.OnOff.StartUpOnOff

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

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

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

OFF: number: 0

ON: number: 1

TOGGLE_PREVIOUS_ON_OFF: number: 2

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters: base_type_obj (st.matter.data_types.Uint8) – the base data type object to add functionality to

new_value(...)

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

This is also usable with the StartUpOnOff(…) 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

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.data_types.Uint8) –

Returns

the value to write

Return type

st.matter.data_types.Uint8

subscribe(device, endpoint_id)

Reporting policy: StartUpOnOff => 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 StartUpOnOff 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.OnOff.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

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.OnOff.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

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

Server Commands

class st.matter.clusters.OnOff.Off

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

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

build_test_command_response(device, endpoint_id, status)

Builds an Off 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)

Initialize the Off command

Parameters

self (Off) – the template class for this command
device (st.matter.Device) – the device to build this message to

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.OnOff.On

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

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

build_test_command_response(device, endpoint_id, status)

Builds an On 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)

Initialize the On command

Parameters

self (On) – the template class for this command
device (st.matter.Device) – the device to build this message to

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.OnOff.Toggle

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

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

build_test_command_response(device, endpoint_id, status)

Builds an Toggle 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)

Initialize the Toggle command

Parameters

self (Toggle) – the template class for this command
device (st.matter.Device) – the device to build this message to

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.OnOff.OffWithEffect

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

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

effect_id: st.matter.clusters.OnOff.types.OnOffEffectIdentifier

effect_variant: st.matter.clusters.OnOff.types.OnOffDelayedAllOffEffectVariant

build_test_command_response(device, endpoint_id, status)

Builds an OffWithEffect 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, effect_id, effect_variant)

Initialize the OffWithEffect command

Parameters

self (OffWithEffect) – the template class for this command
device (st.matter.Device) – the device to build this message to
effect_id (st.matter.clusters.OnOff.types.OnOffEffectIdentifier) –
effect_variant (st.matter.clusters.OnOff.types.OnOffDelayedAllOffEffectVariant) –

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.OnOff.OnWithRecallGlobalScene

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

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

build_test_command_response(device, endpoint_id, status)

Builds an OnWithRecallGlobalScene 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)

Initialize the OnWithRecallGlobalScene command

Parameters

self (OnWithRecallGlobalScene) – the template class for this command
device (st.matter.Device) – the device to build this message to

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.OnOff.OnWithTimedOff

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

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

on_off_control: st.matter.clusters.OnOff.types.OnOffControl

on_time: data_types.Uint16

off_wait_time: data_types.Uint16

build_test_command_response(device, endpoint_id, status)

Builds an OnWithTimedOff 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, on_off_control, on_time, off_wait_time)

Initialize the OnWithTimedOff command

Parameters

self (OnWithTimedOff) – the template class for this command
device (st.matter.Device) – the device to build this message to
on_off_control (st.matter.clusters.OnOff.types.OnOffControl) –
on_time (st.matter.data_types.Uint16) –
off_wait_time (st.matter.data_types.Uint16) –

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.OnOff.types.OnOffControl

ACCEPT_ONLY_WHEN_ON: number: 1

is_accept_only_when_on_set()

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

set_accept_only_when_on(): Set the value of the bit in the ACCEPT_ONLY_WHEN_ON field to 1

unset_accept_only_when_on(): Set the value of the bits in the ACCEPT_ONLY_WHEN_ON field to 0

class st.matter.clusters.OnOff.types.OnOffFeature

LIGHTING: number: 1

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

class st.matter.clusters.OnOff.types.SceneFeatures

SCENE_NAMES: number: 1

is_scene_names_set()

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

set_scene_names(): Set the value of the bit in the SCENE_NAMES field to 1

unset_scene_names(): Set the value of the bits in the SCENE_NAMES field to 0

Enum types

class st.matter.clusters.OnOff.types.OnOffDelayedAllOffEffectVariant: st.matter.data_types.Uint8 

byte_length: number: 1

FADE_TO_OFF_IN_0P8_SECONDS: number: 0

NO_FADE: number: 1

_50_PERCENT_DIM_DOWN_IN_0P8_SECONDS_THEN_FADE_TO_OFF_IN_12_SECONDS: number: 2

class st.matter.clusters.OnOff.types.OnOffDyingLightEffectVariant: st.matter.data_types.Uint8 

byte_length: number: 1

_20_PERCENTER_DIM_UP_IN_0P5_SECONDS_THEN_FADE_TO_OFF_IN_1_SECOND: number: 0

class st.matter.clusters.OnOff.types.OnOffEffectIdentifier: st.matter.data_types.Uint8 

byte_length: number: 1

DELAYED_ALL_OFF: number: 0

DYING_LIGHT: number: 1

class st.matter.clusters.OnOff.types.OnOffStartUpOnOff: st.matter.data_types.Uint8 

byte_length: number: 1

OFF: number: 0

ON: number: 1

TOGGLE_PREVIOUS_ON_OFF: number: 2